lob 6.0.0.pre.rc → 6.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lob (6.0.0.pre.rc)
+    lob (6.0.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -17,15 +17,15 @@ GEM
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    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.0.1)
+    psych (5.0.2)
       stringio
     rainbow (3.1.1)
     rake (13.0.6)
@@ -35,10 +35,10 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -67,4 +67,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.3.26
+   2.4.4

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

@@ -26,38 +26,19 @@ Install with the appropriate [package manager](https://www.ruby-lang.org/en/docu
 
 Then add Lob's Ruby SDK to your Gemfile
 ```ruby
-gem 'openapi_client'
-```
-
-If you're using [Bundler](https://bundler.io/) to manage your dependencies, then you can install our SDK by running this on the command line
-```shell
-$ bundle add openapi_client
-```
-
-If you're not using Bundler, then you can install our SDK by running the following instead
-```shell
-$ gem install openapi_client
-```
-
-And finally import the package in your `.rb` file
-```ruby
-require 'openapi_client'
+gem install 'lob'
 ```
 
 ## First API Call
 
 ```ruby
-# Load the gem
-require 'openapi_client'
+require 'lob'
 
-# Setup authorization
-OpenapiClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = '<YOUR_LOB_API_KEY>'
-end
+config = Lob::Configuration.default
+config.username = ENV['LOB_API_TEST_KEY']
 
-apiInstance = OpenapiClient::AddressesApi.new
-addressEditable = OpenapiClient::AddressEditable.new({
+apiInstance = Lob::AddressesApi.new
+addressEditable = Lob::AddressEditable.new({
     description: "Harry - Office",
     name: "Harry Zhang",
     company: "Lob",
@@ -75,7 +56,7 @@ begin
   #create
   result = apiInstance.create(addressEditable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Exception when calling AddressesApi->create: #{e}"
 end
 ```
@@ -123,14 +104,9 @@ Then, to run the integration tests:
 $ env $(cat LOCAL.env) rspec -P __tests__/Integration/* --color --format doc
 ```
 
-## Documentation For Authorization
-
-
-## basicAuth
-
-- **Type**: HTTP basic authentication
+=======================
 
+Copyright © 2022 Lob.com
 
-## Author
+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).
 
-lob-openapi@lob.com

data/__tests__/Api/Address.unit.rb

@@ -1,6 +1,6 @@
 # Address.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'api/addresses_api'
 require 'models/address'

data/__tests__/Api/BankAccount.unit.rb

@@ -1,6 +1,6 @@
 # BankAccount.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'api/bank_accounts_api'
 require 'models/bank_account'

data/__tests__/Api/BillingGroup.unit.rb

@@ -1,6 +1,6 @@
 # BillingGroup.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'api/billing_groups_api'
 require 'models/billing_group'

data/__tests__/Api/Card.unit.rb

@@ -1,6 +1,6 @@
 # Card.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "CardsApi" do

data/__tests__/Api/CardOrder.unit.rb

@@ -1,6 +1,6 @@
 # CardOrder.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "CardOrdersApi" do

data/__tests__/Api/Check.unit.rb

@@ -1,6 +1,6 @@
 # Check.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "ChecksApi" do

data/__tests__/Api/IntlAutocompletion.unit.rb

@@ -1,6 +1,6 @@
 # IntlAutcompletion.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "IntlAutocompletionsApi" do

data/__tests__/Api/IntlVerification.unit.rb

@@ -1,6 +1,6 @@
 # IntlVerification.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "IntlVerificationsApi" do

data/__tests__/Api/Letter.unit.rb

@@ -1,6 +1,6 @@
 # Letter.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "LettersApi" do

data/__tests__/Api/Postcard.unit.rb

@@ -1,6 +1,6 @@
 # Postcard.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "PostcardsApi" do

data/__tests__/Api/ReverseGeocodeLookup.unit.rb

@@ -1,6 +1,6 @@
 # ReverseGeocodeLookup.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "ReverseGeocodeLookupsApi" do

data/__tests__/Api/SelfMailer.unit.rb

@@ -1,6 +1,6 @@
 # SelfMailer.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "SelfMailersApi" do

data/__tests__/Api/Template.unit.rb

@@ -1,6 +1,6 @@
 # Template.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "TemplatesApi" do

data/__tests__/Api/TemplateVersion.unit.rb

@@ -1,6 +1,6 @@
 # TemplateVersion.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "TemplateVersionsApi" do

data/__tests__/Api/UsAutocompletion.unit.rb

@@ -6,17 +6,17 @@ RSpec.describe "UsAutocompletionsApi" do
 
     it "can be instantiated" do
         usAutocompletionApiMock = double("ApiClient")
-        usAutocompletionApi = OpenapiClient::UsAutocompletionsApi.new(usAutocompletionApiMock)
+        usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
 
         expect(usAutocompletionApi).not_to be_nil
-        expect(usAutocompletionApi).to be_a_kind_of(OpenapiClient::UsAutocompletionsApi)
+        expect(usAutocompletionApi).to be_a_kind_of(Lob::UsAutocompletionsApi)
     end
 
     describe "Autocomplete" do
         it "handles errors returned by the api" do
             usAutocompletionApiMock = double("ApiClient")
-            usAutocompletionApi = OpenapiClient::UsAutocompletionsApi.new(usAutocompletionApiMock)
-            usAutocompletionsWritable = OpenapiClient::UsAutocompletionsWritable.new
+            usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
+            usAutocompletionsWritable = Lob::UsAutocompletionsWritable.new
 
             allow(usAutocompletionApi).to receive(:autocomplete).and_raise("exception thrown in autocomplete test")
             begin
@@ -28,10 +28,10 @@ RSpec.describe "UsAutocompletionsApi" do
 
         it "autocomplete an address" do
             usAutocompletionApiMock = double("ApiClient")
-            usAutocompletionApi = OpenapiClient::UsAutocompletionsApi.new(usAutocompletionApiMock)
-            usAutocompletionsWritable = OpenapiClient::UsAutocompletionsWritable.new
-            usAutocompletions = OpenapiClient::UsAutocompletions.new
-            usAutocompletions.suggestions = Array.new(1, OpenapiClient::Suggestions.new)
+            usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
+            usAutocompletionsWritable = Lob::UsAutocompletionsWritable.new
+            usAutocompletions = Lob::UsAutocompletions.new
+            usAutocompletions.suggestions = Array.new(1, Lob::Suggestions.new)
 
             allow(usAutocompletionApi).to receive(:autocomplete) { usAutocompletions }
             response = usAutocompletionApi.autocomplete(usAutocompletionsWritable)

data/__tests__/Api/UsVerification.unit.rb

@@ -1,6 +1,6 @@
 # UsVerification.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "UsVerificationsApi" do

data/__tests__/Api/ZipLookup.unit.rb

@@ -1,6 +1,6 @@
 # ZipLookup.unit.rb
 
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "ZipLookupsApi" do

data/__tests__/Integration/Address.spec.rb

@@ -1,6 +1,6 @@
 # Address.unit.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'api/addresses_api'
 require 'models/address'
@@ -49,9 +49,9 @@ RSpec.describe "AddressesApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             addressApi = AddressesApi.new(badapi)
             addressEditable = AddressEditable.new({

data/__tests__/Integration/BankAccount.spec.rb

@@ -1,6 +1,6 @@
 # BankAccount.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -43,9 +43,9 @@ RSpec.describe "BankAccountsApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             bankAccountApi = BankAccountsApi.new(badapi)
 

data/__tests__/Integration/BillingGroup.spec.rb

@@ -1,6 +1,6 @@
 # BillingGroup.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -37,9 +37,9 @@ RSpec.describe "BillingGroupsApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             billingGroupApi = BillingGroupsApi.new(badapi)
 

data/__tests__/Integration/Card.spec.rb

@@ -1,6 +1,6 @@
 # Card.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -42,9 +42,9 @@ RSpec.describe "CardsApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             cardApi = CardsApi.new(badapi)
 

data/__tests__/Integration/CardOrder.spec.rb

@@ -1,6 +1,6 @@
 # CardOrder.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -47,9 +47,9 @@ RSpec.describe "CardOrdersApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             cardOrderApi = CardOrdersApi.new(badapi)
 

data/__tests__/Integration/Check.spec.rb

@@ -1,6 +1,6 @@
 # Check.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -77,9 +77,9 @@ RSpec.describe "ChecksApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             checkApi = ChecksApi.new(badapi)
 

data/__tests__/Integration/IntlAutocompletion.spec.rb

@@ -1,6 +1,6 @@
 # IntlAutocompletion.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "IntlAutocompletionsApi" do
@@ -38,9 +38,9 @@ RSpec.describe "IntlAutocompletionsApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             intlAutocompletionApi = IntlAutocompletionsApi.new(badapi)
 

data/__tests__/Integration/IntlVerification.spec.rb

@@ -1,6 +1,6 @@
 # IntlVerification.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 
 RSpec.describe "IntlVerificationsApi" do
@@ -74,9 +74,9 @@ RSpec.describe "IntlVerificationsApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             intlVerificationApi = IntlVerificationsApi.new(badapi)
 

data/__tests__/Integration/Letter.spec.rb

@@ -1,6 +1,6 @@
 # Letter.spec.rb
 require_relative '../TestFixtures'
-include OpenapiClient
+include Lob
 $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
 require 'uri'
 
@@ -54,9 +54,9 @@ RSpec.describe "LettersApi" do
         end
 
         it "does not allow creation with invalid key" do
-            config = OpenapiClient::Configuration.default
+            config = Lob::Configuration.default
             config.username = "fake key"
-            badapi = OpenapiClient::ApiClient.new(config)
+            badapi = Lob::ApiClient.new(config)
 
             letterApi = LettersApi.new(badapi)