lob 5.4.6 → 6.0.0

data/__tests__/Integration/CardOrder.spec.rb

@@ -0,0 +1,122 @@
+# CardOrder.spec.rb
+require_relative '../TestFixtures'
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+require 'uri'
+
+RSpec.describe "CardOrdersApi" do
+    it "can be instantiated" do
+        cardOrderApi = CardOrdersApi.new()
+
+        expect(cardOrderApi).not_to be_nil
+        expect(cardOrderApi).to be_a_kind_of(CardOrdersApi)
+    end
+
+    describe "Create" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @cardOrderApi = CardOrdersApi.new(api)
+            @cardApi = CardsApi.new(api)
+
+            cardEditable = CardEditable.new({
+                front: TestFixtures.FILE_LOCATION,
+                back: TestFixtures.FILE_LOCATION,
+                size: "2.125x3.375"
+            })
+
+            @cardId = @cardApi.create(cardEditable).id
+            puts @cardId
+
+            @cardOrderEditable = CardOrderEditable.new({
+                quantity: 10000
+            })
+        end
+
+        it "creates a new card order" do
+            createdCardOrder = @cardOrderApi.create(@cardId, @cardOrderEditable)
+            expect(createdCardOrder.id).not_to be_nil
+        end
+
+        it "handles errors returned by the api" do
+            cardOrderEditable = CardOrderEditable.new()
+            begin
+                response = @cardOrderApi.create(@cardId, cardOrderEditable)
+            rescue => err
+                expect(err.message.include? "quantity is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = Lob::Configuration.default
+            config.username = "fake key"
+            badapi = Lob::ApiClient.new(config)
+
+            cardOrderApi = CardOrdersApi.new(badapi)
+
+            begin
+                response = cardOrderApi.create(@cardId, @cardOrderEditable)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+
+        after(:all) do
+          api = TestFixtures.api_client_with_test_key()
+          cardApi = CardsApi.new(api)
+          cardApi.delete(@cardId)
+        end
+    end
+
+    describe "List" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @cardOrderApi = CardOrdersApi.new(api)
+            @cardApi = CardsApi.new(api)
+
+            cardEditable = CardEditable.new({
+                front: TestFixtures.FILE_LOCATION,
+                back: TestFixtures.FILE_LOCATION,
+                size: "2.125x3.375"
+            })
+
+            @cardId = @cardApi.create(cardEditable).id
+
+            @cardOrderEditable = CardOrderEditable.new({
+                quantity: 10002
+            })
+            @cardOrderApi.create(@cardId, @cardOrderEditable)
+            @cardOrderApi.create(@cardId, @cardOrderEditable)
+            @cardOrderApi.create(@cardId, @cardOrderEditable)
+        end
+
+        [
+            [nil, nil, nil],
+            ["limit", 2, nil],
+            ["offset", nil, 1],
+        ].each do |which_param, limit, offset|
+            it "lists card orders #{which_param && ("with " + which_param + " param")}" do
+                args = {}
+
+                if limit then
+                    args[:"limit"] = limit
+                end
+
+                if offset then
+                    args[:"offset"] = offset
+                end
+
+                response = @cardOrderApi.get(@cardId, args)
+
+                expect(response.data.length()).to be > 0
+
+                if limit then
+                    expect(response.data.length()).to be == limit
+                end
+            end
+        end
+
+        after(:all) do
+            @cardApi.delete(@cardId)
+        end
+    end
+end

data/__tests__/Integration/Check.spec.rb

@@ -0,0 +1,361 @@
+# Check.spec.rb
+require_relative '../TestFixtures'
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+require 'uri'
+
+RSpec.describe "ChecksApi" do
+    it "can be instantiated" do
+        checkApi = ChecksApi.new()
+
+        expect(checkApi).not_to be_nil
+        expect(checkApi).to be_a_kind_of(ChecksApi)
+    end
+
+    describe "Create" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @checkApi = ChecksApi.new(api)
+            bankAccountApi = BankAccountsApi.new(api)
+
+            addr1 = AddressDomestic.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addr2 = AddressDomestic.new({
+                name: "FESTER",
+                address_line1: "001 CEMETERY LN",
+                address_line2: "SUITE 666",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000"
+            })
+
+            bankWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankVerify = BankAccountVerify.new({
+                amounts: [11, 35]
+            })
+
+            bankAcc = bankAccountApi.create(bankWritable)
+            bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
+            @bankAccId = bankAcc.id
+
+            @checkEditable = CheckEditable.new({
+                to: addr1,
+                message: "Ruby Integration Test Check",
+                bank_account: @bankAccId,
+                from: addr2,
+                amount: 100.0
+            })
+        end
+
+        it "creates a new check" do
+            createdCheck = @checkApi.create(@checkEditable)
+            expect(createdCheck.id).to be
+
+            # delete it in the end
+            @checkApi.cancel(createdCheck.id)
+        end
+
+        it "handles errors returned by the api" do
+            checkEditable = CheckEditable.new()
+            begin
+                response = @checkApi.create(checkEditable)
+            rescue => err
+                expect(err.message.include? "to is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = Lob::Configuration.default
+            config.username = "fake key"
+            badapi = Lob::ApiClient.new(config)
+
+            checkApi = ChecksApi.new(badapi)
+
+            begin
+                response = checkApi.create(@checkEditable)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+
+        after(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            bankAccountApi = BankAccountsApi.new(api)
+            bankAccountApi.delete(@bankAccId)
+        end
+    end
+
+    describe "Get" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @checkApi = ChecksApi.new(api)
+
+            bankAccountApi = BankAccountsApi.new(api)
+
+            addr1 = AddressDomestic.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addr2 = AddressDomestic.new({
+                name: "FESTER",
+                address_line1: "001 CEMETERY LN",
+                address_line2: "SUITE 666",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000"
+            })
+
+            bankWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankVerify = BankAccountVerify.new({
+                amounts: [11, 35]
+            })
+
+            bankAcc = bankAccountApi.create(bankWritable)
+            bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
+            bankAccId = bankAcc.id
+
+            checkEditable = CheckEditable.new({
+                to: addr1,
+                message: "Ruby Integration Test Check",
+                bank_account: bankAccId,
+                from: addr2,
+                amount: 100.0
+            })
+
+            response = @checkApi.create(checkEditable)
+            @checkId = response.id
+
+            bankAccountApi.delete(bankAccId)
+        end
+
+        it "retrieves a check" do
+            response = @checkApi.get(@checkId)
+
+            expect(response).not_to be_nil()
+            expect(response.id).to eq(@checkId)
+        end
+
+        after(:all) do
+            @checkApi.cancel(@checkId)
+        end
+    end
+
+    describe "List" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @checkApi = ChecksApi.new(api)
+
+            bankAccountApi = BankAccountsApi.new(api)
+
+            addr1 = AddressDomestic.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addr2 = AddressDomestic.new({
+                name: "FESTER",
+                address_line1: "001 CEMETERY LN",
+                address_line2: "SUITE 666",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000"
+            })
+
+            bankWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankVerify = BankAccountVerify.new({
+                amounts: [11, 35]
+            })
+
+            bankAcc = bankAccountApi.create(bankWritable)
+            bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
+            bankAccId = bankAcc.id
+
+            checkEditable = CheckEditable.new({
+                to: addr1,
+                message: "Ruby Integration Test Check",
+                bank_account: bankAccId,
+                from: addr2,
+                amount: 100.0
+            })
+
+            response1 = @checkApi.create(checkEditable)
+            response2 = @checkApi.create(checkEditable)
+            response3 = @checkApi.create(checkEditable)
+
+            @check1Id = response1.id
+            @check2Id = response2.id
+            @check3Id = response3.id
+
+            bankAccountApi.delete(bankAccId)
+        end
+
+        it "lists checks with limit, before, and after params" do
+            response = @checkApi.list({ :"limit" => 2 })
+
+            expect(response.data.length()).to be == 2
+            first_chk_id = response.data[0].id
+
+            uri    = URI.parse(response.next_url)
+            params = CGI.parse(uri.query)
+
+            response = @checkApi.list({ :"limit" => 2, :"after" => params["after"][0] })
+
+            expect(response.data[0].id).not_to eq(first_chk_id)
+
+            uri    = URI.parse(response.next_url)
+            params = CGI.parse(uri.query)
+
+            response = @checkApi.list({ :"limit" => 2, :"before" => params["before"][0] })
+            expect(response.data[0].id).not_to be_nil
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["include", Array.new(1, "total_count"), nil, nil, nil, nil, nil, nil],
+            ["date_created", nil, { "gt" => "2020-01-01" }, nil, nil, nil, nil, nil, nil],
+            ["metadata", nil, nil, '{ "name": "Harry" }', nil, nil, nil, nil, nil],
+            ["scheduled", nil, nil, nil, true, nil, nil, nil, nil],
+            ["send_date", nil, nil, nil, nil, { "gt" => "2020-01-01" }, nil, nil, nil],
+            ["mail_type", nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil, nil],
+            ["sort_by", nil, nil, nil, nil, nil, nil, { "date_created": "asc" }],
+        ].each do |which_param, include_param, date_created, metadata, scheduled, send_date, mail_type, sort_by|
+            it "lists checks #{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
+
+                if scheduled then
+                    args[:"scheduled"] = scheduled
+                end
+
+                if send_date then
+                    args[:"send_date"] = send_date
+                end
+
+                if mail_type then
+                    args[:"mail_type"] = mail_type
+                end
+
+                if sort_by then
+                    args[:"sort_by"] = sort_by
+                end
+
+                response = @checkApi.list(args)
+
+                expect(response.data.length()).to be >= 0
+
+                if include_param
+                    expect(response.total_count).to be
+                end
+            end
+        end
+
+        after(:all) do
+            @checkApi.cancel(@check1Id)
+            @checkApi.cancel(@check2Id)
+            @checkApi.cancel(@check3Id)
+        end
+    end
+
+    describe "Delete" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @checkApi = ChecksApi.new(api)
+
+            bankAccountApi = BankAccountsApi.new(api)
+
+            addr1 = AddressDomestic.new({
+                name: "Thing T. Thing",
+                address_line1: "1313 CEMETERY LN",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000",
+            })
+
+            addr2 = AddressDomestic.new({
+                name: "FESTER",
+                address_line1: "001 CEMETERY LN",
+                address_line2: "SUITE 666",
+                address_city: "WESTFIELD",
+                address_state: "NJ",
+                address_zip: "07000"
+            })
+
+            bankWritable = BankAccountWritable.new({
+                routing_number: "322271627",
+                account_number: "123456789",
+                signatory: "Sigourney Lobster",
+                account_type: BankTypeEnum::INDIVIDUAL
+            })
+
+            bankVerify = BankAccountVerify.new({
+                amounts: [11, 35]
+            })
+
+            bankAcc = bankAccountApi.create(bankWritable)
+            bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
+            bankAccId = bankAcc.id
+
+            checkEditable = CheckEditable.new({
+                to: addr1,
+                message: "Ruby Integration Test Check",
+                bank_account: bankAccId,
+                from: addr2,
+                amount: 100.0
+            })
+
+            response = @checkApi.create(checkEditable)
+            @checkId = response.id
+
+            bankAccountApi.delete(bankAccId)
+        end
+
+        it "deletes a check" do
+            response = @checkApi.cancel(@checkId)
+
+            expect(response.id).to eq(@checkId)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end

data/__tests__/Integration/IntlAutocompletion.spec.rb

@@ -0,0 +1,54 @@
+# IntlAutocompletion.spec.rb
+require_relative '../TestFixtures'
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "IntlAutocompletionsApi" do
+    it "can be instantiated" do
+        intlAutocompletionApi = IntlAutocompletionsApi.new()
+
+        expect(intlAutocompletionApi).not_to be_nil
+        expect(intlAutocompletionApi).to be_a_kind_of(IntlAutocompletionsApi)
+    end
+
+    describe "Autocomplete" do
+        before(:all) do
+            api = TestFixtures.api_client_with_test_key()
+            @intlAutocompletionApi = IntlAutocompletionsApi.new(api)
+
+            @validAddress = IntlAutocompletionsWritable.new({
+                address_prefix: "370 W",
+                city: "SUMMERSIDE",
+                country: CountryExtended::CA
+            })
+        end
+
+        it "Autocompletes intl address (with test key)" do
+            autocompletedAddr = @intlAutocompletionApi.autocomplete(@validAddress)
+            expect(autocompletedAddr.suggestions[0].primary_line).to eq("TEST KEYS DO NOT AUTOCOMPLETE INTL ADDRESSES")
+        end
+
+        it "handles errors returned by the api" do
+            validAddress = IntlAutocompletionsWritable.new()
+            begin
+                response = @intlAutocompletionApi.autocomplete(validAddress)
+            rescue => err
+                expect(err.message.include? "address_prefix is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = Lob::Configuration.default
+            config.username = "fake key"
+            badapi = Lob::ApiClient.new(config)
+
+            intlAutocompletionApi = IntlAutocompletionsApi.new(badapi)
+
+            begin
+                response = intlAutocompletionApi.autocomplete(@validAddress)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+    end
+end

data/__tests__/Integration/IntlVerification.spec.rb

@@ -0,0 +1,90 @@
+# IntlVerification.spec.rb
+require_relative '../TestFixtures'
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "IntlVerificationsApi" do
+    it "can be instantiated" do
+        intlVerificationApi = IntlVerificationsApi.new()
+
+        expect(intlVerificationApi).not_to be_nil
+        expect(intlVerificationApi).to be_a_kind_of(IntlVerificationsApi)
+    end
+
+    describe "verifySingle" do
+        before(:all) do
+            api = TestFixtures.api_client_with_live_key()
+            @intlVerificationApi = IntlVerificationsApi.new(api)
+
+            @validAddress = IntlVerificationWritable.new({
+                primary_line: "35 TOWER HILL",
+                city: "LONDON",
+                postal_code: "EC3N 4DR",
+                country: CountryExtended::GB
+            })
+
+            @invalidAddress = IntlVerificationWritable.new({
+                primary_line: "1 CEMETERY ST",
+                city: "POTATOFIELD",
+                postal_code: "EC3N 40R",
+                country: CountryExtended::GB
+            })
+
+            mc1 = MultipleComponentsIntl.new({
+                primary_line: "35 TOWER HILL",
+                city: "LONDON",
+                postal_code: "EC3N 4DR",
+                country: CountryExtended::GB
+            })
+            mc2 = MultipleComponentsIntl.new({
+                primary_line: "10 DOWNING ST",
+                city: "LONDON",
+                postal_code: "SW1A 2AB",
+                country: CountryExtended::GB
+            })
+            @addressList = IntlVerificationsPayload.new({
+                addresses: [mc1, mc2]
+            })
+        end
+
+        it "Verifies valid addresses in bulk" do
+            verifiedList = @intlVerificationApi.verifyBulk(@addressList)
+            expect(verifiedList.addresses.length()).to be(2)
+            expect(verifiedList.addresses[0].deliverability).to eq("deliverable")
+            expect(verifiedList.addresses[1].deliverability).to eq("deliverable_missing_info")
+        end
+
+        it "Verifies single deliverable address" do
+          verifiedAddr = @intlVerificationApi.verifySingle(@validAddress)
+          expect(verifiedAddr.deliverability).to eq("deliverable")
+        end
+
+        it "Verifies single undeliverable address" do
+          verifiedAddr = @intlVerificationApi.verifySingle(@invalidAddress)
+          expect(verifiedAddr.deliverability).to eq("undeliverable")
+        end
+
+        it "handles errors returned by the api" do
+            validAddress = IntlVerificationWritable.new()
+            begin
+                response = @intlVerificationApi.verifySingle(validAddress)
+            rescue => err
+                expect(err.message.include? "primary_line is required").to be(true)
+            end
+        end
+
+        it "does not allow creation with invalid key" do
+            config = Lob::Configuration.default
+            config.username = "fake key"
+            badapi = Lob::ApiClient.new(config)
+
+            intlVerificationApi = IntlVerificationsApi.new(badapi)
+
+            begin
+                response = intlVerificationApi.verifySingle(@validAddress)
+            rescue => err
+                expect(err.message.include? "Your API key is not valid.").to be(true)
+            end
+        end
+    end
+end