feat: adding AdSlot and Newsletter service

.github/workflows/lint.yml

@@ -18,4 +18,4 @@ jobs:
     - name: Install dependencies
       run: composer i
     - name: Run linter
-      run: ./vendor/bin/php-cs-fixer fix --dry-run --diff --format=checkstyle | cs2pr
+      run: ./vendor/bin/php-cs-fixer fix --dry-run --diff --format=checkstyle --allow-risky=yes | cs2pr

README.md

@@ -143,3 +143,8 @@ class TestCase extends PHPUnit
 The LiveIntent client inherits from Laravel's Http Client. Therefore, all the methods available to that client, will also be available here.
 
 For detailed documentation see [here](https://laravel.com/docs/8.x/http-client#testing).
+
+## Development
+
+For information about how to contribute to this project please see
+[here](/docs/development.md).

docs/development.md

@@ -0,0 +1,91 @@
+## Development
+
+To contribute to this package first you need to clone the repo and then copy the `.env` file.
+
+### Clone Repo
+```php
+git clone git@github.com:LiveIntent/sdk-php.git
+```
+
+After you clone the repo, then you need to copy the `.env.example`
+
+### Copy Env
+```php
+cp .env.example .env
+```
+
+After you copy the `.env.example` file then you can install the dependencies.
+
+### Install Dependencies
+```php
+composer install
+```
+
+If you get an error message to install PHP 8.0 then install via homebrew
+
+https://stitcher.io/blog/php-8-upgrade-mac
+
+Once the upgrade is successful, then you can try to install the dependencies.
+
+### Unit Tests
+
+To run the unit tests
+
+```php
+composer test
+```
+
+The SDK uses Heimdall/Bifrost to authenticate so you need to create a Client and use that Client's Secret and Identifier. 
+
+#### Create a Client in Bifrost
+
+First you need to get a token from Bifrost using the `oauth/token` endpoint.
+
+Grab the token and put it into the Authorize header in the Heimdall API.
+
+You can use the Heimdall API to create your client.
+
+```php
+{
+  "name": "testClient234",
+  "environment": "server",
+  "redirectUri": "https://qa-heimdall.liveintenteng.com/sign-in"
+}
+```
+
+Take the response and copy the secret and identifier and put that into your `.env`
+
+```php
+{
+  "secret": "<some secret>",
+  "id": <some id>,
+  "name": "<some name>",
+  "identifier": "<some identifier>",
+  "redirectUri": "https://qa-heimdall.liveintenteng.com/sign-in",
+  "created": "<some datetime>",
+  "updated": "<some datetime>"
+}
+```
+
+#### Client Secret and Identifier
+
+In the `.env` file
+
+```php
+CLIENT_ID=<identifier from response>
+CLIENT_SECRET=<secret from response>
+
+LI_BASE_URL=http://localhost:3000 // Pointing to Heimdall
+```
+
+
+### Linting
+The installed linter will auto-format your code to comply with our agreed php coding standard.
+
+To run the linter
+```php
+composer lint
+```
+
+
+

src/AdSlot.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace LiveIntent;
+
+class AdSlot extends Resource
+{
+    //
+}

src/LiveIntentClient.php

@@ -12,6 +12,7 @@
  * @property \LiveIntent\Services\CampaignService $campaigns
  * @property \LiveIntent\Services\InsertionOrderService $insertionOrders
  * @property \LiveIntent\Services\LineItemService $lineItems
+ * @property \LiveIntent\Services\NewsletterService $newsletters
  *
  * @property \LiveIntent\Services\BaseService $request
  */

src/Newsletter.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace LiveIntent;
+
+class Newsletter extends Resource
+{
+    //
+}

src/Services/AdSlotService.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace LiveIntent\Services;
+
+use LiveIntent\AdSlot;
+
+/**
+ * @method \LiveIntent\AdSlot find($id)
+ * @method \LiveIntent\AdSlot create($attributes)
+ * @method \LiveIntent\AdSlot update($attributes)
+ */
+class AdSlotService extends AbstractResourceService
+{
+    /**
+     * The base url for this entity.
+     */
+    protected $baseUrl = '/ad-slot';
+
+    /**
+     * The resource class for this entity.
+     */
+    protected $objectClass = AdSlot::class;
+}

src/Services/Concerns/MocksRequests.php

@@ -188,9 +188,18 @@ private function isSameRequest(array $a, Request $b)
      */
     private function getNormalizedRequestData(Request $request)
     {
-        $data = $request->isJson()
-            ? json_decode(collect($request->data())->flip()->first(), true)
-            : $request->data();
+        // Initialize data when not json
+        $data = $request->data();
+
+        if ($request->isJson()) {
+            // Turn request data into an array
+            $temp = json_decode((string) collect($request->data()), true);
+
+            $keys = array_keys($temp);
+
+            // Grab the first array key and json_decode it
+            $data = json_decode(reset($keys), true);
+        }
 
         $excludedKeys = ['version', 'client_id', 'client_secret'];
 

src/Services/NewsletterService.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace LiveIntent\Services;
+
+use LiveIntent\Newsletter;
+
+/**
+ * @method \LiveIntent\Newsletter find($id)
+ * @method \LiveIntent\Newsletter create($attributes)
+ * @method \LiveIntent\Newsletter update($attributes)
+ */
+class NewsletterService extends AbstractResourceService
+{
+    /**
+     * The base url for this entity.
+     */
+    protected $baseUrl = '/newsletter';
+
+    /**
+     * The resource class for this entity.
+     */
+    protected $objectClass = Newsletter::class;
+}

src/Services/ServiceFactory.php

@@ -25,12 +25,14 @@ class ServiceFactory
      * @var array<string, class-string>
      */
     protected static $classMap = [
+        'adSlots' => AdSlotService::class,
         'advertisers' => AdvertiserService::class,
         'auth' => AuthService::class,
         'campaigns' => CampaignService::class,
         'insertionOrders' => InsertionOrderService::class,
         'lineItems' => LineItemService::class,
         'mediaGroups' => MediaGroupService::class,
+        'newsletters' => NewsletterService::class,
         'publishers' => PublisherService::class,
         'users' => UserService::class,
 

tests/Fixtures.php

@@ -4,6 +4,18 @@
 
 abstract class Fixtures
 {
+    /** @return string */
+    public static function adSlotHash()
+    {
+        return '60220c073cc811ec941d0ab243175da9';
+    }
+
+    /** @return int */
+    public static function adSlotId()
+    {
+        return 834557;
+    }
+
     /** @return string */
     public static function campaignHash()
     {
@@ -21,4 +33,22 @@ public static function lineItemHash()
     {
         return '00009758365a11e7943622000a974651';
     }
+
+    /** @return string */
+    public static function newsletterHash()
+    {
+        return '03fb20f13cc811ec941d0ab243175da9';
+    }
+
+    /** @return int */
+    public static function newsletterId()
+    {
+        return 36116;
+    }
+
+    /** @return string */
+    public static function publisherHash()
+    {
+        return 'b3e515b13cc711ec941d0ab243175da9';
+    }
 }

tests/Services/AdSlotServiceTest.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace Tests\Services;
+
+use Tests\Fixtures;
+use LiveIntent\AdSlot;
+use LiveIntent\Exceptions\InvalidRequestException;
+
+class AdSlotServiceTest extends ServiceTestCase
+{
+    protected $serviceKey = 'adSlots';
+
+    public function testIsFindable()
+    {
+        $adSlot = $this->service->find(Fixtures::adSlotId());
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+
+        $adSlot = $this->service->find(Fixtures::adSlotHash());
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+    }
+
+    public function testIsCreatableViaAttributesArray()
+    {
+        $adSlot = $this->service->create([
+            'name' => 'SDK Test',
+            'newsletter' => Fixtures::newsletterHash(),
+            'type' => 'image',
+            'mediaType' => 'newsletter',
+            'sizes' => [
+                [
+                    'width' => 500,
+                    'height' => 600,
+                    'floor' => 1.0,
+                    'deviceTypes' => [1,2,3],
+                ],
+            ],
+            'adIndicatorId' => 1,
+        ]);
+
+        $this->assertNotNull($adSlot->id);
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+    }
+
+    public function testIsCreatableViaResourceInstance()
+    {
+        $adSlot = new AdSlot([
+            'name' => 'SDK Test',
+            'newsletter' => Fixtures::newsletterHash(),
+            'type' => 'image',
+            'mediaType' => 'newsletter',
+            'sizes' => [
+                [
+                    'width' => 500,
+                    'height' => 600,
+                    'floor' => 1.0,
+                    'deviceTypes' => [1,2,3],
+                ],
+            ],
+            'adIndicatorId' => 1,
+        ]);
+
+        $adSlot = $this->service->create($adSlot);
+
+        $this->assertNotNull($adSlot->id);
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+    }
+
+    public function testIsUpdateableViaAttributesArray()
+    {
+        $adSlot = $this->service->find(Fixtures::adSlotId());
+
+        $updatedName = 'SDK_TEST_UPDATE_NAME';
+
+        $adSlot = $this->service->update([
+            'id' => $adSlot->id,
+            'version' => $adSlot->version,
+            'name' => $updatedName,
+            'sizes' => [
+                [
+                    'width' => 400,
+                    'height' => 500,
+                    'floor' => 1.0,
+                    'deviceTypes' => [1,2,3],
+                ],
+            ],
+        ]);
+
+        $this->assertEquals($updatedName, $adSlot->name);
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+    }
+
+    public function testIsUpdateableViaResourceInstance()
+    {
+        $adSlot = $this->service->find(Fixtures::adSlotId());
+        $updatedName = 'SDK_TEST_UPDATE_NAME';
+
+        $adSlot->name = $updatedName;
+        $adSlot = $this->service->update($adSlot);
+
+        $this->assertEquals($updatedName, $adSlot->name);
+        $this->assertInstanceOf(AdSlot::class, $adSlot);
+    }
+
+    public function testThrowsWhenInvalidDataIsPassed()
+    {
+        $this->expectException(InvalidRequestException::class);
+
+        $this->service->create([
+            'name' => 'SDK Test',
+            'newsletter' => Fixtures::newsletterHash(),
+        ]);
+    }
+}

tests/Services/AuthServiceTest.php

@@ -14,7 +14,7 @@ public function testGetCurrentUserWithAccessToken()
         $tokenService = new TokenService([
             'client_id' => env('CLIENT_ID'),
             'client_secret' => env('CLIENT_SECRET'),
-            'base_url' => env('LI_BASE_URL', 'http://localhost:33001'),
+            'base_url' => env('LI_BASE_URL', 'http://localhost:3000'),
         ]);
 
         if (env('USE_SNAPSHOTS', true)) {