lob 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30db6f13b99ec0741402870415497e121b65aae5
+  data.tar.gz: 09cd39be27af5bc020f3da55fc05c1cf80328b69
+SHA512:
+  metadata.gz: 62d35cd4ce46eb893300f006d25e9efdeeb090a14fe5afe2bea8e4a22316a888519c668a1cb84edf6fe199f7167d50466d312934233473410ed0b5906e49b28f
+  data.tar.gz: 3db7ed010961fdb7279c82829a1cb88e155b99c0dac30b2c736be59d357dc851860ba0a3053e52f67b943a33049c7547c63ef89aa8ba1cbafb590c93d224ac4b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/vcr_cassettes/
+spec/samples/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lob.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lob.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,315 @@
+# lob-ruby
+
+Ruby wrapper for the [Lob.com](http://lob.com) API. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
+
+Supports Ruby 1.9.3 and greater.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'lob'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lob
+
+## Usage
+
+The library uses an ActiveRecord-style interface. You'll feel right at home.
+You'll need a Lob.com API key. It's free and you can get yours [here](https://www.lob.com/account).
+
+For optional parameters and other details, refer the docs here - <https://lob.com/docs>
+
+### Initialization and configuration
+
+```ruby
+# 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 = "you-api-key"
+@lob = Lob()   # don't forget the paranthesis!
+```
+
+#### Or if you want some detailed configuration
+
+```ruby
+Lob.configure do |config|
+  config.api_key = "your-api-key"  # get your own at http://lob.com :)
+  config.api_version = "v1"        # default version
+  config.protocol = "https"        # default protocol
+  config.api_host = "api.lob.com"  # ofcourse it's Lob
+end
+```
+
+### Addresses
+
+#### To create an address
+
+```ruby
+# name, address, city, state, country and zip are required parameters
+@lob.addresses.create(
+  name: "John Doe",
+  address_line1: "104, Printing Boulevard",
+  city: "Boston",
+  state: "MA",
+  country: "USA"
+  zip: 12345
+)
+
+# You can also pass address_line2
+@lob.addresses.create(
+  name: "John Doe",
+  email: "test@test.com",  # see you can also pass other optional parameters?
+  address_line1: "104, Printing Boulevard",
+  address_line2: "Sunset Town",
+  city: "Boston",
+  state: "MA",
+  country: "USA"
+  zip: 12345
+)
+```
+
+#### List addresses
+
+```ruby
+# returns an array of addresses
+@lob.addresses.list
+
+#you can also pass count and offset
+@lob.addresses.list(count: 10, offset: 3)
+```
+
+#### Find a specific address
+
+```ruby
+# returns the address with the corresponding ID
+@lob.addresses.find("some-address-id")
+```
+
+#### Deletes a specific address
+
+```ruby
+# deletes the address with the corresponding ID
+@lob.addresses.destroy("some-address-id")
+```
+
+### Address verification
+
+```ruby
+# verifies and returns an address with more details
+@lob.addresses.verify(
+      address_line1: "220 WILLIAM T MORRISSEY BLVD",
+      city:    "Boston",
+      state:   "MA",
+      zip:     02125
+  )
+```
+
+### Jobs
+
+#### Create jobs
+
+```ruby
+# name, to-address and object are the arguments
+# to-address can be specified as an address-id
+@lob.jobs.create("New Cool Posters", "to-address-id", "object-id")
+
+# to-address can also be specified as address params to create new address
+@lob.jobs.create(
+  "New Cool Posters",
+  {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
+  "object-id"
+)
+
+# You can also pass new object params for the object
+# and other options like packaging_id an setting_id
+@lob.jobs.create(
+  "New Cool Posters",
+  "to-address-id",
+  "object-id",
+  {
+    name: "Your fantistic object",
+    file: "http://test.com/file.pdf",
+    setting_id: "some-setting-id"
+  }
+)
+```
+
+#### List jobs
+
+```ruby
+# returns an array of jobs
+@lob.jobs.list
+
+#you can also pass count and offset
+@lob.jobs.list(count: 10, offset: 3)
+```
+
+#### Find a specific job
+
+```ruby
+# returns the job with the corresponding ID
+@lob.jobs.find("some-job-id")
+```
+
+### Objects
+
+#### Create objects
+
+```ruby
+# You can create by passing the name, file url and setting ID
+@lob.objects.create(
+  "Your fantistic object",
+  "http://test.com/file.pdf",
+  "some-setting-id"
+)
+
+# You can also pass the quantity as an option
+# Or pass a file for upload instead of a url
+@lob.objects.create(
+  "Your fantistic object",
+  File.new("/path/to/file.pdf"),
+  "some-setting-id",
+  quantity: 12
+)
+```
+
+#### List objects
+
+```ruby
+# returns an array of objects
+@lob.objects.list
+
+#you can also pass count and offset
+@lob.objects.list(count: 10, offset: 3)
+```
+
+#### Find a specific object
+
+```ruby
+# returns the object with the corresponding ID
+@lob.objects.find("some-object-id")
+```
+
+#### Delete a specific object
+
+```ruby
+# deletes the object with the corresponding ID
+@lob.objects.destroy("some-object-id")
+```
+
+### Packagings
+
+#### List packagings
+
+```ruby
+# returns a list of packagings
+@lob.packagings.list
+```
+
+### Postcards
+
+#### Creating post cards
+
+You'll have to specify either the `message` option or the `back` option.
+
+```ruby
+# accepts the name, address-id to send to and options
+@lob.postcards.create(
+  "John Joe",
+  "to-address-id",
+  message: front: File.read("/path/to/file.pdf")
+)
+
+# create using address params, front, back and from address
+@lob.postcards.create(
+  "John Joe",
+  {name: "ToAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
+  message: "Hey buddy. Waiting to hear your stories",
+  front: "http://test.com/file.pdf",
+  back: File.read("/path/to/file.pdf"),
+  from: {name: "FromAddress", address_line1: "120, 6th Ave", city: "Boston", country: "USA", zip: 12345},
+)
+```
+
+#### List postcards
+
+```ruby
+@lob.postcards.list
+
+#you can also pass count and offset
+@lob.postcards.list(count: 10, offset: 3)
+```
+
+#### Find a postcard
+
+```ruby
+@lob.postcards.find "post-card-id"
+```
+
+### Services
+
+#### List services
+
+```ruby
+# returns a list of services
+@lob.services.list
+```
+
+### Settings
+
+#### List settings
+
+```ruby
+# returns a list of settings
+@lob.settings.list
+```
+
+## Developing
+
+Make sure you have Ruby 2.0 installed. Copy and paste the following commands in your projects directory.
+
+    git clone https://github.com/lob/lob-ruby.git
+    cd lob
+    bundle install
+
+You are powered up and ready to roll ~!
+
+## Running the test-suite
+
+To run the tests, download the required sample files by running the following command:
+
+    bundle exec rake dev:setup
+
+Tests are written using MiniTest, a testing library that comes with Ruby stdlib. The remote responses are tested using [vcr](https://github.com/vcr/vcr).
+
+You'll need to pass in your Lob.com API as the environment variable `LOB_API_KEY`, to run the tests. Be sure to use your Test API key, and not the Live one.
+
+Here's how you can run the tests:
+
+    LOB_API_KEY=your_test_api_key bundle exec rake test
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure the tests pass and add tests if required
+6. Create new Pull Request
+
+## Credits
+
+* [Akash Manohar J](http://github.com/HashNuke)
+
+Copyright &copy; 2013 Lob.com
+
+Released under the MIT License, which can be found in the repository in `LICENSE.txt`.

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib", "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+
+namespace :dev do
+
+  desc "Download sample files to run tests with"
+  task :setup do
+    Dir.mkdir("spec/samples") unless File.exist?("spec/samples")
+    files = [
+      {url: "https://www.lob.com/postcardfront.pdf", name: "postcardfront.pdf"},
+      {url: "https://www.lob.com/postcardback.pdf",  name: "postcardback.pdf"},
+      {url: "https://www.lob.com/goblue.pdf",        name: "goblue.pdf"}
+    ]
+    files.each do |f|
+      system "wget #{f[:url]} -O spec/samples/#{f[:name]}"
+    end
+
+  end
+end

data/lib/lob/lob_error.rb

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

data/lib/lob/v1/address.rb

@@ -0,0 +1,42 @@
+module Lob
+  module V1
+    class Address
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def verify(options={})
+        params = @resource.format_address_params(options, false)
+        Lob.submit(:post, address_verify_url, params)
+      end
+
+      def list(options={})
+        Lob.submit(:get, address_url, options)["data"] || []
+      end
+
+      def find(address_id)
+        Lob.submit :get, address_url(address_id)
+      end
+
+      def create(options = {})
+        Lob.submit :post, address_url, @resource.format_address_params(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/job.rb

@@ -0,0 +1,40 @@
+module Lob
+  module V1
+    class Job
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, job_url, options)["data"] || []
+      end
+
+      def find(job_id)
+        Lob.submit :get, job_url(job_id)
+      end
+
+      def create(name, to, object1, options = {})
+        options = { name: name, to: to, object1: object1 }.merge(options)
+
+        if options[:to] && !options[:to].is_a?(String)
+          options[:to] = @resource.format_address_params(options[:to])
+        end
+
+        if options[:from] && !options[:from].is_a?(String)
+          options[:from] = @resource.format_address_params(options[:from])
+        end
+
+        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/object.rb

@@ -0,0 +1,34 @@
+module Lob
+  module V1
+    class Object
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, object_url, options)["data"] || []
+      end
+
+      def find(lob_object_id)
+        Lob.submit :get, object_url(lob_object_id)
+      end
+
+      def create(name, file, setting_id, options = {})
+        options = { name: name, file: file, setting_id: setting_id }.merge(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/packaging.rb

@@ -0,0 +1,21 @@
+module Lob
+  module V1
+    class Packaging
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, packaging_url, options)["data"] || []
+      end
+
+      private
+
+      def packaging_url
+        @resource.construct_url("packagings")
+      end
+
+    end
+  end
+end

data/lib/lob/v1/postcard.rb

@@ -0,0 +1,39 @@
+module Lob
+  module V1
+    class Postcard
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, postcard_url, options)["data"] || []
+      end
+
+      def find(postcard_id)
+        Lob.submit :get, postcard_url(postcard_id)
+      end
+
+      def create(name, to, options = {})
+        options = { name: name, to: to }.merge(options)
+        if options[:to] && !options[:to].is_a?(String)
+          options[:to] = @resource.format_address_params(options[:to])
+        end
+
+        if options[:from] && !options[:from].is_a?(String)
+          options[:from] = @resource.format_address_params(options[:from])
+        end
+
+        Lob.submit :post, postcard_url, options
+      end
+
+
+      private
+
+      def postcard_url(postcard_id = nil)
+        @resource.construct_url("postcards", postcard_id)
+      end
+
+    end
+  end
+end

data/lib/lob/v1/resource.rb

@@ -0,0 +1,63 @@
+module Lob
+  module V1
+    class Resource
+
+      attr_accessor :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def addresses
+        Lob::V1::Address.new(self)
+      end
+
+      def jobs
+        Lob::V1::Job.new(self)
+      end
+
+      def objects
+        Lob::V1::Object.new(self)
+      end
+
+      def packagings
+        Lob::V1::Packaging.new(self)
+      end
+
+      def postcards
+        Lob::V1::Postcard.new(self)
+      end
+
+      def services
+        Lob::V1::Service.new(self)
+      end
+
+      def settings
+        Lob::V1::Setting.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
+
+      #NOTE to format address param names into API-compatible ones
+      def format_address_params(params, check_required_options=true)
+        if check_required_options
+          Lob.require_options(params, :name, :address_line1, :city, :state, :zip, :country)
+        end
+
+        [:city, :state, :zip, :country].each do |option|
+          params["address_#{option}".to_sym] = params[option] if params[option]
+          params.delete(option)
+        end
+
+        params
+      end
+
+    end
+  end
+end

data/lib/lob/v1/service.rb

@@ -0,0 +1,21 @@
+module Lob
+  module V1
+    class Service
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, service_url, options)["data"] || []
+      end
+
+      private
+
+      def service_url
+        @resource.construct_url("services")
+      end
+
+    end
+  end
+end

data/lib/lob/v1/setting.rb

@@ -0,0 +1,25 @@
+module Lob
+  module V1
+    class Setting
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def list(options={})
+        Lob.submit(:get, setting_url, options)["data"] || []
+      end
+
+      def find(setting_id)
+        Lob.submit :get, setting_url(setting_id)
+      end
+
+      private
+
+      def setting_url(setting_id = nil)
+        @resource.construct_url("settings", setting_id)
+      end
+
+    end
+  end
+end

data/lib/lob/version.rb

@@ -0,0 +1,3 @@
+module Lob
+  VERSION = "0.0.1"
+end