Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added pre-send handler #14

Merged
merged 1 commit into from
Aug 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/Api/Module.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,24 @@ class Module
protected $restClient;
protected $moduleSchema;
protected $params;
protected $uri;
protected $preSendHandler;

public function __construct($restClient, $moduleSchema, $options)
public function __construct($restClient, $moduleSchema, $options, $uri = null, $preSendHandler = null)
{
$this->restClient = $restClient;
$this->moduleSchema = $moduleSchema;
$this->params = $options;
$this->uri = $uri;
$this->preSendHandler = $preSendHandler;
}

public function apiFunction($data = [])
{
if (!is_null($this->preSendHandler)) {
call_user_func_array($this->preSendHandler, [&$data, $this->uri, $this->params['method']]);
}

if ($this->moduleSchema) {
$validationResult = Validator::validate($this->moduleSchema, $data);
}
Expand Down
10 changes: 8 additions & 2 deletions src/Api/ModuleLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ private function getFunctionInstance($options)
'method' => $options['definition']['method']
];

$module = new Module($restClient, $moduleSchema, $requestArgs);
$module = new Module($restClient, $moduleSchema, $requestArgs, $options['uri'], $options['sharedOptions']['preSendHandler']);
$functionInstance = array($module, 'apiFunction');
return $functionInstance;
}
Expand Down Expand Up @@ -102,7 +102,10 @@ private function addModuleMapV1($versionFunctions, $moduleInfo, $version, $isSta
'url' => $apiUrl,
'definition' => $functionDefinition,
'sharedOptions' => $sharedOptions,
'moduleSchema' => $moduleSchema
'moduleSchema' => $moduleSchema,
'uri' => implode('/', array_map(function($v) {
return rtrim($v, '/');
}, $urlParts)),
];

$this->moduleMap->{$moduleName}->{$version}->{$functionName} = $this->getFunctionInstance($functionOptions);
Expand Down Expand Up @@ -143,6 +146,9 @@ private function addModuleMapV4_0_0($functions, $moduleInfo, $version, $isStatic
'definition' => $functionDefinition,
'sharedOptions' => $sharedOptions,
'moduleSchema' => $this->getSchema($moduleInfo['schema'] ?? [], $version, $prop, $functionName),
'uri' => implode('/', array_map(function($v) {
return rtrim($v, '/');
}, $urlParts)),
];


Expand Down
17 changes: 16 additions & 1 deletion src/GreenSMS.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace GreenSMS;

use BadFunctionCallException;
use Exception;
use GreenSMS\Api\MethodInvoker;
use GreenSMS\Api\ModuleLoader;
Expand Down Expand Up @@ -76,7 +77,8 @@ public function __construct($options = [])
'restClient' => $this->getHttpClient([
'useCamelCase' => $this->camelCaseResponse
]),
'version' => Version::getVersion($this->version)
'version' => Version::getVersion($this->version),
'preSendHandler' => $this->getPreSendHandler($options),
];

$this->addModules($sharedOptions);
Expand Down Expand Up @@ -111,4 +113,17 @@ public function getHttpClient($args)
$restClient = new RestClient($httpParams);
return $restClient;
}

private function getPreSendHandler($options): ?callable
{
if (array_key_exists('preSendHandler', $options)) {
if (is_callable($options['preSendHandler'])) {
return $options['preSendHandler'];
} else {
throw new BadFunctionCallException('Key `preSendHandler` must be callable');
}
}

return null;
}
}
98 changes: 98 additions & 0 deletions tests/PreSendHandlerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?php

use GreenSMS\Tests\Utility;
use GreenSMS\GreenSMS;
use GreenSMS\Tests\TestCase;

final class PreSendHandlerTest extends TestCase
{
private $utility = null;

public function setUp(): void
{
$this->utility = new Utility();
}

public function testReplacement()
{
$client = new GreenSMS([
'user' => 'test',
'pass' => 'test',
'preSendHandler' => function(&$data, $uri, $method) {
$this->assertEquals('someVal', $data['someKey']);
$this->assertEquals('sms/send', $uri);
$this->assertEqualsIgnoringCase('post', $method);
$data['to'] = $this->utility->getRandomPhone();
$data['txt'] = 'txt';
}
]);

$response = $client->sms->send(['someKey' => 'someVal', 'to'=> 111]);

$this->assertObjectHasProperty('request_id', $response);
}

public function testEmptyData()
{
$client = new GreenSMS([
'user' => 'test',
'pass' => 'test',
'preSendHandler' => function($data, $uri, $method) {
$this->assertEquals('account/balance', $uri);
$this->assertEmpty($data);
$this->assertEqualsIgnoringCase('get', $method);
}
]);

$response = $client->account->balance();

$this->assertObjectHasProperty('balance', $response);
$this->assertEquals(4, $this->getCount());
}

public function testInvocable()
{
$invocable = new class extends TestCase{
public function __invoke($data, $uri, $method) {
$this->assertEquals('account/balance', $uri);
$this->assertEmpty($data);
$this->assertEqualsIgnoringCase('get', $method);
}
};

(new GreenSMS([
'user' => 'test',
'pass' => 'test',
'preSendHandler' => $invocable,
]))->account->balance();
}

public function testV4()
{
$client = new GreenSMS([
'user' => 'test',
'pass' => 'test',
'preSendHandler' => function($data, $uri, $method) {
$this->assertEmpty($data);
$this->assertEquals('account/webhook', $uri);
$this->assertEqualsIgnoringCase('get', $method);
}
]);

$response = $client->account->webhook->get();

$this->assertObjectHasProperty('webhook', $response);
$this->assertEquals(4, $this->getCount());
}

public function testNotCallable()
{
$this->expectException(BadFunctionCallException::class);

new GreenSMS([
'user' => 'test',
'pass' => 'test',
'preSendHandler' => '',
]);
}
}
Loading