easypost 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c0e0c8eb25bf4d96db43cd812a71df8648e2b1a77f2eef5d651bb4c1275cbf
-  data.tar.gz: ac36be5df27407e988d4fcc50c93a312fe8e1465cba96e85c8120d36acdfcf65
+  metadata.gz: 4033b69b8c91126ab87ed8a16c3b5dd8bd7b4b06b9e7cc4011fe478163244a3a
+  data.tar.gz: 554e850ea8107cd0d8de3efca5c0ed18834c7b51c5c437ca9e6c4f8d197489a2
 SHA512:
-  metadata.gz: cd011f19406e4f5187f6daac73c490621052605610160992ce4ec42db0b9a4e1b3f64f90123f2b8a7399f32f3b54c7d6515e03c882e01acbc913d611dce9f0a2
-  data.tar.gz: 3bb63bfce116fa8e1504cde77b38019c68bd4269770246e78aad8916b3e04e29877926550ddaf17fe5fa8489e071069a5e2b0e1432a0fdb52bc0f55e4a981af5
+  metadata.gz: 77335abc417c0cf3d1af97d9b4941b00f8dec6400282d0f4f25a3408c47b82eaa5f8a8de6564f250e6a985f3261c296eb22d535eed3d04cc5c7a2716c5239352
+  data.tar.gz: 27cc114d89dddec6d2bf7862cd0f15c8d875f739a806a1589ca2626fc61ed9387ee5602d373c85902d6fc8908fe266df347d5d7409a4e9af42cb0091e5791690

data/.github/workflows/ci.yml

@@ -1,8 +1,8 @@
-name: 'CI'
+name: "CI"
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request: ~
 
 jobs:
@@ -10,13 +10,27 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        rubyversion: ["2.5", "2.6", "2.7", "3.0", "3.1"]
     steps:
-      - uses: actions/checkout@v2
-      - name: set up ruby
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
           bundler-cache: true
       - name: run tests
         run: bundle exec rspec
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.0"
+      - name: Install Dependencies
+        run: bundle install
+      - name: Lint Project
+        run: rubocop

data/.gitignore

@@ -12,6 +12,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/
 
 # YARD artifacts
 .yardoc

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,12 +1,26 @@
 # CHANGELOG
 
-
-## 3.5.0 2021-12-06
+## v4.0.0 (2022-02-25)
+
+* Bumps minimum Ruby version from `2.2` to `2.5`
+* Bumps dev dependencies
+* Documents each interface of the project in code
+* Overhauls the test suite with full coverage
+* Introduces `Rubocop` and lints the entire project
+* Removes the unusable `Print` and `PrintJob` objects
+* Removes deprecated and unusable `stamp_and_barcode_by_reference` method on the Batch object
+* Explicitly returns an error of "not implemented" for `Rate.all` and `Parcel.all`
+* Removes the `Shipment.get_rates` function as shipments already contain rates. If you need to get new rates for a shipment, use the `Shipment.regenerate_rates` function instead
+* Removes the parameters from `Address.verify` as they are unusable
+* Removes the deprecated `http_status` property of the `EasyPost::Error` object as it was replaced with `status`
+* Fixes a bug that would append an extra `id` field to each retrieved object
+* Various other small improvements and bug fixes
+
+## v3.5.0 (2021-12-06)
 
 * Adds the `update_brand` method to the user object (closes #122)
 
-
-## 3.4.0 2021-07-13
+## v3.4.0 (2021-07-13)
 
 * Removed deprecated `Item` object
 * Sorted EasyPost Resources list
@@ -15,236 +29,222 @@
 * Adds `regenerate_rates` method for new rerate API
 * Adds `deconstruct_keys` method to allow for pattern matching on EasyPost objects
 
-
-## 3.3.0 2021-06-10
+## v3.3.0 (2021-06-10)
 
 * Adds `SmartRate` functionality to the `Shipments` object (available by calling `get_smartrates` on a shipment)
 * Fix bug where `EasyPost::CarrierAccount.types` was hitting the wrong endpoint
 
-
-## 3.2.0 2021-01-14
+## v3.2.0 (2021-01-14)
 
 * Replace Travis CI with Github Actions
 * Add Ruby 3.0 to supported platforms (#110; thanks @maxwell)
 
-
-## 3.1.5 2020-12-16
+## v3.1.5 (2020-12-16)
 
 * Fix attribute lookup when manually constructing objects (#105; thanks @drewtempelmeyer)
 * Flatten class names and clean up some other style issues
 * Fix `EasyPost::Address.create_and_verify`, broken since 3.1.0 (#108; thanks @rajbirverma)
 
-
-## 3.1.4 2020-09-29
+## v3.1.4 (2020-09-29)
 
 * Don't modify params passed into Address#create (#78; thanks @TheRusskiy)
 * Don't modify `carriers` and `services` parameters to `Shipment.lowest_rate` (#71 / #103, thanks @vladvinnikov and @jurisgalang)
 * When constructing an easypost object, convert the key to a string (#102; thanks @Geesu)
 * Expose the raw HTTP response as `#http_body` on `EasyPost::Error` objects (#101; thanks @Geesu)
 
-
-## 3.1.3 2020-06-26
+## v3.1.3 (2020-06-26)
 
 * Fix bug causing Authorization header to be included in User-Agent header. All users must upgrade.
 
-
-## 3.1.2 2020-06-24
+## v3.1.2 (2020-06-24)
 
 * Bad gem push. New version required.
 
-
-## 3.1.1 2020-06-23
+## v3.1.1 (2020-06-23)
 
 * Fix bug where EasyPost.http_config was invalid when not explicitly initialized.
 
-
-## 3.1.0 2020-06-23
+## v3.1.0 (2020-06-23)
 
 * Add Shipment Invoice and Refund Report
 * Remove dependencies on `RestClient` and `MultiJson`
 * Remove some deprecated endpoints
 
-
-## 3.0.1 2018-05-17
+## v3.0.1 (2018-05-17)
 
 * Enforce TLS certificate validity by default
 
-
-## 3.0.0 2018-02-15
+## v3.0.0 (2018-02-15)
 
 * Require use of ruby ~> 2.0 and TLSv1.2
 
-
-## 2.7.3 2018-02-05
+## v2.7.3 (2018-02-05)
 
 * Fix bug with introduced around certain JSON objects with IDs (thanks vladvinnikov!)
 
-
-## 2.7.2 2018-02-01
+## v2.7.2 (2018-02-01)
 
 * Removed unused and unsupported code paths for Container model
 * Removed unused and unsupported code path for Stamp and Barcode methods on the Shipment model
 * Fixed a bug with non-model JSON object with an "id" key being treated as models and raising errors
 
-
-## 2.7.1 2017-05-25
+## v2.7.1 (2017-05-25)
 
 * Allow reports to be retrieved without passing a type
 
-
-## 2.7.0 2017-04-04
+## v2.7.0 (2017-04-04)
 
 * Changed Report CRUD signatures. requires report type to be passed
 
-
-## 2.6.2 2017-02-14
+## v2.6.2 (2017-02-14)
 
 * Added get_rates method for Orders
 
-
-## 2.6.1 2017-01-19
+## v2.6.1 (2017-01-19)
 
 * Updated create method for ScanForms
 
-
-## 2.6.0 2017-01-17
+## v2.6.0 (2017-01-17)
 
 * Add basic CRUD methods for Webhooks
 
-
-## 2.5.0 2016-12-19
+## v2.5.0 (2016-12-19)
 
 * Add prefixes to report in utils
 
-
-## 2.4.0 2016-12-08
+## v2.4.0 (2016-12-08)
 
 * Add report resource to ruby client
 
-
-## 2.3.0 2016-11-25
+## v2.3.0 (2016-11-25)
 
 * Updated dependencies to allow rest-client 2.0.0 and above
 
-
-## 2.2.0 2016-07-26
+## v2.2.0 (2016-07-260
 
 * Added standalone Insurance model
 
-
-## 2.1.11 2016-02-04
+## v2.1.11 (2016-02-04)
 
 * Allowed user creation for top-level users
 
-
-## 2.1.10 2015-12-23
+## v2.1.10 (2015-12-23)
 
 * Added verify and verify_strict params to Address.create
 * Added Tracker.create_list and Tracker.all_updated for working with large
 numbers of Trackers.
 
-
-## 2.1.9 2015-11-04
+## v2.1.9 (2015-11-04)
 
 * Added new tests for Tracker.all
 * Updated some old examples
 
-
-## 2.1.8 2015-10-21
+## v2.1.8 (2015-10-21)
 
 * Added Cancel method for Pickups (thanks Ramie Blatt!)
 
-
-## 2.1.7 2015-10-05
+## v2.1.7 (2015-10-05)
 
 * Fixed Address.create_and_verify and changed how errors are raised (thanks Dimitri Roche!)
 * Require newer version of the multi_json package
 
-
-## 2.1.6 2015-06-10
+## v2.1.6 (2015-06-10)
 
 * Added Address message accessor for backwards compatability
 
-
-## 2.1.5 2015-06-10
+## v2.1.5 (2015-06-10)
 
 * Removed Address.message
 
-
-## 2.1.4 2015-06-03
+## v2.1.4 (2015-06-03)
 
 * Add Printer and PrintJob resources.
 
-
-## 2.1.3 2015-04-30
+## v2.1.3 (2015-04-30)
 
 * Bux fix, EasyPost::Errors no longer break with a nil json body.
 
-
-## 2.1.2 2015-04-29
+## v2.1.2 (2015-04-29)
 
 * EasyPost::Errors now correctly parse field errors and error codes.
 
-
-## 2.1.1 2015-04-15
+## v2.1.1 (2015-04-15)
 
 * CarrierAccount will now correctly save in-place modifications to credentials
 * Nested variables should now be saved correctly across all models
 * Fixed version numbering confusion (the previous version was 2.0.15, not 2.1.0)
 
-
-## 2.0.15 2015-04-15
+## v2.0.15 (2015-04-15)
 
 * Added tracker to shipment buy response
 * Updated tracker tests
 
-
-## 2.0.14 2015-04-15
+## v2.0.14 (2015-04-15)
 
 * Added User and CarrierAccount models with CRUD functionality
 
-
-## 2.0.13 2014-10-30
+## v2.0.13 (2014-10-30)
 
 * Added Pickup, PickupRate resources.
 * Added ability to pass api_key to a few resources that were missing it.
 
-
-## 2.0.12 2014-07-07
+## v2.0.12 (2014-07-07)
 
 * Added Item, Container, and Order resources.
 * Fixed and added a lot of tests.
 
-
-## 2.0.11 2013-12-16
+## v2.0.11 (2013-12-16)
 
 * Added Event.receive method for parsing events sent by webhook.
 * Fixed tests to account for the tracking code returning and array of details instead of a Hash
 
-
-## 2.0.10 2013-10-03
+## v2.0.10 (2013-10-03)
 
 * API Addition: Event resource added for webhook consumption.
 
-
-## 2.0.9 2013-09-19
+## v2.0.9 (2013-09-19)
 
 * Interface Change: Changed batch.scan_form to batch.create_scan_form to support the ability to refer to scan forms associated to batches.
 
-
-## 2.0.3 2013-07-31
+## v2.0.3 (2013-07-31)
 
 * API Addition: Tracker resource added. Trackers can be used to register any tracking code with EasyPost webhooks.
 
-
-## 2.0.2 2013-07-23
+## v2.0.2 (2013-07-23)
 
 * API Addition: Shipment.track_with_code returns tracking details for any tracking code.
 
-
-## 2.0.1 2013-07-07
+## v2.0.1 (2013-07-07)
 
 * API Addition: Address.create_and_verify returns a verified address in one step.
 * API Addition: Shipment.label forces the creation of additional label formats (pdf, epl2, zpl).
 * API Addition: Shipment.insure purchases insurance for a shipment.
 * Library Update: Added the ability to negatively filter carriers and services with Shipment.lowest_rate (e.g. '!usps').
+
+## v2.0.0 (2013-06-25)
+
+## v1.1.3 (2013-06-05)
+
+## v1.1.2 (2013-06-05)
+
+## v1.1.1 (2013-02-12)
+
+## v1.1.0 (2013-01-29)
+
+## v1.0.8 (2012-11-19)
+
+## v1.0.7 (2012-11-19)
+
+## v1.0.6 (2012-11-19)
+
+## v1.0.5 (2012-11-19)
+
+## v1.0.4 (2012-11-14)
+
+## v1.0.3 (2012-11-13)
+
+## v1.0.2 (2012-11-13)
+
+## v1.0.1 (2012-11-13)
+
+## v1.0.0 (2012-11-02)

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -100,14 +100,6 @@ Up-to-date documentation at: https://easypost.com/docs
 ## Development
 
 ```bash
-# Run tests
-API_KEY=123... bundle exec rspec
+# Run tests (coverage is generated on a successful test suite run)
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... bundle exec rspec
 ```
-
-## Releasing
-
-1. Update the version in `VERSION`
-1. Update the `CHANGELOG`
-1. Tag a release on GitHub
-1. Build the Gem `gem build easypost.gemspec`
-1. Publish the Gem `gem push easypost-X.X.X.gem` (replace `X.X.X` with the version being released)

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/UPGRADE_GUIDE.md

@@ -0,0 +1,62 @@
+# Upgrade Guide
+
+Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions.
+
+## Upgrading from 3.x to 4.0
+
+### 4.0 High Impact Changes
+
+* [Updating Dependencies](#40-updating-dependencies)
+
+### 4.0 Medium Impact Changes
+
+* [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method)
+
+### 4.0 Low Impact Changes
+
+* [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects)
+* [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method)
+* [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters)
+* [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror)
+
+## 4.0 Updating Dependencies
+
+Likelihood of Impact: High
+
+**Ruby 2.5 Required**
+
+easypost-ruby now requires Ruby 2.5 or greater.
+
+**Dependencies**
+
+No production dependencies were altered. Development dependencies were all bumped and `simplecov` and `rubocop` were introduced.
+
+## 4.0 Removal of get_rates Shipment Method
+
+Likelihood of Impact: Medium
+
+The HTTP method used for the `get_rates` endpoint at the API level has changed from `POST` to `GET` and will only retrieve rates for a shipment instead of regenerating them. A new `/rerate` endpoint has been introduced to replace this functionality; In this library, you can now call the `Shipment.regenerate_rates` method to regenerate rates. Due to the logic change, the `get_rates` method has been removed since a Shipment inherently already has rates associated.
+
+## 4.0 Removal of Print and PrintJob Objects
+
+Likelihood of Impact: Low
+
+The `Print` and `PrintJob` objects have been removed as they are no longer usable with the current version of the API.
+
+## 4.0 Removal of stamp_and_barcode_by_reference Batch Method
+
+Likelihood of Impact: Low
+
+The `stamp_and_barcode_by_reference` Batch method has been removed as it is no longer usable with the current version of the API.
+
+## 4.0 Removal of Address.verify Parameters
+
+Likelihood of Impact: Low
+
+The parameters for the `Address.verify` method were removed as they were unusable, the current version of the API does not allow you to verify an address by specifying a carrier.
+
+## 4.0 Removal of http_status Property on EasyPost::Error
+
+Likelihood of Impact: Low
+
+The deprecated `http_status` property has been removed in favor of the `status` property on the EasyPost::Error object.

data/VERSION

@@ -1 +1 @@
-3.5.0
+4.0.0

data/bin/easypost-irb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 
-libs =  " -r irb/completion"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/easypost'}"
-puts "Initializing EasyPost..."
+libs = ' -r irb/completion'
+libs << " -r #{"#{File.dirname(__FILE__)}/../lib/easypost"}"
+puts 'Initializing EasyPost...'
 exec "#{irb} #{libs} --simple-prompt"

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