feat: use new submoduled fixtures

Author: Justintime50

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "examples"]
+	path = examples
+	url = https://github.com/EasyPost/examples

Makefile

@@ -16,6 +16,8 @@ fix:
 
 ## install - Install dependencies
 install:
+	git submodule init
+	git submodule update
 	composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
 
 ## lint - Lint the project
@@ -37,6 +39,8 @@ test:
 
 ## update - Update dependencies
 update:
+	git submodule init
+	git submodule update --remote
 	composer update
 
 .PHONY: help clean fix install lint release scan test update

README.md

@@ -93,6 +93,10 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
 
 # Run security analysis
 make scan
+
+# Update submodules
+git submodule init
+git submodule update --remote
 ```
 
 ### Testing
@@ -112,9 +116,8 @@ The following are required on every test run:
 - `EASYPOST_TEST_API_KEY`
 - `EASYPOST_PROD_API_KEY`
 
-The following are required when you need to re-record cassettes for applicable tests (fallback values are used otherwise):
+Some tests may require an EasyPost user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
 
 - `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
+- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral user)
 - `REFERRAL_USER_PROD_API_KEY` (eg: adding a credit card to a referral user)
-
-Some tests may require a user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings.

examples

@@ -35,7 +35,7 @@ public function testCreate()
     {
         VCR::insertCassette('addresses/create.yml');
 
-        $address = Address::create(Fixture::basic_address());
+        $address = Address::create(Fixture::caAddress1());
 
         $this->assertInstanceOf('\EasyPost\Address', $address);
         $this->assertStringMatchesFormat('adr_%s', $address->id);
@@ -51,7 +51,7 @@ public function testCreateVerify()
     {
         VCR::insertCassette('addresses/createVerify.yml');
 
-        $addressData = Fixture::incorrect_address_to_verify();
+        $addressData = Fixture::incorrectAddress();
         $addressData['verify'] = true;
 
         $address = Address::create($addressData);
@@ -69,7 +69,7 @@ public function testCreateVerifyStrict()
     {
         VCR::insertCassette('addresses/createVerifyStrict.yml');
 
-        $addressData = Fixture::basic_address();
+        $addressData = Fixture::caAddress1();
         $addressData['verify_strict'] = true;
 
         $address = Address::create($addressData);
@@ -88,7 +88,7 @@ public function testCreateVerifyArray()
     {
         VCR::insertCassette('addresses/createVerifyArray.yml');
 
-        $addressData = Fixture::incorrect_address_to_verify();
+        $addressData = Fixture::incorrectAddress();
         $addressData['verify'] = [true];
 
         $address = Address::create($addressData);
@@ -106,7 +106,7 @@ public function testRetrieve()
     {
         VCR::insertCassette('addresses/retrieve.yml');
 
-        $address = Address::create(Fixture::basic_address());
+        $address = Address::create(Fixture::caAddress1());
 
         $retrievedAddress = Address::retrieve($address->id);
 
@@ -122,12 +122,12 @@ public function testAll()
         VCR::insertCassette('addresses/all.yml');
 
         $addresses = Address::all([
-            'page_size' => Fixture::page_size(),
+            'page_size' => Fixture::pageSize(),
         ]);
 
         $addressesArray = $addresses['addresses'];
 
-        $this->assertLessThanOrEqual($addressesArray, Fixture::page_size());
+        $this->assertLessThanOrEqual($addressesArray, Fixture::pageSize());
         $this->assertNotNull($addresses['has_more']);
         $this->assertContainsOnlyInstancesOf('\EasyPost\Address', $addressesArray);
     }
@@ -141,7 +141,7 @@ public function testCreateAndVerify()
     {
         VCR::insertCassette('addresses/createAndVerify.yml');
 
-        $addressData = Fixture::incorrect_address_to_verify();
+        $addressData = Fixture::incorrectAddress();
 
         $address = Address::create_and_verify($addressData);
 
@@ -157,7 +157,7 @@ public function testVerify()
     {
         VCR::insertCassette('addresses/verify.yml');
 
-        $address = Address::create(Fixture::basic_address());
+        $address = Address::create(Fixture::caAddress1());
 
         $address->verify();
 

test/EasyPost/AddressTest.php

@@ -37,7 +37,7 @@ public function testCreate()
         VCR::insertCassette('batches/create.yml');
 
         $batch = Batch::create([
-            'shipments' => [Fixture::basic_shipment()],
+            'shipments' => [Fixture::basicShipment()],
         ]);
 
         $this->assertInstanceOf('\EasyPost\Batch', $batch);
@@ -53,7 +53,7 @@ public function testRetrieve()
         VCR::insertCassette('batches/retrieve.yml');
 
         $batch = Batch::create([
-            'shipments' => [Fixture::basic_shipment()],
+            'shipments' => [Fixture::basicShipment()],
         ]);
 
         $retrievedBatch = Batch::retrieve($batch->id);
@@ -70,12 +70,12 @@ public function testAll()
         VCR::insertCassette('batches/all.yml');
 
         $batches = Batch::all([
-            'page_size' => Fixture::page_size(),
+            'page_size' => Fixture::pageSize(),
         ]);
 
         $batchesArray = $batches['batches'];
 
-        $this->assertLessThanOrEqual($batchesArray, Fixture::page_size());
+        $this->assertLessThanOrEqual($batchesArray, Fixture::pageSize());
         $this->assertNotNull($batches['has_more']);
         $this->assertContainsOnlyInstancesOf('\EasyPost\Batch', $batchesArray);
     }
@@ -88,8 +88,8 @@ public function testCreateAndBuy()
         VCR::insertCassette('batches/createAndBuy.yml');
 
         $batch = Batch::create_and_buy([
-            Fixture::one_call_buy_shipment(),
-            Fixture::one_call_buy_shipment(),
+            Fixture::oneCallBuyShipment(),
+            Fixture::oneCallBuyShipment(),
         ]);
 
         $this->assertInstanceOf('\EasyPost\Batch', $batch);
@@ -104,7 +104,7 @@ public function testBuy()
     {
         VCR::insertCassette('batches/buy.yml');
 
-        $shipmentData = Fixture::one_call_buy_shipment();
+        $shipmentData = Fixture::oneCallBuyShipment();
 
         $batch = Batch::create([
             'shipments' => [$shipmentData],
@@ -130,7 +130,7 @@ public function testCreateScanForm()
         VCR::insertCassette($cassetteName);
 
         $batch = Batch::create([
-            'shipments' => [Fixture::one_call_buy_shipment()],
+            'shipments' => [Fixture::oneCallBuyShipment()],
         ]);
         $batch->buy();
 
@@ -151,7 +151,7 @@ public function testAddRemoveShipment()
     {
         VCR::insertCassette('batches/addRemoveShipment.yml');
 
-        $shipment = Shipment::create(Fixture::one_call_buy_shipment());
+        $shipment = Shipment::create(Fixture::oneCallBuyShipment());
 
         $batch = Batch::create();
 
@@ -177,7 +177,7 @@ public function testLabel()
         VCR::insertCassette($cassetteName);
 
         $batch = Batch::create([
-            'shipments' => [Fixture::one_call_buy_shipment()],
+            'shipments' => [Fixture::oneCallBuyShipment()],
         ]);
         $batch->buy();
 

test/EasyPost/BatchTest.php

@@ -34,7 +34,7 @@ public function testCreate()
     {
         VCR::insertCassette('end_shipper/create.yml');
 
-        $endShipper = EndShipper::create(Fixture::end_shipper_address());
+        $endShipper = EndShipper::create(Fixture::caAddress1());
 
         $this->assertInstanceOf('\EasyPost\Beta\EndShipper', $endShipper);
         $this->assertStringMatchesFormat('es_%s', $endShipper->id);
@@ -48,7 +48,7 @@ public function testRetrieve()
     {
         VCR::insertCassette('end_shipper/retrieve.yml');
 
-        $endShipper = EndShipper::create(Fixture::end_shipper_address());
+        $endShipper = EndShipper::create(Fixture::caAddress1());
 
         $retrievedEndShipper = EndShipper::retrieve($endShipper->id);
 
@@ -64,10 +64,10 @@ public function testAll()
         VCR::insertCassette('end_shipper/all.yml');
 
         $endShipper = EndShipper::all([
-            'page_size' => Fixture::page_size(),
+            'page_size' => Fixture::pageSize(),
         ]);
 
-        $this->assertLessThanOrEqual($endShipper, Fixture::page_size());
+        $this->assertLessThanOrEqual($endShipper, Fixture::pageSize());
         $this->assertContainsOnlyInstancesOf('\EasyPost\Beta\EndShipper', $endShipper);
     }
 
@@ -78,7 +78,7 @@ public function testUpdate()
     {
         VCR::insertCassette('end_shipper/update.yml');
 
-        $endShipper = EndShipper::create(Fixture::end_shipper_address());
+        $endShipper = EndShipper::create(Fixture::caAddress1());
 
         // All caps because API will return all caps as part of verification.
         $newName = 'NEW NAME';

test/EasyPost/Beta/EndShipperTest.php

@@ -35,9 +35,9 @@ public function testCreate()
     {
         VCR::insertCassette('carrier_accounts/create.yml');
 
-        $carrierAccount = CarrierAccount::create(Fixture::basic_carrier_account());
+        $carrierAccount = CarrierAccount::create(Fixture::basicCarrierAccount());
 
-        $this->assertEquals('UpsAccount', $carrierAccount->type);
+        $this->assertEquals('DhlEcsAccount', $carrierAccount->type);
         $this->assertInstanceOf('\EasyPost\CarrierAccount', $carrierAccount);
         $this->assertStringMatchesFormat('ca_%s', $carrierAccount->id);
 
@@ -51,7 +51,7 @@ public function testRetrieve()
     {
         VCR::insertCassette('carrier_accounts/retrieve.yml');
 
-        $carrierAccount = CarrierAccount::create(Fixture::basic_carrier_account());
+        $carrierAccount = CarrierAccount::create(Fixture::basicCarrierAccount());
 
         $retrievedCarrierAccount = CarrierAccount::retrieve($carrierAccount->id);
 
@@ -80,7 +80,7 @@ public function testUpdate()
     {
         VCR::insertCassette('carrier_accounts/update.yml');
 
-        $carrierAccount = CarrierAccount::create(Fixture::basic_carrier_account());
+        $carrierAccount = CarrierAccount::create(Fixture::basicCarrierAccount());
 
         $testDescription = 'My custom description';
 
@@ -101,7 +101,7 @@ public function testDelete()
     {
         VCR::insertCassette('carrier_accounts/delete.yml');
 
-        $carrierAccount = CarrierAccount::create(Fixture::basic_carrier_account());
+        $carrierAccount = CarrierAccount::create(Fixture::basicCarrierAccount());
 
         $response = $carrierAccount->delete();
 

test/EasyPost/CarrierAccountTest.php

@@ -35,7 +35,7 @@ public function testCreate()
     {
         VCR::insertCassette('customs_info/create.yml');
 
-        $customsInfo = CustomsInfo::create(Fixture::basic_customs_info());
+        $customsInfo = CustomsInfo::create(Fixture::basicCustomsInfo());
 
         $this->assertInstanceOf('\EasyPost\CustomsInfo', $customsInfo);
         $this->assertStringMatchesFormat('cstinfo_%s', $customsInfo->id);
@@ -49,7 +49,7 @@ public function testRetrieve()
     {
         VCR::insertCassette('customs_info/retrieve.yml');
 
-        $customsInfo = CustomsInfo::create(Fixture::basic_customs_info());
+        $customsInfo = CustomsInfo::create(Fixture::basicCustomsInfo());
 
         $retrievedCustomsInfo = CustomsInfo::retrieve($customsInfo->id);
 

test/EasyPost/CustomsInfoTest.php

@@ -35,11 +35,11 @@ public function testCreate()
     {
         VCR::insertCassette('customs_items/create.yml');
 
-        $customsItem = CustomsItem::create(Fixture::basic_customs_item());
+        $customsItem = CustomsItem::create(Fixture::basicCustomsItem());
 
         $this->assertInstanceOf('\EasyPost\CustomsItem', $customsItem);
         $this->assertStringMatchesFormat('cstitem_%s', $customsItem->id);
-        $this->assertEquals('23.0', $customsItem->value);
+        $this->assertEquals('23.25', $customsItem->value);
     }
 
     /**
@@ -49,7 +49,7 @@ public function testRetrieve()
     {
         VCR::insertCassette('customs_items/retrieve.yml');
 
-        $customsItem = CustomsItem::create(Fixture::basic_customs_item());
+        $customsItem = CustomsItem::create(Fixture::basicCustomsItem());
 
         $retrievedCustomsItem = CustomsItem::retrieve($customsItem->id);
 

test/EasyPost/CustomsItemTest.php

@@ -40,19 +40,17 @@ public function testError()
             Shipment::create();
         } catch (Error $error) {
             $this->assertEquals(422, $error->getHttpStatus());
-            $this->assertEquals('SHIPMENT.INVALID_PARAMS', $error->ecode);
-            $this->assertEquals('Unable to create shipment, one or more parameters were invalid.', $error->getMessage());
-            $this->assertEquals(['to_address' => 'Required and missing.'], $error->errors[0]);
-            $this->assertEquals(['from_address' => 'Required and missing.'], $error->errors[1]);
-            $this->assertEquals('{"error":{"code":"SHIPMENT.INVALID_PARAMS","message":"Unable to create shipment, one or more parameters were invalid.","errors":[{"to_address":"Required and missing."},{"from_address":"Required and missing."}]}}', $error->getHttpBody());
+            $this->assertEquals('PARAMETER.REQUIRED', $error->ecode);
+            $this->assertEquals('Missing required parameter.', $error->getMessage());
+            $this->assertEquals(['field' => 'shipment', 'message' => 'cannot be blank'], $error->errors[0]);
+            $this->assertEquals('{"error":{"code":"PARAMETER.REQUIRED","message":"Missing required parameter.","errors":[{"field":"shipment","message":"cannot be blank"}]}}', $error->getHttpBody());
 
             // We check that the pretty printed output is the same here, leave the odd formatting as it is here and do not auto-format the next few lines
             $error->prettyPrint();
-            $this->expectOutputString('SHIPMENT.INVALID_PARAMS (422): Unable to create shipment, one or more parameters were invalid.
+            $this->expectOutputString('PARAMETER.REQUIRED (422): Missing required parameter.
 Field errors:
-  to_address: Required and missing.
-
-  from_address: Required and missing.
+  field: shipment
+  message: cannot be blank
 
 ');
         }

test/EasyPost/ErrorTest.php

@@ -37,12 +37,12 @@ public function testAll()
         VCR::insertCassette('events/all.yml');
 
         $events = Event::all([
-            'page_size' => Fixture::page_size(),
+            'page_size' => Fixture::pageSize(),
         ]);
 
         $eventsArray = $events['events'];
 
-        $this->assertLessThanOrEqual($eventsArray, Fixture::page_size());
+        $this->assertLessThanOrEqual($eventsArray, Fixture::pageSize());
         $this->assertNotNull($events['has_more']);
         $this->assertContainsOnlyInstancesOf('\EasyPost\Event', $eventsArray);
     }
@@ -55,7 +55,7 @@ public function testRetrieve()
         VCR::insertCassette('events/retrieve.yml');
 
         $events = Event::all([
-            'page_size' => Fixture::page_size(),
+            'page_size' => Fixture::pageSize(),
         ]);
 
         $event = Event::retrieve($events['events'][0]);
@@ -69,7 +69,7 @@ public function testRetrieve()
      */
     public function testReceive()
     {
-        $event = Event::receive(Fixture::event());
+        $event = Event::receive(Fixture::eventJson());
 
         $this->assertInstanceOf('\EasyPost\Event', $event);
         $this->assertStringMatchesFormat('evt_%s', $event->id);