lob 5.4.6 → 6.0.0.pre.rc

data/__tests__/Api/ZipLookup.unit.rb

@@ -0,0 +1,42 @@
+# ZipLookup.unit.rb
+
+include OpenapiClient
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "ZipLookupsApi" do
+
+    it "can be instantiated" do
+        zipLookupApiMock = double("ApiClient")
+        zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
+
+        expect(zipLookupApi).not_to be_nil
+        expect(zipLookupApi).to be_a_kind_of(ZipLookupsApi)
+    end
+
+    describe "Lookup" do
+        it "handles errors returned by the api" do
+            zipLookupApiMock = double("ApiClient")
+            zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
+            zip = Zip.new
+
+            allow(zipLookupApi).to receive(:lookup).and_raise("exception thrown in lookup test")
+            begin
+                response = zipLookupApi.lookup(zip)
+            rescue => err
+                expect(err.message).to eq("exception thrown in lookup test")
+            end
+        end
+
+        it "lookup a zip code" do
+            zipLookupApiMock = double("ApiClient")
+            zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
+            zip = Zip.new
+            zip.id = "us_zip_fakeId"
+
+            allow(zipLookupApi).to receive(:lookup) { zip }
+            response = zipLookupApi.lookup("12345")
+
+            expect(response.id).to eq("us_zip_fakeId")
+        end
+    end
+end

data/__tests__/Integration/Address.spec.rb

@@ -0,0 +1,200 @@
+# Address.unit.rb
+require_relative '../TestFixtures'
+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
+        addressApi = AddressesApi.new()
+
+        expect(addressApi).not_to be_nil
+        expect(addressApi).to be_a_kind_of(AddressesApi)
+    end
+
+    describe "Create" do
+        before(:all) do
+            @api = TestFixtures.api_client_with_test_key()
+        end
+
+        it "creates a new address" do
+            addressApi = AddressesApi.new(@api)
+            addressEditable = AddressEditable.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            response = addressApi.create(addressEditable)
+            adrId = response.id
+
+            expect(response.address_line1).to eq(addressEditable.address_line1)
+
+            # delete it afterwards
+            addressApi.delete(adrId)
+        end
+
+        it "handles errors returned by the api" do
+            addressApi = AddressesApi.new(@api)
+            addressEditable = AddressEditable.new()
+            begin
+                response = addressApi.create(addressEditable)
+            rescue => err
+                expect(err.message.include? "address_line1 is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = OpenapiClient::Configuration.default
+            config.username = "fake key"
+            badapi = OpenapiClient::ApiClient.new(config)
+
+            addressApi = AddressesApi.new(badapi)
+            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 => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+    end
+
+    describe "Get" do
+        before(:all) do
+            @api = TestFixtures.api_client_with_test_key()
+
+            @addressApi = AddressesApi.new(@api)
+            addressEditable = AddressEditable.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            response = @addressApi.create(addressEditable)
+            @addressId = response.id
+        end
+
+        it "retrieves an address" do
+            response = @addressApi.get(@addressId)
+
+            expect(response).not_to be_nil()
+            expect(response.id).to eq(@addressId)
+        end
+
+        after(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            addressApi = AddressesApi.new(api)
+            addressApi.delete(@addressId)
+        end
+    end
+
+    describe "List" do
+        before(:all) do
+            @api = TestFixtures.api_client_with_test_key()
+            @addressApi = AddressesApi.new(@api)
+
+            addressEditable1 = AddressEditable.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addressEditable2 = AddressEditable.new({
+                name: "FESTER",
+                address_line1: "001 CEMETERY LN",
+                address_line2: "SUITE 666",
+                address_city: "WESTFIELD ",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addressEditable3 = AddressEditable.new({
+                name: "MORTICIA ADDAMS",
+                address_line1: "1212 CEMETERY LANE",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            response1 = @addressApi.create(addressEditable1)
+            response2 = @addressApi.create(addressEditable2)
+            response3 = @addressApi.create(addressEditable3)
+
+            @address1Id = response1.id
+            @address2Id = response2.id
+            @address3Id = response3.id
+        end
+
+        it "lists addresses" do
+            response = @addressApi.list()
+
+            expect(response.data.length()).to be > 0
+        end
+
+        it "lists addresses with after param" do
+            response = @addressApi.list()
+            responseAfter = @addressApi.list(after: response.getNextPageToken())
+            expect(responseAfter.data.length()).to be > 0
+        end
+
+        it "lists addresses with before param" do
+            response = @addressApi.list()
+            responseAfter = @addressApi.list(before: response.getNextPageToken())
+            expect(responseAfter.data.length()).to be > 0
+        end
+
+        it "lists addresses with a limit parameter" do
+            response = @addressApi.list(limit: 2)
+
+            expect(response.data.length()).to be(2)
+        end
+
+        after(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            addressApi = AddressesApi.new(api)
+            addressApi.delete(@address1Id)
+            addressApi.delete(@address2Id)
+            addressApi.delete(@address3Id)
+        end
+    end
+
+    describe "Delete" do
+        before(:all) do
+            @api = TestFixtures.api_client_with_test_key()
+
+            @addressApi = AddressesApi.new(@api)
+            addressEditable = AddressEditable.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            response = @addressApi.create(addressEditable)
+            @addressId = response.id
+        end
+
+        it "deletes an address" do
+            response = @addressApi.delete(@addressId)
+
+            expect(response.id).to eq(@addressId)
+            expect(response.deleted).to eq(true)
+        end
+    end
+  end

data/__tests__/Integration/BankAccount.spec.rb

@@ -0,0 +1,243 @@
+# BankAccount.spec.rb
+require_relative '../TestFixtures'
+include OpenapiClient
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+require 'uri'
+
+RSpec.describe "BankAccountsApi" do
+    it "can be instantiated" do
+        bankAccountApi = BankAccountsApi.new()
+
+        expect(bankAccountApi).not_to be_nil
+        expect(bankAccountApi).to be_a_kind_of(BankAccountsApi)
+    end
+
+    describe "Create" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @bankAccountApi = BankAccountsApi.new(api)
+
+            @bankAccountWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+        end
+
+        it "creates a new bank account" do
+            createdBankAccount = @bankAccountApi.create(@bankAccountWritable)
+            expect(createdBankAccount.id).not_to be_nil
+
+            # delete it in the end
+            @bankAccountApi.delete(createdBankAccount.id)
+        end
+
+        it "handles errors returned by the api" do
+            bankAccountWritable = BankAccountWritable.new()
+            begin
+                response = @bankAccountApi.create(bankAccountWritable)
+            rescue => err
+                expect(err.message.include? "routing_number is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = OpenapiClient::Configuration.default
+            config.username = "fake key"
+            badapi = OpenapiClient::ApiClient.new(config)
+
+            bankAccountApi = BankAccountsApi.new(badapi)
+
+            begin
+                response = bankAccountApi.create(@bankAccountWritable)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+    end
+
+    describe "Verify" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @bankAccountApi = BankAccountsApi.new(api)
+
+            bankAccountWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            response = @bankAccountApi.create(bankAccountWritable)
+            @bankAccountId = response.id
+        end
+
+        it "verifies a bank account" do
+            bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
+            response = @bankAccountApi.verify(@bankAccountId, bankVerify)
+
+            expect(response).not_to be_nil()
+            expect(response.id).to eq(@bankAccountId)
+        end
+
+        it "handles errors returned by the api" do
+            bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
+            begin
+                response = @bankAccountApi.verify("bank_fakeId", bankVerify)
+            rescue => err
+                expect(err.message.include? "bank account not found").to be(true)
+            end
+        end
+
+        after(:all) do
+            @bankAccountApi.delete(@bankAccountId)
+        end
+    end
+
+    describe "Get" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @bankAccountApi = BankAccountsApi.new(api)
+
+            bankAccountWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            response = @bankAccountApi.create(bankAccountWritable)
+            @bankAccountId = response.id
+        end
+
+        it "retrieves a bank account" do
+            response = @bankAccountApi.get(@bankAccountId)
+
+            expect(response).not_to be_nil()
+            expect(response.id).to eq(@bankAccountId)
+        end
+
+        after(:all) do
+            @bankAccountApi.delete(@bankAccountId)
+        end
+    end
+
+    describe "List" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @bankAccountApi = BankAccountsApi.new(api)
+
+            bankAccountWritable1 = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankAccountWritable2 = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankAccountWritable3 = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            response1 = @bankAccountApi.create(bankAccountWritable1)
+            response2 = @bankAccountApi.create(bankAccountWritable2)
+            response3 = @bankAccountApi.create(bankAccountWritable3)
+
+            @bankAccount1Id = response1.id
+            @bankAccount2Id = response2.id
+            @bankAccount3Id = response3.id
+        end
+
+        it "lists bank accounts with limit, before, and after params" do
+            response = @bankAccountApi.list({ :"limit" => 2 })
+
+            expect(response.data.length()).to be == 2
+            first_bank_id = response.data[0].id
+
+            uri    = URI.parse(response.next_url)
+            params = CGI.parse(uri.query)
+
+            response = @bankAccountApi.list({ :"limit" => 2, :"after" => params["after"][0] })
+
+            expect(response.data[0].id).not_to eq(first_bank_id)
+
+            uri    = URI.parse(response.previous_url)
+            params = CGI.parse(uri.query)
+
+            response = @bankAccountApi.list({ :"limit" => 2, :"before" => params["before"][0] })
+            expect(response.data[0].id).not_to be_nil
+
+        end
+
+        [
+            [nil, nil, nil, nil],
+            ["include", Array.new(1, "total_count"), nil, nil],
+            ["date_created", nil, { "gt" => "2020-01-01" }, nil],
+            ["metadata", nil, nil, '{ "name": "Harry" }'],
+        ].each do |which_param, include_param, date_created, metadata|
+            it "lists bank accounts #{which_param && ("with " + which_param + " param")}" do
+                args = {}
+
+                if include_param then
+                    args[:"include"] = include_param
+                end
+
+                if date_created then
+                    args[:"date_created"] = date_created
+                end
+
+                if metadata then
+                    args[:"metadata"] = metadata
+                end
+
+                response = @bankAccountApi.list(args)
+
+                expect(response.data.length()).to be > 0
+
+                if include_param
+                    expect(response.total_count).to be
+                end
+            end
+        end
+
+        after(:all) do
+            @bankAccountApi.delete(@bankAccount1Id)
+            @bankAccountApi.delete(@bankAccount2Id)
+            @bankAccountApi.delete(@bankAccount3Id)
+        end
+    end
+
+    describe "Delete" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @bankAccountApi = BankAccountsApi.new(api)
+
+            bankAccountWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            response = @bankAccountApi.create(bankAccountWritable)
+            @bankAccountId = response.id
+        end
+
+        it "deletes a bank account" do
+            response = @bankAccountApi.delete(@bankAccountId)
+
+            expect(response.id).to eq(@bankAccountId)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end

data/__tests__/Integration/BillingGroup.spec.rb

@@ -0,0 +1,163 @@
+# BillingGroup.spec.rb
+require_relative '../TestFixtures'
+include OpenapiClient
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+require 'uri'
+
+RSpec.describe "BillingGroupsApi" do
+    it "can be instantiated" do
+        billingGroupApi = BillingGroupsApi.new()
+
+        expect(billingGroupApi).not_to be_nil
+        expect(billingGroupApi).to be_a_kind_of(BillingGroupsApi)
+    end
+
+    describe "Create" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @billingGroupApi = BillingGroupsApi.new(api)
+
+            @billingGroupEditable = BillingGroupEditable.new({
+                name: "Ruby Integration Test BG"
+            })
+        end
+
+        it "creates a new billing group" do
+            createdBillingGroup = @billingGroupApi.create(@billingGroupEditable)
+            expect(createdBillingGroup.id).not_to be_nil
+        end
+
+        it "handles errors returned by the api" do
+            billingGroupEditable = BillingGroupEditable.new()
+            begin
+                response = @billingGroupApi.create(billingGroupEditable)
+            rescue => err
+                expect(err.message.include? "name is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = OpenapiClient::Configuration.default
+            config.username = "fake key"
+            badapi = OpenapiClient::ApiClient.new(config)
+
+            billingGroupApi = BillingGroupsApi.new(badapi)
+
+            begin
+                response = billingGroupApi.create(@billingGroupEditable)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+    end
+
+    describe "Update" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @billingGroupApi = BillingGroupsApi.new(api)
+
+            billingGroupEditable = BillingGroupEditable.new({
+                name: "Ruby Integration Test BG"
+            })
+
+            response = @billingGroupApi.create(billingGroupEditable)
+            @billingGroupId = response.id
+        end
+
+        it "updates a billing group" do
+            bgUpdatable = BillingGroupEditable.new({ name: "Updated Test Billing Group" })
+            response = @billingGroupApi.update(@billingGroupId, bgUpdatable)
+
+            expect(response.name).to eq("Updated Test Billing Group")
+            expect(response.id).to eq(@billingGroupId)
+        end
+
+        it "handles errors returned by the api" do
+            bgUpdatable = BillingGroupEditable.new({ name: "Updated Test Billing Group" })
+            begin
+                response = @billingGroupApi.update("bg_fakeId", bgUpdatable)
+            rescue => err
+                expect(err.message.include? "billing_group not found").to be(true)
+            end
+        end
+    end
+
+    describe "Get" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @billingGroupApi = BillingGroupsApi.new(api)
+
+            billingGroupEditable = BillingGroupEditable.new({
+                name: "Ruby Integration Test BG"
+            })
+
+            response = @billingGroupApi.create(billingGroupEditable)
+            @billingGroupId = response.id
+        end
+
+        it "retrieves a billing group" do
+            response = @billingGroupApi.get(@billingGroupId)
+
+            expect(response).not_to be_nil()
+            expect(response.id).to eq(@billingGroupId)
+        end
+    end
+
+    describe "List" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @billingGroupApi = BillingGroupsApi.new(api)
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil],
+            ["offset", nil, 1, nil, nil, nil, nil],
+            ["include", nil, nil, Array.new(1, "total_count"), nil, nil, nil],
+            ["date_created", nil, nil, nil, { "gt" => "2020-01-01" }, nil, nil],
+            ["date_modified", nil, nil, nil, nil, { "gt" => "2020-01-01" }, nil],
+            ["sort_by", nil, nil, nil, nil, nil, { "date_modified": "asc" }]
+        ].each do |which_param, limit, offset, include_param, date_created, date_modified, sort_by|
+            it "lists billing groups #{which_param && ("with " + which_param + " param")}" do
+                args = {}
+
+                if limit then
+                    args[:"limit"] = limit
+                end
+
+                if offset then
+                    args[:"offset"] = offset
+                end
+
+                if include_param then
+                    args[:"include"] = include_param
+                end
+
+                if date_created then
+                    args[:"date_created"] = date_created
+                end
+
+                if date_modified then
+                    args[:"date_modified"] = date_modified
+                end
+
+                if sort_by then
+                    args[:"sort_by"] = sort_by
+                end
+
+                response = @billingGroupApi.list(args)
+
+                expect(response.data.length()).to be > 0
+
+                if limit then
+                    expect(response.data.length()).to be == limit
+                end
+
+                # seems to be broken
+                # if include_param
+                #     expect(response.total_count).to be
+                # end
+            end
+        end
+    end
+end