easypost 3.5.1 → 4.0.0

data/lib/easypost.rb

@@ -1,63 +1,66 @@
-require "base64"
-require "cgi"
-require "net/http"
+# frozen_string_literal: true
 
-require "easypost/version"
-require "easypost/util"
-require "easypost/object"
-require "easypost/resource"
-require "easypost/error"
-
-# Resources
-require "easypost/address"
-require "easypost/api_key"
-require "easypost/batch"
-require "easypost/brand"
-require "easypost/carrier_account"
-require "easypost/carrier_type"
-require "easypost/customs_info"
-require "easypost/customs_item"
-require "easypost/event"
-require "easypost/insurance"
-require "easypost/order"
-require "easypost/parcel"
-require "easypost/pickup_rate"
-require "easypost/pickup"
-require "easypost/postage_label"
-require "easypost/print_job"
-require "easypost/printer"
-require "easypost/rate"
-require "easypost/refund"
-require "easypost/report"
-require "easypost/scan_form"
-require "easypost/shipment"
-require "easypost/tax_identifier"
-require "easypost/tracker"
-require "easypost/user"
-require "easypost/webhook"
+require 'base64'
+require 'cgi'
+require 'net/http'
 
+require 'easypost/version'
 require 'easypost/util'
+require 'easypost/object'
+require 'easypost/resource'
+require 'easypost/error'
+
+# Resources
+require 'easypost/address'
+require 'easypost/api_key'
+require 'easypost/batch'
+require 'easypost/brand'
+require 'easypost/carrier_account'
+require 'easypost/carrier_type'
+require 'easypost/customs_info'
+require 'easypost/customs_item'
+require 'easypost/event'
+require 'easypost/insurance'
+require 'easypost/order'
+require 'easypost/parcel'
+require 'easypost/pickup_rate'
+require 'easypost/pickup'
+require 'easypost/postage_label'
+require 'easypost/rate'
+require 'easypost/refund'
+require 'easypost/report'
+require 'easypost/scan_form'
+require 'easypost/shipment'
+require 'easypost/tax_identifier'
+require 'easypost/tracker'
+require 'easypost/user'
+require 'easypost/webhook'
 
 module EasyPost
   @api_key = nil
-  @api_base = "https://api.easypost.com"
+  @api_base = 'https://api.easypost.com'
 
+  # Set the ApiKey.
   def self.api_key=(api_key)
     @api_key = api_key
   end
 
+  # Get the ApiKey.
   def self.api_key
     @api_key
   end
 
+  # Set the API base.
   def self.api_base=(api_base)
     @api_base = api_base
   end
 
+  # Get the API base.
   def self.api_base
     @api_base
   end
 
+  # Reset the HTTP config.
   def self.reset_http_config
     @http_config = {
       timeout: 60,
@@ -66,23 +69,26 @@ module EasyPost
     }
 
     ruby_version = Gem::Version.new(RUBY_VERSION)
-    if ruby_version >= Gem::Version.new("2.5.0")
+    if ruby_version >= Gem::Version.new('2.5.0')
       @http_config[:min_version] = OpenSSL::SSL::TLS1_2_VERSION
     else
-      @http_config[:ssl_version] = :TLSv1_2
+      @http_config[:ssl_version] = :TLSv1_2 # rubocop:disable Naming/VariableNumber
     end
 
     @http_config
   end
 
+  # Get the HTTP config.
   def self.http_config
     @http_config ||= reset_http_config
   end
 
+  # Set the HTTP config.
   def self.http_config=(http_config_params)
     http_config.merge!(http_config_params)
   end
 
+  # Create an EasyPost Client.
   def self.make_client(uri)
     client = if http_config[:proxy]
                proxy_uri = URI(http_config[:proxy])
@@ -92,7 +98,7 @@ module EasyPost
                  proxy_uri.host,
                  proxy_uri.port,
                  proxy_uri.user,
-                 proxy_uri.password
+                 proxy_uri.password,
                )
              else
                Net::HTTP.new(uri.host, uri.port)
@@ -101,9 +107,10 @@ module EasyPost
 
     http_config.each do |name, value|
       # Discrepancies between RestClient and Net::HTTP.
-      if name == :verify_ssl
+      case name
+      when :verify_ssl
         name = :verify_mode
-      elsif name == :timeout
+      when :timeout
         name = :read_timeout
       end
 
@@ -118,7 +125,8 @@ module EasyPost
     client
   end
 
-  def self.make_request(method, path, api_key=nil, body=nil)
+  # Make an HTTP request.
+  def self.make_request(method, path, api_key = nil, body = nil)
     client = make_client(URI(@api_base))
 
     request = Net::HTTP.const_get(method.capitalize).new(path)
@@ -126,29 +134,25 @@ module EasyPost
       request.body = JSON.dump(EasyPost::Util.objects_to_ids(body))
     end
 
-    request["Content-Type"] = "application/json"
-    request["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}"
-    if api_key = api_key || @api_key
-      request["Authorization"] = "Basic #{Base64.strict_encode64("#{api_key}:")}"
+    request['Content-Type'] = 'application/json'
+    request['User-Agent'] = "EasyPost/v2 RubyClient/#{VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+    if api_key ||= @api_key
+      request['Authorization'] = "Basic #{Base64.strict_encode64("#{api_key}:")}"
     end
 
     response = client.request(request)
 
     if (400..599).include? response.code.to_i
-      error = JSON.parse(response.body)["error"]
-      raise EasyPost::Error.new(error["message"], response.code.to_i, error["code"], error["errors"], response.body)
+      error = JSON.parse(response.body)['error']
+      raise EasyPost::Error.new(error['message'], response.code.to_i, error['code'], error['errors'], response.body)
     end
 
-    if response["Content-Type"].include? "application/json"
+    if response['Content-Type'].include? 'application/json'
       JSON.parse(response.body)
     else
       response.body
     end
   rescue JSON::ParserError
-    raise RuntimeError.new(
-      "Invalid response object from API, unable to decode.\n#{response.body}"
-    )
+    raise "Invalid response object from API, unable to decode.\n#{response.body}"
   end
 end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 4.0.0
 platform: ruby
 authors:
-- Jake Epstein
-- Andrew Tribone
-- James Brown
+- EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -18,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,44 +44,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.14'
 description: Client library for accessing the EasyPost shipping API via Ruby.
-email: support@easypost.com
+email: oss@easypost.com
 executables:
 - easypost-irb
 extensions: []
@@ -91,13 +145,16 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADE_GUIDE.md
 - VERSION
 - bin/easypost-irb
+- easycop.yml
 - easypost.gemspec
 - lib/easypost.rb
 - lib/easypost/address.rb
@@ -117,8 +174,6 @@ files:
 - lib/easypost/pickup.rb
 - lib/easypost/pickup_rate.rb
 - lib/easypost/postage_label.rb
-- lib/easypost/print_job.rb
-- lib/easypost/printer.rb
 - lib/easypost/rate.rb
 - lib/easypost/refund.rb
 - lib/easypost/report.rb
@@ -143,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library

data/lib/easypost/print_job.rb

@@ -1,2 +0,0 @@
-class EasyPost::PrintJob < EasyPost::Resource
-end

data/lib/easypost/printer.rb

@@ -1,24 +0,0 @@
-class EasyPost::Printer < EasyPost::Resource
-
-  def job
-    response = EasyPost.make_request(
-      :get, url + '/jobs', @api_key
-    )
-    return EasyPost::Util::convert_to_easypost_object(response, api_key)
-  end
-
-  def print(params={})
-    if params.instance_of?(EasyPost::PostageLabel)
-      temp = params.clone
-      params = {}
-      params[:postage_label] = temp
-    end
-
-    response = EasyPost.make_request(
-      :post, url + '/print_postage_label', @api_key, params
-    )
-    true
-  rescue
-    false
-  end
-end