lob 5.4.6 → 6.0.0

data/__tests__/Api/Letter.unit.rb

@@ -0,0 +1,191 @@
+# Letter.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "LettersApi" do
+
+    it "can be instantiated" do
+        letterApiMock = double("ApiClient")
+        letterApi = LettersApi.new(letterApiMock)
+
+        expect(letterApi).not_to be_nil
+        expect(letterApi).to be_a_kind_of(LettersApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+
+            allow(letterApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = letterApi.create(letterEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new letter" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+            fakeLetter = Letter.new
+
+            fakeLetter.id = "ltr_fakeId"
+            allow(letterApi).to receive(:create) { fakeLetter }
+            response = letterApi.create(letterEditable)
+
+            expect(response).to eq(fakeLetter)
+            expect(response.id).to eq(fakeLetter.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+
+            allow(letterApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = letterApi.get("ltr_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an letter" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+            fakeLetter = Letter.new
+
+            fakeLetter.id = "ltr_fakeId"
+            allow(letterApi).to receive(:get) { fakeLetter }
+            response = letterApi.get(fakeLetter.id)
+
+            expect(response).to eq(fakeLetter)
+            expect(response.id).to eq(fakeLetter.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+
+            allow(letterApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = letterApi.list()
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["before", nil, "before", nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["after", nil, nil, "after", nil, nil, nil, nil, nil, nil, nil, nil],
+            ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil, nil, nil, nil, nil, nil],
+            ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil, nil, nil, nil, nil],
+            ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }, nil, nil, nil, nil, nil],
+            ["color", nil, nil, nil, nil, nil, nil, true, nil, nil, nil, nil],
+            ["scheduled", nil, nil, nil, nil, nil, nil, nil, true, nil, nil, nil],
+            ["send_date", nil, nil, nil, nil, nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil],
+            ["mail_type", nil, nil, nil, nil, nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil],
+            ["sort_by", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, SortByDateModified.new(date_modified: "asc")],
+        ].each do |which_param, limit, before, after, include_param, date_created, metadata, color, scheduled, send_date, mail_type, sort_by|
+            it "lists letters #{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
+
+                if color then
+                    args["color"] = color
+                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
+
+                letterApiMock = double("ApiClient")
+                letterApi = LettersApi.new(letterApiMock)
+                letterEditable = LetterEditable.new
+                fakeLetters = Array.new(2) { Letter.new }
+
+                fakeLetters[0].id = "ltr_fakeId"
+                allow(letterApi).to receive(:list) { fakeLetters }
+                response = letterApi.list(args)
+
+                expect(response.length()).to eq(2)
+                expect(response).to eq(fakeLetters)
+                expect(response[0].id).to eq(fakeLetters[0].id)
+            end
+        end
+    end
+
+    describe "Delete" do
+        it "handles errors returned by the api" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            letterEditable = LetterEditable.new
+
+            allow(letterApi).to receive(:cancel).and_raise("exception thrown in delete test")
+            begin
+                response = letterApi.cancel(letterEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in delete test")
+            end
+        end
+
+        it "deletes a letter" do
+            letterApiMock = double("ApiClient")
+            letterApi = LettersApi.new(letterApiMock)
+            fakeLetterDeletion = LetterDeletion.new
+
+            fakeLetterDeletion.deleted = true
+            allow(letterApi).to receive(:cancel) { fakeLetterDeletion }
+            response = letterApi.cancel("ltr_fakeId")
+
+            expect(response).to eq(fakeLetterDeletion)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end

data/__tests__/Api/Postcard.unit.rb

@@ -0,0 +1,189 @@
+# Postcard.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "PostcardsApi" do
+
+    it "can be instantiated" do
+        postcardApiMock = double("ApiClient")
+        postcardApi = PostcardsApi.new(postcardApiMock)
+
+        expect(postcardApi).not_to be_nil
+        expect(postcardApi).to be_a_kind_of(PostcardsApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+
+            allow(postcardApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = postcardApi.create(postcardEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new postcard" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+            fakePostcard = Postcard.new
+
+            fakePostcard.id = "psc_fakeId"
+            allow(postcardApi).to receive(:create) { fakePostcard }
+            response = postcardApi.create(postcardEditable)
+
+            expect(response).to eq(fakePostcard)
+            expect(response.id).to eq(fakePostcard.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+
+            allow(postcardApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = postcardApi.get("psc_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an postcard" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+            fakePostcard = Postcard.new
+
+            fakePostcard.id = "psc_fakeId"
+            allow(postcardApi).to receive(:get) { fakePostcard }
+            response = postcardApi.get(fakePostcard.id)
+
+            expect(response).to eq(fakePostcard)
+            expect(response.id).to eq(fakePostcard.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+
+            allow(postcardApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = postcardApi.list()
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["before", nil, "before", nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["after", nil, nil, "after", nil, nil, nil, nil, nil, nil, nil, nil],
+            ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil, nil, nil, nil, nil, nil],
+            ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil, nil, nil, nil, nil],
+            ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }, nil, nil, nil, nil, nil],
+            ["size", nil, nil, nil, nil, nil, nil, "6x11", nil, nil, nil, nil],
+            ["scheduled", nil, nil, nil, nil, nil, nil, nil, true, nil, nil, nil],
+            ["send_date", nil, nil, nil, nil, nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil],
+            ["mail_type", nil, nil, nil, nil, nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil],
+            ["sort_by", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, SortByDateModified.new(date_modified: "asc")],
+        ].each do |which_param, limit, before, after, include_param, date_created, metadata, size, scheduled, send_date, mail_type, sort_by|
+            it "lists postcards #{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
+
+                if size then
+                    args["size"] = size
+                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
+
+                postcardApiMock = double("ApiClient")
+                postcardApi = PostcardsApi.new(postcardApiMock)
+                postcardEditable = PostcardEditable.new
+                fakePostcards = Array.new(2) { Postcard.new }
+
+                fakePostcards[0].id = "psc_fakeId"
+                allow(postcardApi).to receive(:list) { fakePostcards }
+                response = postcardApi.list(args)
+
+                expect(response.length()).to eq(2)
+                expect(response).to eq(fakePostcards)
+                expect(response[0].id).to eq(fakePostcards[0].id)
+            end
+        end
+    end
+
+    describe "cancel" do
+        it "handles errors returned by the api" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            postcardEditable = PostcardEditable.new
+
+            allow(postcardApi).to receive(:cancel).and_raise("exception thrown in cancel test")
+            begin
+                response = postcardApi.cancel(postcardEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in cancel test")
+            end
+        end
+
+        it "cancels a postcard" do
+            postcardApiMock = double("ApiClient")
+            postcardApi = PostcardsApi.new(postcardApiMock)
+            fakePostcardDeletion = PostcardDeletion.new
+
+            allow(postcardApi).to receive(:cancel) { fakePostcardDeletion }
+            response = postcardApi.cancel("psc_fakeId")
+
+            expect(response).to eq(fakePostcardDeletion)
+        end
+    end
+end

data/__tests__/Api/ReverseGeocodeLookup.unit.rb

@@ -0,0 +1,43 @@
+# ReverseGeocodeLookup.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "ReverseGeocodeLookupsApi" do
+
+    it "can be instantiated" do
+        reverseGeocodeLookupApiMock = double("ApiClient")
+        reverseGeocodeLookupApi = ReverseGeocodeLookupsApi.new(reverseGeocodeLookupApiMock)
+
+        expect(reverseGeocodeLookupApi).not_to be_nil
+        expect(reverseGeocodeLookupApi).to be_a_kind_of(ReverseGeocodeLookupsApi)
+    end
+
+    describe "Lookup" do
+        it "handles errors returned by the api" do
+            reverseGeocodeLookupApiMock = double("ApiClient")
+            reverseGeocodeLookupApi = ReverseGeocodeLookupsApi.new(reverseGeocodeLookupApiMock)
+            location = Location.new
+
+            allow(reverseGeocodeLookupApi).to receive(:lookup).and_raise("exception thrown in lookup test")
+            begin
+                response = reverseGeocodeLookupApi.lookup(location)
+            rescue => err
+                expect(err.message).to eq("exception thrown in lookup test")
+            end
+        end
+
+        it "lookup an address" do
+            reverseGeocodeLookupApiMock = double("ApiClient")
+            reverseGeocodeLookupApi = ReverseGeocodeLookupsApi.new(reverseGeocodeLookupApiMock)
+            location = Location.new
+            reverseGeocode = ReverseGeocode.new
+            reverseGeocode.id = "us_reverse_geocode_fakeId"
+
+            allow(reverseGeocodeLookupApi).to receive(:lookup) { reverseGeocode }
+            response = reverseGeocodeLookupApi.lookup(location, { size: 6 })
+
+            expect(response.id).to eq("us_reverse_geocode_fakeId")
+        end
+    end
+end

data/__tests__/Api/SelfMailer.unit.rb

@@ -0,0 +1,190 @@
+# SelfMailer.unit.rb
+
+include Lob
+$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
+
+RSpec.describe "SelfMailersApi" do
+
+    it "can be instantiated" do
+        selfMailerApiMock = double("ApiClient")
+        selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+
+        expect(selfMailerApi).not_to be_nil
+        expect(selfMailerApi).to be_a_kind_of(SelfMailersApi)
+    end
+
+    describe "Create" do
+        it "handles errors returned by the api" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerEditable = SelfMailerEditable.new
+
+            allow(selfMailerApi).to receive(:create).and_raise("exception thrown in create test")
+            begin
+                response = selfMailerApi.create(selfMailerEditable)
+            rescue => err
+                expect(err.message).to eq("exception thrown in create test")
+            end
+        end
+
+        it "creates a new self mailer" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerEditable = SelfMailerEditable.new
+            fakeSelfMailer = SelfMailer.new
+
+            fakeSelfMailer.id = "sfm_fakeId"
+            allow(selfMailerApi).to receive(:create) { fakeSelfMailer }
+            response = selfMailerApi.create(selfMailerEditable)
+
+            expect(response).to eq(fakeSelfMailer)
+            expect(response.id).to eq(fakeSelfMailer.id)
+        end
+    end
+
+    describe "Get" do
+        it "handles errors returned by the api" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerEditable = SelfMailerEditable.new
+
+            allow(selfMailerApi).to receive(:get).and_raise("exception thrown in get test")
+            begin
+                response = selfMailerApi.get("sfm_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        it "retrieves an self mailer" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerEditable = SelfMailerEditable.new
+            fakeSelfMailer = SelfMailer.new
+
+            fakeSelfMailer.id = "sfm_fakeId"
+            allow(selfMailerApi).to receive(:get) { fakeSelfMailer }
+            response = selfMailerApi.get(fakeSelfMailer.id)
+
+            expect(response).to eq(fakeSelfMailer)
+            expect(response.id).to eq(fakeSelfMailer.id)
+        end
+    end
+
+    describe "List" do
+        it "handles errors returned by the api" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerEditable = SelfMailerEditable.new
+
+            allow(selfMailerApi).to receive(:list).and_raise("exception thrown in get test")
+            begin
+                response = selfMailerApi.list()
+            rescue => err
+                expect(err.message).to eq("exception thrown in get test")
+            end
+        end
+
+        [
+            [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["limit", 2, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["before", nil, "before", nil, nil, nil, nil, nil, nil, nil, nil, nil],
+            ["after", nil, nil, "after", nil, nil, nil, nil, nil, nil, nil, nil],
+            ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil, nil, nil, nil, nil, nil],
+            ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil, nil, nil, nil, nil],
+            ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }, nil, nil, nil, nil, nil],
+            ["size", nil, nil, nil, nil, nil, nil, "11x9_bifold", nil, nil, nil, nil],
+            ["scheduled", nil, nil, nil, nil, nil, nil, nil, true, nil, nil, nil],
+            ["send_date", nil, nil,nil, nil, nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil, nil],
+            ["mail_type", nil, nil, nil, nil, nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil],
+            ["sort_by", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, SortByDateModified.new(date_modified: "asc")],
+        ].each do |which_param, limit, before, after, include_param, date_created, metadata, size, scheduled, send_date, mail_type, sort_by|
+            it "lists selfMailers #{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
+
+                if size then
+                    args["size"] = size
+                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
+
+                selfMailerApiMock = double("ApiClient")
+                selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+                selfMailerEditable = SelfMailerEditable.new
+                fakeSelfMailers = Array.new(2) { SelfMailer.new }
+
+                fakeSelfMailers[0].id = "sfm_fakeId"
+                allow(selfMailerApi).to receive(:list) { fakeSelfMailers }
+                response = selfMailerApi.list(args)
+
+                expect(response.length()).to eq(2)
+                expect(response).to eq(fakeSelfMailers)
+                expect(response[0].id).to eq(fakeSelfMailers[0].id)
+            end
+        end
+    end
+
+    describe "Delete" do
+        it "handles errors returned by the api" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+
+            allow(selfMailerApi).to receive(:delete).and_raise("exception thrown in delete test")
+            begin
+                response = selfMailerApi.delete("sfm_fakeId")
+            rescue => err
+                expect(err.message).to eq("exception thrown in delete test")
+            end
+        end
+
+        it "deletes a self mailer" do
+            selfMailerApiMock = double("ApiClient")
+            selfMailerApi = SelfMailersApi.new(selfMailerApiMock)
+            selfMailerDeletion = SelfMailerDeletion.new
+
+            selfMailerDeletion.deleted = true
+            allow(selfMailerApi).to receive(:delete) { selfMailerDeletion }
+            response = selfMailerApi.delete("sfm_fakeId")
+
+            expect(response).to eq(selfMailerDeletion)
+            expect(response.deleted).to eq(true)
+        end
+    end
+end