├── .gitignore
├── vonage_logo.png
├── src
    ├── Facade
    │   └── Vonage.php
    └── VonageServiceProvider.php
├── phpunit.xml
├── .phpunit.result.cache
├── tests
    ├── vonageTest
    │   ├── TestServiceProvider.php
    │   ├── TestNoVonageConfiguration.php
    │   ├── TestClientBasicAPICredentials.php
    │   ├── TestClientPrivateKeyCredentials.php
    │   ├── TestClientSignatureAPICredentials.php
    │   ├── TestClientPrivateKeyBasicCredentials.php
    │   └── TestClientPrivateKeySignatureCredentials.php
    └── AbstractTestCase.php
├── composer.json
├── .github
    └── workflows
    │   └── build.yml
├── config
    └── vonage.php
├── README.md
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | 


--------------------------------------------------------------------------------
/vonage_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Vonage/vonage-laravel/HEAD/vonage_logo.png


--------------------------------------------------------------------------------
/src/Facade/Vonage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Facade;
 4 | 
 5 | use Vonage\Client;
 6 | use Illuminate\Support\Facades\Facade;
 7 | 
 8 | class Vonage extends Facade
 9 | {
10 |     /**
11 |      * Get the registered name of the component.
12 |      *
13 |      * @return string
14 |      *
15 |      * @throws \RuntimeException
16 |      */
17 |     protected static function getFacadeAccessor()
18 |     {
19 |         return Client::class;
20 |     }
21 | }


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit backupGlobals="false"
 3 |          backupStaticAttributes="false"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 |          convertErrorsToExceptions="true"
 7 |          convertNoticesToExceptions="true"
 8 |          convertWarningsToExceptions="true"
 9 |          processIsolation="false"
10 |          stopOnFailure="false"
11 | >
12 |     <testsuites>
13 |         <testsuite name="Vonage Laravel Suite">
14 |             <directory suffix=".php">./tests/vonageTest</directory>
15 |         </testsuite>
16 |     </testsuites>
17 |     <php>
18 |         <env name="APP_DEBUG" value="true"/>
19 |         <env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
20 |         <env name="CACHE_DRIVER" value="array"/>
21 |     </php>
22 | </phpunit>


--------------------------------------------------------------------------------
/.phpunit.result.cache:
--------------------------------------------------------------------------------
1 | {"version":1,"defects":[],"times":{"Nexmo\\Laravel\\Tests\\TestServiceProvider::testClientResolutionFromContainer with data set #0":0.011,"Vonage\\Laravel\\Tests\\TestClientBasicAPICredentials::testClientCreatedWithBasicAPICredentials":0.137,"Vonage\\Laravel\\Tests\\TestClientPrivateKeyBasicCredentials::testClientCreatedWithPrivateKeyBasicCredentials with data set #0":0.013,"Vonage\\Laravel\\Tests\\TestClientPrivateKeyCredentials::testClientCreatedWithPrivateKeyCredentials with data set #0":0.011,"Vonage\\Laravel\\Tests\\TestClientPrivateKeySignatureCredentials::testClientCreatedWithPrivateKeySignatureCredentials with data set #0":0.011,"Vonage\\Laravel\\Tests\\TestClientSignatureAPICredentials::testClientCreatedWithSignatureAPICredentials with data set #0":0.011,"Vonage\\Laravel\\Tests\\TestNoVonageConfiguration::testWhenNoConfigurationIsGivenExceptionIsRaised with data set #0":0.012}}


--------------------------------------------------------------------------------
/tests/vonageTest/TestServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Laravel\Tests\AbstractTestCase;
 7 | 
 8 | class TestServiceProvider extends AbstractTestCase
 9 | {
10 |     /**
11 |      * Define environment setup.
12 |      *
13 |      * @param  Application $app
14 |      *
15 |      * @return void
16 |      */
17 |     protected function getEnvironmentSetUp($app): void
18 |     {
19 |         $app['config']->set('vonage.api_key', 'my_api_key');
20 |         $app['config']->set('vonage.api_secret', 'my_secret');
21 |     }
22 | 
23 |     /**
24 |      * Test that we can create the Vonage client
25 |      * from container binding.
26 |      *
27 |      * @dataProvider classNameProvider
28 |      *
29 |      * @param $className
30 |      *
31 |      * @return void
32 |      */
33 |     public function testClientResolutionFromContainer($className): void
34 |     {
35 |         $client = app($className);
36 | 
37 |         $this->assertInstanceOf($className, $client);
38 |     }
39 | }


--------------------------------------------------------------------------------
/tests/vonageTest/TestNoVonageConfiguration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Laravel\Tests\AbstractTestCase;
 7 | 
 8 | class TestNoVonageConfiguration extends AbstractTestCase
 9 | {
10 |     /**
11 |      * Define environment setup.
12 |      *
13 |      * @param  Application $app
14 |      *
15 |      * @return void
16 |      */
17 |     protected function getEnvironmentSetUp($app): void
18 |     {
19 |         $app['config']->set('vonage.api_key', 'my_api_key');
20 |     }
21 | 
22 |     /**
23 |      * Test that when we do not supply Vonage configuration
24 |      * a Runtime exception is generated under the Vonage namespace.
25 |      *
26 |      * @dataProvider classNameProvider
27 |      *
28 |      * @param $className
29 |      *
30 |      * @return void
31 |      */
32 |     public function testWhenNoConfigurationIsGivenExceptionIsRaised($className): void
33 |     {
34 |         $this->expectException(\RuntimeException::class);
35 |         $this->expectExceptionMessage('Please provide Vonage API credentials. Possible combinations: api_key + api_secret, api_key + signature_secret, private_key + application_id, api_key + api_secret + private_key + application_id, api_key + signature_secret + private_key + application_id');
36 | 
37 |         app($className);
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/tests/vonageTest/TestClientBasicAPICredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Client;
 7 | use Vonage\Laravel\Tests\AbstractTestCase;
 8 | 
 9 | class TestClientBasicAPICredentials extends AbstractTestCase
10 | {
11 |     /**
12 |      * Define environment setup.
13 |      *
14 |      * @param  Application $app
15 |      *
16 |      * @return void
17 |      */
18 |     protected function defineEnvironment($app): void
19 |     {
20 |         $app['config']->set('vonage.api_key', 'my_api_key');
21 |         $app['config']->set('vonage.api_secret', 'my_secret');
22 |     }
23 | 
24 |     /**
25 |      * Test that our Vonage client is created with
26 |      * the Basic API credentials.
27 |      *
28 |      * @return void
29 |      */
30 |     public function testClientCreatedWithBasicAPICredentials(): void
31 |     {
32 |         $client = app(Client::class);
33 |         $credentialsObject = $this->getClassProperty(Client::class, 'credentials', $client);
34 |         $credentialsArray = $this->getClassProperty(Client\Credentials\Basic::class, 'credentials', $credentialsObject);
35 | 
36 |         $this->assertInstanceOf(Client\Credentials\Basic::class, $credentialsObject);
37 |         $this->assertEquals(['api_key' => 'my_api_key', 'api_secret' => 'my_secret'], $credentialsArray);
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "vonage/vonage-laravel",
 3 |     "description": "Service provider for Laravel for the Vonage PHP SDK",
 4 |     "type": "package",
 5 |     "require": {
 6 |         "vonage/client": "^4.0",
 7 |         "php": "^8.0|^8.1|^8.2",
 8 |         "illuminate/support": "^9.0|^10.0|^11.0|^12.0"
 9 |     },
10 |     "require-dev": {
11 |         "roave/security-advisories": "dev-latest",
12 |         "phpunit/phpunit": "^5.3|~6.0|~8.0|~9.0|^10.5|^11.0",
13 |         "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0|^9.0|^10.0"
14 |     },
15 |     "license": "MIT",
16 |     "autoload": {
17 |         "psr-4": {
18 |             "Vonage\\Laravel\\": "src/"
19 |         }
20 |     },
21 |     "autoload-dev": {
22 |         "psr-4": {
23 |             "Vonage\\Laravel\\Tests\\": "tests/"
24 |         }
25 |     },
26 |     "extra": {
27 |         "laravel": {
28 |             "providers": [
29 |                 "Vonage\\Laravel\\VonageServiceProvider"
30 |             ],
31 |             "aliases": {
32 |                 "Vonage": "Vonage\\Laravel\\Facade\\Vonage"
33 |             }
34 |         }
35 |     },
36 |     "scripts": {
37 |         "test": "phpunit"
38 |     },
39 |     "authors": [
40 |         {
41 |             "name": "James Seconde",
42 |             "role": "PHP Developer Advocate",
43 |             "email": "jim.seconde@googlemail.com"
44 |         }
45 |     ]
46 | }
47 | 


--------------------------------------------------------------------------------
/tests/vonageTest/TestClientPrivateKeyCredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Client;
 7 | use Vonage\Laravel\Tests\AbstractTestCase;
 8 | 
 9 | class TestClientPrivateKeyCredentials extends AbstractTestCase
10 | {
11 |     /**
12 |      * Define environment setup.
13 |      *
14 |      * @param  Application $app
15 |      *
16 |      * @return void
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         $app['config']->set('vonage.private_key', '/path/to/key');
21 |         $app['config']->set('vonage.application_id', 'application-id-123');
22 |     }
23 | 
24 |     /**
25 |      * Test that our Vonage client is created with
26 |      * the private key credentials
27 |      *
28 |      * @dataProvider classNameProvider
29 |      *
30 |      * @param $className
31 |      *
32 |      * @return void
33 |      */
34 |     public function testClientCreatedWithPrivateKeyCredentials($className): void
35 |     {
36 |         $client = app($className);
37 |         $credentialsObject = $this->getClassProperty(Client::class, 'credentials', $client);
38 |         $credentialsArray = $this->getClassProperty(Client\Credentials\Keypair::class, 'credentials', $credentialsObject);
39 | 
40 |         $this->assertInstanceOf(Client\Credentials\Keypair::class, $credentialsObject);
41 |         $this->assertEquals(['key' => '===FAKE-KEY===', 'application' => 'application-id-123'], $credentialsArray);
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: build
 3 | 
 4 | on: [ push, pull_request ]
 5 | 
 6 | jobs:
 7 |   build:
 8 |     runs-on: ubuntu-latest
 9 |     strategy:
10 |       matrix:
11 |         php: [ '8.1', '8.2', '8.3' ]
12 | 
13 |     name: PHP ${{ matrix.php }} Test
14 | 
15 |     steps:
16 |       - name: Checkout
17 |         uses: actions/checkout@v2
18 | 
19 |       - name: Setup PHP
20 |         uses: shivammathur/setup-php@v2
21 |         with:
22 |           php-version: ${{ matrix.php }}
23 |           extensions: json, mbstring
24 |           coverage: pcov
25 |         env:
26 |           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27 | 
28 |       - name: Setup problem matchers for PHPUnit
29 |         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
30 | 
31 |       - name: Get Composer cache directory
32 |         id: composercache
33 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
34 | 
35 |       - name: Cache Composer dependencies
36 |         uses: actions/cache@v2
37 |         with:
38 |           path: ${{ steps.composercache.outputs.dir }}
39 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
40 |           restore-keys: ${{ runner.os }}-composer-
41 | 
42 |       - name: Install dependencies
43 |         run: composer update --prefer-dist --no-interaction
44 | 
45 |       - name: Analyze & test
46 |         run: composer test --coverage-clover=coverage.xml
47 | 
48 |       - name: Run codecov
49 |         uses: codecov/codecov-action@v1
50 | 


--------------------------------------------------------------------------------
/tests/vonageTest/TestClientSignatureAPICredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Client;
 7 | use Vonage\Laravel\Tests\AbstractTestCase;
 8 | 
 9 | class TestClientSignatureAPICredentials extends AbstractTestCase
10 | {
11 |     /**
12 |      * Define environment setup.
13 |      *
14 |      * @param  Application $app
15 |      *
16 |      * @return void
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         $app['config']->set('vonage.api_key', 'my_api_key');
21 |         $app['config']->set('vonage.signature_secret', 'my_signature');
22 |     }
23 | 
24 |     /**
25 |      * Test that our Vonage client is created with
26 |      * the signature credentials
27 |      *
28 |      * @dataProvider classNameProvider
29 |      *
30 |      * @param $className
31 |      *
32 |      * @return void
33 |      */
34 |     public function testClientCreatedWithSignatureAPICredentials($className): void
35 |     {
36 |         $client = app($className);
37 | 
38 |         $credentialsObject = $this->getClassProperty(Client::class, 'credentials', $client);
39 |         $credentialsArray = $this->getClassProperty(Client\Credentials\SignatureSecret::class, 'credentials', $credentialsObject);
40 | 
41 |         $this->assertInstanceOf(Client\Credentials\SignatureSecret::class, $credentialsObject);
42 |         $this->assertEquals(['api_key' => 'my_api_key', 'signature_secret' => 'my_signature', 'signature_method' => 'md5hash'], $credentialsArray);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/tests/AbstractTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Orchestra\Testbench\TestCase;
 7 | use Vonage\Laravel\VonageServiceProvider;
 8 | use Vonage\Client;
 9 | 
10 | abstract class AbstractTestCase extends TestCase
11 | {
12 |     /**
13 |      * Get package providers.
14 |      *
15 |      * @param  Application $app
16 |      *
17 |      * @return array
18 |      */
19 |     protected function getPackageProviders($app): array
20 |     {
21 |         return [
22 |             VonageServiceProvider::class,
23 |         ];
24 |     }
25 | 
26 |     /**
27 |      * Get package aliases.
28 |      *
29 |      * @param  Application $app
30 |      *
31 |      * @return array
32 |      */
33 |     protected function getPackageAliases($app): array
34 |     {
35 |         return [
36 |             'Vonage' => \Vonage\Laravel\Facade\Vonage::class,
37 |         ];
38 |     }
39 | 
40 |     /**
41 |      * Gets the property of an object of a class.
42 |      *
43 |      * @param string $class
44 |      * @param string $property
45 |      * @param mixed $object
46 |      *
47 |      * @return mixed
48 |      * @throws \ReflectionException
49 |      */
50 |     public function getClassProperty(string $class, string $property, mixed $object): mixed
51 |     {
52 |         $reflectionClass = new \ReflectionClass($class);
53 |         $refProperty = $reflectionClass->getProperty($property);
54 |         $refProperty->setAccessible(true);
55 | 
56 |         return $refProperty->getValue($object);
57 |     }
58 | 
59 |     /**
60 |      * Returns a list of classes we should attempt to create
61 |      */
62 |     public static function classNameProvider(): array
63 |     {
64 |         return [
65 |             [Client::class],
66 |         ];
67 |     }
68 | }


--------------------------------------------------------------------------------
/tests/vonageTest/TestClientPrivateKeyBasicCredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Client;
 7 | use Vonage\Laravel\Tests\AbstractTestCase;
 8 | 
 9 | class TestClientPrivateKeyBasicCredentials extends AbstractTestCase
10 | {
11 |     /**
12 |      * Define environment setup.
13 |      *
14 |      * @param  Application $app
15 |      *
16 |      * @return void
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         $app['config']->set('vonage.private_key', '/path/to/key');
21 |         $app['config']->set('vonage.application_id', 'application-id-123');
22 |         $app['config']->set('vonage.api_key', 'my_api_key');
23 |         $app['config']->set('vonage.api_secret', 'my_secret');
24 |     }
25 | 
26 |     /**
27 |      * Test that our Vonage client is created with
28 |      * a container with key + basic credentials.
29 |      *
30 |      * @dataProvider classNameProvider
31 |      *
32 |      * @return void
33 |      */
34 |     public function testClientCreatedWithPrivateKeyBasicCredentials($className): void
35 |     {
36 |         $client = app($className);
37 |         $credentialsObject = $this->getClassProperty(Client::class, 'credentials', $client);
38 |         $credentialsArray = $this->getClassProperty(Client\Credentials\Container::class, 'credentials', $credentialsObject);
39 |         $keypairCredentials = $this->getClassProperty(Client\Credentials\Keypair::class, 'credentials', $credentialsArray[Client\Credentials\Keypair::class]);
40 |         $basicCredentials = $this->getClassProperty(Client\Credentials\Basic::class, 'credentials', $credentialsArray[Client\Credentials\Basic::class]);
41 | 
42 |         $this->assertInstanceOf(Client\Credentials\Container::class, $credentialsObject);
43 |         $this->assertEquals(['key' => '===FAKE-KEY===', 'application' => 'application-id-123'], $keypairCredentials);
44 |         $this->assertEquals(['api_key' => 'my_api_key', 'api_secret' => 'my_secret'], $basicCredentials);
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/tests/vonageTest/TestClientPrivateKeySignatureCredentials.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vonage\Laravel\Tests\vonageTest;
 4 | 
 5 | use Illuminate\Foundation\Application;
 6 | use Vonage\Client;
 7 | use Vonage\Laravel\Tests\AbstractTestCase;
 8 | 
 9 | class TestClientPrivateKeySignatureCredentials extends AbstractTestCase
10 | {
11 |     /**
12 |      * Define environment setup.
13 |      *
14 |      * @param  Application $app
15 |      *
16 |      * @return void
17 |      */
18 |     protected function getEnvironmentSetUp($app): void
19 |     {
20 |         $app['config']->set('vonage.private_key', '/path/to/key');
21 |         $app['config']->set('vonage.application_id', 'application-id-123');
22 |         $app['config']->set('vonage.api_key', 'my_api_key');
23 |         $app['config']->set('vonage.signature_secret', 'my_signature');
24 |     }
25 | 
26 |     /**
27 |      * Test that our Vonage client is created with
28 |      * a container with private key + signature credentials
29 |      *
30 |      * @dataProvider classNameProvider
31 |      *
32 |      * @param $className
33 |      *
34 |      * @return void
35 |      */
36 |     public function testClientCreatedWithPrivateKeySignatureCredentials($className): void
37 |     {
38 |         $client = app($className);
39 |         $credentialsObject = $this->getClassProperty(Client::class, 'credentials', $client);
40 | 
41 |         $credentialsArray = $this->getClassProperty(Client\Credentials\Container::class, 'credentials', $credentialsObject);
42 |         $keypairCredentials = $this->getClassProperty(Client\Credentials\Keypair::class, 'credentials', $credentialsArray[Client\Credentials\Keypair::class]);
43 |         $signatureCredentials = $this->getClassProperty(Client\Credentials\SignatureSecret::class, 'credentials', $credentialsArray[Client\Credentials\SignatureSecret::class]);
44 | 
45 |         $this->assertInstanceOf(Client\Credentials\Container::class, $credentialsObject);
46 |         $this->assertEquals(['key' => '===FAKE-KEY===', 'application' => 'application-id-123'], $keypairCredentials);
47 |         $this->assertEquals(['api_key' => 'my_api_key', 'signature_secret' => 'my_signature', 'signature_method' => 'md5hash'], $signatureCredentials);
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/config/vonage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | API Credentials
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | If you're using API credentials, change these settings. Get your
11 |     | credentials from https://dashboard.nexmo.com | 'Settings'.
12 |     |
13 |     */
14 | 
15 |     'api_key'    => function_exists('env') ? env('VONAGE_KEY', '') : '',
16 |     'api_secret' => function_exists('env') ? env('VONAGE_SECRET', '') : '',
17 | 
18 |     /*
19 |     |--------------------------------------------------------------------------
20 |     | Signature Secret
21 |     |--------------------------------------------------------------------------
22 |     |
23 |     | If you're using a signature secret, use this section. This can be used
24 |     | without an `api_secret` for some APIs, as well as with an `api_secret`
25 |     | for all APIs.
26 |     |
27 |     */
28 | 
29 |     'signature_secret' => function_exists('env') ? env('VONAGE_SIGNATURE_SECRET', '') : '',
30 | 
31 |     /*
32 |     |--------------------------------------------------------------------------
33 |     | Private Key
34 |     |--------------------------------------------------------------------------
35 |     |
36 |     | Private keys are used to generate JWTs for authentication. Generation is
37 |     | handled by the library. JWTs are required for newer APIs, such as voice
38 |     | and media
39 |     |
40 |     */
41 | 
42 |     'private_key' => function_exists('env') ? env('VONAGE_PRIVATE_KEY', '') : '',
43 |     'application_id' => function_exists('env') ? env('VONAGE_APPLICATION_ID', '') : '',
44 | 
45 |     /*
46 |     |--------------------------------------------------------------------------
47 |     | Application Identifiers
48 |     |--------------------------------------------------------------------------
49 |     |
50 |     | Add an application name and version here to identify your application when
51 |     | making API calls
52 |     |
53 |     */
54 | 
55 |     'app' => ['name' => function_exists('env') ? env('VONAGE_APP_NAME', 'VonageLaravel') : 'VonageLaravel',
56 |               'version' => function_exists('env') ? env('VONAGE_APP_VERSION', '0.0.1') : '0.0.1'],
57 | 
58 |     /*
59 |     |--------------------------------------------------------------------------
60 |     | Client Override
61 |     |--------------------------------------------------------------------------
62 |     |
63 |     | In the event you need to use this with vonage/client-core, this can be set
64 |     | to provide a custom HTTP client.
65 |     |
66 |     */
67 | 
68 |     'http_client' => function_exists('env') ? env('VONAGE_HTTP_CLIENT', '') : '',
69 | ];


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ![The Vonage logo](./vonage_logo.png)
  2 | ![The Laravel logo](https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg)
  3 | 
  4 | # Vonage Package for Laravel
  5 | [![Latest Stable Version](http://poser.pugx.org/vonage/vonage-laravel/v)](https://packagist.org/packages/vonage/vonage-laravel)
  6 | [![Total Downloads](http://poser.pugx.org/vonage/vonage-laravel/downloads)](https://packagist.org/packages/vonage/vonage-laravel)
  7 | [![License](http://poser.pugx.org/vonage/vonage-laravel/license)](https://packagist.org/packages/vonage/vonage-laravel)
  8 | [![PHP Version Require](http://poser.pugx.org/vonage/vonage-laravel/require/php)](https://packagist.org/packages/vonage/vonage-laravel)
  9 | 
 10 | ### Introduction
 11 | 
 12 | This is a Laravel Service Provider for integrating the [Vonage PHP Client Library](https://github.com/Vonage/vonage-php-sdk).
 13 | 
 14 | ### Requirements
 15 | 
 16 | This Package is for use with Laravel versions 9.x and upwards due to PHP Version restrictions. You will need to be running
 17 | PHP8.0 and upwards - for older compatibility you will need to look at previous versions.
 18 | 
 19 | ### Installation
 20 | 
 21 | Using [Composer](https://getcomposer.org/), run the terminal command:
 22 | 
 23 | ```bash
 24 | composer require vonage/vonage-laravel
 25 | ```
 26 | 
 27 | ### Dealing with Guzzle Client issues
 28 | By default, this package uses vonage/client, which includes a Guzzle adapter for
 29 | accessing the API. Some other libraries supply their own Guzzle adapter, leading 
 30 | to composer not being able to resolve a list of dependencies. You may get an 
 31 | error when adding `vonage/vonage-laravel` to your application because of this.
 32 | 
 33 | The Vonage client allows you to override the HTTP adapter that is being used.
 34 | This takes a bit more configuration, but this package allows you to use `vonage/client-core` to supply 
 35 | your own HTTP adapter.
 36 | 
 37 | To do this:
 38 | 
 39 | Run `composer require vonage/client-core` to install the Core SDK with Composer.
 40 | 
 41 | Install your own httplug-compatible adapter. For example, to use Symfony's HTTP Client:
 42 | 
 43 | ```bash
 44 | composer require symfony/http-client php-http/message-factory php-http/httplug nyholm/psr7
 45 | ```
 46 | 
 47 | `composer require vonage/vonage-laravel` to install this package
 48 | 
 49 | In your .env file, add the following configuration:
 50 | 
 51 | ```dotenv
 52 | VONAGE_HTTP_CLIENT="Symfony\\Component\\HttpClient\\HttplugClient"
 53 | ```
 54 | 
 55 | You can now pull the Vonage\Client object from the Laravel Service Container, or use the 
 56 | Facade provided by this package.
 57 | 
 58 | ### Configuration
 59 | 
 60 | You can use `artisan vendor:publish` to copy the distribution configuration file to your app's 
 61 | config directory:
 62 | 
 63 | ```bash
 64 | php artisan vendor:publish --provider="Vonage\Laravel\VonageServiceProvider"
 65 | ```
 66 | 
 67 | Then update `config/vonage.php` with your credentials. Alternatively, you can update your `.env` file 
 68 | with the following:
 69 | 
 70 | ```dotenv
 71 | VONAGE_KEY=my_api_key
 72 | VONAGE_SECRET=my_secret
 73 | ```
 74 | 
 75 | Optionally, you could also set an `application_id` and `private_key` if required:
 76 | 
 77 | ```dotenv
 78 | VONAGE_APPLICATION_ID=my_application_id
 79 | VONAGE_PRIVATE_KEY=./private.key
 80 | ```
 81 | 
 82 | Private keys can either be a path to a file, like above, or the string of the key itself:
 83 | 
 84 | ```dotenv
 85 | VONAGE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n[...]\n-----END PRIVATE KEY-----\n"
 86 | ```
 87 | 
 88 | ```dotenv
 89 | VONAGE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
 90 | [...]
 91 | -----END PRIVATE KEY-----
 92 | "
 93 | ```
 94 | 
 95 | ### Usage
 96 | 
 97 | To use the Vonage Client Library you can use the Facade, or request the instance from the service 
 98 | container:
 99 | 
100 | ```php
101 | $text = new \Vonage\SMS\Message\SMS($toNumber, $fromNumber, 'Test SMS using Laravel');
102 | Vonage::sms()->send($text);
103 | ```
104 | 
105 | Or
106 | 
107 | ```php
108 | $vonage = app('Vonage\Client');
109 | $text = new \Vonage\SMS\Message\SMS($toNumber, $fromNumber, 'Test SMS using Laravel');
110 | $vonage->sms()->send($text);
111 | ```
112 | 
113 | If you're using private key authentication, you can make a voice call:
114 | 
115 | ```php
116 | $outboundCall = new \Vonage\Voice\OutboundCall(
117 |     new \Vonage\Voice\Endpoint\Phone('14843331234'),
118 |     new \Vonage\Voice\Endpoint\Phone('14843335555')
119 | );
120 | $outboundCall
121 |     ->setAnswerWebhook(
122 |         new \Vonage\Voice\Webhook('https://example.com/answer')
123 |     )
124 |     ->setEventWebhook(
125 |         new \Vonage\Voice\Webhook('https://example.com/event')
126 |     )
127 | ;
128 | 
129 | $response = Vonage::voice()->createOutboundCall($outboundCall);
130 | ```
131 | 
132 | For more information on using the Vonage Client library, see 
133 | the [official client library repository](https://github.com/Vonage/vonage-php-sdk-core).
134 | 
135 | [client-library]: https://github.com/Vonage/vonage-php
136 | 


--------------------------------------------------------------------------------
/src/VonageServiceProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Vonage\Laravel;
  4 | 
  5 | use Illuminate\Contracts\Container\BindingResolutionException;
  6 | use Vonage\Client;
  7 | use Illuminate\Support\Str;
  8 | use Illuminate\Support\ServiceProvider;
  9 | use Vonage\Client\Credentials\Basic;
 10 | use Vonage\Client\Credentials\Keypair;
 11 | use Vonage\Client\Credentials\SignatureSecret;
 12 | 
 13 | class VonageServiceProvider extends ServiceProvider
 14 | {
 15 |     /**
 16 |      * Indicates if loading of the provider is deferred.
 17 |      *
 18 |      * @var bool
 19 |      */
 20 |     protected bool $defer = true;
 21 | 
 22 |     protected array $config;
 23 | 
 24 |     /**
 25 |      * Bootstrap the application services.
 26 |      *
 27 |      * @return void
 28 |      */
 29 |     public function boot(): void
 30 |     {
 31 |         // Config file path.
 32 |         $dist = __DIR__ . '/../config/vonage.php';
 33 | 
 34 |         // If we're installing in to a Lumen project, config_path
 35 |         // won't exist so we can't auto-publish the config
 36 |         if (function_exists('config_path')) {
 37 |             // Publishes config File.
 38 |             $this->publishes([
 39 |                 $dist => config_path('vonage.php'),
 40 |             ]);
 41 |         }
 42 | 
 43 |         // Merge config.
 44 |         $this->mergeConfigFrom($dist, 'vonage');
 45 |     }
 46 | 
 47 |     /**
 48 |      * Register the application services.
 49 |      *
 50 |      * @return void
 51 |      */
 52 |     public function register(): void
 53 |     {
 54 |         // Bind Vonage Client in Service Container.
 55 |         $this->app->singleton(Client::class, function ($app) {
 56 |             return $this->createVonageClient();
 57 |         });
 58 |     }
 59 | 
 60 |     /**
 61 |      * Get the services provided by the provider.
 62 |      *
 63 |      * @return array
 64 |      */
 65 |     public function provides(): array
 66 |     {
 67 |         return [
 68 |             Client::class,
 69 |         ];
 70 |     }
 71 | 
 72 |     /**
 73 |      * Create a new Vonage Client.
 74 |      * @return Client
 75 |      *
 76 |      * @throws BindingResolutionException
 77 |      */
 78 |     protected function createVonageClient(): Client
 79 |     {
 80 |         $this->config = config('vonage');
 81 | 
 82 |         // Check for Vonage config file.
 83 |         if (!$this->config) {
 84 |             $this->raiseRunTimeException('Missing Vonage configuration section.');
 85 |         }
 86 | 
 87 |         // Get Client Options.
 88 |         $options = array_diff_key($this->config,
 89 |             ['private_key', 'application_id', 'api_key', 'api_secret', 'shared_secret', 'app']);
 90 | 
 91 |         // Do we have a private key?
 92 |         $privateKeyCredentials = null;
 93 |         if ($this->vonageConfigHas('private_key')) {
 94 |             if ($this->vonageConfigHasNo('application_id')) {
 95 |                 $this->raiseRunTimeException('You must provide vonage.application_id when using a private key');
 96 |             }
 97 | 
 98 |             $privateKeyCredentials = $this->createPrivateKeyCredentials($this->config['private_key'],
 99 |                 $this->config['application_id']);
100 |         }
101 | 
102 |         $basicCredentials = null;
103 |         if ($this->vonageConfigHas('api_secret')) {
104 |             $basicCredentials = $this->createBasicCredentials($this->config['api_key'],
105 |                 $this->config['api_secret']);
106 |         }
107 | 
108 |         $signatureCredentials = null;
109 |         if ($this->vonageConfigHas('signature_secret')) {
110 |             $signatureCredentials = $this->createSignatureCredentials($this->config['api_key'],
111 |                 $this->config['signature_secret']);
112 |         }
113 | 
114 |         // We can have basic only, signature only, private key only or
115 |         // we can have private key + basic/signature, so let's work out
116 |         // what's been provided
117 |         // @TODO this does not handle private and signature and nor does the SDK
118 |         if ($basicCredentials && $signatureCredentials) {
119 |             $this->raiseRunTimeException('Provide either vonage.api_secret or vonage.signature_secret');
120 |         }
121 | 
122 |         if ($privateKeyCredentials && $basicCredentials) {
123 |             $credentials = new Client\Credentials\Container(
124 |                 $privateKeyCredentials,
125 |                 $basicCredentials
126 |             );
127 |         } elseif ($privateKeyCredentials && $signatureCredentials) {
128 |             $credentials = new Client\Credentials\Container(
129 |                 $privateKeyCredentials,
130 |                 $signatureCredentials
131 |             );
132 |         } elseif ($privateKeyCredentials) {
133 |             $credentials = $privateKeyCredentials;
134 |         } elseif ($signatureCredentials) {
135 |             $credentials = $signatureCredentials;
136 |         } elseif ($basicCredentials) {
137 |             $credentials = $basicCredentials;
138 |         } else {
139 |             $possibleVonageKeys = [
140 |                 'api_key + api_secret',
141 |                 'api_key + signature_secret',
142 |                 'private_key + application_id',
143 |                 'api_key + api_secret + private_key + application_id',
144 |                 'api_key + signature_secret + private_key + application_id',
145 |             ];
146 |             $this->raiseRunTimeException(
147 |                 'Please provide Vonage API credentials. Possible combinations: '
148 |                 . join(", ", $possibleVonageKeys)
149 |             );
150 |         }
151 | 
152 |         $httpClient = null;
153 |         if ($this->vonageConfigHas('http_client')) {
154 |             $httpClient = $this->app->make($this->config['http_client']);
155 |         }
156 | 
157 |         return new Client($credentials, $options, $httpClient);
158 |     }
159 | 
160 |     protected function vonageConfigHas(string $key): bool
161 |     {
162 |         if (!array_key_exists($key, $this->config) || empty($this->config[$key])) {
163 |             return false;
164 |         }
165 | 
166 |         return true;
167 |     }
168 | 
169 |     protected function vonageConfigHasNo(string $key): bool
170 |     {
171 |         return ! $this->vonageConfigHas($key);
172 |     }
173 | 
174 |     protected function createBasicCredentials(string $key, string $secret): Basic
175 |     {
176 |         return new Basic($key, $secret);
177 |     }
178 | 
179 |     protected function createSignatureCredentials(string $key, string $signatureSecret): SignatureSecret
180 |     {
181 |         return new SignatureSecret($key, $signatureSecret);
182 |     }
183 | 
184 |     protected function createPrivateKeyCredentials(string $key, string $applicationId): Keypair
185 |     {
186 |         return new Keypair($this->loadPrivateKey($key), $applicationId);
187 |     }
188 | 
189 |     /**
190 |      * Load private key contents from root directory
191 |      */
192 |     protected function loadPrivateKey(string $key): bool|string
193 |     {
194 |         if (app()->runningUnitTests()) {
195 |             return '===FAKE-KEY===';
196 |         }
197 | 
198 |         if (Str::startsWith($key, '-----BEGIN PRIVATE KEY-----')) {
199 |             return $key;
200 |         }
201 | 
202 |         // If it's a relative path, start searching in the
203 |         // project root
204 |         if ($key[0] !== '/') {
205 |             $key = base_path() . '/' . $key;
206 |         }
207 | 
208 |         return file_get_contents($key);
209 |     }
210 | 
211 |     protected function raiseRunTimeException(string $message): void
212 |     {
213 |         throw new \RuntimeException($message);
214 |     }
215 | }
216 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------