Merge pull request #199 from EasyPost/carbon_offset

Add ability to create carbon offset shipment

Author: Justintime50

CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Next Release
 
 - Adds `validateWebhook` function that returns your webhook or raises an error if there is a `webhookSecret` mismatch
+- Adds ability to create a shipment with carbon offset
+- Adds ability to buy a shipment with carbon offset
+- Adds ability to one-call-buy a shipment with carbon offset
+- Adds ability to rerate a shipment with carbon offset
 - Fixes a bug that required the values of `verify` and `verify_strict` params on an Address creation call to be arrays since passing `true` as a boolean is also valid (passing an array will continue to work but is no longer required)
 
 ## v5.4.0 (2022-07-18)

lib/EasyPost/CarbonOffset.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace EasyPost;
+
+/**
+ * @package EasyPost
+ * @property string $currency
+ * @property int $grams
+ * @property string $price
+ * @property string $object
+ */
+class CarbonOffset extends EasypostResource
+{
+}

lib/EasyPost/Rate.php

@@ -20,6 +20,7 @@
  * @property int $delivery_days
  * @property string $delivery_date
  * @property bool $delivery_date_guaranteed
+ * @property CarbonOffset $carbon_offset
  * @property string $created_at
  * @property string $updated_at
  */

lib/EasyPost/Shipment.php

@@ -65,31 +65,36 @@ public static function all($params = null, $apiKey = null)
      * Create a shipment.
      *
      * @param mixed $params
-     * @param string $apiKey
+     * @param string|null $apiKey
+     * @param boolean $withCarbonOffset
      * @return mixed
      */
-    public static function create($params = null, $apiKey = null)
+    public static function create($params = null, $apiKey = null, $withCarbonOffset = false)
     {
         if (!isset($params['shipment']) || !is_array($params['shipment'])) {
             $clone = $params;
             unset($params);
             $params['shipment'] = $clone;
         }
 
+        $params['carbon_offset'] = $withCarbonOffset;
+
         return self::createResource(get_class(), $params, $apiKey);
     }
 
     /**
      * Re-rate a shipment.
      *
      * @param mixed $params
+     * @param boolean $withCarbonOffset
      * @return $this
      * @throws \EasyPost\Error
      */
-    public function regenerate_rates($params = null)
+    public function regenerate_rates($params = null, $withCarbonOffset = false)
     {
         $requestor = new Requestor($this->_apiKey);
         $url = $this->instanceUrl() . '/rerate';
+        $params['carbon_offset'] = $withCarbonOffset;
         list($response, $apiKey) = $requestor->request('post', $url, $params);
         $this->refreshFrom($response, $apiKey, true);
 
@@ -115,10 +120,11 @@ public function get_smartrates()
      * Buy a shipment.
      *
      * @param mixed $params
+     * @param boolean $withCarbonOffset
      * @return $this
      * @throws \EasyPost\Error
      */
-    public function buy($params = null)
+    public function buy($params = null, $withCarbonOffset = false)
     {
         $requestor = new Requestor($this->_apiKey);
         $url = $this->instanceUrl() . '/buy';
@@ -129,6 +135,7 @@ public function buy($params = null)
             $params['rate'] = $clone;
         }
 
+        $params['carbon_offset'] = $withCarbonOffset;
         list($response, $apiKey) = $requestor->request('post', $url, $params);
         $this->refreshFrom($response, $apiKey, true);
 

lib/easypost.php

@@ -24,6 +24,7 @@
 require(dirname(__FILE__) . '/EasyPost/Address.php');
 require(dirname(__FILE__) . '/EasyPost/Batch.php');
 require(dirname(__FILE__) . '/EasyPost/Brand.php');
+require(dirname(__FILE__) . '/EasyPost/CarbonOffset.php');
 require(dirname(__FILE__) . '/EasyPost/CarrierAccount.php');
 require(dirname(__FILE__) . '/EasyPost/CarrierDetail.php');
 require(dirname(__FILE__) . '/EasyPost/CreditCard.php');

test/EasyPost/Fixture.php

@@ -180,7 +180,7 @@ public static function one_call_buy_shipment()
     // USPS only does "next-day" pickups including Saturday but not Sunday or Holidays.
     public static function basic_pickup()
     {
-        $pickupDate = '2022-05-16';
+        $pickupDate = '2022-07-29';
 
         return [
             'address' => self::basic_address(),
@@ -333,4 +333,47 @@ public static function webhookBody()
 
         return utf8_encode(json_encode($data));
     }
+
+    public static function carbonOffsetShipment()
+    {
+        return [
+            'to_address' => [
+                'name' => 'Dr. Steve Brule',
+                'street1' => '179 N Harbor Dr',
+                'city' => 'Redondo Beach',
+                'state' => 'CA',
+                'zip' => '90277',
+                'country' => 'US',
+                'phone' => '8573875756',
+                'email' => 'dr_steve_brule@gmail.com',
+            ],
+            'from_address' => [
+                'name' => 'EasyPost',
+                'street1' => '417 Montgomery Street',
+                'street2' => '5th Floor',
+                'city' => 'San Francisco',
+                'state' => 'CA',
+                'zip' => '94104',
+                'country' => 'US',
+                'phone' => '4153334445',
+                'email' => 'support@easypost.com',
+            ],
+            'parcel' => [
+                'length' => '20.2',
+                'width' => '10.9',
+                'height' => '5',
+                'weight' => '65.9',
+            ],
+        ];
+    }
+
+    public static function carbon_offset_shipment_one_call_buy()
+    {
+        $carbonOffsetShipment = Fixture::carbonOffsetShipment();
+        $carbonOffsetShipment['service'] = 'Priority';
+        $carbonOffsetShipment['carrier_accounts'] = Fixture::usps_carrier_account_id();
+        $carbonOffsetShipment['carrier'] = Fixture::usps();
+
+        return $carbonOffsetShipment;
+    }
 }

test/EasyPost/ShipmentTest.php

@@ -10,6 +10,8 @@
 use EasyPost\Test\Fixture;
 use VCR\VCR;
 
+use function PHPUnit\Framework\assertTrue;
+
 EasyPost::setApiKey(getenv('EASYPOST_TEST_API_KEY'));
 
 class ShipmentTest extends \PHPUnit\Framework\TestCase
@@ -332,9 +334,9 @@ public function testLowestSmartrate()
         $shipment = Shipment::create(Fixture::full_shipment());
 
         // Test lowest rate with no filters
-        $lowestRate = $shipment->lowest_smartrate(1, 'percentile_90');
-        $this->assertEquals('Priority', $lowestRate['service']);
-        $this->assertEquals(7.37, $lowestRate['rate']);
+        $lowestRate = $shipment->lowest_smartrate(2, 'percentile_90');
+        $this->assertEquals('First', $lowestRate['service']);
+        $this->assertEquals(5.49, $lowestRate['rate']);
         $this->assertEquals('USPS', $lowestRate['carrier']);
 
         // Test lowest smartrate with invalid filters (should error due to strict delivery_days)
@@ -365,9 +367,9 @@ public function testGetLowestSmartrate()
         $smartrates = $shipment->get_smartrates();
 
         // Test lowest smartrate with valid filters
-        $lowestSmartrate = Shipment::get_lowest_smartrate($smartrates, 1, 'percentile_90');
-        $this->assertEquals('Priority', $lowestSmartrate['service']);
-        $this->assertEquals(7.37, $lowestSmartrate['rate']);
+        $lowestSmartrate = Shipment::get_lowest_smartrate($smartrates, 2, 'percentile_90');
+        $this->assertEquals('First', $lowestSmartrate['service']);
+        $this->assertEquals(5.49, $lowestSmartrate['rate']);
         $this->assertEquals('USPS', $lowestSmartrate['carrier']);
 
         // Test lowest smartrate with invalid filters (should error due to strict delivery_days)
@@ -409,4 +411,84 @@ public function testGenerateForm()
         $this->assertEquals($formType, $form->form_type);
         $this->assertNotNull($form->form_url);
     }
+
+    /**
+     * Tests creating a carbon offset shipment.
+     *
+     */
+    public function testCreateCarbonOffsetShipment()
+    {
+        VCR::insertCassette('shipments/createCarbonOffsetShipment.yml');
+
+        $shipment = Shipment::create(Fixture::carbonOffsetShipment(), null, true);
+
+        $this->assertInstanceOf('\EasyPost\Shipment', $shipment);
+
+        foreach ($shipment->rates as $rate) {
+            $this->assertNotNull($rate->carbon_offset);
+        }
+    }
+
+    /**
+     * Tests buying a carbon offset shipment.
+     *
+     */
+    public function testBuyCarbonOffsetShipment()
+    {
+        VCR::insertCassette('shipments/buyCarbonOffsetShipment.yml');
+
+        $shipment = Shipment::create(Fixture::carbonOffsetShipment());
+
+        $shipment->buy(
+            [
+            'rate' => $shipment->lowest_rate(),
+            ],
+            true,
+        );
+
+        $this->assertInstanceOf('\EasyPost\Shipment', $shipment);
+
+        $foundCarbonOffset = false;
+
+        foreach ($shipment->fees as $fee) {
+            if ($fee->type == 'CarbonOffsetFee') {
+                $foundCarbonOffset = true;
+            }
+        }
+
+        $this->assertTrue($foundCarbonOffset);
+    }
+
+    /**
+     * Tests one call buy a carbon offset shipment.
+     *
+     */
+    public function testOneCallBuyCarbonOffsetShipment()
+    {
+        VCR::insertCassette('shipments/oneCallBuyCarbonOffsetShipment.yml');
+
+        $shipment = Shipment::create(Fixture::carbon_offset_shipment_one_call_buy(), null, true);
+
+        $this->assertInstanceOf('\EasyPost\Shipment', $shipment);
+
+        foreach ($shipment->rates as $rate) {
+            $this->assertNotNull($rate->carbon_offset);
+        }
+    }
+
+    /**
+     * Tests rerate a shipment with carbon offset.
+     *
+     */
+    public function testRerateShipmentWithCarbonOffset()
+    {
+        VCR::insertCassette('shipments/rerateCarbonOffsetShipment.yml');
+
+        $shipment = Shipment::create(Fixture::carbon_offset_shipment_one_call_buy());
+
+        $newCarbonOffset = $shipment->regenerate_rates(null, true);
+        foreach ($newCarbonOffset->rates as $rate) {
+            $this->assertNotNull($rate->carbon_offset);
+        }
+    }
 }