easypost 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9995cfcc5bc7cce1ebefa6343fc31ba18f6f0f4b36dfb7502225b7abb1b40f8
-  data.tar.gz: 64d814764933ba53e3de2b01f39ba6fd2195a3a65ec4ec6c01b720078750fc42
+  metadata.gz: d6f62b9504efc5502cea14eb8c0ec792fe8c2987d857aedc34522663f2587706
+  data.tar.gz: e8c927c3ee7d01bc7a4d1d42c9cc6c1360ea082c66017bdf31c6399d503753fe
 SHA512:
-  metadata.gz: 44179f3818dd5d9098eed96f3263b12a67dd7ec415c49fb9efc976b07b858e63ed326c68b0a07415a62da8311cd5b4e72c406bf6650e197ad69956c674b03d76
-  data.tar.gz: 86007bac46665593dc205c9c231409698401af9b58da3d2d22049c0510b29528303a625c2be2945814ceffd7ee93838049dba5a8a34dcbf3afe3879f583cee80
+  metadata.gz: 7a731d243163def53e558f86191f992156ad50d2da7ed35f8993ae3b4f01298cacf99f5c507df44f420f856bd6c7c87b1f0965e98bd5f2719f7ebc048a383cd1
+  data.tar.gz: c79fb8e2236b550a0ca7925674f685054262bf0a88dda6dbd5582ad74828e85bb5268d188656513feb6e8cdf164792eb0f646ca436cb2d67d95b83c6f5be9906

data/.github/workflows/ci.yml

@@ -32,6 +32,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.1"
+          bundler-cache: true
       - name: Install Dependencies
         run: make install
       - name: Lint Project

data/.rubocop.yml

@@ -1,5 +1,7 @@
 inherit_from: easycop.yml
 
+AllCops:
+  SuggestExtensions: false
 # We are ignoring RSpec/FilePath because Simplecov doesn't play nice with nested spec files
 RSpec/FilePath:
   Enabled: false

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 # CHANGELOG
 
+## v4.8.0 (2022-09-21)
+
+- Adds support to buy a shipment by passing in `end_shipper_id`
+- `with_carbon_offset` can now alternatively be passed in the `params` parameter of the `shipment.buy` function
+- Migrates Partner White Label (Referrals) to general library namespace and deprecates beta functions
+
+## v4.7.1 (2022-09-06)
+
+- Makes not implemented `all` calls match the `EasyPost::Resource` interface so that one can call `.to_json` on them and receive the proper error
+
 ## v4.7.0 (2022-08-25)
 
 - Moves EndShipper out of beta to the general library namespace
-- Ensure the Easypost object will respond to `.id` when it has one in @values
+- Ensure the Easypost object will respond to `.id` when it has one in `@values`
 
 ## v4.6.0 (2022-08-02)
 

data/Makefile

@@ -14,7 +14,7 @@ clean:
 
 ## fix - Fix Rubocop errors
 fix:
-	rubocop -A
+	bundle exec rubocop -A
 
 ## install - Install globally from source
 install:
@@ -24,7 +24,7 @@ install:
 
 ## lint - Lint the project
 lint:
-	rubocop
+	bundle exec rubocop
 
 ## publish - Publishes the built gem to Rubygems
 publish:
@@ -37,7 +37,7 @@ release:
 
 ## scan - Runs security analysis on the project with Brakeman
 scan:
-	brakeman lib --force
+	bundle exec brakeman lib --force
 
 ## test - Test the project
 test:

data/VERSION

@@ -1 +1 @@
-4.7.0
+4.8.0

data/lib/easypost/beta/end_shipper.rb

@@ -2,6 +2,7 @@
 
 # EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon creation.
 class EasyPost::Beta::EndShipper < EasyPost::Resource
+  # Create an EndShipper object.
   # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
   def self.create(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `EndShipper.create` in the main namespace instead.'
@@ -10,6 +11,7 @@ class EasyPost::Beta::EndShipper < EasyPost::Resource
   end
 
   # Retrieves an EndShipper object.
+  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
   def self.retrieve(id, params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `EndShipper.retrieve` in the main namespace instead.'
     response = EasyPost.make_request(:get, "/beta/end_shippers/#{id}", api_key, params)
@@ -17,6 +19,7 @@ class EasyPost::Beta::EndShipper < EasyPost::Resource
   end
 
   # Retrieves a list of EndShipper objects.
+  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
   def self.all(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `EndShipper.all` in the main namespace instead.'
     response = EasyPost.make_request(:get, '/beta/end_shippers', api_key, params)
@@ -24,6 +27,7 @@ class EasyPost::Beta::EndShipper < EasyPost::Resource
   end
 
   # Updates (saves) an EndShipper object. This requires all parameters to be set.
+  # <b>DEPRECATED:</b> Please use <tt>EndShipper</tt> in the main namespace instead.
   def save
     warn '[DEPRECATION] Please use `endShipper.save` in the main namespace instead.'
     if @unsaved_values.length.positive?

data/lib/easypost/beta/referral.rb

@@ -3,13 +3,17 @@
 # Referral objects are User objects created from a Partner user.
 class EasyPost::Beta::Referral < EasyPost::Resource
   # Create a referral user. This function requires the Partner User's API key.
+  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.create(params = {}, api_key = nil)
+    warn '[DEPRECATION] Please use `EndShipper.create` in the main namespace instead.'
     response = EasyPost.make_request(:post, '/beta/referral_customers', api_key, { user: params })
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
   # Update a referral user. This function requires the Partner User's API key.
+  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.update_email(email, user_id, api_key = nil)
+    warn '[DEPRECATION] Please use `EndShipper.update_email` in the main namespace instead.'
     wrapped_params = {
       user: {
         email: email,
@@ -22,13 +26,17 @@ class EasyPost::Beta::Referral < EasyPost::Resource
   end
 
   # Retrieve a list of referral users. This function requires the Partner User's API key.
+  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.all(params = {}, api_key = nil)
+    warn '[DEPRECATION] Please use `EndShipper.all` in the main namespace instead.'
     response = EasyPost.make_request(:get, '/beta/referral_customers', api_key, params)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
   # Add credit card to a referral user. This function requires the Referral User's API key.
+  # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
+    warn '[DEPRECATION] Please use `EndShipper.add_credit_card` in the main namespace instead.'
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key
 
     begin
@@ -48,13 +56,14 @@ class EasyPost::Beta::Referral < EasyPost::Resource
   end
 
   # Retrieve EasyPost's Stripe public API key.
-  def self.retrieve_easypost_stripe_api_key
+  private_class_method def self.retrieve_easypost_stripe_api_key
     response = EasyPost.make_request(:get, '/beta/partners/stripe_public_key', @api_key)
     response['public_key']
   end
 
   # Get credit card token from Stripe.
-  def self.create_stripe_token(number, expiration_month, expiration_year, cvc, easypost_stripe_token)
+  private_class_method def self.create_stripe_token(number, expiration_month, expiration_year,
+                                                    cvc, easypost_stripe_token)
     headers = {
       # This Stripe endpoint only accepts URL form encoded bodies.
       Authorization: "Bearer #{easypost_stripe_token}",
@@ -84,7 +93,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
   end
 
   # Submit Stripe credit card token to EasyPost.
-  def self.create_easypost_credit_card(referral_api_key, stripe_object_id, priority = 'primary')
+  private_class_method def self.create_easypost_credit_card(referral_api_key, stripe_object_id, priority = 'primary')
     wrapped_params = {
       credit_card: {
         stripe_object_id: stripe_object_id,

data/lib/easypost/customs_info.rb

@@ -3,7 +3,7 @@
 # CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs forms required for international shipping.
 class EasyPost::CustomsInfo < EasyPost::Resource
   # Retrieve a list of CustomsInfo objects
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('CustomsInfo.all not implemented.')
   end
 end

data/lib/easypost/customs_item.rb

@@ -3,7 +3,7 @@
 # A CustomsItem object describes goods for international shipment and should be created then included in a CustomsInfo object.
 class EasyPost::CustomsItem < EasyPost::Resource
   # Retrieve a list of CustomsItem objects
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('CustomsItem.all not implemented.')
   end
 end

data/lib/easypost/order.rb

@@ -26,7 +26,7 @@ class EasyPost::Order < EasyPost::Resource
   end
 
   # Retrieve a list of Order objects.
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('Order.all not implemented.')
   end
 

data/lib/easypost/parcel.rb

@@ -3,7 +3,7 @@
 # Parcel objects represent the physical container being shipped.
 class EasyPost::Parcel < EasyPost::Resource
   # Retrieving all Parcel objects is not supported.
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('Parcel.all not implemented.')
   end
 end

data/lib/easypost/payment_method.rb

@@ -4,7 +4,7 @@
 class EasyPost::PaymentMethod < EasyPost::Resource
   # <b>DEPRECATED:</b> Please use <tt>Billing class</tt> instead.
   # Deprecated: v4.5.0 - v6.0.0
-  def self.all(api_key = nil)
+  def self.all(_filters = {}, api_key = nil)
     warn '[DEPRECATION] `all` is deprecated.  Please use `Billing.retrieve_payment_methods` instead.'
     EasyPost::Billing.retrieve_payment_methods(api_key)
   end

data/lib/easypost/pickup.rb

@@ -26,7 +26,7 @@ class EasyPost::Pickup < EasyPost::Resource
   end
 
   # Retrieve a list of all Pickup objects.
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('Pickup.all not implemented.')
   end
 

data/lib/easypost/rate.rb

@@ -3,7 +3,7 @@
 # A Rate object contains all the details about the rate of a Shipment.
 class EasyPost::Rate < EasyPost::Resource
   # Retrieving all Rate objects is not supported.
-  def self.all
+  def self.all(_filters = {}, _api_key = nil)
     raise NotImplementedError.new('Rate.all not implemented.')
   end
 end

data/lib/easypost/referral.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Referral objects are User objects created from a Partner user.
+class EasyPost::Referral < EasyPost::Resource
+  # Create a referral user. This function requires the Partner User's API key.
+  def self.create(params = {}, api_key = nil)
+    response = EasyPost.make_request(:post, '/v2/referral_customers', api_key, { user: params })
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Update a referral user. This function requires the Partner User's API key.
+  def self.update_email(email, user_id, api_key = nil)
+    wrapped_params = {
+      user: {
+        email: email,
+      },
+    }
+    EasyPost.make_request(:put, "/v2/referral_customers/#{user_id}", api_key, wrapped_params)
+
+    # return true if API succeeds, else an error is throw if it fails.
+    true
+  end
+
+  # Retrieve a list of referral users. This function requires the Partner User's API key.
+  def self.all(params = {}, api_key = nil)
+    response = EasyPost.make_request(:get, '/v2/referral_customers', api_key, params)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Add credit card to a referral user. This function requires the Referral User's API key.
+  def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
+    easypost_stripe_api_key = retrieve_easypost_stripe_api_key
+
+    begin
+      stripe_credit_card_token = create_stripe_token(
+        number,
+        expiration_month,
+        expiration_year,
+        cvc,
+        easypost_stripe_api_key,
+      )
+    rescue StandardError
+      raise EasyPost::Error.new('Could not send card details to Stripe, please try again later.')
+    end
+
+    response = create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
+    EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
+  end
+
+  # Retrieve EasyPost's Stripe public API key.
+  private_class_method def self.retrieve_easypost_stripe_api_key
+    response = EasyPost.make_request(:get, '/beta/partners/stripe_public_key', @api_key)
+    response['public_key']
+  end
+
+  # Get credit card token from Stripe.
+  private_class_method def self.create_stripe_token(number, expiration_month, expiration_year,
+                                                    cvc, easypost_stripe_token)
+    headers = {
+      # This Stripe endpoint only accepts URL form encoded bodies.
+      Authorization: "Bearer #{easypost_stripe_token}",
+      'Content-type': 'application/x-www-form-urlencoded',
+    }
+
+    credit_card_hash = {
+      card: {
+        number: number,
+        exp_month: expiration_month,
+        exp_year: expiration_year,
+        cvc: cvc,
+      },
+    }
+
+    form_encoded_params = EasyPost::Util.form_encode_params(credit_card_hash)
+
+    uri = URI.parse('https://api.stripe.com/v1/tokens')
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new(uri.request_uri, headers)
+    query = URI.encode_www_form(form_encoded_params)
+
+    response = http.request(request, query)
+    response_json = JSON.parse(response.body)
+    response_json['id']
+  end
+
+  # Submit Stripe credit card token to EasyPost.
+  private_class_method def self.create_easypost_credit_card(referral_api_key, stripe_object_id, priority = 'primary')
+    wrapped_params = {
+      credit_card: {
+        stripe_object_id: stripe_object_id,
+        priority: priority,
+      },
+    }
+    response = EasyPost.make_request(:post, '/beta/credit_cards', referral_api_key, wrapped_params)
+    EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
+  end
+end

data/lib/easypost/shipment.rb

@@ -35,14 +35,23 @@ class EasyPost::Shipment < EasyPost::Resource
   end
 
   # Buy a Shipment.
-  def buy(params = {}, with_carbon_offset = false)
+  def buy(params = {}, with_carbon_offset = false, end_shipper_id = nil)
     if params.instance_of?(EasyPost::Rate)
       temp = params.clone
       params = {}
       params[:rate] = temp
     end
 
-    params[:carbon_offset] = with_carbon_offset
+    if params[:with_carbon_offset]
+      params[:carbon_offset] = params[:with_carbon_offset]
+      params.delete(:with_carbon_offset)
+    else
+      params[:carbon_offset] = with_carbon_offset
+    end
+
+    if end_shipper_id
+      params[:end_shipper_id] = end_shipper_id
+    end
 
     response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
     refresh_from(response, @api_key)

data/lib/easypost.rb

@@ -30,6 +30,7 @@ require 'easypost/pickup_rate'
 require 'easypost/pickup'
 require 'easypost/postage_label'
 require 'easypost/rate'
+require 'easypost/referral'
 require 'easypost/refund'
 require 'easypost/report'
 require 'easypost/scan_form'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -208,6 +208,7 @@ files:
 - lib/easypost/pickup_rate.rb
 - lib/easypost/postage_label.rb
 - lib/easypost/rate.rb
+- lib/easypost/referral.rb
 - lib/easypost/refund.rb
 - lib/easypost/report.rb
 - lib/easypost/resource.rb