lob 1.0.2

data/lib/lob.rb

@@ -0,0 +1,68 @@
+require "rest-client"
+require "json"
+
+require "lob/lob_error"
+require "lob/v1/resource"
+require "lob/v1/address"
+require "lob/v1/job"
+require "lob/v1/object"
+require "lob/v1/packaging"
+require "lob/v1/postcard"
+require "lob/v1/service"
+require "lob/v1/setting"
+
+
+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.require_options(options, *keys)
+    keys.each do |key|
+      raise ArgumentError.new(":#{key} is required") unless options.key?(key)
+    end
+  end
+
+
+  def self.submit(method, url, parameters={})
+    parameters = {:params => parameters} if method == :get
+    JSON(RestClient.send(method, url, parameters))
+  rescue => e
+    error_message = nil
+    raise e unless e.respond_to? :http_body
+    begin
+      error_message = JSON(e.http_body)["errors"].first.values.first
+    rescue
+      raise e
+    end
+    raise Lob::Error.new(error_message)
+  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 || "v1"
+  options[:api_key]      ||= Lob.api_key
+
+  unless options[:api_key]
+    raise ArgumentError.new(":api_key is a required argument to initialize Lob")
+  end
+
+  #TODO check if the version exists first
+  Lob.const_get("#{options[:api_version].capitalize}::Resource").new(options)
+end

data/lob.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "lob"
+  spec.version       = "1.0.2"
+  spec.authors       = ["Akash Manohar J"]
+  spec.email         = ["akash@akash.im"]
+  spec.description   = %q{Lob API Ruby wrapper}
+  spec.summary       = %q{Ruby wrapper for Lob.com API with ActiveRecord-style syntax}
+  spec.homepage      = "https://github.com/lob/lob-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", ">= 0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/spec/lob/v1/address_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Lob::V1::Address do
+
+  before :all do
+    @sample_params = {
+      name:    "Test",
+      email:   "test@test.com",
+      address_line1: "220 WILLIAM T MORRISSEY BLVD",
+      city:    "Boston",
+      state:   "MA",
+      country: "USA",
+      zip:     02125
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "verify" do
+    it "should verify an address" do
+      VCR.use_cassette('verify_address') do
+        result = subject.addresses.verify(
+          address_line1: @sample_params[:address_line1],
+          city:  @sample_params[:city],
+          state: @sample_params[:state],
+          zip:   @sample_params[:zip]
+        )
+
+        result["address"]["address_country"].must_equal("USA")
+      end
+    end
+  end
+
+
+  describe "list" do
+    it "should list addresses" do
+      VCR.use_cassette('list_addresses') do
+        new_address = subject.addresses.create @sample_params
+
+        list_result = subject.addresses.list
+        assert /#{new_address["name"]}/ =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create an address" do
+      VCR.use_cassette('create_address') do
+        result = subject.addresses.create @sample_params
+        result["name"].must_equal(@sample_params[:name])
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find an address" do
+      VCR.use_cassette('find_address') do
+        new_address = subject.addresses.create @sample_params
+
+        find_result = subject.addresses.find(new_address["id"])
+        find_result["name"].must_equal(@sample_params[:name])
+      end
+    end
+  end
+
+
+  describe "destroy" do
+    it "should delete an address" do
+      VCR.use_cassette('delete_address') do
+        new_address = subject.addresses.create @sample_params
+
+        delete_result = subject.addresses.destroy(new_address["id"])
+        assert /has been deleted/ =~ delete_result["message"]
+      end
+    end
+  end
+end

data/spec/lob/v1/job_spec.rb

@@ -0,0 +1,117 @@
+require "spec_helper"
+
+describe Lob::V1::Job do
+
+  before :all do
+    @sample_address_params = {
+      name:    "TestAddress",
+      email:   "test@test.com",
+      address_line1: "123 Test Street",
+      address_line2: "Unit 199",
+      city:    "Mountain View",
+      state:   "CA",
+      country: "USA",
+      zip:     94085
+    }
+
+    @sample_job_params    = { name: "TestJob" }
+    @sample_object_params = { name: "TestObject" }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+
+  describe "list" do
+    it "should list jobs" do
+      VCR.use_cassette('list_jobs') do
+        new_address = subject.addresses.create @sample_address_params
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_object_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        new_job = subject.jobs.create(
+          @sample_job_params[:name],
+          new_address["id"],
+          new_object["id"]
+        )
+
+        list_result = subject.jobs.list
+        assert /#{new_job["name"]}/ =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create a job with address_id" do
+      VCR.use_cassette('create_job_with_address_id') do
+        new_address = subject.addresses.create @sample_address_params
+
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_object_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        result = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object["id"])
+        result["name"].must_equal(@sample_job_params[:name])
+      end
+    end
+
+    it "should create a job with address params" do
+      VCR.use_cassette('create_job_with_address_params') do
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_object_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        result = subject.jobs.create(@sample_job_params[:name], @sample_address_params, new_object["id"])
+        result["name"].must_equal(@sample_job_params[:name])
+      end
+    end
+
+
+    it "should create a job with object params" do
+      VCR.use_cassette('create_job_with_object_params') do
+        new_address = subject.addresses.create @sample_address_params
+        settings_list = subject.settings.list
+        new_object_params = {
+          name:      @sample_object_params[:name],
+          file:      "https://www.lob.com/goblue.pdf",
+          setting_id: settings_list.first["id"]
+        }
+
+        result = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object_params)
+        result["name"].must_equal(@sample_job_params[:name])
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find a job" do
+      VCR.use_cassette('find_job') do
+        new_address = subject.addresses.create @sample_address_params
+
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_object_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        new_job = subject.jobs.create(@sample_job_params[:name], new_address["id"], new_object["id"])
+
+        result  = subject.jobs.find(new_job["id"])
+        result["name"].must_equal(@sample_job_params[:name])
+      end
+    end
+  end
+
+end

data/spec/lob/v1/object_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Lob::V1::Object do
+
+  before :all do
+    @sample_params = {
+      name:    "TestObject",
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+
+  describe "list" do
+    it "should list objects" do
+      VCR.use_cassette('list_objects') do
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        list_result = subject.objects.list
+        assert /#{new_object["name"]}/ =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create an object with file url" do
+      VCR.use_cassette('create_object_with_url') do
+        settings_list = subject.settings.list
+        result = subject.objects.create(
+          @sample_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        result["name"].must_equal(@sample_params[:name])
+      end
+    end
+
+    it "should create an object with file" do
+      VCR.use_cassette('create_object_with_file') do
+        settings_list = subject.settings.list
+        result = subject.objects.create(
+          @sample_params[:name],
+          File.new(File.expand_path("../../../samples/goblue.pdf", __FILE__), "rb"),
+          settings_list.first["id"]
+        )
+
+        result["name"].must_equal(@sample_params[:name])
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find an object" do
+      VCR.use_cassette('find_object') do
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        find_result = subject.objects.find(new_object["id"])
+        find_result["name"].must_equal(@sample_params[:name])
+      end
+    end
+  end
+
+
+  describe "destroy" do
+    it "should delete an object" do
+      VCR.use_cassette('delete_object') do
+        settings_list = subject.settings.list
+        new_object = subject.objects.create(
+          @sample_params[:name],
+          "https://www.lob.com/goblue.pdf",
+          settings_list.first["id"]
+        )
+
+        delete_result = subject.objects.destroy(new_object["id"])
+        assert /has been deleted/ =~ delete_result["message"]
+      end
+    end
+  end
+
+end

data/spec/lob/v1/packaging_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Lob::V1::Packaging do
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list packagings" do
+      VCR.use_cassette('list_packagings') do
+        result = subject.packagings.list
+        result.length.must_be :>, 0
+      end
+    end
+  end
+
+end

data/spec/lob/v1/postcard_spec.rb

@@ -0,0 +1,128 @@
+require "spec_helper"
+
+describe Lob::V1::Postcard do
+
+  before :all do
+    @sample_address_params = {
+      name:    "TestAddress",
+      email:   "test@test.com",
+      address_line1: "123 Test Street",
+      address_line2: "Unit 199",
+      city:    "Mountain View",
+      state:   "CA",
+      country: "USA",
+      zip:     94085
+    }
+
+    @sample_postcard_params    = {
+      name:    "TestPostcard",
+      message: "Sample postcard message"
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list postcards" do
+      VCR.use_cassette('list_postcards') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_postcard = subject.postcards.create(
+          @sample_postcard_params[:name],
+          new_address["id"],
+          front: File.new(File.expand_path("../../../samples/postcardfront.pdf", __FILE__), "rb"),
+          back: File.new(File.expand_path("../../../samples/postcardback.pdf", __FILE__), "rb")
+        )
+
+        list_result = subject.postcards.list
+        assert /#{new_postcard["name"]}/ =~ list_result.to_s
+      end
+    end
+  end
+
+
+  describe "create" do
+    it "should create a postcard with address_id" do
+      VCR.use_cassette('create_postcard_with_address_id_and_message') do
+        new_address = subject.addresses.create @sample_address_params
+
+        result = subject.postcards.create(
+          @sample_postcard_params[:name],
+          new_address["id"],
+          message: @sample_postcard_params[:message],
+          front: "https://www.lob.com/postcardfront.pdf",
+        )
+
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
+
+
+    it "should create a postcard with address params" do
+      VCR.use_cassette('create_postcard_with_address_params') do
+
+        result = subject.postcards.create(
+          @sample_postcard_params[:name],
+          @sample_address_params,
+          message: @sample_postcard_params[:message],
+          front: "https://www.lob.com/postcardfront.pdf"
+        )
+
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
+
+
+    it "should create a postcard with front and back as urls" do
+      VCR.use_cassette('create_postcard_with_front_and_back_urls') do
+        new_address = subject.addresses.create @sample_address_params
+  
+        result = subject.postcards.create(
+          @sample_postcard_params[:name],
+          new_address["id"],
+          front: "https://www.lob.com/postcardfront.pdf",
+          back:  "https://www.lob.com/postcardback.pdf"
+        )
+
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
+
+
+    it "should create a postcard with front and back as PDFs" do
+      VCR.use_cassette('create_postcard_with_front_and_back_pdfs') do
+        new_address = subject.addresses.create @sample_address_params
+  
+        result = subject.postcards.create(
+          @sample_postcard_params[:name],
+          new_address["id"],
+          front: File.new(File.expand_path("../../../samples/postcardfront.pdf", __FILE__), "rb"),
+          back: File.new(File.expand_path("../../../samples/postcardback.pdf", __FILE__), "rb")
+        )
+
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
+
+  end
+
+
+  describe "find" do
+    it "should find a postcard" do
+      VCR.use_cassette('find_postcard') do
+        new_address = subject.addresses.create @sample_address_params
+
+        new_postcard = subject.postcards.create(
+          @sample_postcard_params[:name],
+          new_address["id"],
+          front: File.new(File.expand_path("../../../samples/postcardfront.pdf", __FILE__), "rb"),
+          back: File.new(File.expand_path("../../../samples/postcardback.pdf", __FILE__), "rb")
+        )
+
+        result  = subject.postcards.find(new_postcard["id"])
+        result["name"].must_equal(@sample_postcard_params[:name])
+      end
+    end
+  end
+
+end

data/spec/lob/v1/resource_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Lob::V1::Resource do
+
+  before :all do
+    @api_key = "test"
+  end
+
+  subject { Lob(api_key: @api_key) }
+
+  describe "when Lob is initialized" do
+    it "should receive and contain default options when Lob is initialized" do
+      subject.options[:protocol].must_equal "https"
+      subject.options[:api_host].must_equal "api.lob.com"
+    end
+
+    it "should have API key in options" do
+      subject.options[:api_key].must_equal @api_key
+    end
+  end
+
+
+  it "should return addresses resource" do
+    subject.addresses.must_be_kind_of(Lob::V1::Address)
+  end
+
+  it "should return jobs resource" do
+    subject.jobs.must_be_kind_of(Lob::V1::Job)
+  end
+
+  it "should return objects resource" do
+    subject.objects.must_be_kind_of(Lob::V1::Object)
+  end
+
+  it "should return packagings resource" do
+    subject.packagings.must_be_kind_of(Lob::V1::Packaging)
+  end
+
+  it "should return postcards resource" do
+    subject.postcards.must_be_kind_of(Lob::V1::Postcard)
+  end
+
+  it "should return services resource" do
+    subject.services.must_be_kind_of(Lob::V1::Service)
+  end
+  
+  it "should return settings resource" do
+    subject.settings.must_be_kind_of(Lob::V1::Setting)
+  end
+end

data/spec/lob/v1/service_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Lob::V1::Service do
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list services" do
+      VCR.use_cassette('list_services') do
+        result = subject.services.list
+        result.length.must_be :>, 0
+      end
+    end
+  end
+
+end

data/spec/lob/v1/setting_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Lob::V1::Setting do
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list settings" do
+      VCR.use_cassette('list_settings') do
+        result = subject.settings.list
+        result.length.must_be :>, 0
+        /Document/ =~ result.to_s
+        /Poster/   =~ result.to_s
+        /Card/     =~ result.to_s
+      end
+    end
+  end
+
+
+  describe "find" do
+    it "should find a setting" do
+      VCR.use_cassette('find_setting') do
+        list_result = subject.settings.list
+        result = subject.settings.find(list_result.first["id"])
+        result["description"].must_equal(list_result.first["description"])
+      end
+    end
+  end
+end

data/spec/lob_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+module Lob
+  module Test
+    class Resource
+      attr_accessor :options
+      def initialize(options)
+        @options = options
+      end
+    end
+  end
+end
+
+
+describe Lob do
+
+  it "should return the resource object for the specified version" do
+    Lob(api_key: "test", api_version: "test").must_be_kind_of(Lob::Test::Resource)
+  end
+
+  it "should raise an error if API key is not passed as an option or set on module" do
+    Lob.api_key = nil  # make sure API key is nil
+    ->{ Lob() }.must_raise(ArgumentError)
+  end
+
+  it "should *not* raise an error if API key has been on module and not passed as option" do
+    Lob.api_key = "test"
+    Lob().wont_be_nil
+  end
+
+  it "should pass the API key to the resource for the version" do
+    Lob(api_key: "test").options[:api_key].must_equal "test"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require "lob"
+require "minitest/spec"
+require "minitest/pride"
+require "minitest/autorun"
+require "vcr"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/vcr_cassettes"
+  config.hook_into :webmock
+end
+
+VCR.use_cassette("example") do
+  RestClient.get 'https://raw.github.com/gist/3887508/b84579e450e2fb483b9b0475d938b7acd8861d15/README.md'
+end