easypost 3.5.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c893399d43b9432c0b6812c5649ab48ad2ad1c04b6373e7999cc8c1fdf22d82b
-  data.tar.gz: f98230c21010af6117011b0ddee1a1bda574a821fc5ae470a85e4961e72954ef
+  metadata.gz: 043543a947c3d50354a25d984eded8e68e37d9af9d7e2c6158176201426cafa1
+  data.tar.gz: 15ebc3486ec63ac23b0dfa6de82001537a72697863e1587fd9a1d909cde33a9a
 SHA512:
-  metadata.gz: 1822930673f844b99cc6f53ea4c5564b54342590383433ee359f4c3420d56ddbd3cc166d4d2e1975b52a848c95d6854b1b0e79245e3a9b9660ee309a795f5b99
-  data.tar.gz: b7fa805a9b6cc8a65b3076828f9bd5740709475b4d63824d34dc4981c9ea779af1c9eff273d546e59c7e79d0b7002f9dbbd3353d5faad2911e6615495cbec6cc
+  metadata.gz: 8a004acaa7797b54fd7226e4321a47e9aaa11aa055ee39dd886456d547f3e9ec847046c77f2f548a3f510c9d992842c4896fcb5beb6ee060280098e87ee2ae40
+  data.tar.gz: 7b4f5377749b4d65278f744befef446cfcfe7372f171e64a6b42996b9c0c988b0a6370f949d2986698fc5484f66d4bc3cb879b0f714b04a25e9216c196d960ee

data/.gitattributes

@@ -0,0 +1,9 @@
+* text=auto
+
+# Cassettes
+spec/cassettes/**/* -diff
+spec/cassettes/**/* linguist-generated
+
+# Docs
+docs/**/* -diff
+docs/**/* linguist-generated

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Ping the DevEx team for reviews on every PR
+* @EasyPost/devex

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

@@ -2,21 +2,70 @@ name: 'CI'
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request: ~
+  workflow_dispatch: ~
 
 jobs:
   run-tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2']
     steps:
-      - uses: actions/checkout@v2
-      - name: set up ruby
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
+          rubygems: '3.0.0'
           bundler-cache: true
+      - name: Install Dependencies
+        run: make install
       - name: run tests
-        run: bundle exec rspec
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test
+      - name: Coveralls
+        if: github.ref == 'refs/heads/master'
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: './coverage/lcov/easypost-ruby.lcov'
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: make install
+      - name: Install style guides
+        run: make install-styleguide
+      - name: Lint Project
+        run: make lint
+  docs:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: make install
+      - name: Generate Docs
+        run: make docs
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

data/.gitignore

@@ -1,9 +1,20 @@
-*.gem
-*.rbc
+._*
+.AppleDouble
 .bundle
 .config
-Gemfile.lock
+.DS_Store
+.env
+.idea/
+.LSOverride
+.Spotlight-V100
+.Trashes
+*.gem
+*.rbc
 coverage
+dist
+docs
+Gemfile.lock
+Icon
 InstalledFiles
 lib/bundler/man
 pkg
@@ -12,18 +23,17 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-
-# iOS
-.DS_Store
-.AppleDouble
-.LSOverride
-Icon
-._*
-.Spotlight-V100
-.Trashes
 vendor/
+/easycop.yml
+/.rubocop.yml
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+Session.vim
+Sessionx.vim
+.netrwhist
+*~
+tags
+[._]*.un~

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "examples"]
+	path = examples
+	url = https://github.com/EasyPost/examples