lob 1.3.1 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b1bd25b6896a7a20910ff62e4aecb86cc73877
-  data.tar.gz: 6e52736c7c0b7f380bb841d659d3c9372137ef07
+  metadata.gz: 73c25870f258cf39d0d433b254712629a7ca7e91
+  data.tar.gz: 6c7b1d259b1e8d8ee8f48398ac03290608d567a7
 SHA512:
-  metadata.gz: e4243be1598476f54d6eda19a384a66da23b258e702d9c39dbb3f164038eda1de726ce195916b1308767385c3a4dd497cf6137af8b594f5b398d223bd6c9eea8
-  data.tar.gz: 17e5b1d1118920e1026dac87382c610f5e0ef602bc8412bfda38cdf4b91fcbb9b667f0fd88bc2dfa95b8c95bbb65a6ebe0d50d0dfc26d86098a535353ee21957
+  metadata.gz: 08df0587f62aa357c84323426dbc3cb81906be0c56a888fd5c283222ef29734373ac775e27722911525669554476545bd028ede36fa313c1dfee2c5258522151
+  data.tar.gz: 97597db31774db70091e0dc49f2a6e71ab1a9ce28545e4c34a715094b4aa97dfed4252b9f91721ca7ae92ac95777b117f1085cb594f994c1e8871387b1f56e2f

data/README.md

@@ -1,8 +1,6 @@
 # lob-ruby
 
-[![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby) [![Gem Version](https://badge.fury.io/rb/lob.svg)](http://badge.fury.io/rb/lob) [![Dependency Status](https://gemnasium.com/lob/lob-ruby.svg)](https://gemnasium.com/lob/lob-ruby)
-
-[![Coverage Status](https://img.shields.io/coveralls/lob/lob-ruby.svg)](https://coveralls.io/r/lob/lob-ruby?branch=master)
+[![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby) [![Gem Version](https://badge.fury.io/rb/lob.svg)](http://badge.fury.io/rb/lob) [![Dependency Status](https://gemnasium.com/lob/lob-ruby.svg)](https://gemnasium.com/lob/lob-ruby) [![Coverage Status](https://img.shields.io/coveralls/lob/lob-ruby.svg)](https://coveralls.io/r/lob/lob-ruby?branch=master) ![](http://ruby-gem-downloads-badge.herokuapp.com/lob?color=green)
 
 Ruby wrapper for the [Lob.com](http://lob.com) API. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
 
@@ -41,12 +39,22 @@ The Ruby interpreter assumes it's not of base-10 and tries to convert it to base
 # To initialize a Lob object
 @lob = Lob(api_key: "your-api-key")
 
-
 # Alternatively, to set the API key for all calls in the future
 Lob.api_key = "your-api-key"
 @lob = Lob()   # don't forget the paranthesis!
 ```
 
+### Alternatively, you can use initialize and configure like this
+
+```ruby
+# To initialize a Lob object
+@lob = Lob.load(api_key: "your-api-key")
+
+# Alternatively, to set the API key for all calls in the future
+Lob.api_key = "your-api-key"
+@lob = Lob.load
+```
+
 #### Or if you want some detailed configuration
 
 ```ruby
@@ -369,6 +377,64 @@ You'll have to specify either the `message` option or the `back` option.
 @lob.postcards.find("post-card-id")
 ```
 
+### Simple Area Mail
+
+#### Create areas
+
+You'll have to specify front, back, and either zip_codes or routes
+
+```ruby
+# create an area request with routes
+@lob.area.create(
+  name: "My Area",
+  front: "https://www.lob.com/areafront.pdf",
+  back: "https://www.lob.com/areaback.pdf",
+  routes: ["94158-C001", "94107-C031"],
+  target_type: "all",
+  full_blled = "1"
+)
+
+# create an area request with zip_codes
+@lob.area.create(
+  name: "My Area",
+  front: "https://www.lob.com/areafront.pdf",
+  back: "https://www.lob.com/areaback.pdf",
+  zip_codes: ["95678", "94158"],
+  target_type: "all",
+  full_blled = "1"
+)
+```
+
+zip_codes and routes can be a string or an array of strings
+
+#### List areas
+```ruby
+  @lob.areas.list
+
+  # you can also pass count and offset
+  @lob.areas.list(count: 10, offset: 3)
+```
+
+
+#### Find an area
+```ruby
+@lob.areas.find("area_id")
+```
+
+### Routes
+
+You'll have to specify zip_codes
+
+#### Find routes
+
+```ruby
+@lob.routes.find(
+  zip_codes: ["95678, 94158"]
+)
+```
+
+zip_codes can be a string or an array of strings
+
 ### Services
 
 #### List services

data/lib/lob.rb

@@ -1,18 +1,9 @@
 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"
-require "lob/v1/country"
-require "lob/v1/check"
-require "lob/v1/bank_account"
+
+# Dynamically require files
+Dir[File.join(File.dirname(__FILE__), 'lob', 'v*', '*.rb')].each {|file| require file }
 
 module Lob
 
@@ -30,7 +21,6 @@ module Lob
     alias :config :configure
   end
 
-
   def self.require_options(options, *keys)
     keys.each do |key|
       raise ArgumentError.new(":#{key} is required") unless options.key?(key)
@@ -63,6 +53,9 @@ module Lob
   # :nocov:
   end
 
+  def self.load(options={})
+    Lob(options)
+  end
 end
 
 
@@ -72,10 +65,13 @@ def Lob(options={})
   options[:api_version]  ||= Lob.api_version || "v1"
   options[:api_key]      ||= Lob.api_key
 
-  unless options[:api_key]
+  if options[:api_key].nil?
     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}").const_get("Resource").new(options)
+  if Dir[File.join(File.dirname(__FILE__), 'lob', options[:api_version])].empty?
+    raise Lob::VersionInvalidError.new("api version #{options[:api_version]} doesn't exist")
+  end
+
+  Lob.const_get(options[:api_version].capitalize).const_get("Resource").new(options)
 end

data/lib/lob/lob_error.rb

@@ -1,4 +1,6 @@
 module Lob
   class Error < StandardError
   end
+  class VersionInvalidError < StandardError
+  end
 end

data/lib/lob/v1/area.rb

@@ -0,0 +1,27 @@
+module Lob
+  module V1
+    class Area
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options = {})
+        Lob.submit(:get, area_url, options)["data"] || []
+      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/object.rb

@@ -6,7 +6,7 @@ module Lob
         @resource = resource
       end
 
-      def list(options={})
+      def list(options = {})
         Lob.submit(:get, object_url, options)["data"] || []
       end
 

data/lib/lob/v1/resource.rb

@@ -8,6 +8,10 @@ module Lob
         @options = options
       end
 
+      def areas
+        Lob::V1::Area.new(self)
+      end
+
       def addresses
         Lob::V1::Address.new(self)
       end
@@ -28,6 +32,10 @@ module Lob
         Lob::V1::Postcard.new(self)
       end
 
+      def routes
+        Lob::V1::Route.new(self)
+      end
+
       def services
         Lob::V1::Service.new(self)
       end

data/lib/lob/v1/route.rb

@@ -0,0 +1,19 @@
+module Lob
+  module V1
+    class Route
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options = {})
+        Lob.submit(:get, route_url, options)["data"] || []
+      end
+
+      private
+
+      def route_url(route_id = nil)
+        @resource.construct_url("routes", route_id)
+      end
+    end
+  end
+end

data/lob.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "lob"
-  spec.version       = "1.3.1"
+  spec.version       = "1.4"
   spec.authors       = ["Lob"]
   spec.email         = ["support@lob.com"]
   spec.description   = %q{Lob API Ruby wrapper}

data/spec/lob/v1/area_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+
+describe Lob::V1::Area do
+  before :each do
+    @sample_area_params = {
+      front: "https://www.lob.com/areafront.pdf",
+      back: "https://www.lob.com/areaback.pdf",
+      routes: ["94158-C001", "94107-C031"],
+    }
+  end
+
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list areas" do
+      VCR.use_cassette('list_areas') do
+        @sample_area_params[:name] = "Test Area"
+        new_area = subject.areas.create @sample_area_params
+
+        list_result = subject.areas.list
+
+        assert /#{new_area["name"]}/ =~ list_result.to_s
+      end
+    end
+  end
+
+  describe "create" do
+    it "should create an area object" do
+      VCR.use_cassette('create_area_object') do
+        result = subject.areas.create @sample_area_params
+
+        result["object"].must_equal("area")
+      end
+    end
+
+    it "should create an area object with optionals params" do
+      VCR.use_cassette('create_area_object_with_optional_params') do
+        @sample_area_params[:name] = "123456789"
+        @sample_area_params[:target_type] = "all"
+        @sample_area_params[:full_bleed] = "1"
+
+        result = subject.areas.create @sample_area_params
+
+        result["name"].must_equal @sample_area_params[:name]
+        result["target_type"].must_equal @sample_area_params[:target_type]
+        # TODO this should be added when Lob API is updated
+        # result["full_bleed"].must_equal(@sample_area_params[:full_bleed])
+      end
+    end
+
+    it "should create an area object with a single route" do
+      VCR.use_cassette('create_area_object_with_single_route') do
+        @sample_area_params[:routes] = "94158-C001"
+        result = subject.areas.create @sample_area_params
+
+        result["object"].must_equal("area")
+      end
+    end
+
+    it "should create an area object with zip_codes" do
+      VCR.use_cassette('create_area_object_with_zip') do
+        @sample_area_params.delete("routes")
+        @sample_area_params[:zip_codes] = "94158"
+        result = subject.areas.create @sample_area_params
+
+        result["object"].must_equal("area")
+      end
+    end
+
+    it "should error without routes required params" do
+      VCR.use_cassette('create_area_object_with_zip') do
+        @sample_area_params.delete("routes")
+        @sample_area_params[:zip_codes] = "94158"
+        result = subject.areas.create @sample_area_params
+
+        result["object"].must_equal("area")
+      end
+    end
+  end
+
+  describe "find" do
+    it "should find an area" do
+      VCR.use_cassette('find_area') do
+        @sample_area_params[:name] = "Test Area"
+        new_area = subject.areas.create @sample_area_params
+
+        result = subject.areas.find new_area["id"]
+        result["name"].must_equal @sample_area_params[:name]
+      end
+    end
+  end
+end

data/spec/lob/v1/route_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Lob::V1::Route do
+  subject { Lob(api_key: ENV["LOB_API_KEY"], api_version: "v1") }
+
+  describe "list" do
+    it "should list routes" do
+      VCR.use_cassette("list_routes") do
+        routes = subject.routes.list(
+          zip_codes: "94158"
+        )
+
+        routes[0]["zip_code"].must_equal("94158")
+      end
+    end
+  end
+end

data/spec/lob_spec.rb

@@ -1,19 +1,12 @@
 require "spec_helper"
 
-module Lob
-  module Test
-    class Resource
-      attr_accessor :options
-      def initialize(options)
-        @options = options
-      end
-    end
+describe Lob do
+  it "should return the resource object for the valid version" do
+    Lob(api_key: "test", api_version: "v1").must_be_kind_of(Lob::V1::Resource)
   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)
+  it "should raise an error if the version doesn't exist" do
+    ->{Lob(api_key: "test", api_version: "test")}.must_raise(Lob::VersionInvalidError)
   end
 
   it "should raise an error if API key is not passed as an option or set on module" do
@@ -43,4 +36,18 @@ describe Lob do
     Lob.protocol.must_equal "https"
     Lob.api_host.must_equal "api.lob.com"
   end
+
+  it "should work with Lob.load" do
+    Lob.load(api_key: "test").options[:api_key].must_equal "test"
+
+    Lob.api_key = "test"
+    Lob.load.wont_be_nil
+
+    Lob.api_key = nil  # make sure API key is nil
+    ->{ Lob.load }.must_raise(ArgumentError)
+
+    ->{Lob.load(api_key: "test", api_version: "test")}.must_raise(Lob::VersionInvalidError)
+
+    Lob.load(api_key: "test", api_version: "v1").must_be_kind_of(Lob::V1::Resource)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lob
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: '1.4'
 platform: ruby
 authors:
 - Lob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -152,6 +152,7 @@ files:
 - lib/lob.rb
 - lib/lob/lob_error.rb
 - lib/lob/v1/address.rb
+- lib/lob/v1/area.rb
 - lib/lob/v1/bank_account.rb
 - lib/lob/v1/check.rb
 - lib/lob/v1/country.rb
@@ -160,10 +161,12 @@ files:
 - lib/lob/v1/packaging.rb
 - lib/lob/v1/postcard.rb
 - lib/lob/v1/resource.rb
+- lib/lob/v1/route.rb
 - lib/lob/v1/service.rb
 - lib/lob/v1/setting.rb
 - lob.gemspec
 - spec/lob/v1/address_spec.rb
+- spec/lob/v1/area_spec.rb
 - spec/lob/v1/bank_account_spec.rb
 - spec/lob/v1/check_spec.rb
 - spec/lob/v1/country_spec.rb
@@ -172,6 +175,7 @@ files:
 - spec/lob/v1/packaging_spec.rb
 - spec/lob/v1/postcard_spec.rb
 - spec/lob/v1/resource_spec.rb
+- spec/lob/v1/route_spec.rb
 - spec/lob/v1/service_spec.rb
 - spec/lob/v1/setting_spec.rb
 - spec/lob_spec.rb
@@ -202,6 +206,7 @@ specification_version: 4
 summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax
 test_files:
 - spec/lob/v1/address_spec.rb
+- spec/lob/v1/area_spec.rb
 - spec/lob/v1/bank_account_spec.rb
 - spec/lob/v1/check_spec.rb
 - spec/lob/v1/country_spec.rb
@@ -210,6 +215,7 @@ test_files:
 - spec/lob/v1/packaging_spec.rb
 - spec/lob/v1/postcard_spec.rb
 - spec/lob/v1/resource_spec.rb
+- spec/lob/v1/route_spec.rb
 - spec/lob/v1/service_spec.rb
 - spec/lob/v1/setting_spec.rb
 - spec/lob_spec.rb