lob 5.4.6 → 6.0.0

data/__tests__/Api/Template.unit.rb

@@ -0,0 +1,165 @@
+# Template.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "TemplatesApi" do
+
+    it "can be instantiated" do
+        templateApiMock = double("ApiClient")
+        templateApi = TemplatesApi.new(templateApiMock)
+
+        expect(templateApi).not_to be_nil
+        expect(templateApi).to be_a_kind_of(TemplatesApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateWritable = TemplateWritable.new
+
+            allow(templateApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = templateApi.create(TemplateWritable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new template" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateWritable = TemplateWritable.new
+            fakeTemplate = Template.new
+
+            fakeTemplate.id = "tmpl_fakeId"
+            allow(templateApi).to receive(:create) { fakeTemplate }
+            response = templateApi.create(TemplateWritable)
+
+            expect(response).to eq(fakeTemplate)
+            expect(response.id).to eq(fakeTemplate.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateWritable = TemplateWritable.new
+
+            allow(templateApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = templateApi.get("tmpl_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an template" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateWritable = TemplateWritable.new
+            fakeTemplate = Template.new
+
+            fakeTemplate.id = "tmpl_fakeId"
+            allow(templateApi).to receive(:get) { fakeTemplate }
+            response = templateApi.get(fakeTemplate.id)
+
+            expect(response).to eq(fakeTemplate)
+            expect(response.id).to eq(fakeTemplate.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateWritable = TemplateWritable.new
+
+            allow(templateApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = templateApi.list()
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil],
+            ["before", nil, "before", nil, nil, nil, nil],
+            ["after", nil, nil, "after", nil, nil, nil],
+            ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil],
+            ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil],
+            ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }]
+        ].each do |which_param, limit, before, after, include_param, date_created, metadata|
+            it "lists templates #{which_param && ("with " + which_param + " param")}" do
+                args = {}
+                if limit then
+                    args["limit"] = limit
+                end
+
+                if before then
+                    args["before"] = before
+                end
+
+                if after then
+                    args["after"] = after
+                end
+
+                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
+
+                templateApiMock = double("ApiClient")
+                templateApi = TemplatesApi.new(templateApiMock)
+                templateWritable = TemplateWritable.new
+                fakeTemplates = Array.new(2) { Template.new }
+
+                fakeTemplates[0].id = "tmpl_fakeId"
+                allow(templateApi).to receive(:list) { fakeTemplates }
+                response = templateApi.list(args)
+
+                expect(response.length()).to eq(2)
+                expect(response).to eq(fakeTemplates)
+                expect(response[0].id).to eq(fakeTemplates[0].id)
+            end
+        end
+    end
+
+    describe "Delete" do
+        it "handles errors returned by the api" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+
+            allow(templateApi).to receive(:delete).and_raise("exception thrown in delete test")
+            begin
+                response = templateApi.delete("tmpl_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in delete test")
+            end
+        end
+
+        it "deletes a template" do
+            templateApiMock = double("ApiClient")
+            templateApi = TemplatesApi.new(templateApiMock)
+            templateDeletion = TemplateDeletion.new
+
+            templateDeletion.deleted = true
+            allow(templateApi).to receive(:delete) { templateDeletion }
+            response = templateApi.delete("tmpl_fakeId")
+
+            expect(response).to eq(templateDeletion)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end

data/__tests__/Api/TemplateVersion.unit.rb

@@ -0,0 +1,165 @@
+# TemplateVersion.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "TemplateVersionsApi" do
+
+    it "can be instantiated" do
+        templateVersionApiMock = double("ApiClient")
+        templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+
+        expect(templateVersionApi).not_to be_nil
+        expect(templateVersionApi).to be_a_kind_of(TemplateVersionsApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateVersionWritable = TemplateVersionWritable.new
+
+            allow(templateVersionApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = templateVersionApi.create("tmpl_fakeId", templateVersionWritable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new template" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateVersionWritable = TemplateVersionWritable.new
+            fakeTemplateVersion = TemplateVersion.new
+
+            fakeTemplateVersion.id = "vrsn_fakeId"
+            allow(templateVersionApi).to receive(:create) { fakeTemplateVersion }
+            response = templateVersionApi.create("tmpl_fakeId", templateVersionWritable)
+
+            expect(response).to eq(fakeTemplateVersion)
+            expect(response.id).to eq(fakeTemplateVersion.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateVersionWritable = TemplateVersionWritable.new
+
+            allow(templateVersionApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = templateVersionApi.get("tmpl_fakeId", "vrsn_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an template" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateVersionWritable = TemplateVersionWritable.new
+            fakeTemplateVersion = TemplateVersion.new
+
+            fakeTemplateVersion.id = "vrsn_fakeId"
+            allow(templateVersionApi).to receive(:get) { fakeTemplateVersion }
+            response = templateVersionApi.get("tmpl_fakeId", fakeTemplateVersion.id)
+
+            expect(response).to eq(fakeTemplateVersion)
+            expect(response.id).to eq(fakeTemplateVersion.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateVersionWritable = TemplateVersionWritable.new
+
+            allow(templateVersionApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = templateVersionApi.list("tmpl_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil],
+            ["before", nil, "before", nil, nil, nil, nil],
+            ["after", nil, nil, "after", nil, nil, nil],
+            ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil],
+            ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil],
+            ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }]
+        ].each do |which_param, limit, before, after, include_param, date_created, metadata|
+            it "lists template versions #{which_param && ("with " + which_param + " param")}" do
+                args = {}
+                if limit then
+                    args["limit"] = limit
+                end
+
+                if before then
+                    args["before"] = before
+                end
+
+                if after then
+                    args["after"] = after
+                end
+
+                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
+
+                templateVersionApiMock = double("ApiClient")
+                templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+                templateVersionWritable = TemplateVersionWritable.new
+                fakeTemplateVersionVersions = Array.new(2) { TemplateVersion.new }
+
+                fakeTemplateVersionVersions[0].id = "vrsn_fakeId"
+                allow(templateVersionApi).to receive(:list) { fakeTemplateVersionVersions }
+                response = templateVersionApi.list(args)
+
+                expect(response.length()).to eq(2)
+                expect(response).to eq(fakeTemplateVersionVersions)
+                expect(response[0].id).to eq(fakeTemplateVersionVersions[0].id)
+            end
+        end
+    end
+
+    describe "Delete" do
+        it "handles errors returned by the api" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+
+            allow(templateVersionApi).to receive(:delete).and_raise("exception thrown in delete test")
+            begin
+                response = templateVersionApi.delete("tmpl_fakeId", "vrsn_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in delete test")
+            end
+        end
+
+        it "deletes a template" do
+            templateVersionApiMock = double("ApiClient")
+            templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
+            templateDeletion = TemplateVersionDeletion.new
+
+            templateDeletion.deleted = true
+            allow(templateVersionApi).to receive(:delete) { templateDeletion }
+            response = templateVersionApi.delete("tmpl_fakeId", "vrsn_fakeId")
+
+            expect(response).to eq(templateDeletion)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end

data/__tests__/Api/UsAutocompletion.unit.rb

@@ -0,0 +1,42 @@
+# IntlAutcompletion.unit.rb
+
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "UsAutocompletionsApi" do
+
+    it "can be instantiated" do
+        usAutocompletionApiMock = double("ApiClient")
+        usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
+
+        expect(usAutocompletionApi).not_to be_nil
+        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 = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
+            usAutocompletionsWritable = Lob::UsAutocompletionsWritable.new
+
+            allow(usAutocompletionApi).to receive(:autocomplete).and_raise("exception thrown in autocomplete test")
+            begin
+                response = usAutocompletionApi.autocomplete(usAutocompletionsWritable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in autocomplete test")
+            end
+        end
+
+        it "autocomplete an address" do
+            usAutocompletionApiMock = double("ApiClient")
+            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)
+
+            expect(response.suggestions.length()).to eq(1)
+        end
+    end
+end

data/__tests__/Api/UsVerification.unit.rb

@@ -0,0 +1,71 @@
+# UsVerification.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "UsVerificationsApi" do
+
+    it "can be instantiated" do
+        usVerificationApiMock = double("ApiClient")
+        usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
+
+        expect(usVerificationApi).not_to be_nil
+        expect(usVerificationApi).to be_a_kind_of(UsVerificationsApi)
+    end
+
+    describe "Bulk Verification" do
+        it "handles errors returned by the api" do
+            usVerificationApiMock = double("ApiClient")
+            usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
+            usVerificationsWritable = UsVerificationsWritable.new
+
+            allow(usVerificationApi).to receive(:verifyBulk).and_raise("exception thrown in verification test")
+            begin
+                response = usVerificationApi.verifyBulk(usVerificationsWritable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in verification test")
+            end
+        end
+
+        it "bulk verify addresses" do
+            usVerificationApiMock = double("ApiClient")
+            usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
+            usVerificationsWritable = UsVerificationsWritable.new
+            usVerifications = UsVerifications.new
+            usVerifications.addresses = Array.new(2, { "id": "intl_ver_fakeId", "status": "LF1"})
+
+            allow(usVerificationApi).to receive(:verifyBulk) { usVerifications }
+            response = usVerificationApi.verifyBulk(usVerificationsWritable)
+
+            expect(response.addresses.length()).to eq(2)
+        end
+    end
+
+    describe "Single Verification" do
+        it "handles errors returned by the api" do
+            usVerificationApiMock = double("ApiClient")
+            usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
+            usVerificationWritable = UsVerificationsWritable.new
+
+            allow(usVerificationApi).to receive(:verifySingle).and_raise("exception thrown in verification test")
+            begin
+                response = usVerificationApi.verifySingle(usVerificationWritable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in verification test")
+            end
+        end
+
+        it "single verify addresses" do
+            usVerificationApiMock = double("ApiClient")
+            usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
+            usVerificationWritable = UsVerificationsWritable.new
+            usVerification = UsVerification.new
+            usVerification.deliverability = "deliverable"
+
+            allow(usVerificationApi).to receive(:verifySingle) { usVerification }
+            response = usVerificationApi.verifySingle(usVerificationWritable)
+
+            expect(response.deliverability).to eq("deliverable")
+        end
+    end
+end

data/__tests__/Api/ZipLookup.unit.rb

@@ -0,0 +1,42 @@
+# ZipLookup.unit.rb
+
+include Lob
+$:.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 Lob
+$:.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 = Lob::Configuration.default
+            config.username = "fake key"
+            badapi = Lob::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