lob 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8225f20dd05a0f5b903f986a88f5e93254dec38e28361076a9724cfef0c50661
-  data.tar.gz: d0e4ccd13e9bd6f5b9b4010f48a7b6e9f2926c57de5a6a914d4f6153ecfd43a0
+SHA1:
+  metadata.gz: 82cb4d2c08d73f1a0c9a9f894e9ab667d9fb21c7
+  data.tar.gz: 21ee072bff001b317e143c816c1846ea5862c328
 SHA512:
-  metadata.gz: 7f21d43ad6e066f4c94d00365d92bc155947bd4c56c2b0794aebfcecd75cd9f5189dab7583a39585eedc8060a788d0fa20ee6111097291ddefb06ef7f38ae37e
-  data.tar.gz: c8df84c18215df4af65573cd1109b80d6bb053160a5958a867cfc5ab0bfcf3b09f9bb568c2235e4830a1c270f69512ae9727ea2704312316043e1d6073fdf581
+  metadata.gz: c2dbc48bdf335100921f6e0310a151142c08f58afe123837dd0782fd043f232f6cd952447f8ab67ca32db5f93d2e3a48de0877f462b572bdfff03bf8749ad78d
+  data.tar.gz: 4909bb74ee1dcf52dcbd35bc0ececa581766d7cac52e2c982811fb3ff002cbfc0023ff6318772d3a64289fc4cd728060d0c718bda292f20c5469904305698d8c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 5.0.0
+
+Version 5.0.0 introduces a breaking change. It removes support for the area mail resources (`Areas` and `Routes`).
+
+* Removes `Lob.areas`.
+* Removes `Lob.routes`.
+
 ## [**4.3.0**](https://github.com/lob/lob-ruby/releases/tag/v4.3.0)
 - [**171**](https://github.com/lob/lob-ruby/pull/171) add USAutocompletions
 - [**170**](https://github.com/lob/lob-ruby/pull/170) Fix test name

data/README.md

@@ -28,7 +28,6 @@ Here's a general overview of the Lob services available, click through to read m
 - [Postcards API](https://lob.com/services/postcards)
 - [Letters API](https://lob.com/services/letters)
 - [Checks API](https://lob.com/services/checks)
-- [Area Mail API](https://lob.com/services/area)
 - [Address Verification API](https://lob.com/services/verifications)
 
 Please read through the official [API Documentation](#api-documentation) to get a complete sense of what to expect from each endpoint.
@@ -169,16 +168,6 @@ There are simple scripts to demonstrate how to create all the core Lob objects (
     - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
     - [Verify a Bank Account](https://lob.com/docs/ruby#bankaccounts_verify)
     - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
-- **Area Mail API**
-  - [Areas](https://lob.com/docs/ruby#areas)
-    - [The Area Object](https://lob.com/docs/ruby#areas_object)
-    - [Create an Area Mailing](https://lob.com/docs/ruby#areas_create)
-    - [Retrieve an Area Mailing](https://lob.com/docs/ruby#areas_retrieve)
-    - [List all Area Mailings](https://lob.com/docs/ruby#areas_list)
-  - [Routes](https://lob.com/docs/ruby#routes)
-    - [The Routes Object](https://lob.com/docs/ruby#routes_object)
-    - [Retrieve Routes](https://lob.com/docs/ruby#routes_retrieve)
-    - [List all Routes](https://lob.com/docs/ruby#routes_list)
 - **Appendix**
   - [API Changelog](https://lob.com/docs/ruby#changelog)
   - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)

data/lib/lob/client.rb

@@ -1,11 +1,9 @@
 require "lob/resources/address"
-require "lob/resources/area"
 require "lob/resources/bank_account"
 require "lob/resources/check"
 require "lob/resources/intl_verifications"
 require "lob/resources/letter"
 require "lob/resources/postcard"
-require "lob/resources/route"
 require "lob/resources/us_autocompletions"
 require "lob/resources/us_verifications"
 require "lob/resources/us_zip_lookups"
@@ -23,10 +21,6 @@ module Lob
       @config = config
     end
 
-    def areas
-      Lob::Resources::Area.new(config)
-    end
-
     def addresses
       Lob::Resources::Address.new(config)
     end
@@ -51,10 +45,6 @@ module Lob
       Lob::Resources::Postcard.new(config)
     end
 
-    def routes
-      Lob::Resources::Route.new(config)
-    end
-
     def us_autocompletions
       Lob::Resources::USAutocompletions.new(config)
     end

data/lib/lob/version.rb

@@ -1,3 +1,3 @@
 module Lob
-  VERSION = "4.3.0"
+  VERSION = "5.0.0"
 end

data/spec/lob/resources/resource_base_spec.rb

@@ -14,10 +14,6 @@ describe Lob::Resources::ResourceBase do
     end
   end
 
-  it "should return areas resource" do
-    subject.areas.must_be_kind_of(Lob::Resources::Area)
-  end
-
   it "should return addresses resource" do
     subject.addresses.must_be_kind_of(Lob::Resources::Address)
   end
@@ -38,10 +34,6 @@ describe Lob::Resources::ResourceBase do
     subject.postcards.must_be_kind_of(Lob::Resources::Postcard)
   end
 
-  it "should return routes resource" do
-    subject.routes.must_be_kind_of(Lob::Resources::Route)
-  end
-
   it "should accept an idempotency_key" do
     sample_address_params = {
       name:    "TestAddress",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -177,14 +177,12 @@ files:
 - lib/lob/errors/invalid_request_error.rb
 - lib/lob/errors/lob_error.rb
 - lib/lob/resources/address.rb
-- lib/lob/resources/area.rb
 - lib/lob/resources/bank_account.rb
 - lib/lob/resources/check.rb
 - lib/lob/resources/intl_verifications.rb
 - lib/lob/resources/letter.rb
 - lib/lob/resources/postcard.rb
 - lib/lob/resources/resource_base.rb
-- lib/lob/resources/route.rb
 - lib/lob/resources/us_autocompletions.rb
 - lib/lob/resources/us_verifications.rb
 - lib/lob/resources/us_zip_lookups.rb
@@ -192,14 +190,12 @@ files:
 - lob.gemspec
 - spec/lob/errors/lob_error_spec.rb
 - spec/lob/resources/address_spec.rb
-- spec/lob/resources/area_spec.rb
 - spec/lob/resources/bank_account_spec.rb
 - spec/lob/resources/check_spec.rb
 - spec/lob/resources/intl_verifications_spec.rb
 - spec/lob/resources/letter_spec.rb
 - spec/lob/resources/postcard_spec.rb
 - spec/lob/resources/resource_base_spec.rb
-- spec/lob/resources/route_spec.rb
 - spec/lob/resources/us_autocompletions_spec.rb
 - spec/lob/resources/us_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb
@@ -228,21 +224,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax
 test_files:
 - spec/lob/errors/lob_error_spec.rb
 - spec/lob/resources/address_spec.rb
-- spec/lob/resources/area_spec.rb
 - spec/lob/resources/bank_account_spec.rb
 - spec/lob/resources/check_spec.rb
 - spec/lob/resources/intl_verifications_spec.rb
 - spec/lob/resources/letter_spec.rb
 - spec/lob/resources/postcard_spec.rb
 - spec/lob/resources/resource_base_spec.rb
-- spec/lob/resources/route_spec.rb
 - spec/lob/resources/us_autocompletions_spec.rb
 - spec/lob/resources/us_verifications_spec.rb
 - spec/lob/resources/us_zip_lookups_spec.rb

data/lib/lob/resources/area.rb

@@ -1,16 +0,0 @@
-require "lob/resources/resource_base"
-
-module Lob
-  module Resources
-    class Area < Lob::Resources::ResourceBase
-
-      undef_method :destroy
-
-      def initialize(config)
-        super(config)
-        @endpoint = "areas"
-      end
-
-    end
-  end
-end

data/lib/lob/resources/route.rb

@@ -1,33 +0,0 @@
-require "lob/resources/resource_base"
-
-module Lob
-  module Resources
-    class Route < Lob::Resources::ResourceBase
-
-      undef_method :create, :destroy
-
-      def initialize(config)
-        super(config)
-        @endpoint = "routes"
-      end
-
-      def list(options = {})
-        if options.is_a?(String)
-          request = {
-            method: :get,
-            url: resource_url(options)
-          }
-        else
-          request = {
-            method: :get,
-            url: endpoint_url,
-            query: options
-          }
-        end
-
-        submit request
-      end
-
-    end
-  end
-end

data/spec/lob/resources/area_spec.rb

@@ -1,59 +0,0 @@
-require "spec_helper"
-
-describe Lob::Resources::Area do
-  before :each do
-    @sample_area_params = {
-      description: "Test Area",
-      front: "https://s3-us-west-2.amazonaws.com/lob-assets/areafront.pdf",
-      back: "https://s3-us-west-2.amazonaws.com/lob-assets/areaback.pdf",
-      routes: ["94158-C001", "94107-C031"],
-    }
-  end
-
-  subject { Lob::Client.new(api_key: API_KEY) }
-
-  describe "list" do
-    it "should list areas" do
-      assert subject.areas.list["object"] == "list"
-    end
-  end
-
-  describe "create" do
-    it "should create an area object" do
-      result = subject.areas.create @sample_area_params
-
-      result["object"].must_equal("area")
-    end
-
-    it "should create an area object with optionals params" do
-      @sample_area_params[:target_type] = "all"
-
-      result = subject.areas.create @sample_area_params
-
-      result["description"].must_equal @sample_area_params[:description]
-    end
-
-    it "should create an area object with a single route" do
-      @sample_area_params[:routes] = "94158-C001"
-      result = subject.areas.create @sample_area_params
-
-      result["object"].must_equal("area")
-    end
-
-    it "should create an area object with zip_codes" do
-      @sample_area_params[:routes] = ["94158"];
-      result = subject.areas.create @sample_area_params
-
-      result["object"].must_equal("area")
-    end
-  end
-
-  describe "find" do
-    it "should find an area" do
-      new_area = subject.areas.create @sample_area_params
-
-      result = subject.areas.find new_area["id"]
-      result["object"].must_equal("area")
-    end
-  end
-end

data/spec/lob/resources/route_spec.rb

@@ -1,39 +0,0 @@
-require "spec_helper"
-
-describe Lob::Resources::Route do
-
-  subject { Lob::Client.new(api_key: API_KEY) }
-
-  describe "find" do
-
-    it "should fetch a route" do
-      zip_code = "94158"
-      routes = subject.routes.find(zip_code)
-      routes["zip_code"].must_equal(zip_code)
-    end
-
-  end
-
-  describe "list" do
-
-    it "should list routes" do
-      zip_code = "94158"
-      routes = subject.routes.list(zip_codes: zip_code)
-      routes["data"][0]["zip_code"].must_equal(zip_code)
-    end
-
-    it "should accept a single ZIP code as input" do
-      zip_code = "94158"
-      routes = subject.routes.list(zip_code)
-      routes["zip_code"].must_equal(zip_code)
-    end
-
-    it "should list routes given multiple zip codes" do
-      zip_codes = ["94107", "94158"]
-      routes = subject.routes.list(zip_codes: zip_codes)
-      routes["data"][0]["zip_code"].must_equal(zip_codes[0])
-    end
-
-  end
-
-end