easypost 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02404008f0fc1078e49e1e418c5a208fbca5d646f31886c3c7fab55d932def70'
-  data.tar.gz: b8a2f7d514f9f22fa5b7ec3daf010adbfcc793c689954102b6ccbaafd7742e6a
+  metadata.gz: c07c842f7ff2eb209a6f447259afce469b6e1f0f481ea2bf68585869167ea8f9
+  data.tar.gz: 0ffb89bcb615cd1835f12e70d3c23ffa9ca9033daddddaad9db20a363f483212
 SHA512:
-  metadata.gz: f6c9af835a6ff8ccb7574fd5a14ef96f850784e6600249a8441d23a521763ad3fb40d826cdce0f758cd4b87213a65c6ee733476d34824dabbb7fb09db2af0de0
-  data.tar.gz: c492ad0635133598e8535a2a0c72949b0acd6f0095b511bb91011c50cec67e6d8999b5358da8aa7ae4543e38a30bc029367d8c0cfd791e4944f46fac3cdf75d9
+  metadata.gz: f03686d79b7d2023c26dc3c69362955465f3f99efc9b666d101a3499697ed155061afa2e8a47767bd83ae78bdd265d5363339ad4fb7686f47e5cff472483fa6a
+  data.tar.gz: 25f79bcc1b8c745ae9556c675d3aad56a06518853b4389081325170d2c1c1e425906bb8ded8925d40805ef961c5ccea3394da7bfe1f845117a8701f80526d526

data/.gitattributes

@@ -0,0 +1,4 @@
+* text=auto
+
+spec/cassettes/**/* -diff
+spec/cassettes/**/* linguist-generated

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
           ruby-version: ${{ matrix.rubyversion }}
           bundler-cache: true
       - name: run tests
-        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 bundle exec rspec
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -31,6 +31,8 @@ jobs:
         with:
           ruby-version: "3.1"
       - name: Install Dependencies
-        run: bundle install
+        run: make install
       - name: Lint Project
-        run: rubocop
+        run: make lint
+      - name: Run security analysis
+        run: make brakeman

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v4.4.0 (2022-07-11)
+
+- Adds `Billing.retrieve_payment_methods()`, `Billing.fund_wallet()`, and `Billing.delete_payment_method()` functions
+- Captures OS information in the user-agent header for easier debugging
+- Update functions now use `patch` instead of `put` under the hood to better match API behavior and documentation. The behavior of these functions should remain the same
+
 ## v4.3.0 (2022-05-19)
 
 - Adds the `EndShipper` Beta class with `create`, `retrieve`, `all`, and `save` functions

data/Makefile

@@ -0,0 +1,37 @@
+## help - Display help about make targets for this Makefile
+help:
+	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
+
+## brakeman - Runs security analysis on the project with Brakeman
+brakeman:
+	brakeman lib --force
+
+## build - Builds the project
+build:
+	gem build easypost.gemspec
+
+## clean - Cleans the project
+clean:
+	rm -rf coverage doc *.gem
+
+## fix - Fix Rubocop errors
+fix:
+	rubocop -A
+
+## install - Install globally from source
+install:
+	bundle install
+
+## lint - Lint the project
+lint:
+	rubocop
+
+## push - Pushes the built gem to Rubygems
+push:
+	gem push *.gem
+
+## test - Test the project
+test:
+	bundle exec rspec
+
+.PHONY: help build clean fix install lint push test

data/README.md

@@ -116,10 +116,13 @@ API Documentation can be found at: <https://easypost.com/docs/api>.
 
 ```bash
 # Install dependencies
-bundle install
+make install
+
+# Lint project
+make lint
 
 # Run tests (coverage is generated on a successful test suite run)
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... bundle exec rspec
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
 ```
 
 ### Testing

data/VERSION

@@ -1 +1 @@
-4.3.0
+4.4.0

data/easypost.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.5'
 
+  spec.add_development_dependency 'brakeman', '~> 5.2'
   spec.add_development_dependency 'pry', '~> 0.14'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'

data/lib/easypost/billing.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Billing class that users can manage their payment and fund
+class EasyPost::Billing < EasyPost::Resource
+  # 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)
+    endpoint = payment_info[0]
+    payment_id = payment_info[1]
+
+    wrapped_params = { amount: amount }
+    EasyPost.make_request(:post, "#{endpoint}/#{payment_id}/charges", api_key, wrapped_params)
+
+    # Return true if succeeds, an error will be thrown if it fails
+    true
+  end
+
+  # 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)
+    endpoint = payment_info[0]
+    payment_id = payment_info[1]
+
+    EasyPost.make_request(:delete, "#{endpoint}/#{payment_id}", api_key)
+
+    # Return true if succeeds, an error will be thrown if it fails
+    true
+  end
+
+  # Retrieve all payment methods.
+  def self.retrieve_payment_methods(api_key = nil)
+    response = EasyPost.make_request(:get, '/v2/payment_methods', api_key)
+
+    if response['id'].nil?
+      raise EasyPost::Error.new('Billing has not been setup for this user. Please add a payment method.')
+    end
+
+    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/payment_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# PaymentMethod objects represent a payment method of a user.
+class EasyPost::PaymentMethod < EasyPost::Resource
+  # Retrieve all payment methods.
+  def self.all(api_key = nil)
+    response = EasyPost.make_request(:get, url, api_key)
+
+    if response['id'].nil?
+      raise EasyPost::Error.new('Billing has not been setup for this user. Please add a payment method.')
+    end
+
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+end

data/lib/easypost/resource.rb

@@ -97,7 +97,7 @@ class EasyPost::Resource < EasyPost::EasyPostObject
 
       wrapped_params = { self.class.class_name => values }
 
-      response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
+      response = EasyPost.make_request(:patch, url, @api_key, wrapped_params)
       refresh_from(response, api_key)
     end
     self

data/lib/easypost/user.rb

@@ -16,7 +16,7 @@ class EasyPost::User < EasyPost::Resource
 
       wrapped_params = { user: values }
 
-      response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
+      response = EasyPost.make_request(:patch, url, @api_key, wrapped_params)
       refresh_from(response, api_key)
     end
     self

data/lib/easypost/util.rb

@@ -2,6 +2,90 @@
 
 # Internal utilities helpful for this libraries operation.
 module EasyPost::Util
+  attr_accessor :os_name, :os_version, :os_arch
+
+  BY_PREFIX = {
+    'adr' => EasyPost::Address,
+    'batch' => EasyPost::Batch,
+    'brd' => EasyPost::Brand,
+    'ca' => EasyPost::CarrierAccount,
+    'cstinfo' => EasyPost::CustomsInfo,
+    'cstitem' => EasyPost::CustomsItem,
+    'es' => EasyPost::Beta::EndShipper,
+    'evt' => EasyPost::Event,
+    'hook' => EasyPost::Webhook,
+    'ins' => EasyPost::Insurance,
+    'order' => EasyPost::Order,
+    'pickup' => EasyPost::Pickup,
+    'pickuprate' => EasyPost::PickupRate,
+    'pl' => EasyPost::PostageLabel,
+    'plrep' => EasyPost::Report,
+    'prcl' => EasyPost::Parcel,
+    'rate' => EasyPost::Rate,
+    'refrep' => EasyPost::Report,
+    'rfnd' => EasyPost::Refund,
+    'sf' => EasyPost::ScanForm,
+    'shp' => EasyPost::Shipment,
+    'shpinvrep' => EasyPost::Report,
+    'shprep' => EasyPost::Report,
+    'trk' => EasyPost::Tracker,
+    'trkrep' => EasyPost::Report,
+    'user' => EasyPost::User,
+  }.freeze
+
+  BY_TYPE = {
+    'Address' => EasyPost::Address,
+    'Batch' => EasyPost::Batch,
+    'Brand' => EasyPost::Brand,
+    'CarrierAccount' => EasyPost::CarrierAccount,
+    'CustomsInfo' => EasyPost::CustomsInfo,
+    'CustomsItem' => EasyPost::CustomsItem,
+    'EndShipper' => EasyPost::Beta::EndShipper,
+    'Event' => EasyPost::Event,
+    'Insurance' => EasyPost::Insurance,
+    'Order' => EasyPost::Order,
+    'Parcel' => EasyPost::Parcel,
+    'PaymentLogReport' => EasyPost::Report,
+    'Pickup' => EasyPost::Pickup,
+    'PickupRate' => EasyPost::PickupRate,
+    'PostageLabel' => EasyPost::PostageLabel,
+    'Rate' => EasyPost::Rate,
+    'Referral' => EasyPost::Beta::Referral,
+    'Refund' => EasyPost::Refund,
+    'RefundReport' => EasyPost::Report,
+    'Report' => EasyPost::Report,
+    'ScanForm' => EasyPost::ScanForm,
+    'Shipment' => EasyPost::Shipment,
+    'ShipmentInvoiceReport' => EasyPost::Report,
+    'ShipmentReport' => EasyPost::Report,
+    'TaxIdentifier' => EasyPost::TaxIdentifier,
+    'Tracker' => EasyPost::Tracker,
+    'TrackerReport' => EasyPost::Report,
+    'User' => EasyPost::User,
+    'Webhook' => EasyPost::Webhook,
+  }.freeze
+
+  def self.os_name
+    case RUBY_PLATFORM
+    when /linux/i
+      'Linux'
+    when /darwin/i
+      'Darwin'
+    when /cygwin|mswin|mingw|bccwin|wince|emx/i
+      'Windows'
+    else
+      'Unknown'
+    end
+  end
+
+  def self.os_version
+    Gem::Platform.local.version
+  end
+
+  def self.os_arch
+    Gem::Platform.local.cpu
+  end
+
   # Form-encode a multi-layer dictionary to a one-layer dictionary.
   def self.form_encode_params(hash, parent_keys = [], parent_dict = {})
     result = parent_dict or {}
@@ -55,84 +139,23 @@ module EasyPost::Util
 
   # Convert data to an EasyPost Object.
   def self.convert_to_easypost_object(response, api_key, parent = nil, name = nil)
-    types = {
-      'Address' => EasyPost::Address,
-      'Batch' => EasyPost::Batch,
-      'Brand' => EasyPost::Brand,
-      'CarrierAccount' => EasyPost::CarrierAccount,
-      'CustomsInfo' => EasyPost::CustomsInfo,
-      'CustomsItem' => EasyPost::CustomsItem,
-      'EndShipper' => EasyPost::Beta::EndShipper,
-      'Event' => EasyPost::Event,
-      'Insurance' => EasyPost::Insurance,
-      'Order' => EasyPost::Order,
-      'Parcel' => EasyPost::Parcel,
-      'PaymentLogReport' => EasyPost::Report,
-      'Pickup' => EasyPost::Pickup,
-      'PickupRate' => EasyPost::PickupRate,
-      'PostageLabel' => EasyPost::PostageLabel,
-      'Rate' => EasyPost::Rate,
-      'Referral' => EasyPost::Beta::Referral,
-      'Refund' => EasyPost::Refund,
-      'RefundReport' => EasyPost::Report,
-      'Report' => EasyPost::Report,
-      'ScanForm' => EasyPost::ScanForm,
-      'Shipment' => EasyPost::Shipment,
-      'ShipmentInvoiceReport' => EasyPost::Report,
-      'ShipmentReport' => EasyPost::Report,
-      'TaxIdentifier' => EasyPost::TaxIdentifier,
-      'Tracker' => EasyPost::Tracker,
-      'TrackerReport' => EasyPost::Report,
-      'User' => EasyPost::User,
-      'Webhook' => EasyPost::Webhook,
-    }
-
-    prefixes = {
-      'adr' => EasyPost::Address,
-      'batch' => EasyPost::Batch,
-      'brd' => EasyPost::Brand,
-      'ca' => EasyPost::CarrierAccount,
-      'cstinfo' => EasyPost::CustomsInfo,
-      'cstitem' => EasyPost::CustomsItem,
-      'es' => EasyPost::Beta::EndShipper,
-      'evt' => EasyPost::Event,
-      'hook' => EasyPost::Webhook,
-      'ins' => EasyPost::Insurance,
-      'order' => EasyPost::Order,
-      'pickup' => EasyPost::Pickup,
-      'pickuprate' => EasyPost::PickupRate,
-      'pl' => EasyPost::PostageLabel,
-      'plrep' => EasyPost::Report,
-      'prcl' => EasyPost::Parcel,
-      'rate' => EasyPost::Rate,
-      'refrep' => EasyPost::Report,
-      'rfnd' => EasyPost::Refund,
-      'sf' => EasyPost::ScanForm,
-      'shp' => EasyPost::Shipment,
-      'shpinvrep' => EasyPost::Report,
-      'shprep' => EasyPost::Report,
-      'trk' => EasyPost::Tracker,
-      'trkrep' => EasyPost::Report,
-      'user' => EasyPost::User,
-    }
-
     case response
     when Array
       response.map { |i| convert_to_easypost_object(i, api_key, parent) }
     when Hash
       if (cls_name = response[:object])
-        cls = types[cls_name]
+        cls = BY_TYPE[cls_name]
       elsif response[:id]
         if response[:id].index('_').nil?
           cls = EasyPost::EasyPostObject
         elsif (cls_prefix = response[:id][0..response[:id].index('_')])
-          cls = prefixes[cls_prefix[0..-2]]
+          cls = BY_PREFIX[cls_prefix[0..-2]]
         end
       elsif response['id']
         if response['id'].index('_').nil?
           cls = EasyPost::EasyPostObject
         elsif (cls_prefix = response['id'][0..response['id'].index('_')])
-          cls = prefixes[cls_prefix[0..-2]]
+          cls = BY_PREFIX[cls_prefix[0..-2]]
         end
       end
 

data/lib/easypost/webhook.rb

@@ -12,7 +12,7 @@ class EasyPost::Webhook < EasyPost::Resource
 
     instance_url = "#{self.class.url}/#{CGI.escape(id)}"
 
-    response = EasyPost.make_request(:put, instance_url, @api_key, params)
+    response = EasyPost.make_request(:patch, instance_url, @api_key, params)
     refresh_from(response, api_key)
 
     self

data/lib/easypost.rb

@@ -5,7 +5,6 @@ require 'cgi'
 require 'net/http'
 
 require 'easypost/version'
-require 'easypost/util'
 require 'easypost/object'
 require 'easypost/resource'
 require 'easypost/error'
@@ -15,6 +14,7 @@ require 'easypost/connection'
 require 'easypost/address'
 require 'easypost/api_key'
 require 'easypost/batch'
+require 'easypost/billing'
 require 'easypost/brand'
 require 'easypost/carrier_account'
 require 'easypost/carrier_type'
@@ -38,9 +38,10 @@ require 'easypost/user'
 require 'easypost/webhook'
 require 'easypost/beta'
 
+require 'easypost/util'
+
 module EasyPost
   DEFAULT_API_BASE = 'https://api.easypost.com'
-  DEFAULT_USER_AGENT = "EasyPost/v2 RubyClient/#{EasyPost::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
 
   class << self
     attr_accessor :api_key, :api_base
@@ -49,10 +50,17 @@ module EasyPost
 
   self.api_base = DEFAULT_API_BASE
 
+  def self.user_agent
+    @user_agent ||=
+      "EasyPost/v2 RubyClient/#{EasyPost::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} " \
+      "OS/#{EasyPost::Util.os_name} OSVersion/#{EasyPost::Util.os_version} " \
+      "OSArch/#{EasyPost::Util.os_arch}"
+  end
+
   def self.default_headers
     @default_headers ||= {
       'Content-Type' => 'application/json',
-      'User-Agent' => EasyPost::DEFAULT_USER_AGENT,
+      'User-Agent' => user_agent,
     }
   end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".github/ISSUE_TEMPLATE/bug_report.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
@@ -154,6 +169,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - SECURITY.md
@@ -170,6 +186,7 @@ files:
 - lib/easypost/beta.rb
 - lib/easypost/beta/end_shipper.rb
 - lib/easypost/beta/referral.rb
+- lib/easypost/billing.rb
 - lib/easypost/brand.rb
 - lib/easypost/carrier_account.rb
 - lib/easypost/carrier_type.rb
@@ -182,6 +199,7 @@ files:
 - lib/easypost/object.rb
 - lib/easypost/order.rb
 - lib/easypost/parcel.rb
+- lib/easypost/payment_method.rb
 - lib/easypost/pickup.rb
 - lib/easypost/pickup_rate.rb
 - lib/easypost/postage_label.rb
@@ -216,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library