easypost 1.1.3 → 2.0.0

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# iOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.Spotlight-V100
+.Trashes

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    easypost (2.0.0)
+      multi_json (>= 1.0.4, < 2)
+      rest-client (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    mime-types (1.23)
+    multi_json (1.7.7)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  easypost!
+  rspec (~> 2.13.0)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 EasyPost (Simpler Postage, Inc)
+
+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,99 @@
+# EasyPost Ruby Client Library
+
+EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com
+
+Installation
+---------------
+
+Install the gem:
+
+```
+gem install
+```
+
+Import the EasyPost client in your application:
+
+```
+require 'easypost'
+```
+
+Example
+------------------
+
+```ruby
+require 'easypost'
+EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+
+to_address = EasyPost::Address.create(
+  :name => 'Sawyer Bateman',
+  :street1 => '1A Larkspur Cres.',
+  :city => 'St. Albert',
+  :state => 'AB',
+  :zip => 't8n2m4',
+  :country => 'CA',
+  :phone => '780-273-8374'
+)
+from_address = EasyPost::Address.create(
+  :company => 'Simpler Postage Inc',
+  :street1 => '388 Townsend Street',
+  :street2 => 'Apt 20',
+  :city => 'San Francisco',
+  :state => 'CA',
+  :zip => '94107',
+  :phone => '415-456-7890'
+)
+
+parcel = EasyPost::Parcel.create(
+  :width => 15.2,
+  :length => 18, 
+  :height => 9.5,
+  :weight => 35.1
+)
+
+customs_item = EasyPost::CustomsItem.create(
+  :description => 'EasyPost T-shirts',
+  :quantity => 2,
+  :value => 23.56,
+  :weight => 33,
+  :origin_country => 'us',
+  :hs_tariff_number => 123456
+)
+customs_info = EasyPost::CustomsInfo.create(
+  :integrated_form_type => 'form_2976',
+  :customs_certify => true,
+  :customs_signer => 'Dr. Pepper',
+  :contents_type => 'gift',
+  :contents_explanation => '', # only required when contents_type => 'other'
+  :eel_pfc => 'NOEEI 30.37(a)',
+  :non_delivery_option => 'abandon',
+  :restriction_type => 'none',
+  :restriction_comments => '',
+  :customs_items => [customs_item]
+)
+
+shipment = EasyPost::Shipment.create(
+  :to_address => to_address,
+  :from_address => from_address,
+  :parcel => parcel,
+  :customs_info => customs_info
+)
+
+shipment.buy(
+  :rate => shipment.lowest_rate
+)
+
+puts shipment.postage_label.label_url
+
+```
+
+Documentation
+--------------------
+
+Up-to-date documentation at: https://easypost.com/docs
+
+Tests
+--------------------
+
+```
+rspec spec
+```

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/bin/easypost-irb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/easypost'}"
+puts "Initializing EasyPost..."
+exec "#{irb} #{libs} --simple-prompt"

data/easypost.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easypost/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'easypost'
+  spec.version     = EasyPost::VERSION
+  spec.date        = '2013-06-25'
+  spec.summary     = 'EasyPost Ruby Client Library'
+  spec.description = 'Client library for accessing the EasyPost shipping API via Ruby.'
+  spec.authors     = ['Jon Calhoun', 'Sawyer Bateman']
+  spec.email       = 'contact@easypost.com'
+  spec.homepage    = 'https://easypost.com/docs'
+  
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_path  = 'lib'
+
+  spec.add_dependency('rest-client', '~> 1.4')
+  spec.add_dependency('multi_json', '>= 1.0.4', '< 2')
+  spec.add_development_dependency('rspec', "~> 2.13.0")
+end

data/lib/easypost.rb

@@ -1,13 +1,33 @@
-require 'typhoeus'
-require 'json'
+require 'cgi'
+require 'set'
+require 'openssl'
+require 'rest_client'
+require 'multi_json'
+
+# Resources
+require 'easypost/util'
+require 'easypost/object'
+require 'easypost/resource'
+require 'easypost/address'
+require 'easypost/parcel'
+require 'easypost/customs_item'
+require 'easypost/customs_info'
+require 'easypost/shipment'
+require 'easypost/rate'
+require 'easypost/postage_label'
+require 'easypost/scan_form'
+require 'easypost/refund'
+require 'easypost/batch'
+
+require 'easypost/error'
 
 module EasyPost
-  @@api_key = "..."
-  @@api_base = 'https://www.geteasypost.com/api/'
+  @@api_key = nil
+  @@api_base = 'https://api.easypost.com/v2'
+  @@api_version = nil
 
-  def self.api_url(args={})
-    raise ArgumentError unless args.keys.eql?([:type, :action])
-    return "#{@@api_base}#{args[:type]}/#{args[:action]}"
+  def self.api_url(url='')
+    @@api_base + url
   end
 
   def self.api_key=(api_key)
@@ -18,40 +38,91 @@ module EasyPost
     @@api_key
   end
 
-  def self.symbolize_keys(hash={})
-    hash.keys.each do |key|
-      hash[(key.to_sym rescue key) || key] = hash.delete(key)
-    end
-    return hash
+  def self.api_base=(api_base)
+    @@api_base = api_base
   end
 
-  def self.symbolize_keys_recursive(hash={})
-    hash.keys.each do |key|
-      keysym = (key.to_sym rescue key) || key
-      hash[keysym] = hash.delete(key)
-      if hash[keysym].is_a?(Hash)
-        hash[keysym] = symbolize_keys_recursive(hash[keysym])
-      end
-    end
-    return hash
+  def self.api_base
+    @@api_base
   end
 
-  def self.get(url, params={})
-    params = {:userpwd => @@api_key, :params => params}
-    @response = Typhoeus::Request.get(url, params)
-    return EasyPost.symbolize_keys_recursive(JSON.parse(@response.body))
+  def self.api_version=(version)
+    @@api_version = version
   end
 
-  def self.post(url, params={})
-    params = {:userpwd => @@api_key, :params => params}
-    @response = Typhoeus::Request.post(url, params)
-    return EasyPost.symbolize_keys_recursive(JSON.parse(@response.body))
+  def self.api_version
+    @@api_version
   end
 
-end
+  def self.request(method, url, api_key, params={}, headers={})
+    api_key ||= @@api_key
+    raise Error.new('No API key provided.') unless api_key
 
-require 'easypost/address'
-require 'easypost/postage'
-require 'easypost/errors/easypost_error'
-require 'easypost/errors/authentication_error'
+    ssl_opts = { :verify_ssl => false }
+
+    params = Util.objects_to_ids(params)
+    url = self.api_url(url)
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      if params && params.count > 0
+        query_string = Util.flatten_params(params).collect{|key, value| "#{key}=#{Util.url_encode(value)}"}.join('&')
+        url += "#{URI.parse(url).query ? '&' : '?'}#{query_string}"
+      end
+      payload = nil
+    else
+      payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
+    end
+
+    headers = {
+      :user_agent => "EasyPost/v2 RubyClient/2.0.0",
+      :authorization => "Bearer #{api_key}",
+      :content_type => 'application/x-www-form-urlencoded'
+    }.merge(headers)
 
+    opts = {
+      :method => method,
+      :url => url,
+      :headers => headers,
+      :open_timeout => 30,
+      :payload => payload,
+      :timeout => 60
+    }.merge(ssl_opts)
+
+    begin
+      response = execute_request(opts)
+    rescue RestClient::ExceptionWithResponse => e
+      if response_code = e.http_code and response_body = e.http_body
+        begin
+          response_json = MultiJson.load(response_body, :symbolize_keys => true)
+        rescue MultiJson::DecodeError
+          raise Error.new("Invalid response from API, unable to decode.", response_code, response_body)
+        end
+        begin
+          raise NoMethodError if response_json[:error][:message] == nil
+          raise Error.new(response_json[:error][:message], response_code, response_body, response_json)
+        rescue NoMethodError, TypeError
+          raise Error.new(response_json[:error], response_code, response_body, response_json)
+        end
+      else
+        raise Error.new(e.message)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      raise Error.new(e.message)
+    end
+
+    begin
+      response_json = MultiJson.load(response.body, :symbolize_keys => true)
+    rescue MultiJson::DecodeError
+      raise Error.new("Invalid response object from API, unable to decode.", response.code, response.body)
+    end
+
+    return [response_json, api_key]
+  end
+
+  private
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+end

data/lib/easypost/address.rb

@@ -1,13 +1,20 @@
 module EasyPost
-  class Address
-    @@type = "address"
+  class Address < Resource
 
-    def self.test
-      puts EasyPost.api_url("verify")
-    end
+    def verify(params={})
+      response, api_key = EasyPost.request(:get, url + '/verify', @api_key, params)
+
+      if response.has_key?(:address)
+        if response.has_key?(:message)
+          response[:address][:message] = response[:message]
+        end
+        verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
+        return verified_address
+      else
+        raise Error.new("Unable to verify address.")
+      end
 
-    def self.verify(address={})
-      @verified_address = EasyPost.get(EasyPost.api_url(:type => @@type, :action => "verify"), :address => address)
+      return self
     end
 
   end

data/lib/easypost/batch.rb

@@ -0,0 +1,34 @@
+module EasyPost
+  class Batch < Resource
+
+    def self.create_and_buy(params={})
+      wrapped_params = {}
+      wrapped_params[self.class_name().to_sym] = params
+      response, api_key = EasyPost.request(:post, url + '/create_and_buy', @api_key, wrapped_params)
+
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+
+    def label(params={})
+      response, api_key = EasyPost.request(:post, url + '/label', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+      
+      return self
+    end
+
+    def remove_shipments(params={})
+      response, api_key = EasyPost.request(:post, url + '/remove_shipments', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+      
+      return self
+    end
+
+    def add_shipments(params={})
+      response, api_key = EasyPost.request(:post, url + '/add_shipments', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+      
+      return self
+    end
+
+  end
+end