Move EndShipper to general availability (#210)

- Copy EndShipper to main namespace
- Mark beta EndShipper as deprecated
- Update unit tests

Author: nwithan8

lib/EasyPost/Beta/EndShipper.php

@@ -16,6 +16,8 @@
  * @property string $name
  * @property string $company
  * @property string $phone
+ *
+ * @deprecated Use EasyPost\EndShipper instead.
  */
 
 class EndShipper extends EasypostResource

lib/EasyPost/EndShipper.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace EasyPost;
+
+/**
+ * @package EasyPost
+ * @property string $name
+ * @property string $company
+ * @property string $id
+ * @property string $street1
+ * @property string $street2
+ * @property string $city
+ * @property string $state
+ * @property string $zip
+ * @property string $country
+ * @property string $phone
+ * @property string $email
+ */
+
+class EndShipper extends EasypostResource
+{
+    /**
+     * Create an EndShipper object.
+     *
+     * @param mixed $params
+     * @param string $apiKey
+     * @return mixed
+     */
+    public static function create($params = null, $apiKey = null)
+    {
+        $wrappedParams = [];
+        $wrappedParams['address'] = $params;
+
+        return self::createResource(get_class(), $wrappedParams, $apiKey);
+    }
+
+    /**
+     * Retrieve an EndShipper object.
+     *
+     * @param string $id
+     * @param string $apiKey
+     * @return mixed
+     */
+    public static function retrieve($id, $apiKey = null)
+    {
+        return self::retrieveResource(get_class(), $id, $apiKey);
+    }
+
+    /**
+     * Retrieve all EndShipper objects.
+     *
+     * @param mixed $params
+     * @param string $apiKey
+     * @return mixed
+     */
+    public static function all($params = null, $apiKey = null)
+    {
+        return self::allResources(get_class(), $params, $apiKey);
+    }
+
+    /**
+     * Update (save) an EndShipper object.
+     *
+     * @return $this
+     */
+    public function save()
+    {
+        // We are passing the `Address` class here so that the request gets properly wrapped in the required object.
+        return $this->saveResource('EasyPost\Address', false, 'put');
+    }
+}

lib/EasyPost/Util.php

@@ -64,7 +64,7 @@ public static function convertToEasyPostObject($response, $apiKey, $parent = nul
             'CarrierDetail'         => '\EasyPost\CarrierDetail',
             'CustomsInfo'           => '\EasyPost\CustomsInfo',
             'CustomsItem'           => '\EasyPost\CustomsItem',
-            'EndShipper'            => '\EasyPost\Beta\EndShipper',
+            'EndShipper'            => '\EasyPost\EndShipper',
             'Event'                 => '\EasyPost\Event',
             'Fee'                   => '\EasyPost\Fee',
             'Insurance'             => '\EasyPost\Insurance',
@@ -103,7 +103,7 @@ public static function convertToEasyPostObject($response, $apiKey, $parent = nul
             'ca'        => '\EasyPost\CarrierAccount',
             'cstinfo'   => '\EasyPost\CustomsInfo',
             'cstitem'   => '\EasyPost\CustomsItem',
-            'es'        => '\EasyPost\Beta\EndShipper',
+            'es'        => '\EasyPost\EndShipper',
             'evt'       => '\EasyPost\Event',
             'fee'       => '\EasyPost\Fee',
             'hook'      => '\EasyPost\Webhook',

lib/easypost.php

@@ -30,6 +30,7 @@
 require_once(dirname(__FILE__) . '/EasyPost/CustomsInfo.php');
 require_once(dirname(__FILE__) . '/EasyPost/CustomsItem.php');
 require_once(dirname(__FILE__) . '/EasyPost/Beta/EndShipper.php');
+require_once(dirname(__FILE__) . '/EasyPost/EndShipper.php');
 require_once(dirname(__FILE__) . '/EasyPost/Event.php');
 require_once(dirname(__FILE__) . '/EasyPost/Fee.php');
 require_once(dirname(__FILE__) . '/EasyPost/FieldError.php');

test/EasyPost/Beta/EndShipperTest.php renamed to test/EasyPost/EndShipperTest.php

@@ -2,7 +2,7 @@
 
 namespace EasyPost\Test;
 
-use EasyPost\Beta\EndShipper;
+use EasyPost\EndShipper;
 use EasyPost\EasyPost;
 use VCR\VCR;
 
@@ -36,7 +36,7 @@ public function testCreate()
 
         $endShipper = EndShipper::create(Fixture::caAddress1());
 
-        $this->assertInstanceOf('\EasyPost\Beta\EndShipper', $endShipper);
+        $this->assertInstanceOf('\EasyPost\EndShipper', $endShipper);
         $this->assertStringMatchesFormat('es_%s', $endShipper->id);
         $this->assertEquals('388 TOWNSEND ST APT 20', $endShipper->street1);
     }
@@ -52,7 +52,7 @@ public function testRetrieve()
 
         $retrievedEndShipper = EndShipper::retrieve($endShipper->id);
 
-        $this->assertInstanceOf('\EasyPost\Beta\EndShipper', $retrievedEndShipper);
+        $this->assertInstanceOf('\EasyPost\EndShipper', $retrievedEndShipper);
         $this->assertEquals($endShipper->street1, $retrievedEndShipper->street1);
     }
 
@@ -63,12 +63,15 @@ public function testAll()
     {
         VCR::insertCassette('end_shipper/all.yml');
 
-        $endShipper = EndShipper::all([
+        $endShippers = EndShipper::all([
             'page_size' => Fixture::pageSize(),
         ]);
 
-        $this->assertLessThanOrEqual($endShipper, Fixture::pageSize());
-        $this->assertContainsOnlyInstancesOf('\EasyPost\Beta\EndShipper', $endShipper);
+        $endShipperArray = $endShippers['end_shippers'];
+
+        $this->assertLessThanOrEqual($endShipperArray, Fixture::pageSize());
+        $this->assertNotNull($endShippers['has_more']);
+        $this->assertContainsOnlyInstancesOf('\EasyPost\EndShipper', $endShipperArray);
     }
 
     /**
@@ -95,7 +98,7 @@ public function testUpdate()
         $endShipper->email = 'test@example.com';
         $endShipper->save();
 
-        $this->assertInstanceOf('\EasyPost\Beta\EndShipper', $endShipper);
+        $this->assertInstanceOf('\EasyPost\EndShipper', $endShipper);
         $this->assertStringMatchesFormat('es_%s', $endShipper->id);
         $this->assertEquals($newName, $endShipper->name);
     }