Merge pull request #17 from ably/feature/laravel-agent-header

Php-Laravel Ably Agent Header

Author: owenpearson

.github/workflows/check.yml

@@ -0,0 +1,38 @@
+# Loosely based upon:
+#   https://github.com/actions/starter-workflows/blob/main/ci/php.yml
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  check:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: [7.2, 7.3, 7.4, 8.0]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: 'recursive'
+
+      - name: Set up PHP ${{ matrix.php-version }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      # the test script is configured in composer.json.
+      # see: https://getcomposer.org/doc/articles/scripts.md
+      - name: Run test suite
+        run: composer run-script test

composer.json

@@ -12,12 +12,12 @@
     ],
     "require": {
         "php": "^7.2 || ^8.0",
-        "ably/ably-php": "~1.1.5",
-        "laravel/framework": ">=5.1.0"
+        "ably/ably-php": "~1.1.6",
+        "laravel/framework": ">=6.0.0"
     },
     "require-dev": {
-        "phpunit/phpunit": ">=4.5",
-        "orchestra/testbench": "~3.2"
+        "phpunit/phpunit": "^8.0.0",
+        "orchestra/testbench": "4.13.0"
     },
     "autoload": {
         "psr-4": {

src/AblyFactory.php

@@ -2,6 +2,7 @@
 namespace Ably\Laravel;
 
 use Ably\AblyRest;
+use Ably\Utils\Miscellaneous;
 
 /**
  * Instantiates AblyRest objects
@@ -31,11 +32,12 @@ public function make($clientOptions = null)
      * @param array|null $clientOptions
      *
      * @return \Ably\AblyRest
+     * @throws \Ably\Exceptions\AblyException
      */
     protected function createInstance($clientOptions)
     {
-        AblyRest::setLibraryFlavourString('laravel');
-
+        $laravelVersion = Miscellaneous::getNumeric(app()->version());
+        AblyRest::setAblyAgentHeader('laravel', $laravelVersion);
         return new AblyRest($clientOptions);
     }
 }

src/AblyServiceProvider.php

@@ -2,6 +2,7 @@
 namespace Ably\Laravel;
 
 use Ably\AblyRest;
+use Ably\Utils\Miscellaneous;
 use Illuminate\Support\ServiceProvider;
 
 class AblyServiceProvider extends ServiceProvider
@@ -33,8 +34,8 @@ public function boot()
     public function register()
     {
         $this->app->singleton('ably', function($app) {
-            AblyRest::setLibraryFlavourString('laravel');
-            
+            $laravelVersion = Miscellaneous::getNumeric(app()->version());
+            AblyRest::setAblyAgentHeader('laravel', $laravelVersion);
             return new AblyRest(config('ably'));
         });
     }

tests/AblyLaravelTest.php

@@ -1,5 +1,8 @@
 <?php
+
+use Ably\AblyRest;
 use Ably\Http;
+use Ably\Utils\Miscellaneous;
 
 class AblyLaravelTest extends Orchestra\Testbench\TestCase
 {
@@ -131,7 +134,7 @@ public function testInstances()
         $this->assertInstanceOf(\Ably\Auth::class, $factoryInstanceAuth2);
     }
 
-    public function testAblyFlavourString()
+    public function testLaravelAblyAgentHeader()
     {
         $ablyFactory = App::make('\Ably\Laravel\AblyFactory');
         $ably = $ablyFactory->make([
@@ -140,7 +143,8 @@ public function testAblyFlavourString()
         ]);
 
         $ably->time();
-        $this->assertRegExp('/php-laravel-[0-9]+\.[0-9]+\.[0-9]+/', $ably->http->lastHeaders['X-Ably-Lib']);
+        $expectedLaravelHeader = 'ably-php/'.AblyRest::LIB_VERSION.' '.'php/'.Miscellaneous::getNumeric(phpversion()).' laravel/'.app()->version();
+        $this->assertcontains( 'Ably-Agent: '.$expectedLaravelHeader, $ably->http->lastHeaders, 'Expected PHP laravel header in HTTP request' );
     }
 }