lob 5.1.0 → 6.0.5

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in lob.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    lob (6.0.5)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.16.3)
+    jaro_winkler (1.5.6)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    stringio (3.0.9)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  lob!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.4.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lob
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/MIGRATION.md

@@ -0,0 +1,174 @@
+# Migrate from version < v6.0.0
+
+This guide illustrates differences between Lob’s the legacy versions of this SDK and the new current version.
+
+In this guide we compare how `v5.*.*` and >= `v6.0.0` implement the following method pattern.
+
+- CREATE
+- LIST
+- GET
+- DELETE
+- VERIFY (BANK ACCOUNTS)
+- UPDATE
+
+## INSTALL
+
+Similar to the legacy version, the new lob-ruby SDK is available through `gem`:
+
+```
+$ gem install lob
+```
+
+## IMPORT AND INITIALIZE
+
+
+```ruby
+require 'lob'
+config = Lob::Configuration.default
+config.username = ENV['LOB_API_TEST_KEY']
+```
+You then instantiate the specific resource API that you need access to as follows:
+
+```ruby
+api = Lob::ApiClient.new(config)
+addressApi = AddressesApi.new(@api)
+
+```
+
+## METHODS
+
+The new SDK version abstracts the request/response interaction out of the calling code such that you create the resource and pass it to the corresponding API in a begin/rescue such that any non-success is an `ApiException` that must be handled.
+
+### COMPARE CREATE METHODS
+
+Here is a sample of the legacy lob-ruby CREATE function:
+
+```ruby
+@lob.addresses.create(
+  description: 'Harry - Office',
+  name: 'Harry Zhang',
+  company: 'Lob',
+  email: 'harry@lob.com',
+  phone: '5555555555',
+  address_line1: '210 King St',
+  address_line2: '# 6100',
+  address_city: 'San Francisco',
+  address_state: 'CA',
+  address_country: 'US',
+  address_zip: '94107'
+)
+```
+
+Here is a sample of the updated CREATE method
+
+```ruby
+addressEditable = AddressEditable.new({
+    name: 'Thing T. Thing',
+    address_line1: '1313 CEMETERY LN',
+    address_city: 'WESTFIELD',
+    address_state: 'NJ',
+    address_zip: '07000',
+})
+
+begin
+  response = @addressApi.create(addressEditable)
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```
+
+### COMPARE LIST METHODS
+
+Here is a sample of the legacy lob-ruby LIST method:
+
+```ruby
+@lob.addresses.list(limit: 2)
+```
+
+Here is a sample of the updated LIST method:
+
+```ruby
+begin
+  response = @addressApi.list()
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```
+
+### COMPARE GET BY ID METHOD
+
+Here is a sample of the legacy lob-ruby GET method:
+
+```ruby
+@lob.addresses.find('adr_xxx')
+
+```
+
+Here is a sample of the updated GET method:
+
+```ruby
+begin
+  response = @addressApi.get('adr_xxx')
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```
+
+### COMPARE DELETE METHOD
+
+Here is a sample of the legacy lob-ruby DELETE method:
+
+```ruby
+@lob.addresses.destroy('adr_xxx')
+```
+
+Here is a sample of the updated DELETE method:
+
+```ruby
+begin
+  response = @addressApi.delete('adr_xxx')
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```
+
+### COMPARE BANK ACCOUNT VERIFY
+
+Here is a sample of the legacy lob-ruby BANK ACCOUNT VERIFY method:
+
+```ruby
+@lob.bank_accounts.verify('bank_xxx', amounts: [25, 63])
+```
+
+Here is a sample of the updated BANK ACCOUNT VERIFY method:
+
+```ruby
+bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
+begin
+  response = @bankAccountApi.verify('bank_xxx', bankVerify)
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```
+
+### COMPARE UPDATE METHOD
+
+Here is a sample of the legacy lob-ruby UPDATE method:
+
+```ruby
+This feature was not supported by the legacy library.
+```
+
+Here is a sample of the updated UPDATE method:
+
+```ruby
+updatableTemplate = TemplateUpdate.new({
+    description: 'Updated template for Ruby Integration Test'
+})
+
+begin
+  updatedTemplate = @templateApi.update('tmpl_xxxx', updatableTemplate)
+rescue => e
+  puts 'An error of has occcured, message is #{e.message}'
+end
+```

data/README.md

@@ -1,196 +1,112 @@
-# lob-ruby
+# lob-ruby-sdk
+The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
 
-[![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby)
-[![Gem Version](https://badge.fury.io/rb/lob.svg)](https://badge.fury.io/rb/lob)
-[![Coverage Status](https://coveralls.io/repos/lob/lob-ruby/badge.svg?branch=master)](https://coveralls.io/r/lob/lob-ruby?branch=master)
-[![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/lob?color=green&type=total)](https://rubygems.org/gems/lob)
+This Ruby package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-Ruby wrapper for the [Lob.com](https://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby).  For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
+- API version: 1.3.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://support.lob.com/](https://support.lob.com/)
 
-Supports Ruby 2.0.0 and greater.
+## Requirements
 
-## Table of Contents
-
-- [Getting Started](#getting-started)
-  - [Registration](#registration)
-  - [Installation](#installation)
-  - [Usage](#usage)
-- [Examples](#examples)
-- [API Documentation](#api-documentation)
-- [Contributing](#contributing)
-- [Testing](#testing)
+Ruby
 
 ## Getting Started
 
-Here's a general overview of the Lob services available, click through to read more.
-
-- [Postcards API](https://lob.com/services/postcards)
-- [Letters API](https://lob.com/services/letters)
-- [Checks API](https://lob.com/services/checks)
-- [Address Verification API](https://lob.com/services/verifications)
-
-Please read through the official [API Documentation](#api-documentation) to get a complete sense of what to expect from each endpoint.
-
 ### Registration
 
 First, you will need to first create an account at [Lob.com](https://dashboard.lob.com/#/register) and obtain your Test and Live API Keys.
 
 Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).
 
-### Installation
-
-Add this line to your application's `Gemfile`:
-
-    gem 'lob'
-
-And then execute:
-
-    $ bundle
+### Installation & Usage
 
-Or manually install it yourself:
-
-    $ gem install lob
-
-### Usage
-
-The library uses an ActiveRecord-style interface. You'll feel right at home.
-
-For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
-
-#### Initialization and Configuration
+Install with the appropriate [package manager](https://www.ruby-lang.org/en/documentation/installation/#winget).
 
+Then add Lob's Ruby SDK to your Gemfile
 ```ruby
-# To initialize a Lob object
-lob = Lob::Client.new(api_key: "your-api-key")
-
-# To initialize a Lob object with an older API version
-lob = Lob::Client.new(api_key: "your-api-key", api_version: "2014-12-18")
+gem install 'lob'
 ```
 
-#### Caution: Pass zero-prefixed zip codes as strings
+## First API Call
 
-When using zip codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
-
-The Ruby interpreter interprets a number with a leading zero as an octal (i.e., base-8) number and converts it to a base-10 number.  Thus `01000` is converted to the base-10 value `512` (since `8*8*8=512`).  So not quoting might result in an entirely different zip-code than intended.
+```ruby
+require 'lob'
+
+config = Lob::Configuration.default
+config.username = ENV['LOB_API_TEST_KEY']
+
+apiInstance = Lob::AddressesApi.new
+addressEditable = Lob::AddressEditable.new({
+    description: "Harry - Office",
+    name: "Harry Zhang",
+    company: "Lob",
+    email: "harry@lob.com",
+    phone: "5555555555",
+    address_line1: "210 King St",
+    address_line2: "# 6100",
+    address_city: "San Francisco",
+    address_state: "CA",
+    address_zip: "94107",
+    address_country: "US",
+});
 
-#### Accessing Response Headers
+begin
+  #create
+  result = apiInstance.create(addressEditable)
+  p result
+rescue Lob::ApiError => e
+  puts "Exception when calling AddressesApi->create: #{e}"
+end
+```
 
-You can access response headers via a hidden `headers` method on the response hash.
+## API Documentation
 
-```ruby
-addresses = lob.addresses.list
+The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
 
-addresses._response.headers[:content_type]
-# => "application/json; charset=utf-8"
+## Testing
 
-addresses._response.headers[:rate_limit_window]
-# => "60"
+First, install [RSpec](https://rspec.info/) to run the tests. This can be done by running either of the following lines on your command line depending on whether you use Bundler:
+```shell
+$ bundle add rspec # with Bundler
 
-addresses._response.headers[:rate_limit_remaining]
-# => "1234"
+$ gem install rspec # without Bundler
 ```
 
-You can also access headers from `Lob::InvalidRequestError`s.
+### Unit Tests
 
-```ruby
-begin
-  lob.objects.create(name: "Test", file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/incorrect_size.pdf", bad_param: "bad_value")
-rescue Lob::InvalidRequestError => e
-  e._response.headers[:content_type]
-  # => "application/json; charset=utf-8"
-end
+```bash
+$ rspec -P __tests__/Api/* --color --format doc
 ```
 
-## Examples
-
-We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).
+### Integration Tests
 
-There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files.
+Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.
 
-## API Documentation
+To run integration tests:
 
-- [Introduction](https://lob.com/docs/ruby#introduction)
-- [Versioning](https://lob.com/docs/ruby#version)
-- [Errors](https://lob.com/docs/ruby#errors)
-- [Rate Limiting](https://lob.com/docs/ruby#rate-limits)
-- [Webhooks](https://lob.com/docs/ruby#webhooks)
-- [Cancellation Windows](https://lob.com/docs/ruby#cancellation)
-- [Scheduled Mailings](https://lob.com/docs/ruby#scheduled)
-- [Metadata](https://lob.com/docs/ruby#metadata)
-- [HTML Templates](https://lob.com/docs/ruby#templates)
-- [Asset URLs](https://lob.com/docs/ruby#urls)
-- **Addresses**
-  - [Address Book](https://lob.com/docs/ruby#addresses)
-    - [The Address Object](https://lob.com/docs/ruby#addresses_object)
-    - [Create an Address](https://lob.com/docs/ruby#addresses_create)
-    - [Retrieve an Address](https://lob.com/docs/ruby#addresses_retrieve)
-    - [Delete an Address](https://lob.com/docs/ruby#addresses_delete)
-    - [List all Addresses](https://lob.com/docs/ruby#addresses_list)
-- **US Verification API**
-  - [US Verification API](https://lob.com/docs/ruby#us_verifications)
-    - [The US Verification Object](https://lob.com/docs/ruby#us_verifications_object)
-    - [Verify a US Address](https://lob.com/docs/ruby#us_verifications_create)
-    - [The US Zip Lookup Object](https://lob.com/docs/ruby#us_zip_lookups_object)
-    - [Lookup a US Zip Code](https://lob.com/docs/ruby#us_zip_lookups_create)
-  - [US Autocompletion API](https://lob.com/docs/ruby#us_autocompletions)
-    - [The US Autocompletion Object](https://lob.com/docs/ruby#us_autocompletions_object)
-    - [Autocomplete a US Address](https://lob.com/docs/ruby#us_autocompletions_create)
-    - [The US Autocompletion Test Environment](https://lob.com/docs/ruby#us-autocompletions-test-environment)
-- **Int'l Verification API**
-  - [International Verifications](https://lob.com/docs/ruby#intl_verifications)
-    - [Verify an International Address](https://lob.com/docs/ruby#intl_verifications_create)
-- **Postcards API**
-  - [Postcards](https://lob.com/docs/ruby#postcards)
-    - [The Postcard Object](https://lob.com/docs/ruby#postcards_object)
-    - [Create a Postcard](https://lob.com/docs/ruby#postcards_create)
-    - [Retrieve a Postcard](https://lob.com/docs/ruby#postcards_retrieve)
-    - [Cancel a Postcard](https://lob.com/docs/ruby#postcards_delete)
-    - [List all Postcards](https://lob.com/docs/ruby#postcards_list)
-- **Letters API**
-  - [Letters](https://lob.com/docs/ruby#letters)
-    - [The Letter Object](https://lob.com/docs/ruby#letters_object)
-    - [Create a Letter](https://lob.com/docs/ruby#letters_create)
-    - [Retrieve a Letter](https://lob.com/docs/ruby#letters_retrieve)
-    - [Cancel a Letter](https://lob.com/docs/ruby#letters_delete)
-    - [List all Letters](https://lob.com/docs/ruby#letters_list)
-- **Checks API**
-  - [Checks](https://lob.com/docs/ruby#checks)
-    - [The Check Object](https://lob.com/docs/ruby#checks_object)
-    - [Create a Check](https://lob.com/docs/ruby#checks_create)
-    - [Retrieve a Check](https://lob.com/docs/ruby#checks_retrieve)
-    - [Cancel a Check](https://lob.com/docs/ruby#checks_delete)
-    - [List all Checks](https://lob.com/docs/ruby#checks_list)
-  - [Bank Accounts](https://lob.com/docs/ruby#bank-accounts)
-    - [The Bank Account Object](https://lob.com/docs/ruby#bankaccounts_object)
-    - [Create a Bank Account](https://lob.com/docs/ruby#bankaccounts_create)
-    - [Retrieve a Bank Account](https://lob.com/docs/ruby#bankaccounts_retrieve)
-    - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
-    - [Verify a Bank Account](https://lob.com/docs/ruby#bankaccounts_verify)
-    - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
-- **Appendix**
-  - [API Changelog](https://lob.com/docs/ruby#changelog)
-  - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)
-  - [Events](https://lob.com/docs/ruby#events)
-  - [HTML Examples](https://lob.com/docs/ruby#html-examples)
-  - [Image Prepping](https://lob.com/docs/ruby#prepping)
-  - [US Verification Details](https://lob.com/docs/ruby#us_verification_details)
-
-## Contributing
-
-To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+```bash
+$ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> rspec -P __tests__/Integration/* --color --format doc
+```
 
-## Testing
+#### A cleaner alternative if you are going to run integration tests frequently
 
-Tests are written using MiniTest, a testing library that comes with Ruby stdlib.
+Run this the first time:
 
-Here's how you can run the tests:
+```bash
+$ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env
+```
 
-    bundle exec rake test
+Then, to run the integration tests:
 
-You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
+```bash
+$ env $(cat LOCAL.env) rspec -P __tests__/Integration/* --color --format doc
+```
 
 =======================
 
-Copyright &copy; 2016 Lob.com
+Copyright © 2022 Lob.com
+
+Released under the MIT License, which can be found in the repository in [LICENSE.txt](https://github.com/lob/lob-go/blob/main/LICENSE.txt).
 
-Released under the MIT License, which can be found in the repository in `LICENSE.txt`.

data/Rakefile

@@ -1,8 +1,10 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.libs.push "lib", "spec"
-  t.test_files = FileList['spec/**/*_spec.rb']
-  t.verbose = true
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
 end