RubyGems - lob - Versions diffs - 2.5.1 → 3.0.0 - Mend

lob 2.5.1 → 3.0.0

Files changed (61) hide show

checksums.yaml +4 -4
data/.travis.yml +2 -2
data/CHANGELOG.md +9 -0
data/CONTRIBUTING.md +19 -0
data/Gemfile +0 -2
data/README.md +19 -36
data/examples/README.md +14 -6
data/examples/checks.rb +6 -7
data/examples/csv_checks/create_checks.rb +47 -0
data/examples/csv_checks/input.csv +6 -0
data/examples/csv_letters/create_letters.rb +40 -0
data/examples/csv_letters/input.csv +6 -0
data/examples/csv_letters/letter_template.html +33 -0
data/examples/csv_postcards/create_postcards.rb +2 -3
data/examples/letters.rb +4 -5
data/examples/postcards.rb +4 -5
data/examples/verify/verify.rb +3 -4
data/lib/lob.rb +1 -91
data/lib/lob/client.rb +61 -0
data/lib/lob/resources/address.rb +24 -0
data/lib/lob/resources/area.rb +16 -0
data/lib/lob/resources/bank_account.rb +24 -0
data/lib/lob/resources/check.rb +14 -0
data/lib/lob/resources/country.rb +16 -0
data/lib/lob/resources/letter.rb +14 -0
data/lib/lob/resources/postcard.rb +14 -0
data/lib/lob/resources/resource_base.rb +108 -0
data/lib/lob/resources/route.rb +24 -0
data/lib/lob/resources/state.rb +16 -0
data/lib/lob/version.rb +1 -1
data/spec/lob/{v1 → resources}/address_spec.rb +15 -14
data/spec/lob/{v1 → resources}/area_spec.rb +2 -2
data/spec/lob/{v1 → resources}/bank_account_spec.rb +2 -2
data/spec/lob/{v1 → resources}/check_spec.rb +3 -2
data/spec/lob/{v1 → resources}/country_spec.rb +2 -2
data/spec/lob/{v1 → resources}/letter_spec.rb +2 -2
data/spec/lob/{v1 → resources}/postcard_spec.rb +2 -2
data/spec/lob/resources/resource_base_spec.rb +53 -0
data/spec/lob/{v1 → resources}/route_spec.rb +2 -2
data/spec/lob/{v1 → resources}/state_spec.rb +2 -2
data/spec/lob_spec.rb +12 -45
data/spec/spec_helper.rb +2 -0
metadata +86 -89
data/examples/jobs.rb +0 -91
data/lib/lob/v1/address.rb +0 -41
data/lib/lob/v1/area.rb +0 -27
data/lib/lob/v1/bank_account.rb +0 -37
data/lib/lob/v1/check.rb +0 -33
data/lib/lob/v1/country.rb +0 -21
data/lib/lob/v1/job.rb +0 -39
data/lib/lob/v1/letter.rb +0 -33
data/lib/lob/v1/object.rb +0 -33
data/lib/lob/v1/postcard.rb +0 -33
data/lib/lob/v1/resource.rb +0 -69
data/lib/lob/v1/route.rb +0 -27
data/lib/lob/v1/setting.rb +0 -25
data/lib/lob/v1/state.rb +0 -21
data/spec/lob/v1/job_spec.rb +0 -161
data/spec/lob/v1/object_spec.rb +0 -72
data/spec/lob/v1/resource_spec.rb +0 -41
data/spec/lob/v1/setting_spec.rb +0 -21

data/examples/letters.rb CHANGED Viewed

@@ -2,8 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 # initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
 html = %{
 <html>
@@ -42,7 +41,7 @@ html = %{
 }
 # create a to address
-to_address = @lob.addresses.create(
+to_address = lob.addresses.create(
   name: "ToAddress",
   address_line1: "120 6th Ave",
   address_city: "Boston",
@@ -52,7 +51,7 @@ to_address = @lob.addresses.create(
 )
 # create a from address
-from_address = @lob.addresses.create(
+from_address = lob.addresses.create(
   name: "FromAddress",
   address_line1: "120 6th Ave",
   address_city: "Boston",
@@ -62,7 +61,7 @@ from_address = @lob.addresses.create(
 )
 # send the letter
-puts @lob.letters.create(
+puts lob.letters.create(
   description: "Test letter",
   to: to_address["id"],
   from: from_address["id"],

data/examples/postcards.rb CHANGED Viewed

@@ -2,8 +2,7 @@ $:.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'lob'
 # initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
 # HTML to send to the server
 html = %{
@@ -56,7 +55,7 @@ html = %{
 }
 # create a to address
-to_address = @lob.addresses.create(
+to_address = lob.addresses.create(
   name: "ToAddress",
   address_line1: "120 6th Ave",
   address_city: "Boston",
@@ -66,7 +65,7 @@ to_address = @lob.addresses.create(
 )
 # create a from address
-from_address = @lob.addresses.create(
+from_address = lob.addresses.create(
   name: "FromAddress",
   address_line1: "120 6th Ave",
   address_city: "Boston",
@@ -76,7 +75,7 @@ from_address = @lob.addresses.create(
 )
 # send a postcard
-puts @lob.postcards.create(
+puts lob.postcards.create(
   description: "Beach Postcard",
   to: to_address["id"],
   from: from_address["id"],

data/examples/verify/verify.rb CHANGED Viewed

@@ -7,18 +7,17 @@ require 'lob'
 require 'street_address'
 # Initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
+lob = Lob::Client.new(api_key: 'test_799ff27291c166d10ba191902ad02fb059c')
 output = File.open(File.expand_path('../output.csv', __FILE__), 'w')
 output.puts ['address_line1', 'address_city', 'address_state', 'address_zip', 'address_country'].join(',')
-# Parse the CSV and create the postcards.
+# Parse the input file and verify the addresses
 File.open(File.expand_path('../input.txt', __FILE__)).each_line do |line|
   parsed_address = StreetAddress::US.parse(line)
-  verified_address = @lob.addresses.verify(
+  verified_address = lob.addresses.verify(
     address_line1: parsed_address.to_s(:line1),
     address_city: parsed_address.city,
     address_state: parsed_address.state,

data/lib/lob.rb CHANGED Viewed

@@ -1,97 +1,7 @@
-require "rest-client"
-require "json"
-require 'uri'
+require "lob/client"
 require "lob/version"
 require "lob/errors/lob_error"
 require "lob/errors/invalid_request_error"
-# Dynamically require files
-Dir[File.join(File.dirname(__FILE__), 'lob', 'v*', '*.rb')].each {|file| require file }
 module Lob
-  class << self
-    attr_accessor :api_key, :api_version, :protocol, :api_host
-    def configure
-      yield self
-      true
-    end
-    alias :config :configure
-  end
-  def self.submit(method, url, parameters={})
-    clientVersion = Lob::VERSION
-    begin
-      if method == :get || method == :delete
-        # Hack to URL encode nested objects like metadata.
-        url = "#{url}?#{build_nested_query(parameters)}"
-        response = RestClient.send(method, url, {
-          user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
-          "Lob-Version" => self.api_version
-        })
-      else
-        response = RestClient.send(method, url, parameters, {
-          user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
-          "Lob-Version" => self.api_version
-        })
-      end
-      body = JSON.parse(response)
-      body.define_singleton_method(:_response) do
-        response
-      end
-      return body
-    rescue RestClient::ExceptionWithResponse => e
-      handle_api_error(e)
-    end
-  end
-  def self.load(options={})
-    Lob(options)
-  end
-  def self.handle_api_error(error)
-    begin
-      response = JSON.parse(error.http_body.to_s)
-      message = response.fetch("error").fetch("message")
-      raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
-    rescue JSON::ParserError, KeyError
-      # :nocov:
-      raise LobError.new("Invalid response object:", error.http_code, error.http_body)
-      # :nocov:
-    end
-  end
-  def self.build_nested_query(value, prefix = nil)
-    case value
-    when Array
-      value.map { |v|
-        build_nested_query(v, "#{prefix}[]")
-      }.join("&")
-    when Hash
-      value.map { |k, v|
-        build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
-      }.reject(&:empty?).join('&')
-    else
-      raise ArgumentError, "value must be an Array or Hash" if prefix.nil?
-      "#{prefix}=#{URI.encode_www_form_component(value)}"
-    end
-  end
-end
-def Lob(options={})
-  options[:api_host]     ||= Lob.api_host    || "api.lob.com"
-  options[:protocol]     ||= Lob.protocol    || "https"
-  options[:api_version]  ||= Lob.api_version
-  options[:api_key]      ||= Lob.api_key
-  if options[:api_key].nil?
-    raise ArgumentError.new(":api_key is a required argument to initialize Lob")
-  end
-  Lob::V1::Resource.new(options)
 end

data/lib/lob/client.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require "lob/resources/address"
+require "lob/resources/area"
+require "lob/resources/bank_account"
+require "lob/resources/check"
+require "lob/resources/country"
+require "lob/resources/letter"
+require "lob/resources/postcard"
+require "lob/resources/route"
+require "lob/resources/state"
+module Lob
+  class Client
+    attr_reader :config
+    def initialize(config = nil)
+      if config.nil? || config[:api_key].nil?
+        raise ArgumentError.new(":api_key is a required argument to initialize Lob")
+      end
+      @config = config
+    end
+    def areas
+      Lob::Resources::Area.new(config)
+    end
+    def addresses
+      Lob::Resources::Address.new(config)
+    end
+    def bank_accounts
+      Lob::Resources::BankAccount.new(config)
+    end
+    def checks
+      Lob::Resources::Check.new(config)
+    end
+    def countries
+      Lob::Resources::Country.new(config)
+    end
+    def letters
+      Lob::Resources::Letter.new(config)
+    end
+    def postcards
+      Lob::Resources::Postcard.new(config)
+    end
+    def routes
+      Lob::Resources::Route.new(config)
+    end
+    def states
+      Lob::Resources::State.new(config)
+    end
+  end
+end

data/lib/lob/resources/address.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require "lob/resources/resource_base"
+module Lob
+  module Resources
+    class Address < Lob::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "addresses"
+      end
+      def verify(options={})
+        submit :post, address_verify_url, options
+      end
+      private
+      def address_verify_url
+        "#{base_url}/verify"
+      end
+    end
+  end
+end

data/lib/lob/resources/area.rb ADDED Viewed

@@ -0,0 +1,16 @@
+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/bank_account.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require "lob/resources/resource_base"
+module Lob
+  module Resources
+    class BankAccount < Lob::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "bank_accounts"
+      end
+      def verify(bank_account_id, options = {})
+        submit :post, verify_url(bank_account_id), options
+      end
+      private
+      def verify_url(bank_account_id)
+        "#{resource_url(bank_account_id)}/verify"
+      end
+    end
+  end
+end

data/lib/lob/resources/check.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require "lob/resources/resource_base"
+module Lob
+  module Resources
+    class Check < Lob::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "checks"
+      end
+    end
+  end
+end

data/lib/lob/resources/country.rb ADDED Viewed

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

data/lib/lob/resources/letter.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require "lob/resources/resource_base"
+module Lob
+  module Resources
+    class Letter < Lob::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "letters"
+      end
+    end
+  end
+end

data/lib/lob/resources/postcard.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require "lob/resources/resource_base"
+module Lob
+  module Resources
+    class Postcard < Lob::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "postcards"
+      end
+    end
+  end
+end

data/lib/lob/resources/resource_base.rb ADDED Viewed

@@ -0,0 +1,108 @@
+require "rest-client"
+require "json"
+require "uri"
+module Lob
+  module Resources
+    class ResourceBase
+      attr_reader :config, :endpoint
+      def initialize(config)
+        @config = config
+      end
+      def list(options={})
+        submit :get, endpoint_url, options
+      end
+      def find(resource_id)
+        submit :get, resource_url(resource_id)
+      end
+      def create(options = {})
+        submit :post, endpoint_url, options
+      end
+      def destroy(resource_id)
+        submit :delete, resource_url(resource_id)
+      end
+      private
+      def submit(method, url, parameters={})
+        clientVersion = Lob::VERSION
+        begin
+          if method == :get || method == :delete
+            # Hack to URL encode nested objects like metadata.
+            url = "#{url}?#{build_nested_query(parameters)}"
+            response = RestClient.send(method, url, {
+              user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
+              "Lob-Version" => config[:api_version]
+            })
+          else
+            response = RestClient.send(method, url, parameters, {
+              user_agent: 'Lob/v1 RubyBindings/' + clientVersion,
+              "Lob-Version" => config[:api_version]
+            })
+          end
+          body = JSON.parse(response)
+          body.define_singleton_method(:_response) do
+            response
+          end
+          return body
+        rescue RestClient::ExceptionWithResponse => e
+          handle_api_error(e)
+        end
+      end
+      private
+      def handle_api_error(error)
+        begin
+          response = JSON.parse(error.http_body.to_s)
+          message = response.fetch("error").fetch("message")
+          raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
+        rescue JSON::ParserError, KeyError
+          # :nocov:
+          raise LobError.new("Invalid response object:", error.http_code, error.http_body)
+          # :nocov:
+        end
+      end
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map { |v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map { |k, v|
+            build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
+          }.reject(&:empty?).join('&')
+        else
+          raise ArgumentError, "value must be an Array or Hash" if prefix.nil?
+          "#{prefix}=#{URI.encode_www_form_component(value)}"
+        end
+      end
+      def base_url
+        "https://#{config[:api_key]}:@api.lob.com/v1"
+      end
+      def endpoint_url
+        "#{base_url}/#{endpoint}"
+      end
+      def resource_url(resource_id)
+        "#{endpoint_url}/#{resource_id}"
+      end
+    end
+  end
+end