shippo 0.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e17e4581ec82ca7bb1242373d0f42045696f9a8
-  data.tar.gz: b159bf9011321abef4e546f7a60b276de4b09d93
+  metadata.gz: 3b70f8f58f5b9ba939df519f8843c57a600e8f1c
+  data.tar.gz: ca1964b87ce5f092e4af8880cf9c5568b0598297
 SHA512:
-  metadata.gz: 48150a7adda38b277e70b3e031229456086a74472e5836892c3d42158445fe1e747e7bc3aef25de24c9a078354c424f53dae96de3b92671b3905180297a3436b
-  data.tar.gz: 5d2a381f23176b9c45a8c772fee6588facf4134e00e974581fb93edec09fa000d3b0b7d3b8b5d11ea9855e23505bcd207b1a4ca8af226ad99240bac15738db8d
+  metadata.gz: 69cab04b54f2063bdd876d9b11d0ae41a90094f54a08d697c92c29d54c52f0aff692216397786bd3e32dd4776d3eb4bdcb11d26942764697498f3518f6dd39b7
+  data.tar.gz: 48ee7d5df7a153fc00136ae19a5e6173b6c50eeab1a7a5900fbf5ab3188a61c7bee4a07ebe0d15c349a0ac6e415810b95bbdadac0a414f2e0bf2692b0ce8343c

data/example.rb

@@ -1,9 +1,16 @@
+# This example demonstrates how to purchase a label for an international shipment.
+# Creating domestic shipment would follow a similiar proccess but would not require
+# the creation of CustomsItems and CustomsDeclaration objects.
 require 'shippo'
-Shippo::api_user = 'YOUR_API_USER'
-Shippo::api_pass = 'YOUR_API_PASS'
+require 'timeout'
 
-from = Shippo::Address.create(
-  :object_purchase => 'QUOTE',
+# replace <USERNAME> and <PASSWORD> with your credentials
+Shippo::api_user = '<USERNAME>'
+Shippo::api_pass = '<PASSWORD>'
+
+# Create address_from object
+address_from = {
+  :object_purpose => 'PURCHASE',
   :name => 'Laura Behrens Wu',
   :company => 'Shippo',
   :street1 => 'Clayton St.',
@@ -14,46 +21,98 @@ from = Shippo::Address.create(
   :zip => '94117',
   :country => 'US',
   :phone => '+1 555 341 9393',
-  :email => 'laura@goshippo.com',
-  :ip => '',
-  :metadata => 'Customer ID 123456'
-)
-puts from
-to = Shippo::Address.create(
-  :object_purchase => 'QUOTE',
-  :name => 'Mr. John Doe',
-  :company => 'ACME Inc.',
-  :street1 => nil,
-  :street_no => '',
-  :street2 => '',
-  :city => 'Berlin',
-  :country => 'DE',
-  :ip => '',
-  :metadata => ''
-)
-puts to
-parcel = Shippo::Parcel.create(
+  :email => 'laura@goshippo.com'}
+
+# Create address_to object
+address_to = {
+  :object_purpose => 'PURCHASE',
+  :name => 'Mr Hippo"',
+  :company => 'London Zoo"',
+  :street1 => 'Regents Park',
+  :street2 => 'Outer Cir',
+  :city => 'LONDON',
+  :state => '',
+  :zip => 'NW1 4RY',
+  :country => 'GB',
+  :phone => '+1 555 341 9393',
+  :email => 'mrhippo@goshippo.com'}
+
+# Create parcel object
+parcel = {
   :length => 5,
   :width => 1,
   :height => 5.555,
   :distance_unit => :cm,
-  :weight => '2.122',
-  :mass_unit => :lb,
-  :metadata => 'Customer ID 123456'
-)
-puts parcel
+  :weight => 2,
+  :mass_unit => :lb}
+
+#example CustomsItems object. This is only required for int'l shipment only.
+customs_item = {
+  :description => "T-Shirt",
+  :quantity => 2,
+  :net_weight => "400",
+  :mass_unit => "g",
+  :value_amount => "20",
+  :value_currency => "USD",
+  :origin_country => "US"}
+
+#Creating the CustomsDeclaration
+#(CustomsDeclarations are only required for international shipments)
+customs_declaration = Shippo::Customs_Declaration.create(
+  :contents_type => "MERCHANDISE",
+  :contents_explanation => "T-Shirt purchase",
+  :non_delivery_option => "RETURN",
+  :certify => true,
+  :certify_signer => "Laura Behrens Wu",
+  :items => [customs_item])
+
+# Creating the shipment object. In this example, the objects are directly passed to the
+# Shipment.create method, Alternatively, the Address and Parcel objects could be created
+# using Address.create(..) and Parcel.create(..) functions respectively
+puts "Creating shipment object.."
 shipment = Shippo::Shipment.create(
-  :object_purpose => 'QUOTE',
-  # you can also put in the object_id directly, but this is more convenient
-  :address_from => from,
-  :address_to => to,
+  :object_purpose => 'PURCHASE',
+  :submission_type => 'DROPOFF',
+  :address_from => address_from,
+  :address_to => address_to,
   :parcel => parcel,
-  :metadata => 'Quote Shipment'
-)
-puts shipment
-# never do this in real life
-sleep(5)
+  :customs_declaration => customs_declaration)
+
+puts "Shipment created. Waiting for rates to be generated.."
+
+# Wait for rates to be generated
+timeout_rates_request = 10 # seconds
+while ["QUEUED","WAITING"].include? shipment.object_status do
+  Timeout::timeout(timeout_rates_request) do
+    shipment = Shippo::Shipment.get(shipment["object_id"])
+  end
+end
+
+# Get all rates for shipment.
+rates = shipment.rates()
+
+# Get the first rate in the rates results
+rate = rates[0]
+
+puts "Rates generated. Purchasing a #{rate.provider} #{rate.servicelevel_name} label"
+
+# Purchase the desired rate (create a Transaction object)
+transaction = Shippo::Transaction.create(:rate => rate["object_id"])
 
-rates = shipment.rates
+# Wait for transaction to be proccessed
+timeout_label_request = 10 # seconds
+while ["QUEUED","WAITING"].include? transaction.object_status do
+  Timeout::timeout(timeout_label_request) do
+    transaction = Shippo::Transaction.get(transaction["object_id"])
+  end
+end
 
-puts "Shipment #{shipment[:object_id]} has the following rates:\n\n#{rates}"
+# label_url and tracking_number
+if transaction.object_status == "SUCCESS"
+  puts "Label sucessfully generated:"
+  puts "label_url: #{transaction.label_url}" 
+  puts "tracking_number: #{transaction.tracking_number}" 
+else
+  puts "Error generating label:"
+  puts transaction.messages
+end

data/lib/shippo.rb

@@ -2,17 +2,21 @@ require 'rest_client'
 require 'json'
 require 'set'
 
-require 'shippo/error.rb'
-require 'shippo/container_object.rb'
-require 'shippo/api_object.rb'
-require 'shippo/list.rb'
-require 'shippo/create.rb'
-require 'shippo/resource.rb'
-require 'shippo/address.rb'
-require 'shippo/parcel.rb'
-require 'shippo/shipment.rb'
-require 'shippo/transaction.rb'
-require 'shippo/rate.rb'
+require_relative 'shippo/error.rb'
+require_relative 'shippo/container_object.rb'
+require_relative 'shippo/api_object.rb'
+require_relative 'shippo/list.rb'
+require_relative 'shippo/create.rb'
+require_relative 'shippo/resource.rb'
+require_relative 'shippo/address.rb'
+require_relative 'shippo/parcel.rb'
+require_relative 'shippo/shipment.rb'
+require_relative 'shippo/transaction.rb'
+require_relative 'shippo/rate.rb'
+require_relative 'shippo/manifest.rb'
+require_relative 'shippo/customs_item.rb'
+require_relative 'shippo/customs_declaration.rb'
+require_relative 'shippo/refund.rb'
 
 module Shippo
   @api_base = 'https://api.goshippo.com/v1'
@@ -29,46 +33,51 @@ module Shippo
   end
 
   def self.request(method, url, params = {}, headers = {})
-   unless @api_user && @api_pass
-     raise AuthError.new("API credentials missing! Make sure to set Shippo.api_user, Shippo.api_Pass")
-   end
-   begin
-     payload = {}
-     url = api_url(url)
-     case method
-     when :get
-       pairs = []
-       params.each { |k, v|
-         pairs.push "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
-       }
-       url += "?#{pairs.join('&')}" unless pairs.empty?
-     when :post
-       payload = params
-     end
-     opts = { :headers => headers,
-       :method => method,
-       :payload => payload,
-       :url => url,
-       :open_timeout => 15,
-       :timeout => 30,
-       :user => @api_user,
-       :password => @api_pass
-     }
-     res = make_request(opts)
-   rescue => e
-     case e
-     when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-       msg = "Could not connect to the Shippo API at #{@api_base}. " +
-         "Please proceed to check your connection, try again and " +
-         "contact Shippo support should the issue persist."
-     when SocketError
-       msg = "Unexpected error connecting to the Shippo API at #{@api_base}."
-     else
-       msg = "Connection error"
-     end
-     raise ConnectionError.new msg + "\n\n(e.message)"
-   end
-   parse(res)
+    unless @api_user && @api_pass
+      raise AuthError.new("API credentials missing! Make sure to set Shippo.api_user, Shippo.api_Pass")
+    end
+    begin
+      payload = {}
+      url = api_url(url)
+      headers.merge!(:accept => :json, :content_type => :json)
+      case method
+      when :get
+        pairs = []
+        params.each { |k, v|
+          pairs.push "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+        }
+        url += "?#{pairs.join('&')}" unless pairs.empty?
+      when :post
+        payload = params.to_json
+      end
+      opts = { :headers => headers,
+        :method => method,
+        :payload => payload,
+        :url => url,
+        :open_timeout => 15,
+        :timeout => 30,
+        :user => @api_user,
+        :password => @api_pass,
+        :user_agent => "Shippo/v1 RubyBindings"
+      }
+      res = make_request(opts)
+    rescue => e
+      case e
+      when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+        msg = "Could not connect to the Shippo API at #{@api_base}. " +
+        "Please proceed to check your connection, try again and " +
+        "contact Shippo support should the issue persist."
+        raise ConnectionError.new msg + "\n\n(e.message)"
+      when SocketError
+        msg = "Unexpected error connecting to the Shippo API at #{@api_base}."
+      when RestClient::ExceptionWithResponse
+        msg = "error: #{e} #{e.http_body}"
+      else
+        msg = "error: #{e}"
+      end
+      raise APIError.new msg
+    end
+    parse(res)
   end
   def self.parse(response)
     JSON::parse(response.body, { :symbolize_names => true })
@@ -83,4 +92,3 @@ def make_request(opts)
     end
   }
 end
-

data/lib/shippo/address.rb

@@ -1,6 +1,10 @@
-module Shippo 
+module Shippo
   class Address < Resource
     include Shippo::Operations::List
     include Shippo::Operations::Create
+    def validate(params={})
+      response = Shippo.request(:get, "#{url}/validate/", params)
+      Shippo::Address.construct_from(response)
+    end
   end
 end

data/lib/shippo/api_object.rb

@@ -41,7 +41,7 @@ module Shippo
         @values[k.to_sym] = v
       end
       instance_eval do
-         add_accessors(@values.keys)
+        add_accessors(@values.keys)
       end
 
     end

data/lib/shippo/create.rb

@@ -10,7 +10,6 @@ module Shippo
           self.construct_from(response)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/shippo/customs_declaration.rb

@@ -0,0 +1,7 @@
+module Shippo 
+  class Customs_Declaration < Resource 
+    @non_standard_URL = "/customs/declarations"
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+  end
+end

data/lib/shippo/customs_item.rb

@@ -0,0 +1,7 @@
+module Shippo 
+  class Customs_Item < Resource 
+    @non_standard_URL = "/customs/items"
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+  end
+end

data/lib/shippo/list.rb

@@ -5,7 +5,9 @@ module Shippo
         # return all items
         def all(params={})
           response = Shippo.request(:get, "#{url}/", params)
-          self.construct_from(response[:results] || [])
+          # Limiting to results array, does not allow user to see count,..
+          # self.construct_from(response[:results] || [])
+          self.construct_from(response)
         end
         # return a specific item
         def get(id, params={})
@@ -13,7 +15,6 @@ module Shippo
           self.construct_from(response)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/shippo/manifest.rb

@@ -0,0 +1,6 @@
+module Shippo 
+  class Manifest < Resource 
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+  end
+end

data/lib/shippo/refund.rb

@@ -0,0 +1,6 @@
+module Shippo 
+  class Refund < Resource 
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+  end
+end

data/lib/shippo/resource.rb

@@ -1,11 +1,18 @@
 module Shippo
   class Resource < ApiObject
+    @non_standard_URL
     def self.class_name
       self.name.split('::')[-1]
     end
     def self.url()
-      dc = class_name.downcase
-      "/" + dc + (dc[-1] == 's' ? 'es' : 's')
+      # Process non standard URL
+      if defined? @non_standard_URL
+        return @non_standard_URL
+      else
+        # Process standard url
+        dc = class_name.downcase
+        "/" + dc + (dc[-1] == 's' ? 'es' : 's')
+      end
     end
     def url
       unless id = self['object_id']
@@ -13,7 +20,6 @@ module Shippo
       end
       "#{self.class.url}/#{CGI.escape(id)}"
     end
-
     def refresh
       response, api_key = Shippo.request(:get, url, @retrieve_options)
       refresh_from(response)

data/lib/shippo/shipment.rb

@@ -2,8 +2,12 @@ module Shippo
   class Shipment < Resource
     include Shippo::Operations::List
     include Shippo::Operations::Create
-    def rates(params={})
-      response = Shippo.request(:get, "#{url}/rates/", params)
+    def rates(currency=nil, params={})
+      if !currency.nil?
+        response = Shippo.request(:get, "#{url}/rates/#{currency}/", params)
+      else
+        response = Shippo.request(:get, "#{url}/rates/", params)
+      end
       Shippo::Rate.construct_from(response[:results])
     end
   end

metadata

@@ -1,17 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: shippo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.2
 platform: ruby
 authors:
-- Tobias Schottdorf
+- Shippo & Contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
-dependencies: []
+date: 2014-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 description: Quick and easy access to the Shippo API
-email: tobias.schottdorf@gmail.com
+email: support@goshippo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -23,10 +71,14 @@ files:
 - ./lib/shippo/api_object.rb
 - ./lib/shippo/container_object.rb
 - ./lib/shippo/create.rb
+- ./lib/shippo/customs_declaration.rb
+- ./lib/shippo/customs_item.rb
 - ./lib/shippo/error.rb
 - ./lib/shippo/list.rb
+- ./lib/shippo/manifest.rb
 - ./lib/shippo/parcel.rb
 - ./lib/shippo/rate.rb
+- ./lib/shippo/refund.rb
 - ./lib/shippo/resource.rb
 - ./lib/shippo/shipment.rb
 - ./lib/shippo/transaction.rb