easypost 4.7.1 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33802b8af58e7efc3e5592c6559dd48dfa5a58cc9338f719c78bc97639f73c51
-  data.tar.gz: 1ec9df3da15eb1169817db4d3610f78826388836995615ec928a80d60e17fcf1
+  metadata.gz: 9ad992fe480aa1a1c8b1fc7e85dd06c7af4478bca9bcc3a2f083daaeeedcc39e
+  data.tar.gz: f37a2a32dac1dcc1efa0121dce6b6edbf14e3aa690308d393815ecaabddedda4
 SHA512:
-  metadata.gz: 8f66b559d5f34005ad16151f3b32b168254efaff625ab06eba13a97ebe1aade1ff40f3d281fed9f32f80016bf662337be2053dc9a74d0f748bff47c67c3f6dd8
-  data.tar.gz: a22e6a0c850f686807aae90db0d81a24f963c045e043dbd497a5078b9b4f5806124782906d78b3e30b760a13cd78daf9c99b4252c58760205d5b7364472f3310
+  metadata.gz: 6f0e9c8cbfb299608c58c865a2193e163739ca3543fb5bbea44026930bbecf34ae8d772fc2377909492a89d8c7d3d1440c7a9f7ebf25935927db35bc6ba1b7c3
+  data.tar.gz: 8b02eee4c36c0c918e4a3f4884694c48d453bbf3aba7db653669618462d67bad30c0cf0ceec96ee44de0b335626e0992b493ad06e4457feeb5f661ebe55ceb70

data/.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches: [master]
   pull_request: ~
+  workflow_dispatch: ~
 
 jobs:
   run-tests:
@@ -32,6 +33,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,5 +1,16 @@
 # CHANGELOG
 
+## v4.8.1 (2022-10-24)
+
+- Concatenates `error.message` if it incorrectly comes back from the API as an array
+- Treats any HTTP status outside the `2xx` range as an error. Impact expected is minimal as this change only affects `1xx` and `3xx` HTTP status codes
+
+## 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

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,11 +37,11 @@ release:
 
 ## scan - Runs security analysis on the project with Brakeman
 scan:
-	brakeman lib --force
+	bundle exec brakeman lib --force
 
-## test - Test the project
+## test - Test the project (and ignore warnings for test output)
 test:
-	bundle exec rspec
+	RUBYOPT="-W0" bundle exec rspec
 
 ## update - Updates dependencies
 update:

data/VERSION

@@ -1 +1 @@
-4.7.1
+4.8.1

data/lib/easypost/address.rb

@@ -28,20 +28,12 @@ class EasyPost::Address < EasyPost::Resource
     wrapped_params[class_name.to_sym] = params
     response = EasyPost.make_request(:post, "#{url}/create_and_verify", api_key, wrapped_params)
 
-    raise EasyPost::Error.new('Unable to verify address.') unless response.key?('address')
-
     EasyPost::Util.convert_to_easypost_object(response['address'], api_key)
   end
 
   # Verify an Address.
   def verify
-    begin
-      response = EasyPost.make_request(:get, "#{url}/verify", @api_key)
-    rescue StandardError
-      raise EasyPost::Error.new('Unable to verify address.')
-    end
-
-    raise EasyPost::Error.new('Unable to verify address.') unless response.key?('address')
+    response = EasyPost.make_request(:get, "#{url}/verify", @api_key)
 
     EasyPost::Util.convert_to_easypost_object(response['address'], api_key)
   end

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

@@ -2,14 +2,71 @@
 
 # Referral objects are User objects created from a Partner user.
 class EasyPost::Beta::Referral < EasyPost::Resource
+  class << self
+    protected
+
+    # Retrieve EasyPost's Stripe public API key.
+    def 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 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.
+    def 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
+
   # 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 `Referral.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 `Referral.update_email` in the main namespace instead.'
     wrapped_params = {
       user: {
         email: email,
@@ -22,13 +79,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 `Referral.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 `Referral.add_credit_card` in the main namespace instead.'
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key
 
     begin
@@ -46,52 +107,4 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     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.
-  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)
-    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.
-  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/billing.rb

@@ -2,9 +2,41 @@
 
 # Billing class that users can manage their payment and fund
 class EasyPost::Billing < EasyPost::Resource
+  class << self
+    protected
+
+    # Get payment method info (type of the payment method and ID of the payment method)
+    def get_payment_method_info(primary_or_secondary)
+      payment_methods = EasyPost::Billing.retrieve_payment_methods
+      payment_method_map = {
+        'primary' => 'primary_payment_method',
+        'secondary' => 'secondary_payment_method',
+      }
+
+      payment_method_to_use = payment_method_map[primary_or_secondary]
+
+      error_string = 'The chosen payment method is not valid. Please try again.'
+      raise EasyPost::Error.new(error_string) if payment_methods[payment_method_to_use].nil?
+
+      payment_method_id = payment_methods[payment_method_to_use]['id']
+
+      unless payment_method_id.nil?
+        if payment_method_id.start_with?('card_')
+          endpoint = '/v2/credit_cards'
+        elsif payment_method_id.start_with?('bank_')
+          endpoint = '/v2/bank_accounts'
+        else
+          raise EasyPost::Error.new(error_string)
+        end
+      end
+
+      [endpoint, payment_method_id]
+    end
+  end
+
   # Fund your EasyPost wallet by charging your primary or secondary card on file.
   def self.fund_wallet(amount, primary_or_secondary = 'primary', api_key = nil)
-    payment_info = EasyPost::Billing.get_payment_method_info(primary_or_secondary.downcase)
+    payment_info = get_payment_method_info(primary_or_secondary.downcase)
     endpoint = payment_info[0]
     payment_id = payment_info[1]
 
@@ -17,7 +49,7 @@ class EasyPost::Billing < EasyPost::Resource
 
   # Delete a payment method.
   def self.delete_payment_method(primary_or_secondary, api_key = nil)
-    payment_info = EasyPost::Billing.get_payment_method_info(primary_or_secondary.downcase)
+    payment_info = get_payment_method_info(primary_or_secondary.downcase)
     endpoint = payment_info[0]
     payment_id = payment_info[1]
 
@@ -37,32 +69,4 @@ class EasyPost::Billing < EasyPost::Resource
 
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
-
-  # Get payment method info (type of the payment method and ID of the payment method)
-  private_class_method def self.get_payment_method_info(primary_or_secondary)
-    payment_methods = EasyPost::Billing.retrieve_payment_methods
-    payment_method_map = {
-      'primary' => 'primary_payment_method',
-      'secondary' => 'secondary_payment_method',
-    }
-
-    payment_method_to_use = payment_method_map[primary_or_secondary]
-
-    error_string = 'The chosen payment method is not valid. Please try again.'
-    raise EasyPost::Error.new(error_string) if payment_methods[payment_method_to_use].nil?
-
-    payment_method_id = payment_methods[payment_method_to_use]['id']
-
-    unless payment_method_id.nil?
-      if payment_method_id.start_with?('card_')
-        endpoint = '/v2/credit_cards'
-      elsif payment_method_id.start_with?('bank_')
-        endpoint = '/v2/bank_accounts'
-      else
-        raise EasyPost::Error.new(error_string)
-      end
-    end
-
-    [endpoint, payment_method_id]
-  end
 end

data/lib/easypost/connection.rb

@@ -52,7 +52,7 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
     request.body = JSON.dump(EasyPost::Util.objects_to_ids(body)) if body
 
     EasyPost.default_headers.each_pair { |h, v| request[h] = v }
-    request['Authorization'] = EasyPost.authorization(api_key) if api_key
+    request['Authorization'] = EasyPost.authorization(api_key)
 
     response = connection.request(request)
     response_is_json = response['Content-Type'] ? response['Content-Type'].start_with?('application/json') : false

data/lib/easypost/error.rb

@@ -6,7 +6,8 @@ class EasyPost::Error < StandardError
 
   # Initialize a new EasyPost Error
   def initialize(message = nil, status = nil, code = nil, errors = nil, http_body = nil)
-    @message = message
+    # message should be a string but can sometimes incorrectly come back as an array
+    @message = message.is_a?(Array) ? message.join(', ') : message
     @status = status
     @code = code
     @errors = errors

data/lib/easypost/referral.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Referral objects are User objects created from a Partner user.
+class EasyPost::Referral < EasyPost::Resource
+  class << self
+    protected
+
+    # Retrieve EasyPost's Stripe public API key.
+    def 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 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.
+    def 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
+
+  # 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
+end

data/lib/easypost/resource.rb

@@ -48,6 +48,7 @@ class EasyPost::Resource < EasyPost::EasyPostObject
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
+  # Filter all results based on criteria.
   def self.each(filters = {}, api_key = EasyPost.api_key, &block)
     return to_enum(:each, filters, api_key) unless block_given?
 

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

@@ -26,10 +26,12 @@ require 'easypost/event'
 require 'easypost/insurance'
 require 'easypost/order'
 require 'easypost/parcel'
+require 'easypost/payment_method' # deprecated
 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'
@@ -132,7 +134,7 @@ module EasyPost
   end
 
   def self.parse_response(status:, body:, json:)
-    if status >= 400
+    if status < 200 || status >= 300
       error = JSON.parse(body)['error']
 
       raise EasyPost::Error.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.1
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-10-24 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