shippo 1.0.4 → 2.0.0

data/example.rb

@@ -1,71 +0,0 @@
-# This example demonstrates how to purchase a label for a domestic US shipment.
-require 'shippo'
-
-# replace <YOUR_PRIVATE_KEY> with your ShippoToken key
-Shippo::api_token = '<YOUR_PRIVATE_KEY>'
-
-# Create address_from object
-address_from = {
-  :object_purpose => 'PURCHASE',
-  :name => 'Mr Hippo',
-  :company => 'Shippo',
-  :street1 => '215 Clayton St.',
-  :street2 => '',
-  :city => 'San Francisco',
-  :state => 'CA',
-  :zip => '94117',
-  :country => 'US',
-  :phone => '+1 555 341 9393',
-  :email => 'support@goshippo.com'}
-
-# Create address_to object
-address_to = {
-  :object_purpose => 'PURCHASE',
-  :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 => 'hippo@goshippo.com'}
-
-# Create parcel object
-parcel = {
-  :length => 5,
-  :width => 2,
-  :height => 5,
-  :distance_unit => :in,
-  :weight => 2,
-  :mass_unit => :lb}
-
-# Creating the shipment object
-puts "Creating shipment object.."
-shipment = Shippo::Shipment.create(
-  :object_purpose => 'PURCHASE',
-  :address_from => address_from,
-  :address_to => address_to,
-  :parcel => parcel,
-  :async => false )
-
-# 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"],
-  :async => false )
-
-# 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/address.rb

@@ -1,10 +0,0 @@
-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

@@ -1,89 +0,0 @@
-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/carrieraccount.rb

@@ -1,8 +0,0 @@
-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/container_object.rb

@@ -1,28 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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/customs_declaration.rb

@@ -1,7 +0,0 @@
-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

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

data/lib/shippo/error.rb

@@ -1,18 +0,0 @@
-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

@@ -1,23 +0,0 @@
-module Shippo
-  module Operations
-    module List
-      module ClassMethods
-        # return all items
-        def all(params={})
-          response = Shippo.request(:get, "#{url}/", params)
-          # 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={})
-          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/manifest.rb

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

data/lib/shippo/parcel.rb

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

data/lib/shippo/rate.rb

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

data/lib/shippo/refund.rb

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

data/lib/shippo/resource.rb

@@ -1,29 +0,0 @@
-module Shippo
-  class Resource < ApiObject
-    @non_standard_URL
-    def self.class_name
-      self.name.split('::')[-1]
-    end
-    def self.url()
-      # 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']
-        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

@@ -1,14 +0,0 @@
-module Shippo 
-  class Shipment < Resource
-    include Shippo::Operations::List
-    include Shippo::Operations::Create
-    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
-end

data/lib/shippo/transaction.rb

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

data/lib/shippo/update.rb

@@ -1,15 +0,0 @@
-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/test/test.rb

@@ -1,26 +0,0 @@
-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