easypost 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b2de1c12852ffd59083d6ee132f2071577e7ff774f77cb515b444f75eaf86fc
-  data.tar.gz: 98b1d4bce4a86d9cdf3480f91e818dc362af2963e38f9bccb434b557aebf6bcc
+  metadata.gz: 18f330382213345312caf4cb5981ad506f3d882aaf2f78f556598d5201e28d94
+  data.tar.gz: 4a750f473664d70f8d72f252a875e4eab75d256ffe0925fc5027915ecfc4cd3e
 SHA512:
-  metadata.gz: 97fceef78d0d5706cd0ddb553f6da95ad5a27fe2491069f2eb416dafcb296a158d6e03bab6232ef0efe63f7503a256830635847288e99f17129920adade55eae
-  data.tar.gz: 2d3a0058d85435a3b743ef9f1b3f21e42bd77bf5cf830f5522794369f27315a9ca673f65fb9f3900df718668d2207ed63c295b7f36f415979cd53dae8cfe0110
+  metadata.gz: 96e3c87b8ff96f797ca25e42e2dc61ce8c814826fca95b7f80506aa96624a5df58fe0f762fb87eab71f0e89422996d31d88f153b434c11268b220893731438a1
+  data.tar.gz: 2ea7ea89d3cedea7222de7cbe41af96ef0b912b23e0409cfa2ffc5576915553ed578f7dfb315d0870bf5e6391ed5a7eff396eed7972db4e814223faa3152bc56

data/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,81 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: [ "triage" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to report an issue in this repository. Please fill out the form below.
+  - type: input
+    id: software-version
+    attributes:
+      label: Software Version
+      # change this description for the specific repo
+      description: |
+        What version of our software are you running?
+        TIP: [Available versions](https://github.com/EasyPost/easypost-ruby/releases)
+    validations:
+      required: true
+  - type: input
+    id: language-version
+    attributes:
+      label: Language Version
+      # change this description for the specific language of the repo
+      description: |
+        What language version and/or framework are you using?
+        TIP: [How to find your Ruby version](https://blog.arkency.com/which-ruby-version-am-i-using-how-to-check/)
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you running the software on?
+    validations:
+      required: true
+  - type: textarea
+    id: behavior
+    attributes:
+      label: What happened?
+      description: |
+        Please describe what happened in reproducible steps.
+        Include how often you see this issue, and any relevant links (i.e. GitHub issue, Stack Overflow, etc.).
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: What was expected?
+      description: Please describe what was expected to happen instead.
+    validations:
+      required: true
+  - type: textarea
+    id: sample-code
+    attributes:
+      label: Sample Code
+      description: |
+        Please provide any sample code that demonstrates the behavior.
+        This will be automatically formatted into the appropriate language, so no need for backticks.
+        **Do not include any private information such as API keys or passwords.**
+      # change this render to the appropriate language: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
+      render: rb
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant logs
+      description: |
+        Please copy and paste any relevant log output.
+        This will be automatically formatted into shell output, so no need for backticks.
+        If you have screenshots instead, please paste them below.
+        **Do not include any private information such as API keys or passwords.**
+      render: sh
+    validations:
+      required: false

data/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,37 @@
+name: Feature Request
+description: Request a new feature
+title: "[Feat]: "
+labels: [ "triage" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to request a new feature.
+        Please note, all feature requests are subject to review and approval.
+        We welcome all suggestions and ideas, but we cannot guarantee when or if we will implement them.
+        
+        We also welcome pull requests, if you would like to implement the feature yourself.
+        Doing so will likely accelerate the process of implementing the requested feature.
+  - type: checkboxes
+    id: searched
+    attributes:
+      label: Feature Request Is New
+      # change issue link below for the specific repo
+      description: |
+        Before we begin, please confirm that the requested feature does not already exist or has not [already been requested](https://github.com/EasyPost/easypost-ruby/issues).
+      options:
+        - label: I have verified that the requested feature does not already exist or has not already been requested.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of the feature
+      description: |
+        Please provide a detailed description of the feature, including:
+        - What the feature is
+        - What value it adds to the application
+        - How it should be implemented (i.e. pseudo-code, or a high-level description of the user experience)
+        - Any other relevant information
+    validations:
+      required: true
+

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+# Description
+
+<!-- Please provide a general summary of your PR changes and link any related issues or other pull requests. -->
+
+# Testing
+
+<!-- 
+Please provide details on how you tested this code. See below.
+
+- All pull requests must be tested (unit tests where possible with accompanying cassettes, or provide a screenshot of end-to-end testing when unit tests are not possible)
+- New features must get a new unit test
+- Bug fixes/refactors must re-record existing cassettes 
+-->
+
+# Pull Request Type
+
+Please select the option(s) that are relevant to this PR.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Improvement (fixing a typo, updating readme, renaming a variable name, etc)

data/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
         rubyversion: ["2.5", "2.6", "2.7", "3.0", "3.1"]
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -25,11 +25,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.0"
+          ruby-version: "3.1"
       - name: Install Dependencies
         run: bundle install
       - name: Lint Project

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v4.2.0 (2022-05-09)
+
+- Adds a `lowest_rate()` function to Orders and Pickups
+- Adds a `Shipment.get_lowest_smartrate()` function and a `shipment.lowest_smartrate()` function
+- Removes the unusable `carrier` param from `Address.create_and_verify` along with the dead `message` conditional check
+- Add beta Referral class for White Label API with these new functions: `create()`, `update_email()`, `all()`, and `add_credit_card()`
+
 ## v4.1.2 (2022-03-16)
 
 - Rolls back the original connection behavior of establishing a new connection for every request (restores previous expectations for multithreaded implementations)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,16 @@
+# Code of Conduct
+
+> Remember the golden rule? Treat others as you'd like to be treated
+
+## Standards
+
+- Create a welcoming and safe community for `everyone`
+- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
+- Be respectful of others opinions, viewpoints, and experiences
+- Give and receive respectful constructive feedback
+- Accept responsibility and apologize when necessary
+- Focus on what is best for the overall community
+
+## Failure to Follow Standards
+
+If there is a failure to follow the standards laid out above, the user will first be warned. If the offending behavior continues, the user may be blocked entirely.

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing Guide
+
+Please read this document in its entirety.
+
+## General
+
+- Be nice and respectful of maintainers’ and contributors’ time and viewpoints
+- Be as descriptive as possible! More info is always better than not enough
+- Be patient, there may be a lot of in-flight work, some of it across multiple projects not related to the repo being contributed to
+- Have fun!
+
+## Contributing
+
+Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following:
+
+- Add new features
+- Fix bugs
+- Fix typos
+- Improve docs
+- Improve tests
+- Triage issues
+- Review pull requests
+- Share opinions and viewpoints on issues
+
+## Issues
+
+- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md)
+- Before opening a new issue, check for existing issues that are related, including closed ones
+- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior
+- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out)
+
+## Pull Requests
+
+- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed
+- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain
+- Pull Requests should be as small as possible
+- Don't make unrelated changes in your Pull Request
+- Don't open a Pull Request if you don't plan to see it through. PRs submitted by individuals that cannot complete additional work to get a PR merged may be closed without completion
+- Adhere to the existing code style of the repo, even if it differs from your personal preference
+- When applicable, add tests that provide ample coverage of the logic added or changed
+- Pull Requests should come from branches and never the default `master` branch
+- Pull Requests must pass CI, including linting and testing
+- Pull Requests must go through code review before they can be merged to the main branch
+- Do not include "version bump" changes in the same PR as your code changes; these will be handled as a separate PR and releasing process
+- Make sure the `Allow edits from maintainers` checkbox is checked. That way EasyPost engineers can make certain minor changes as needed, allowing your pull request to be merged sooner.
+
+You agree and acknowledge that you have necessary intellectual property rights to provide your Contribution and hereby assign to EasyPost all right, title and interest in such Contribution.

data/README.md

@@ -3,112 +3,65 @@
 [![Build Status](https://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
 [![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
+EasyPost, the simple shipping solution. You can sign up for an account at https://easypost.com.
 
-EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com.
-
-## Installation
-
-Install the gem:
+## Install
 
 ```bash
 gem install easypost
 ```
 
-Import the EasyPost client in your application:
-
 ```ruby
+# Require the library in your project:
 require 'easypost'
 ```
 
-## Example
+## Usage
+
+A simple create & buy shipment example:
 
 ```ruby
 require 'easypost'
-EasyPost.api_key = 'API_KEY'
-
-to_address = EasyPost::Address.create(
-  :name => 'Dr. Steve Brule',
-  :street1 => '179 N Harbor Dr',
-  :city => 'Redondo Beach',
-  :state => 'CA',
-  :zip => '90277',
-  :country => 'US',
-  :phone => '310-808-5243'
-)
 
-from_address = EasyPost::Address.create(
-  :company => 'EasyPost',
-  :street1 => '118 2nd Street',
-  :street2 => '4th Floor',
-  :city => 'San Francisco',
-  :state => 'CA',
-  :zip => '94105',
-  :phone => '415-456-7890'
-)
-
-parcel = EasyPost::Parcel.create(
-  :width => 15.2,
-  :length => 18,
-  :height => 9.5,
-  :weight => 35.1
-)
-
-customs_item = EasyPost::CustomsItem.create(
-  :description => 'EasyPost T-shirts',
-  :quantity => 2,
-  :value => 23.56,
-  :weight => 33,
-  :origin_country => 'us',
-  :hs_tariff_number => 123456
-)
-
-customs_info = EasyPost::CustomsInfo.create(
-  :integrated_form_type => 'form_2976',
-  :customs_certify => true,
-  :customs_signer => 'Dr. Pepper',
-  :contents_type => 'gift',
-  :contents_explanation => '', # only required when contents_type => 'other'
-  :eel_pfc => 'NOEEI 30.37(a)',
-  :non_delivery_option => 'abandon',
-  :restriction_type => 'none',
-  :restriction_comments => '',
-  :customs_items => [customs_item]
-)
+EasyPost.api_key = ENV['EASYPOST_API_KEY']
 
 shipment = EasyPost::Shipment.create(
-  :to_address => to_address,
-  :from_address => from_address,
-  :parcel => parcel,
-  :customs_info => customs_info
-)
-
-shipment.buy(
-  :rate => shipment.lowest_rate
+  from_address: {
+    company: 'EasyPost',
+    street1: '118 2nd Street',
+    street2: '4th Floor',
+    city: 'San Francisco',
+    state: 'CA',
+    zip: '94105',
+    phone: '415-456-7890',
+  },
+  to_address: {
+    name: 'Dr. Steve Brule',
+    street1: '179 N Harbor Dr',
+    city: 'Redondo Beach',
+    state: 'CA',
+    zip: '90277',
+    country: 'US',
+    phone: '310-808-5243',
+  },
+  parcel: {
+    width: 15.2,
+    length: 18,
+    height: 9.5,
+    weight: 35.1,
+  },
 )
 
-shipment.insure(amount: 100)
+shipment.buy(rate: shipment.lowest_rate)
 
-puts shipment.insurance
-
-puts shipment.postage_label.label_url
+puts shipment
 ```
 
-## Documentation
-
-Up-to-date documentation at: https://easypost.com/docs
-
-## Development
-
-```bash
-# Run tests (coverage is generated on a successful test suite run)
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... bundle exec rspec
-```
-
-## Custom connections
+### Custom Connections
 
 Set `EasyPost.default_connection` to an object that responds to `call(method, path, api_key = nil, body = nil)`
 
-### Faraday
+#### Faraday
 
 ```ruby
 require 'faraday'
@@ -134,7 +87,7 @@ EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil
 end
 ```
 
-### Typhoeus
+#### Typhoeus
 
 ```ruby
 require 'typhoeus'
@@ -154,3 +107,27 @@ EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil
   }
 end
 ```
+
+## Documentation
+
+API Documentation can be found at: https://easypost.com/docs/api.
+
+## Development
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests (coverage is generated on a successful test suite run)
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... bundle exec rspec
+```
+
+### Testing
+
+The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run.
+
+If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
+
+The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user **with the exception of the USPS carrier account ID** which has a fallback value to our internal testing user's ID. If you are a non-EasyPost employee and are re-recording cassettes, you may need to provide the `USPS_CARRIER_ACCOUNT_ID` environment variable with the ID associated with your USPS account (which will be associated with your API keys in use) for tests that use this fixture.
+
+**Note on dates:** Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).

data/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Guide
+
+We take security seriously at EasyPost. If you find a security issue or vulnerability in our open source projects, please abide by the following guidelines:
+
+- Please read our [Responsible Disclosure Policy](https://www.easypost.com/privacy#disclosure-policy).
+- Do not open an issue on GitHub about the security vulnerability. Doing so draws attention to the issue and exposes it to the public.
+- Send an email to `security-abuse@easypost.com` including as many details as possible.

data/SUPPORT.md

@@ -0,0 +1,3 @@
+# Support Guide
+
+Looking for support for one of our projects? If your question is related to our API, please contact our support team at `support@easypost.com`. If you need support regarding this project, create an issue on GitHub with as many details as possible and we’ll take a look.

data/VERSION

@@ -1 +1 @@
-4.1.2
+4.2.0

data/easycop.yml

@@ -41,7 +41,7 @@ Layout/FirstMethodArgumentLineBreak:
   Enabled: true
 Layout/LineLength:
   Max: 120
-  IgnoredPatterns:
+  IgnoredPatterns: # deprecated in 1.28
     - "(\\A|\\s)#"
 Layout/LineEndStringConcatenationIndentation: # new in 1.18
   Enabled: true

data/easypost.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   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', '= 1.27' # rubocop 1.28 requires Ruby 2.6+
   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 'vcr', '= 6.0' # VCR 6.1 requires Ruby 2.6+
   spec.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/easypost/address.rb

@@ -6,40 +6,30 @@ class EasyPost::Address < EasyPost::Resource
 
   # Create an Address.
   def self.create(params = {}, api_key = nil)
-    url = self.url
-
     address = params.reject { |k, _| [:verify, :verify_strict].include?(k) }
 
-    if params[:verify] || params[:verify_strict]
-      verify = params[:verify] || []
-      verify_strict = params[:verify_strict] || []
-
-      url += '?'
-      verify.each do |verification|
-        url += "verify[]=#{verification}&"
-      end
-      verify_strict.each do |verification|
-        url += "verify_strict[]=#{verification}&"
-      end
+    wrapped_params = { address: address }
+
+    if params[:verify]
+      wrapped_params[:verify] = params[:verify]
+    end
+
+    if params[:verify_strict]
+      wrapped_params[:verify_strict] = params[:verify_strict]
     end
 
-    response = EasyPost.make_request(:post, url, api_key, { address: address })
+    response = EasyPost.make_request(:post, url, api_key, wrapped_params)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
   # Create and verify an Address in one call.
-  def self.create_and_verify(params = {}, carrier = nil, api_key = nil)
+  def self.create_and_verify(params = {}, api_key = nil)
     wrapped_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)
 
     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
 

data/lib/easypost/beta/beta.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'easypost/beta/beta_referral'
+
+module EasyPost::Beta
+end

data/lib/easypost/beta/beta_referral.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+class EasyPost::BetaReferral < EasyPost::Resource
+  # 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, '/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.
+  def self.update_email(email, user_id, api_key = nil)
+    wrapped_params = {
+      user: {
+        email: email,
+      },
+    }
+    _ = EasyPost.make_request(:put, "/beta/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, '/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.
+  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
+
+  # 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/order.rb

@@ -29,4 +29,9 @@ class EasyPost::Order < EasyPost::Resource
   def self.all
     raise NotImplementedError.new('Order.all not implemented.')
   end
+
+  # Get the lowest rate of an Order (can exclude by having `'!'` as the first element of your optional filter lists).
+  def lowest_rate(carriers = [], services = [])
+    EasyPost::Util.get_lowest_object_rate(self, carriers, services)
+  end
 end

data/lib/easypost/pickup.rb

@@ -29,4 +29,9 @@ class EasyPost::Pickup < EasyPost::Resource
   def self.all
     raise NotImplementedError.new('Pickup.all not implemented.')
   end
+
+  # Get the lowest rate of a Pickup (can exclude by having `'!'` as the first element of your optional filter lists).
+  def lowest_rate(carriers = [], services = [])
+    EasyPost::Util.get_lowest_object_rate(self, carriers, services, 'pickup_rates')
+  end
 end

data/lib/easypost/report.rb

@@ -5,6 +5,7 @@ class EasyPost::Report < EasyPost::Resource
   # Create a Report.
   def self.create(params = {}, api_key = nil)
     url = "#{self.url}/#{params[:type]}"
+
     wrapped_params = {}
     wrapped_params[class_name.to_sym] = params
 

data/lib/easypost/shipment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 # The workhorse of the EasyPost API, a Shipment is made up of a "to" and "from" Address, the Parcel
 # being shipped, and any customs forms required for international deliveries.
 class EasyPost::Shipment < EasyPost::Resource
@@ -68,58 +70,46 @@ class EasyPost::Shipment < EasyPost::Resource
     self
   end
 
-  # Get the lowest rate of a Shipment.
+  # Get the lowest rate of a Shipment (can exclude by having `'!'` as the first element of your optional filter lists).
   def lowest_rate(carriers = [], services = [])
-    lowest = nil
-
-    get_rates unless rates
+    EasyPost::Util.get_lowest_object_rate(self, carriers, services)
+  end
 
-    carriers = EasyPost::Util.normalize_string_list(carriers)
+  # Get the lowest smartrate of a Shipment.
+  def lowest_smartrate(delivery_days, delivery_accuracy)
+    smartrates = get_smartrates
+    EasyPost::Shipment.get_lowest_smartrate(smartrates, delivery_days, delivery_accuracy)
+  end
 
-    negative_carriers = []
-    carriers_copy = carriers.clone
-    carriers_copy.each do |carrier|
-      if carrier[0, 1] == '!'
-        negative_carriers << carrier[1..-1]
-        carriers.delete(carrier)
-      end
+  # Get the lowest smartrate from a list of smartrates.
+  def self.get_lowest_smartrate(smartrates, delivery_days, delivery_accuracy)
+    valid_delivery_accuracy_values = Set[
+      'percentile_50',
+      'percentile_75',
+      'percentile_85',
+      'percentile_90',
+      'percentile_95',
+      'percentile_97',
+      'percentile_99',
+    ]
+    lowest_smartrate = nil
+
+    unless valid_delivery_accuracy_values.include?(delivery_accuracy.downcase)
+      raise EasyPost::Error.new("Invalid delivery accuracy value, must be one of: #{valid_delivery_accuracy_values}")
     end
 
-    services = EasyPost::Util.normalize_string_list(services)
+    smartrates.each do |rate|
+      next if rate['time_in_transit'][delivery_accuracy] > delivery_days.to_i
 
-    negative_services = []
-    services_copy = services.clone
-    services_copy.each do |service|
-      if service[0, 1] == '!'
-        negative_services << service[1..-1]
-        services.delete(service)
+      if lowest_smartrate.nil? || rate['rate'].to_f < lowest_smartrate['rate'].to_f
+        lowest_smartrate = rate
       end
     end
 
-    rates.each do |k|
-      rate_carrier = k.carrier.downcase
-      if carriers.size.positive? && !carriers.include?(rate_carrier)
-        next
-      end
-      if negative_carriers.size.positive? && negative_carriers.include?(rate_carrier)
-        next
-      end
-
-      rate_service = k.service.downcase
-      if services.size.positive? && !services.include?(rate_service)
-        next
-      end
-      if negative_services.size.positive? && negative_services.include?(rate_service)
-        next
-      end
-
-      if lowest.nil? || k.rate.to_f < lowest.rate.to_f
-        lowest = k
-      end
+    if lowest_smartrate.nil?
+      raise EasyPost::Error.new('No rates found.')
     end
 
-    raise EasyPost::Error.new('No rates found.') if lowest.nil?
-
-    lowest
+    lowest_smartrate
   end
 end

data/lib/easypost/util.rb

@@ -2,6 +2,35 @@
 
 # Internal utilities helpful for this libraries operation.
 module EasyPost::Util
+  # 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 {}
+    keys = parent_keys or []
+
+    hash.each do |key, value|
+      if value.instance_of?(Hash)
+        keys << key
+        result = form_encode_params(value, keys, result)
+      else
+        dict_key = build_dict_key(keys + [key])
+        result[dict_key] = value
+      end
+    end
+    result
+  end
+
+  # Build a dict key from a list of keys.
+  # Example: [code, number] -> code[number]
+  def self.build_dict_key(keys)
+    result = keys[0].to_s
+
+    keys[1..-1].each do |key|
+      result += "[#{key}]"
+    end
+
+    result
+  end
+
   # Converts an object to an object ID.
   def self.objects_to_ids(obj)
     case obj
@@ -110,4 +139,56 @@ module EasyPost::Util
       response
     end
   end
+
+  # Gets the lowest rate of an EasyPost object such as a Shipment, Order, or Pickup.
+  # You can exclude by having `'!'` as the first element of your optional filter lists
+  def self.get_lowest_object_rate(easypost_object, carriers = [], services = [], rates_key = 'rates')
+    lowest_rate = nil
+
+    carriers = EasyPost::Util.normalize_string_list(carriers)
+    negative_carriers = []
+    carriers_copy = carriers.clone
+    carriers_copy.each do |carrier|
+      if carrier[0, 1] == '!'
+        negative_carriers << carrier[1..-1]
+        carriers.delete(carrier)
+      end
+    end
+
+    services = EasyPost::Util.normalize_string_list(services)
+    negative_services = []
+    services_copy = services.clone
+    services_copy.each do |service|
+      if service[0, 1] == '!'
+        negative_services << service[1..-1]
+        services.delete(service)
+      end
+    end
+
+    easypost_object[rates_key].each do |rate|
+      rate_carrier = rate.carrier.downcase
+      if carriers.size.positive? && !carriers.include?(rate_carrier)
+        next
+      end
+      if negative_carriers.size.positive? && negative_carriers.include?(rate_carrier)
+        next
+      end
+
+      rate_service = rate.service.downcase
+      if services.size.positive? && !services.include?(rate_service)
+        next
+      end
+      if negative_services.size.positive? && negative_services.include?(rate_service)
+        next
+      end
+
+      if lowest_rate.nil? || rate.rate.to_f < lowest_rate.rate.to_f
+        lowest_rate = rate
+      end
+    end
+
+    raise EasyPost::Error.new('No rates found.') if lowest_rate.nil?
+
+    lowest_rate
+  end
 end

data/lib/easypost.rb

@@ -36,6 +36,7 @@ require 'easypost/tax_identifier'
 require 'easypost/tracker'
 require 'easypost/user'
 require 'easypost/webhook'
+require 'easypost/beta/beta'
 
 module EasyPost
   DEFAULT_API_BASE = 'https://api.easypost.com'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.27'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         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
@@ -143,14 +143,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.yml"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
+- SUPPORT.md
 - UPGRADE_GUIDE.md
 - VERSION
 - bin/easypost-irb
@@ -160,6 +167,8 @@ files:
 - lib/easypost/address.rb
 - lib/easypost/api_key.rb
 - lib/easypost/batch.rb
+- lib/easypost/beta/beta.rb
+- lib/easypost/beta/beta_referral.rb
 - lib/easypost/brand.rb
 - lib/easypost/carrier_account.rb
 - lib/easypost/carrier_type.rb
@@ -206,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library