lob 5.4.5 → 6.0.0.pre.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14de59724a258146efda8e6e01416f8c783c5f63e92989dd017ca1ec17c7c43a
-  data.tar.gz: 49c06775670f7101fec498ea258ad2c415d086ea16c15cee163d34379ebacbae
+  metadata.gz: 47b698e7d8180eb422b48f533ecfb7ae2371a6d8d4367a669e3d1c28b28dcbc9
+  data.tar.gz: 28c4f1e8d45c9d035cca90a0569760c0a17a1ff13ed73eb14ed4c65838550c9e
 SHA512:
-  metadata.gz: ad126ff6eef5e894245b99842ada43132454074dbad8d43093828f3069b173c1ff97940769cb55febe079d6bb48de8152d42ac28ed904e7f93df011252528084
-  data.tar.gz: d8f04a69fca64ef67ddfd2ed109f851917ac269f6996ae74009939f8601cd8060eeed56868c40303b9fad56857f5c6df3ff374f19a8a315e6c9ac6bbe39eb60c
+  metadata.gz: a44faa61acce18b83c6f747ac5d577d1f45205affba3d37ac39d960392676c0f7c614224962016d693b2df6ef65ac900a3bbcdb1829551e4845baf50b6280ca1
+  data.tar.gz: b2b02327af966724a28f6167cfe742b53b4a6eac1fc1f04938d49d560ca2d4d322787c95ea2e433e7e12f422b3d408e1080e9854a68ef7361bb8e80619ace9c9

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,70 @@
+PATH
+  remote: .
+  specs:
+    lob (6.0.0.pre.rc)
+      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.15.5)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.0.1)
+      stringio
+    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.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    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.11.0)
+    stringio (3.0.4)
+    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.3.26

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/README.md

@@ -1,139 +1,136 @@
-# 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
-
-- [Table of Contents](#table-of-contents)
-- [Getting Started](#getting-started)
-  - [Registration](#registration)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Initialization and Configuration](#initialization-and-configuration)
-    - [Caution: Pass zero-prefixed zip codes as strings](#caution-pass-zero-prefixed-zip-codes-as-strings)
-    - [Accessing Response Headers](#accessing-response-headers)
-- [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/products/print-mail/postcards)
-- [Letters API](https://lob.com/products/print-mail/letters)
-- [Checks API](https://lob.com/products/print-mail/checks)
-- [Address Verification API](https://lob.com/products/address-verification)
-
-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
-
-Or manually install it yourself:
+### Installation & Usage
 
-    $ gem install lob
+Install with the appropriate [package manager](https://www.ruby-lang.org/en/documentation/installation/#winget).
 
-### Usage
-
-The library uses an ActiveRecord-style interface. You'll feel right at home.
+Then add Lob's Ruby SDK to your Gemfile
+```ruby
+gem 'openapi_client'
+```
 
-For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
+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
+```
 
-#### Initialization and Configuration
+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
-# 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")
-
-# To initialize a Lob object that needs to communicate via a proxy
-lob = Lob::Client.new(api_key: "your-api-key", proxy: "http://proxy.example.com)
+require 'openapi_client'
 ```
 
-#### Caution: Pass zero-prefixed zip codes as strings
+## First API Call
+
+```ruby
+# Load the gem
+require 'openapi_client'
 
-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.
+# Setup authorization
+OpenapiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = '<YOUR_LOB_API_KEY>'
+end
 
-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.
+apiInstance = OpenapiClient::AddressesApi.new
+addressEditable = OpenapiClient::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 OpenapiClient::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
+### Integration Tests
 
-We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).
+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.
 
-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.
+To run integration tests:
 
-## API Documentation
+```bash
+$ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> rspec -P __tests__/Integration/* --color --format doc
+```
 
-The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
+#### A cleaner alternative if you are going to run integration tests frequently
 
-## Contributing
+Run this the first time:
 
-To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+```bash
+$ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env
+```
 
-## Testing
+Then, to run the integration tests:
+
+```bash
+$ env $(cat LOCAL.env) rspec -P __tests__/Integration/* --color --format doc
+```
 
-Tests are written using MiniTest, a testing library that comes with Ruby stdlib.
+## Documentation For Authorization
 
-Here's how you can run the tests:
 
-    bundle exec rake test
+## basicAuth
 
-You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
+- **Type**: HTTP basic authentication
 
-=======================
 
-Copyright &copy; 2016 Lob.com
+## Author
 
-Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
+lob-openapi@lob.com

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

data/__tests__/Api/Address.unit.rb

@@ -0,0 +1,210 @@
+# Address.unit.rb
+
+include OpenapiClient
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+require 'api/addresses_api'
+require 'models/address'
+require 'models/address_editable'
+
+
+RSpec.describe "AddressesApi" do
+
+    it "can be instantiated" do
+        addressApiMock = double("ApiClient")
+        addressApi = AddressesApi.new(addressApiMock)
+
+        expect(addressApi).not_to be_nil
+        expect(addressApi).to be_a_kind_of(AddressesApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+
+            allow(addressApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = addressApi.create(addressEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new address" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddress = Address.new
+
+            fakeAddress.id = "adr_fakeid"
+            allow(addressApi).to receive(:create) { fakeAddress }
+            response = addressApi.create(addressEditable)
+
+            expect(response).to eq(fakeAddress)
+            expect(response.id).to eq(fakeAddress.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+
+            allow(addressApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = addressApi.get("adr_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an address" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            fakeAddress = Address.new
+
+            fakeAddress.id = "adr_fakeid"
+            allow(addressApi).to receive(:get) { fakeAddress }
+            response = addressApi.get(fakeAddress.id)
+
+            expect(response).to eq(fakeAddress)
+            expect(response.id).to eq(fakeAddress.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+
+            allow(addressApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = addressApi.list()
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "lists addresses" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list()
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+
+        it "lists addresses with a limit parameter" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list(limit: 10)
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+
+        it "lists addresses with a before parameter" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list(before: 'before')
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+
+        it "lists addresses with a after parameter" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list(after: 'after')
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+
+        it "lists addresses with a date created parameter" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            DATE_FILTER  = { gt: "2020-01-01", lt: "2020-01-31T12" };
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list(date_created: DATE_FILTER)
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+
+        it "lists addresses with a metadata parameter" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+            fakeAddresses = Array.new(2) { Address.new }
+
+            METADATA  = { fakeMetadata: "fakemetadata" }
+            fakeAddresses[0].id = "adr_fakeid"
+            allow(addressApi).to receive(:list) { fakeAddresses }
+            response = addressApi.list(metadata: METADATA)
+
+            expect(response.length()).to eq(2)
+            expect(response).to eq(fakeAddresses)
+            expect(response[0].id).to eq(fakeAddresses[0].id)
+        end
+    end
+
+    describe "Delete" do
+        it "handles errors returned by the api" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            addressEditable = AddressEditable.new
+
+            allow(addressApi).to receive(:delete).and_raise("exception thrown in delete test")
+            begin
+                response = addressApi.delete(addressEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in delete test")
+            end
+        end
+
+        it "deletes an address" do
+            addressApiMock = double("ApiClient")
+            addressApi = AddressesApi.new(addressApiMock)
+            fakeAddressDeletion = AddressDeletion.new
+
+            fakeAddressDeletion.deleted = true
+            allow(addressApi).to receive(:delete) { fakeAddressDeletion }
+            response = addressApi.delete("adr_fakeId")
+
+            expect(response).to eq(fakeAddressDeletion)
+            expect(response.deleted).to eq(true)
+        end
+    end
+  end