shippo 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e21d3ec29ed56a00fd431e11a2fbef68a7da0e5
-  data.tar.gz: fbb6171b9cd52c4c9f60309dc49a47d90333464b
+  metadata.gz: 3c1afc5735ee9f3e356aaa45c48461d337518999
+  data.tar.gz: 5780d7dac4a8884eded0dd5431ea30ca2fcdd222
 SHA512:
-  metadata.gz: 43f4d4462aed8cdd311635af1c1a6bdb854937b12e8fbd391908dedb2737802c17c7a7f67222264621f1772862fecc22baeacb7c775f25b1569feb83c0f34928
-  data.tar.gz: 1c198688269bb9c5c568828bf6e2b8d4e141f6020429bf5acbc0899c95aca1fe2e65450936a649b3fb996711d8fe80391ef13c276aff0747e20622621b368a11
+  metadata.gz: 8143b0403147d512fb677178f6cab943094238313cea9155ccc489329d1fea6e04c5844f48f9107cdc0500bee9bf50a256c479c1c151167316676229f2e8fdd0
+  data.tar.gz: 989b5c42d4d68739e539bf315f0f8992a5628f989c4181420a2b45134bcbe9508f2c70f1e25d5892222704fe62f7686fb601895f43b124fd8de9a04d75a4129b

data/example.rb

@@ -1,110 +1,64 @@
-# 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.
+# This example demonstrates how to purchase a label for a domestic US shipment.
 require 'shippo'
-require 'timeout'
 
-# replace <YOU_PRIVATE_KEY> with your ShippoToken key
-Shippo::api_token = 'YOU_PRIVATE_KEY'
+# replace <YOUR_PRIVATE_KEY> with your ShippoToken key
+Shippo::api_token = '<YOUR_PRIVATE_KEY>'
 
 # Create address_from object
 address_from = {
   :object_purpose => 'PURCHASE',
-  :name => 'Laura Behrens Wu',
+  :name => 'Mr Hippo',
   :company => 'Shippo',
-  :street1 => 'Clayton St.',
-  :street_no => '215',
+  :street1 => '215 Clayton St.',
   :street2 => '',
   :city => 'San Francisco',
   :state => 'CA',
   :zip => '94117',
   :country => 'US',
   :phone => '+1 555 341 9393',
-  :email => 'laura@goshippo.com'}
+  :email => 'support@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',
+  :name => 'Mrs Hippo"',
+  :company => 'San Diego Zoo',
+  :street1 => '2920 Zoo Drive',
+  :city => 'San Diego',
+  :state => 'CA',
+  :zip => '92101',
+  :country => 'US',
   :phone => '+1 555 341 9393',
-  :email => 'mrhippo@goshippo.com'}
+  :email => 'hippo@goshippo.com'}
 
 # Create parcel object
 parcel = {
   :length => 5,
-  :width => 1,
-  :height => 5.555,
-  :distance_unit => :cm,
+  :width => 2,
+  :height => 5,
+  :distance_unit => :in,
   :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
+# Creating the shipment object
 puts "Creating shipment object.."
 shipment = Shippo::Shipment.create(
   :object_purpose => 'PURCHASE',
-  :submission_type => 'DROPOFF',
   :address_from => address_from,
   :address_to => address_to,
   :parcel => parcel,
-  :customs_declaration => customs_declaration)
-
-puts "Shipment created. Waiting for rates to be generated.."
+  :async => false )
 
-# 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]
+# Get the desired rate according to your business logic
+# We select the first rate in this example
+rate = shipment.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"])
-
-# 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
+transaction = Shippo::Transaction.create(
+  :rate => rate["object_id"],
+  :async => false )
 
 # label_url and tracking_number
 if transaction.object_status == "SUCCESS"

data/lib/shippo/carrieraccount.rb

@@ -0,0 +1,8 @@
+module Shippo 
+  class CarrierAccount < Resource 
+    @non_standard_URL = "/carrier_accounts"
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+    include Shippo::Operations::Update
+  end
+end

data/lib/shippo/update.rb

@@ -0,0 +1,15 @@
+module Shippo
+  module Operations
+    module Update
+      module ClassMethods
+        def update(object_id, params={})
+          response = Shippo.request(:put, "#{url}/#{CGI.escape(object_id)}/", params)
+          self.construct_from(response)
+        end
+      end
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/shippo.rb

@@ -5,18 +5,25 @@ require 'set'
 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'
+
+# api operations
+require_relative 'shippo/create.rb'
+require_relative 'shippo/update.rb'
+require_relative 'shippo/list.rb'
+
+
+# api objects
 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/carrieraccount.rb'
 require_relative 'shippo/customs_item.rb'
 require_relative 'shippo/customs_declaration.rb'
+require_relative 'shippo/manifest.rb'
+require_relative 'shippo/parcel.rb'
+require_relative 'shippo/rate.rb'
 require_relative 'shippo/refund.rb'
+require_relative 'shippo/shipment.rb'
+require_relative 'shippo/transaction.rb'
 
 module Shippo
   @api_base = 'https://api.goshippo.com/v1'
@@ -50,7 +57,7 @@ module Shippo
           pairs.push "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
         }
         url += "?#{pairs.join('&')}" unless pairs.empty?
-      when :post
+      else
         payload = params.to_json
       end
       opts = { :headers => headers,

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: shippo
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Shippo & Contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2015-06-19 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
@@ -64,24 +64,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- "./lib/shippo/address.rb"
+- "./lib/shippo/api_object.rb"
+- "./lib/shippo/carrieraccount.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"
+- "./lib/shippo/update.rb"
 - example.rb
-- test/test.rb
 - lib/shippo.rb
-- ./lib/shippo/address.rb
-- ./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
+- test/test.rb
 homepage: http://goshippo.com
 licenses:
 - MIT
@@ -92,17 +94,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Shippo API