[api] changed Requestable->send() signature

AfterShip · Aug 30, 2017 · 0cb0688 · 0cb0688
1 parent c931c67
commit 0cb0688
Show file tree

Hide file tree

Showing 11 changed files with 79 additions and 69 deletions.
diff --git a/src/Couriers.php b/src/Couriers.php
@@ -34,7 +34,7 @@ public function __construct($apiKey = '', Requestable $request = null)
      */
     public function get()
     {
-        return $this->request->send('couriers', 'GET');
+        return $this->request->send('GET', 'couriers');
     }
 
     /**
@@ -45,7 +45,7 @@ public function get()
      */
     public function all()
     {
-        return $this->request->send('couriers/all', 'GET');
+        return $this->request->send('GET', 'couriers/all');
     }
 
     /**
@@ -66,6 +66,6 @@ public function detect($trackingNumber, array $params = array())
 
         // Fill the tracking number into the params array
         $params['tracking_number'] = $trackingNumber;
-        return $this->request->send('couriers/detect/', 'POST', ['tracking' => $params]);
+        return $this->request->send('POST', 'couriers/detect/', ['tracking' => $params]);
     }
 }
diff --git a/src/LastCheckPoint.php b/src/LastCheckPoint.php
@@ -48,7 +48,7 @@ public function get($slug, $trackingNumber, array $params = array())
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('last_checkpoint/' . $slug . '/' . $trackingNumber, 'GET', $params);
+        return $this->request->send('GET', 'last_checkpoint/' . $slug . '/' . $trackingNumber, $params);
     }
 
     /**
@@ -65,6 +65,6 @@ public function getById($trackingId, array $params = [])
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('last_checkpoint/' . $trackingId, 'GET', $params);
+        return $this->request->send('GET', 'last_checkpoint/' . $trackingId, $params);
     }
 }
diff --git a/src/Notifications.php b/src/Notifications.php
@@ -44,7 +44,7 @@ public function create($slug, $trackingNumber, array $params = array())
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $slug . '/' . $trackingNumber . '/add', 'POST',
+        return $this->request->send('POST', 'notifications/' . $slug . '/' . $trackingNumber . '/add',
             ['notification' => $params]);
     }
 
@@ -62,7 +62,7 @@ public function createById($trackingId, array $params = [])
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $trackingId . '/add', 'POST', array('notification' => $params));
+        return $this->request->send('POST', 'notifications/' . $trackingId . '/add', ['notification' => $params]);
     }
 
     /**
@@ -74,7 +74,7 @@ public function createById($trackingId, array $params = [])
      * @return array Response body
      * @throws AfterShipException
      */
-    public function delete($slug, $trackingNumber, array $params = array())
+    public function delete($slug, $trackingNumber, array $params = [])
     {
         if (empty($slug)) {
             throw new AfterShipException('Slug cannot be empty');
@@ -84,8 +84,8 @@ public function delete($slug, $trackingNumber, array $params = array())
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $slug . '/' . $trackingNumber . '/remove', 'POST',
-            array('notification' => $params));
+        return $this->request->send('POST', 'notifications/' . $slug . '/' . $trackingNumber . '/remove',
+            ['notification' => $params]);
     }
 
     /**
@@ -102,7 +102,7 @@ public function deleteById($trackingId, array $params = [])
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $trackingId . '/remove', 'POST', array('notification' => $params));
+        return $this->request->send('POST', 'notifications/' . $trackingId . '/remove', ['notification' => $params]);
     }
 
     /**
@@ -114,7 +114,7 @@ public function deleteById($trackingId, array $params = [])
      * @return array Response body
      * @throws \Exception
      */
-    public function get($slug, $trackingNumber, array $params = array())
+    public function get($slug, $trackingNumber, array $params = [])
     {
         if (empty($slug)) {
             throw new AfterShipException('Slug cannot be empty');
@@ -124,7 +124,7 @@ public function get($slug, $trackingNumber, array $params = array())
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $slug . '/' . $trackingNumber, 'GET', $params);
+        return $this->request->send('GET', 'notifications/' . $slug . '/' . $trackingNumber, $params);
     }
 
     /**
@@ -141,6 +141,6 @@ public function getById($trackingId, array $params = array())
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('notifications/' . $trackingId, 'GET', $params);
+        return $this->request->send('GET', 'notifications/' . $trackingId, $params);
     }
 }
diff --git a/src/Request.php b/src/Request.php
@@ -2,10 +2,6 @@
 
 namespace AfterShip;
 
-/**
- * Class Request
- * @package AfterShip
- */
 /**
  * Class Request
  * @package AfterShip
@@ -37,13 +33,13 @@ function __construct($apiKey)
     }
 
     /**
-     * @param $url
      * @param $method
+     * @param $url
      * @param array $data
      *
      * @return mixed
      */
-    public function send($url, $method, array $data = [])
+    public function send($method, $url, array $data = [])
     {
         $methodUpper = strtoupper($method);
         $parameters  = [

diff --git a/src/Requestable.php b/src/Requestable.php
@@ -4,5 +4,5 @@
 
 interface Requestable
 {
-    public function send($url, $method, array $data = []);
-}
+    public function send($method, $url, array $data = []);
+}
diff --git a/src/Trackings.php b/src/Trackings.php
@@ -38,7 +38,7 @@ public function create($trackingNumber, array $params = [])
         }
 
         $params['tracking_number'] = $trackingNumber;
-        return $this->request->send('trackings', 'POST', ['tracking' => $params]);
+        return $this->request->send('POST', 'trackings', ['tracking' => $params]);
     }
 
     /**
@@ -71,7 +71,7 @@ public function delete($slug, $trackingNumber)
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $slug . '/' . $trackingNumber, 'DELETE');
+        return $this->request->send('DELETE', 'trackings/' . $slug . '/' . $trackingNumber);
     }
 
     /**
@@ -87,7 +87,7 @@ public function deleteById($trackingId)
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $trackingId, 'DELETE');
+        return $this->request->send('DELETE', 'trackings/' . $trackingId);
     }
 
     /**
@@ -98,7 +98,7 @@ public function deleteById($trackingId)
      */
     public function all(array $params = [])
     {
-        return $this->request->send('trackings', 'GET', $params);
+        return $this->request->send('GET', 'trackings', $params);
     }
 
     /**
@@ -120,7 +120,7 @@ public function get($slug, $trackingNumber, array $params = [])
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $slug . '/' . $trackingNumber, 'GET', $params);
+        return $this->request->send('GET', 'trackings/' . $slug . '/' . $trackingNumber, $params);
     }
 
     /**
@@ -137,7 +137,7 @@ public function getById($trackingId, array $params = [])
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $trackingId, 'GET', $params);
+        return $this->request->send('GET', 'trackings/' . $trackingId, $params);
     }
 
     /**
@@ -159,7 +159,7 @@ public function update($slug, $trackingNumber, array $params = [])
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $slug . '/' . $trackingNumber, 'PUT', ['tracking' => $params]);
+        return $this->request->send('PUT', 'trackings/' . $slug . '/' . $trackingNumber, ['tracking' => $params]);
     }
 
     /**
@@ -176,7 +176,7 @@ public function updateById($trackingId, array $params = [])
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $trackingId, 'PUT', ['tracking' => $params]);
+        return $this->request->send('PUT', 'trackings/' . $trackingId, ['tracking' => $params]);
     }
 
     /**
@@ -197,7 +197,7 @@ public function retrack($slug, $trackingNumber)
             throw new AfterShipException('Tracking number cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $slug . '/' . $trackingNumber . '/retrack', 'POST');
+        return $this->request->send('POST', 'trackings/' . $slug . '/' . $trackingNumber . '/retrack');
     }
 
     /**
@@ -213,7 +213,7 @@ public function retrackById($trackingId)
             throw new AfterShipException('Tracking ID cannot be empty');
         }
 
-        return $this->request->send('trackings/' . $trackingId . '/retrack', 'POST');
+        return $this->request->send('POST', 'trackings/' . $trackingId . '/retrack');
     }
 
 }
diff --git a/tests/AfterShip/CouriersTest.php b/tests/AfterShip/CouriersTest.php
@@ -25,8 +25,8 @@ public function it_gets_all_couriers_when_calling_get()
 
         $request
             ->with(
-                $this->equalTo('couriers'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('couriers')
             );
 
         $couriers->get();
@@ -39,8 +39,8 @@ public function it_will_get_all_couriers_available()
 
         $request
             ->with(
-                $this->equalTo('couriers/all'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('couriers/all')
             );
 
         $couriers->all();
@@ -60,8 +60,8 @@ public function it_will_call_detect_endpoint()
 
         $request
             ->with(
-                $this->equalTo('couriers/detect/'),
                 $this->equalTo('POST'),
+                $this->equalTo('couriers/detect/'),
                 $this->equalTo([
                     'tracking' => [
                         'tracking_number' => 'tracking_number',

diff --git a/tests/AfterShip/LastCheckPointTest.php b/tests/AfterShip/LastCheckPointTest.php
@@ -36,8 +36,8 @@ public function it_should_get_last_checkpoint_by_slug_and_tracking_number()
         list($request, $lastTrackingNumber) = $this->buildLastCheckPoint();
         $request
             ->with(
-                $this->equalTo('last_checkpoint/ups/tracking_number'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('last_checkpoint/ups/tracking_number')
             );
         $lastTrackingNumber->get('ups', 'tracking_number');
     }
@@ -54,8 +54,8 @@ public function it_should_get_last_checkpoint_by_id()
         list($request, $lastTrackingNumber) = $this->buildLastCheckPoint();
         $request
             ->with(
-                $this->equalTo('last_checkpoint/last_checkpoint_id'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('last_checkpoint/last_checkpoint_id')
             );
         $lastTrackingNumber->getById('last_checkpoint_id');
     }

diff --git a/tests/AfterShip/NotificationsTest.php b/tests/AfterShip/NotificationsTest.php
@@ -24,16 +24,16 @@ public function it_should_create_a_notfication()
 
         $request
             ->with(
-                $this->equalTo('notifications/dhl/tracking_number/add'),
                 $this->equalTo('POST'),
+                $this->equalTo('notifications/dhl/tracking_number/add'),
                 $this->equalTo([
                     'notification' => []
                 ])
             );
 
         $notification->create('dhl', 'tracking_number');
     }
-    
+
     /** @test */
     public function create_throws_an_error_when_empty_slug()
     {
@@ -53,8 +53,8 @@ public function could_create_notification_by_id()
 
         $request
             ->with(
-                $this->equalTo('notifications/tracking_id/add'),
                 $this->equalTo('POST'),
+                $this->equalTo('notifications/tracking_id/add'),
                 $this->equalTo([
                     'notification' => []
                 ])
@@ -76,8 +76,8 @@ public function it_should_delete_a_notfication()
 
         $request
             ->with(
-                $this->equalTo('notifications/dhl/tracking_number/remove'),
                 $this->equalTo('POST'),
+                $this->equalTo('notifications/dhl/tracking_number/remove'),
                 $this->equalTo([
                     'notification' => []
                 ])
@@ -105,8 +105,8 @@ public function could_delete_notification_by_id()
 
         $request
             ->with(
-                $this->equalTo('notifications/tracking_id/remove'),
                 $this->equalTo('POST'),
+                $this->equalTo('notifications/tracking_id/remove'),
                 $this->equalTo([
                     'notification' => []
                 ])
@@ -128,8 +128,8 @@ public function it_should_get_a_notfication()
 
         $request
             ->with(
-                $this->equalTo('notifications/dhl/tracking_number'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('notifications/dhl/tracking_number')
             );
 
         $notification->get('dhl', 'tracking_number');
@@ -154,8 +154,8 @@ public function could_get_notification_by_id()
 
         $request
             ->with(
-                $this->equalTo('notifications/tracking_id'),
-                $this->equalTo('GET')
+                $this->equalTo('GET'),
+                $this->equalTo('notifications/tracking_id')
             );
 
         $notification->getById('tracking_id');

diff --git a/tests/AfterShip/RequestTest.php b/tests/AfterShip/RequestTest.php
@@ -0,0 +1,14 @@
+<?php
+
+use AfterShip\Request;
+use PHPUnit\Framework\TestCase;
+
+class RequestTest extends TestCase
+{
+    /* @test */
+    function it_should_have_correct_url_and_api_version_constants()
+    {
+        $this->equalTo(Request::API_URL, 'https://api.aftership.com');
+        $this->equalTo(Request::API_VERSION, 'v4');
+    }
+}