shippo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e17e4581ec82ca7bb1242373d0f42045696f9a8
+  data.tar.gz: b159bf9011321abef4e546f7a60b276de4b09d93
+SHA512:
+  metadata.gz: 48150a7adda38b277e70b3e031229456086a74472e5836892c3d42158445fe1e747e7bc3aef25de24c9a078354c424f53dae96de3b92671b3905180297a3436b
+  data.tar.gz: 5d2a381f23176b9c45a8c772fee6588facf4134e00e974581fb93edec09fa000d3b0b7d3b8b5d11ea9855e23505bcd207b1a4ca8af226ad99240bac15738db8d

data/example.rb

@@ -0,0 +1,59 @@
+require 'shippo'
+Shippo::api_user = 'YOUR_API_USER'
+Shippo::api_pass = 'YOUR_API_PASS'
+
+from = Shippo::Address.create(
+  :object_purchase => 'QUOTE',
+  :name => 'Laura Behrens Wu',
+  :company => 'Shippo',
+  :street1 => 'Clayton St.',
+  :street_no => '215',
+  :street2 => '',
+  :city => 'San Francisco',
+  :state => 'CA',
+  :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(
+  :length => 5,
+  :width => 1,
+  :height => 5.555,
+  :distance_unit => :cm,
+  :weight => '2.122',
+  :mass_unit => :lb,
+  :metadata => 'Customer ID 123456'
+)
+puts parcel
+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,
+  :parcel => parcel,
+  :metadata => 'Quote Shipment'
+)
+puts shipment
+# never do this in real life
+sleep(5)
+
+rates = shipment.rates
+
+puts "Shipment #{shipment[:object_id]} has the following rates:\n\n#{rates}"

data/lib/shippo.rb

@@ -0,0 +1,86 @@
+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'
+
+module Shippo
+  @api_base = 'https://api.goshippo.com/v1'
+  @api_version = 1.0
+  @api_user = ''
+  @api_pass = ''
+
+  class << self
+    attr_accessor :api_base, :api_version, :api_user, :api_pass
+  end
+
+  def self.api_url(url='')
+    @api_base + url
+  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)
+  end
+  def self.parse(response)
+    JSON::parse(response.body, { :symbolize_names => true })
+  end
+end
+def make_request(opts)
+  RestClient::Request.execute(opts){ |response, request, result, &block|
+    if [301, 302, 307].include? response.code
+      response.follow_redirection(request, result, &block)
+    else
+      response.return!(request, result, &block)
+    end
+  }
+end
+

data/lib/shippo/address.rb

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

data/lib/shippo/api_object.rb

@@ -0,0 +1,89 @@
+module Shippo
+  class ApiObject < ContainerObject
+    include Enumerable
+
+    def initialize(id=nil)
+      # parameter overloading!
+      if id.kind_of?(Hash)
+        id = id[:id]
+      end
+
+      @values = {}
+      @values[:id] = id if id
+    end
+
+    def self.construct_from(values)
+      # recursive on arrays
+      case values
+      when Array
+        values.map { |v| self.construct_from(v) }
+      when Hash
+        obj = self.new(values[:id])
+        obj.refresh_from(values)
+        obj
+      else
+        # on scalar types, just identity 
+        values
+      end
+    end
+
+    def to_s(*args)
+      JSON.pretty_generate @values
+    end
+
+    def inspect()
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + self.to_s
+    end
+
+    def refresh_from(values)
+      values.each do |k, v|
+        @values[k.to_sym] = v
+      end
+      instance_eval do
+         add_accessors(@values.keys)
+      end
+
+    end
+    def [](k)
+      @values[k.to_sym]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      JSON.dump(@values)
+    end
+
+    def as_json(*a)
+      @values.as_json(*a)
+    end
+
+    def to_hash
+      @values
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    if RUBY_VERSION < '1.9.2'
+      def respond_to?(symbol)
+        @values.has_key?(symbol) || super
+      end
+    end
+
+
+  end
+
+
+end

data/lib/shippo/container_object.rb

@@ -0,0 +1,28 @@
+module Shippo
+  class ContainerObject
+    protected
+    def create_accessor(k_name, k_index)
+      metaclass.instance_eval do
+        define_method(k_name) { @values[k_index] }
+        define_method(:"#{k_name}=") do |v|
+          @values[k_index] = v unless k_index == ''
+        end
+      end
+    end
+    def add_accessors(keys)
+      keys.each do |k|
+        #TODO raise something here, should filter this before
+        orig_k = k
+        while respond_to?(k) do
+          k = "_#{k}".to_sym
+        end
+        create_accessor(k, orig_k)
+      end
+    end
+    def metaclass
+      class << self
+        self
+      end
+    end
+  end
+end

data/lib/shippo/create.rb

@@ -0,0 +1,19 @@
+module Shippo
+  module Operations
+    module Create
+      module ClassMethods
+        def create(params={})
+          params.each do |k, v|
+            params[k] = v[:object_id] if v.is_a?(ApiObject)
+          end
+          response = Shippo.request(:post, "#{self.url}/", params)
+          self.construct_from(response)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/shippo/error.rb

@@ -0,0 +1,18 @@
+module Shippo
+  class APIError < StandardError
+    attr_reader :message
+    def initialize(message=nil)
+      @message = message
+    end
+
+    def to_s
+      @message
+    end
+  end
+  class ConnectionError < APIError
+  end
+  class MissingDataError < APIError
+  end
+  class AuthError < APIError
+  end
+end

data/lib/shippo/list.rb

@@ -0,0 +1,22 @@
+module Shippo
+  module Operations
+    module List
+      module ClassMethods
+        # return all items
+        def all(params={})
+          response = Shippo.request(:get, "#{url}/", params)
+          self.construct_from(response[:results] || [])
+        end
+        # return a specific item
+        def get(id, params={})
+          response = Shippo.request(:get, "#{url}/#{CGI.escape(id)}/", params)
+          self.construct_from(response)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/shippo/parcel.rb

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

data/lib/shippo/rate.rb

@@ -0,0 +1,5 @@
+module Shippo 
+  class Rate < Resource
+    include Shippo::Operations::List
+  end
+end

data/lib/shippo/resource.rb

@@ -0,0 +1,23 @@
+module Shippo
+  class Resource < ApiObject
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+    def self.url()
+      dc = class_name.downcase
+      "/" + dc + (dc[-1] == 's' ? 'es' : 's')
+    end
+    def url
+      unless id = self['object_id']
+        raise MissingDataError.new("#{self.class} has no object_id")
+      end
+      "#{self.class.url}/#{CGI.escape(id)}"
+    end
+
+    def refresh
+      response, api_key = Shippo.request(:get, url, @retrieve_options)
+      refresh_from(response)
+      self
+    end
+  end
+end

data/lib/shippo/shipment.rb

@@ -0,0 +1,10 @@
+module Shippo 
+  class Shipment < Resource
+    include Shippo::Operations::List
+    include Shippo::Operations::Create
+    def rates(params={})
+      response = Shippo.request(:get, "#{url}/rates/", params)
+      Shippo::Rate.construct_from(response[:results])
+    end
+  end
+end

data/lib/shippo/transaction.rb

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

data/test/test.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'mocha'
+require 'test/unit'
+require 'mocha/test_unit'
+require 'shippo'
+def parcel_list_result
+  JSON::parse File.open('./parcel_list.json').read
+end
+
+module Shippo
+  class ParcelTest < Test::Unit::TestCase
+    def test_import
+      # get an array of test parcels from JSON
+      ret = Shippo::Parcel.construct_from(parcel_list_result)
+      # test the various options of accessing the parcel data
+      assert_equal ret[:metadata], "Customer ID 123456"
+      ret["metadata"] = "Customer ID 007"
+      assert_equal ret.metadata, "Customer ID 007"
+      assert_equal ret.object_owner, "tobias.schottdorf@gmail.com"
+      ret[:object_owner] = "hans.wurst@gmail.com"
+      assert_equal ret["object_owner"], "hans.wurst@gmail.com"
+      assert_equal ret.object_state, "VALID"
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: shippo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobias Schottdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies: []
+description: Quick and easy access to the Shippo API
+email: tobias.schottdorf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/error.rb
+- ./lib/shippo/list.rb
+- ./lib/shippo/parcel.rb
+- ./lib/shippo/rate.rb
+- ./lib/shippo/resource.rb
+- ./lib/shippo/shipment.rb
+- ./lib/shippo/transaction.rb
+homepage: http://goshippo.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Shippo API
+test_files: []