easypost 3.4.0 → 4.1.0

data/easycop.yml

@@ -0,0 +1,180 @@
+# This file was generated by
+# `rake easycop:init`
+# on 2019-12-16 19:20:52 +0000 using EasyCop version 0.1.
+---
+require:
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: disable
+Layout/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_block
+Layout/DotPosition:
+  Enabled: true
+  AutoCorrect: true
+  EnforcedStyle: leading
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+  AutoCorrect: true
+Layout/EmptyLinesAroundArguments:
+  Enabled: true
+  AutoCorrect: true
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: true
+  AutoCorrect: true
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: keyword
+  AutoCorrect: true
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+Layout/MultilineHashBraceLayout:
+  EnforcedStyle: new_line
+Layout/MultilineArrayBraceLayout:
+  EnforcedStyle: new_line
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns:
+    - "(\\A|\\s)#"
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+RSpec/SharedExamples:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/ImplicitSubject:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+Style/BlockDelimiters:
+  Enabled: true
+  EnforcedStyle: braces_for_chaining
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+Style/Documentation:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Severity: warning
+  Enabled: true
+Style/RaiseArgs:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/SymbolArray:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Naming/InclusiveLanguage: # new in 1.18
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true

data/easypost.gemspec

@@ -1,31 +1,33 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "easypost/version"
+require 'easypost/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "easypost"
+  spec.name = 'easypost'
   spec.version = EasyPost::VERSION
-  spec.licenses = ["MIT"]
-  spec.date = Time.now.strftime("%Y-%m-%d")
-  spec.summary = "EasyPost Ruby Client Library"
-  spec.description = "Client library for accessing the EasyPost shipping API via Ruby."
-  spec.authors = ["Jake Epstein", "Andrew Tribone", "James Brown"]
-  spec.email = "support@easypost.com"
-  spec.homepage = "https://www.easypost.com/docs"
+  spec.licenses = ['MIT']
+  spec.summary = 'EasyPost Ruby Client Library'
+  spec.description = 'Client library for accessing the EasyPost shipping API via Ruby.'
+  spec.authors = 'EasyPost Developers'
+  spec.email = 'oss@easypost.com'
+  spec.homepage = 'https://www.easypost.com/docs'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.2"
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_development_dependency "pry", "~> 0.13"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "webmock", "~> 3.8"
-  spec.add_development_dependency "vcr", "~> 5.1"
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.24'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.7'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/easypost/address.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
+# Address objects are used to represent people, places, and organizations in a number of contexts.
 class EasyPost::Address < EasyPost::Resource
   attr_accessor :message # Backwards compatibility
 
-  def self.create(params={}, api_key=nil)
+  # Create an Address.
+  def self.create(params = {}, api_key = nil)
     url = self.url
 
-    address = params.reject { |k,_| k == :verify || k == :verify_strict }
+    address = params.reject { |k, _| [:verify, :verify_strict].include?(k) }
 
     if params[:verify] || params[:verify_strict]
       verify = params[:verify] || []
       verify_strict = params[:verify_strict] || []
 
-      url += "?"
+      url += '?'
       verify.each do |verification|
         url += "verify[]=#{verification}&"
       end
@@ -19,40 +23,36 @@ class EasyPost::Address < EasyPost::Resource
       end
     end
 
-    response = EasyPost.make_request(:post, url, api_key, {address: address})
-    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+    response = EasyPost.make_request(:post, url, api_key, { address: address })
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  def self.create_and_verify(params={}, carrier=nil, api_key=nil)
+  # Create and verify an Address in one call.
+  def self.create_and_verify(params = {}, carrier = nil, api_key = nil)
     wrapped_params = {}
-    wrapped_params[self.class_name().to_sym] = params
+    wrapped_params[class_name.to_sym] = params
     wrapped_params[:carrier] = carrier
-    response = EasyPost.make_request(:post, url + '/create_and_verify', api_key, wrapped_params)
+    response = EasyPost.make_request(:post, "#{url}/create_and_verify", api_key, wrapped_params)
 
-    if response.has_key?("address")
-      if response.has_key?("message")
-        response["address"]["message"] = response["message"]
-      end
-      verified_address = EasyPost::Util::convert_to_easypost_object(response["address"], api_key)
-      return verified_address
-    else
-      raise EasyPost::Error.new("Unable to verify address.")
+    raise EasyPost::Error.new('Unable to verify address.') unless response.key?('address')
+
+    if response.key?('message')
+      response['address']['message'] = response['message']
     end
+
+    EasyPost::Util.convert_to_easypost_object(response['address'], api_key)
   end
 
-  def verify(params={}, carrier=nil)
+  # Verify an Address.
+  def verify
     begin
-      response = EasyPost.make_request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
-    rescue
-      raise EasyPost::Error.new("Unable to verify address.")
+      response = EasyPost.make_request(:get, "#{url}/verify", @api_key)
+    rescue StandardError
+      raise EasyPost::Error.new('Unable to verify address.')
     end
 
-    if response.has_key?("address")
-      return EasyPost::Util::convert_to_easypost_object(response["address"], api_key)
-    else
-      raise EasyPost::Error.new("Unable to verify address.")
-    end
+    raise EasyPost::Error.new('Unable to verify address.') unless response.key?('address')
 
-    return self
+    EasyPost::Util.convert_to_easypost_object(response['address'], api_key)
   end
 end

data/lib/easypost/api_key.rb

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
+# An ApiKey allows you to authenticate with the EasyPost API.
 class EasyPost::ApiKey < EasyPost::Resource
 end

data/lib/easypost/batch.rb

@@ -1,49 +1,50 @@
+# frozen_string_literal: true
+
+# The Batch object allows you to perform operations on multiple Shipments at once.
 class EasyPost::Batch < EasyPost::Resource
-  def self.create_and_buy(params={}, api_key=nil)
+  # Create and buy a batch in one call.
+  def self.create_and_buy(params = {}, api_key = nil)
     wrapped_params = {}
-    wrapped_params[self.class_name().to_sym] = params
-    response = EasyPost.make_request(:post, url + '/create_and_buy', api_key, wrapped_params)
+    wrapped_params[class_name.to_sym] = params
+    response = EasyPost.make_request(:post, "#{url}/create_and_buy", api_key, wrapped_params)
 
-    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  def buy(params={})
-    response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
-    self.refresh_from(response, @api_key, true)
+  # Buy a Batch.
+  def buy(params = {})
+    response = EasyPost.make_request(:post, "#{url}/buy", @api_key, params)
+    refresh_from(response, @api_key)
 
-    return self
+    self
   end
 
-  def label(params={})
-    response = EasyPost.make_request(:post, url + '/label', @api_key, params)
-    self.refresh_from(response, @api_key, true)
+  # Convert the label format of a Batch.
+  def label(params = {})
+    response = EasyPost.make_request(:post, "#{url}/label", @api_key, params)
+    refresh_from(response, @api_key)
 
-    return self
+    self
   end
 
-  def remove_shipments(params={})
-    response = EasyPost.make_request(:post, url + '/remove_shipments', @api_key, params)
-    self.refresh_from(response, @api_key, true)
+  # Remove Shipments from a Batch.
+  def remove_shipments(params = {})
+    response = EasyPost.make_request(:post, "#{url}/remove_shipments", @api_key, params)
+    refresh_from(response, @api_key)
 
-    return self
+    self
   end
 
-  def add_shipments(params={})
-    response = EasyPost.make_request(:post, url + '/add_shipments', @api_key, params)
-    self.refresh_from(response, @api_key, true)
+  # Add Shipments to a Batch.
+  def add_shipments(params = {})
+    response = EasyPost.make_request(:post, "#{url}/add_shipments", @api_key, params)
+    refresh_from(response, @api_key)
 
-    return self
+    self
   end
 
-  def stamp_and_barcode_by_reference(params={})
-    response = EasyPost.make_request(:get, url + '/stamp_and_barcode_by_reference', @api_key, params)
-
-    return response
-  end
-
-  def create_scan_form(params={})
-    response = EasyPost.make_request(:post, url + '/scan_form', @api_key, params)
-
-    return response
+  # Create a ScanForm for a Batch.
+  def create_scan_form(params = {})
+    EasyPost.make_request(:post, "#{url}/scan_form", @api_key, params)
   end
 end

data/lib/easypost/brand.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# The Brand object allows you to customize the publicly-accessible html page that shows tracking details for every EasyPost tracker.
+class EasyPost::Brand < EasyPost::Resource
+  # The url of the Brand object.
+  def url
+    if user_id.nil? || user_id.empty?
+      raise EasyPost::Error, "Missing user_id: #{self.class} instance is missing user_id"
+    end
+
+    "#{::EasyPost::User.url}/#{CGI.escape(user_id)}/brand"
+  end
+end

data/lib/easypost/carrier_account.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+# A CarrierAccount encapsulates your credentials with the carrier.
 class EasyPost::CarrierAccount < EasyPost::Resource
+  # Retrieve a list of available CarrierAccount types for the authenticated User.
   def self.types
     EasyPost::CarrierType.all
   end

data/lib/easypost/carrier_type.rb

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
+# The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.
 class EasyPost::CarrierType < EasyPost::Resource
 end

data/lib/easypost/connection.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
+  attr_reader :connection
+
+  def initialize(uri:, config:)
+    super
+
+    @connection =
+      if config[:proxy]
+        proxy_uri = URI(config[:proxy])
+        Net::HTTP.new(
+          uri.host,
+          uri.port,
+          proxy_uri.host,
+          proxy_uri.port,
+          proxy_uri.user,
+          proxy_uri.password,
+        )
+      else
+        Net::HTTP.new(uri.host, uri.port)
+      end
+
+    connection.use_ssl = true
+
+    config.each do |name, value|
+      # Discrepancies between RestClient and Net::HTTP.
+      case name
+      when :verify_ssl
+        name = :verify_mode
+      when :timeout
+        name = :read_timeout
+      end
+
+      # Handled in the creation of the client.
+      if name == :proxy
+        next
+      end
+
+      connection.public_send("#{name}=", value)
+    end
+  end
+
+  # Make an HTTP request with Ruby's {Net::HTTP}
+  #
+  # @param method [Symbol] the HTTP Verb (get, method, put, post, etc.)
+  # @param path [String] URI path of the resource
+  # @param requested_api_key [String] ({EasyPost.api_key}) key set Authorization header.
+  # @param body [String] (nil) body of the request
+  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @return [Hash] JSON object parsed from the response body
+  def call(method, path, api_key = nil, body = nil)
+    request = Net::HTTP.const_get(method.capitalize).new(path)
+    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
+
+    response = connection.request(request)
+
+    EasyPost.parse_response(
+      status: response.code.to_i,
+      body: response.body,
+      json: response['Content-Type'].start_with?('application/json'),
+    )
+  end
+end

data/lib/easypost/customs_info.rb

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

data/lib/easypost/customs_item.rb

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

data/lib/easypost/error.rb

@@ -1,15 +1,13 @@
+# frozen_string_literal: true
+
+# EasyPost Error object.
 class EasyPost::Error < StandardError
-  attr_reader :message
-  attr_reader :status
-  attr_reader :http_status # deprecated
-  attr_reader :http_body
-  attr_reader :code
-  attr_reader :errors
+  attr_reader :message, :status, :http_body, :code, :errors
 
+  # Initialize a new EasyPost Error
   def initialize(message = nil, status = nil, code = nil, errors = nil, http_body = nil)
     @message = message
     @status = status
-    @http_status = status # deprecated
     @code = code
     @errors = errors
     @http_body = http_body
@@ -17,10 +15,12 @@ class EasyPost::Error < StandardError
     super(message)
   end
 
+  # Convert an error to a string.
   def to_s
     "#{code} (#{status}): #{message} #{errors}".strip
   end
 
+  # Compare error properties.
   def ==(other)
     other.is_a?(EasyPost::Error) &&
       message == other.message &&

data/lib/easypost/event.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'json'
 
+# Webhook Events are triggered by changes in objects you've created via the API.
 class EasyPost::Event < EasyPost::Resource
+  # Converts a raw webhook event into an EasyPost object.
   def self.receive(values)
-      return EasyPost::Util::convert_to_easypost_object(JSON.parse(values), nil)
+    EasyPost::Util.convert_to_easypost_object(JSON.parse(values), nil)
   end
 end

data/lib/easypost/insurance.rb

@@ -1,2 +1,6 @@
+# frozen_string_literal: true
+
+# An Insurance object represents insurance for packages purchased both via the EasyPost API as well
+# as shipments purchased through third parties and later registered with EasyPost.
 class EasyPost::Insurance < EasyPost::Resource
 end