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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/jobs.rb DELETED Viewed

@@ -1,91 +0,0 @@
-$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
-require 'open-uri'
-require 'lob'
-# initialize Lob object
-Lob.api_key = 'test_799ff27291c166d10ba191902ad02fb059c'
-@lob = Lob.load
-html = %{
-<html>
-<head>
-<title>Lob.com Sample Photo</title>
-<style>
-  *, *:before, *:after {
-    -webkit-box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    box-sizing: border-box;
-  }
-  @font-face {
-    font-family: 'Loved by the King';
-    font-style: normal;
-    font-weight: 400;
-    src: url('https://s3-us-west-2.amazonaws.com/lob-assets/LovedbytheKing.ttf') format('truetype');
-  }
-  body {
-    width: 6.25in;
-    height: 4.25in;
-    margin: 0;
-    padding: 0;
-    /* If using an image, the background image should have dimensions of 1875x1275 pixels. */
-    background-image: url(https://s3-us-west-2.amazonaws.com/lob-assets/beach.jpg);
-    background-size: 6.25in 4.25in;
-    background-repeat: no-repeat;
-  }
-  .text {
-    margin: 50px;
-    width: 400px;
-    font-family: 'Loved by the King';
-    font-size: 50px;
-    font-weight: 700;
-    color: white;
-    text-shadow: 3px 3px black;
-  }
-</style>
-</head>
-<body>
-  <h1 class="text">Hello {{name}}!</h1>
-  <p class="text">Join us for the {{event}}!</p>
-</body>
-</html>
-}
-object = @lob.objects.create(
-  description: 'Test Object',
-  file: html,
-  data: { name: "Albert", event: "Summer 2015 Beach-athon" },
-  setting: 201
-)
-# create a to address
-to_address = @lob.addresses.create(
-  name: "ToAddress",
-  address_line1: "120 6th Ave",
-  address_city: "Boston",
-  address_state: "MA",
-  address_country: "US",
-  address_zip: 12345
-)
-# create a from address
-from_address = @lob.addresses.create(
-  name: "FromAddress",
-  address_line1: "120 6th Ave",
-  address_city: "Boston",
-  address_state: "MA",
-  address_country: "US",
-  address_zip: 12345
-)
-# send the object you created
-puts @lob.jobs.create(
-  description: "Michigan Logo to Harry",
-  to: to_address["id"],
-  from: from_address["id"],
-  objects: object["id"]
-)

data/lib/lob/v1/address.rb DELETED Viewed

@@ -1,41 +0,0 @@
-module Lob
-  module V1
-    class Address
-      def initialize(resource)
-        @resource = resource
-      end
-      def verify(options={})
-        Lob.submit(:post, address_verify_url, options)
-      end
-      def list(options={})
-        Lob.submit(:get, address_url, options)
-      end
-      def find(address_id)
-        Lob.submit :get, address_url(address_id)
-      end
-      def create(options = {})
-        Lob.submit :post, address_url, options
-      end
-      def destroy(address_id)
-        Lob.submit :delete, address_url(address_id)
-      end
-      private
-      def address_url(address_id = nil)
-        @resource.construct_url("addresses", address_id)
-      end
-      def address_verify_url
-        @resource.construct_url("verify")
-      end
-    end
-  end
-end

data/lib/lob/v1/area.rb DELETED Viewed

@@ -1,27 +0,0 @@
-module Lob
-  module V1
-    class Area
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options = {})
-        Lob.submit(:get, area_url, options)
-      end
-      def find(lob_object_id)
-        Lob.submit :get, area_url(lob_object_id)
-      end
-      def create(options = {})
-        Lob.submit :post, area_url, options
-      end
-      private
-      def area_url(area_id = nil)
-        @resource.construct_url("areas", area_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/bank_account.rb DELETED Viewed

@@ -1,37 +0,0 @@
-module Lob
-  module V1
-    class BankAccount
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, bank_account_url, options)
-      end
-      def find(bank_account_id)
-        Lob.submit :get, bank_account_url(bank_account_id)
-      end
-      def create(options = {})
-        Lob.submit :post, bank_account_url, options
-      end
-      def destroy(bank_account_id)
-        Lob.submit :delete, bank_account_url(bank_account_id)
-      end
-      def verify(bank_account_id, options = {})
-        Lob.submit :post, "#{bank_account_url(bank_account_id)}/verify", options
-      end
-      private
-      def bank_account_url(bank_account_id = nil)
-        @resource.construct_url("bank_accounts", bank_account_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/check.rb DELETED Viewed

@@ -1,33 +0,0 @@
-module Lob
-  module V1
-    class Check
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, check_url, options)
-      end
-      def find(check_id)
-        Lob.submit :get, check_url(check_id)
-      end
-      def create(options = {})
-        Lob.submit :post, check_url, options
-      end
-      def destroy(check_id)
-        Lob.submit :delete, check_url(check_id)
-      end
-      private
-      def check_url(check_id = nil)
-        @resource.construct_url("checks", check_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/country.rb DELETED Viewed

@@ -1,21 +0,0 @@
-module Lob
-  module V1
-    class Country
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, country_url, options)
-      end
-      private
-      def country_url
-        @resource.construct_url("countries")
-      end
-    end
-  end
-end

data/lib/lob/v1/job.rb DELETED Viewed

@@ -1,39 +0,0 @@
-module Lob
-  module V1
-    class Job
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, job_url, options)
-      end
-      def find(job_id)
-        Lob.submit :get, job_url(job_id)
-      end
-      def create(options = {})
-        if options[:objects].is_a?(Array)
-          options[:objects].each_with_index do |object, index|
-            options["object#{index+1}"] = object
-          end
-        else
-          options["object1"] = options[:objects]
-        end
-        options.delete(:objects)
-        Lob.submit :post, job_url, options
-      end
-      private
-      def job_url(job_id = nil)
-        @resource.construct_url("jobs", job_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/letter.rb DELETED Viewed

@@ -1,33 +0,0 @@
-module Lob
-  module V1
-    class Letter
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, letter_url, options)
-      end
-      def find(letter_id)
-        Lob.submit :get, letter_url(letter_id)
-      end
-      def create(options = {})
-        Lob.submit :post, letter_url, options
-      end
-      def destroy(letter_id)
-        Lob.submit :delete, letter_url(letter_id)
-      end
-      private
-      def letter_url(job_id = nil)
-        @resource.construct_url("letters", job_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/object.rb DELETED Viewed

@@ -1,33 +0,0 @@
-module Lob
-  module V1
-    class Object
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options = {})
-        Lob.submit(:get, object_url, options)
-      end
-      def find(lob_object_id)
-        Lob.submit :get, object_url(lob_object_id)
-      end
-      def create(options = {})
-        Lob.submit :post, object_url, options
-      end
-      def destroy(lob_object_id)
-        Lob.submit :delete, object_url(lob_object_id)
-      end
-      private
-      def object_url(lob_object_id = nil)
-        @resource.construct_url("objects", lob_object_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/postcard.rb DELETED Viewed

@@ -1,33 +0,0 @@
-module Lob
-  module V1
-    class Postcard
-      def initialize(resource)
-        @resource = resource
-      end
-      def list(options={})
-        Lob.submit(:get, postcard_url, options)
-      end
-      def find(postcard_id)
-        Lob.submit :get, postcard_url(postcard_id)
-      end
-      def create(options = {})
-        Lob.submit :post, postcard_url, options
-      end
-      def destroy(postcard_id)
-        Lob.submit :delete, postcard_url(postcard_id)
-      end
-      private
-      def postcard_url(postcard_id = nil)
-        @resource.construct_url("postcards", postcard_id)
-      end
-    end
-  end
-end

data/lib/lob/v1/resource.rb DELETED Viewed

@@ -1,69 +0,0 @@
-module Lob
-  module V1
-    class Resource
-      attr_accessor :options
-      def initialize(options)
-        @options = options
-      end
-      def areas
-        Lob::V1::Area.new(self)
-      end
-      def addresses
-        Lob::V1::Address.new(self)
-      end
-      def bank_accounts
-        Lob::V1::BankAccount.new(self)
-      end
-      def checks
-        Lob::V1::Check.new(self)
-      end
-      def countries
-        Lob::V1::Country.new(self)
-      end
-      def jobs
-        Lob::V1::Job.new(self)
-      end
-      def letters
-        Lob::V1::Letter.new(self)
-      end
-      def objects
-        Lob::V1::Object.new(self)
-      end
-      def postcards
-        Lob::V1::Postcard.new(self)
-      end
-      def routes
-        Lob::V1::Route.new(self)
-      end
-      def settings
-        Lob::V1::Setting.new(self)
-      end
-      def states
-        Lob::V1::State.new(self)
-      end
-      def base_url
-        "#{@options[:protocol]}://#{@options[:api_key]}:@#{@options[:api_host]}/v1"
-      end
-      def construct_url(resource_type, resource_id=nil)
-        "#{base_url}/#{resource_type}#{'/' + resource_id if resource_id}"
-      end
-    end
-  end
-end

lob 2.5.1 → 3.0.0