active_shipping 0.12.6 → 1.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 715dd60ad9d4a6fbe5c9ba36834326fa383c4ee4
-  data.tar.gz: 1f1991bf39492b70a068e92e52bb687f4b3526b4
+  metadata.gz: 8664d2221411bccc635ba71eae6bb4262d369753
+  data.tar.gz: b468c066831f372867d0cd3ecd70ed04069a4d08
 SHA512:
-  metadata.gz: 725e84ee191ce38e56e89a3af8ff0592c21a5e6bc6f584edf9cfdcc4fbb01a5532bc999ae28dfc07045fa403cb8f86c363b8d62e12441fc488efe0e863c33645
-  data.tar.gz: db8156ebcbd65a863f222b7bdfb26b37ac3fbd5a6b4e9036fc499488133a7075ec9906f996cafdce5b4ccc002b2e08fabdeffaabf59c82c7da26430ce4519a6a
+  metadata.gz: 4e7eb03007d6327ab42ee8aa9af0adfe741542769231354058a2cfbffa40399ef2ab7ab9eaf39c1f57b3e9ae2f12568c8156dd4c49be9769f149e974960f8149
+  data.tar.gz: 6d3b6f02166d9eed86426e74d1fca59f6737d21dc4410e36c0d1f65eb815d93fbf4587610c6889af02646e3f83f9b37b8df23f4fcddb56b6def3d09659f98b62

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+/6l8��'
���M��j��x�oc��+0G./V^�3:"�x����D����_
�}���n(�b�K��э,�I(�Ђ���z��ƟL-���t�o-��	�h�h�x�
+��ܰ[�Z5�7�l⢢�=�E+/Q������M�	�R+0�n7�̜~�

data/{CHANGELOG → CHANGELOG.md}

@@ -1,17 +1,21 @@
+# ActiveShipping CHANGELOG
+
 ### v0.10.1
+
  - Canada Post PWS: Makes wrapper act more consistently with the rest of the API [jnormore]
  - UPS: Adds insurance charge to package object declarations [pbonnell]
  - USPS: Improves how unavailable delivery information is handled [cyu]
  - Shipment Packer: Prevents packing errors and consistently return an array when packing [christianblais]
  - General: Improves tests such that they work with ruby 2.0 [Sirupsen]
 
+### 2011/04/21
 
-2011/04/21:
 * USPS updated to use new APIs [james]
 * new :gift boolean option for Package [james]
 * Location's :address_type can be "po_box" [james]
 
-Earlier:
+### Earlier
+
 * New Zealand Post [AbleTech]
 * Include address name for rate requests to Shipwire if provided [dennis]
 * Add support for address name to Location [dennis]

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to ActiveShipping
+
+We welcome fixes and additions to this project. Please use clean, concise code that follows Ruby community standards. For example:
+
+* Be consistent
+* Don't use too much white space
+** Use 2 space indent, no tabs.
+** No spaces after (, [ and before ],)
+* Nor too little
+** Use spaces around operators and after commas, colons and semicolons
+** Indent when as deep as case
+* Write lucid code in lieu of adding comments
+
+## Contributors
+
+* James MacAulay (<http://jmacaulay.net>)
+* Tobias Luetke (<http://blog.leetsoft.com>)
+* Cody Fauser (<http://codyfauser.com>)
+* Jimmy Baker (<http://jimmyville.com/>)
+* William Lang (<http://williamlang.net/>)
+* Cameron Fowler
+* Christopher Saunders (<http://christophersaunders.ca>)
+* Denis Odorcic
+* Dennis O'Connor
+* Dennis Theisen
+* Edward Ocampo-Gooding
+* Isaac Kearse
+* John Duff
+* Nigel Ramsay
+* Philip Arndt
+* Vikram Oberoi
+* Willem van Bergen

data/{README.markdown → README.md}

@@ -2,11 +2,13 @@
 
 [![Build Status](https://travis-ci.org/Shopify/active_shipping.png)](https://travis-ci.org/Shopify/active_shipping)
 
-This library interfaces with the web services of various shipping carriers. The goal is to abstract the features that are most frequently used into a pleasant and consistent Ruby API. Active Shipping is an extension of [Active Merchant][], and as such, it borrows heavily from conventions used in the latter.
+This library interfaces with the web services of various shipping carriers. The goal is to abstract the features that are most frequently used into a pleasant and consistent Ruby API.
+
+- Finding shipping rates
+- Tracking shipments
 
 Active Shipping is currently being used and improved in a production environment for [Shopify][]. Development is being done by the Shopify integrations team (<integrations-team@shopify.com>). Discussion is welcome in the [Active Merchant Google Group][discuss].
 
-[Active Merchant]:http://www.activemerchant.org
 [Shopify]:http://www.shopify.com
 [discuss]:http://groups.google.com/group/activemerchant
 
@@ -17,58 +19,59 @@ Active Shipping is currently being used and improved in a production environment
 * [FedEx](http://www.fedex.com)
 * [Canada Post](http://www.canadapost.ca)
 * [New Zealand Post](http://www.nzpost.co.nz)
-* more soon!
+* [Shipwire](http://www.shipwire.com)
+* [Stamps](http://www.stamps.com)
+* [Kunaki](http://www.kunaki.com)
 
 ## Installation
 
     gem install active_shipping
 
-...or add it to your [Gemfile](http://gembundler.com/).
+...or add it to your project's [Gemfile](http://bundler.io/).
 
 ## Sample Usage
 
 ### Compare rates from different carriers
 
     require 'active_shipping'
-    include ActiveMerchant::Shipping
-  
+
     # Package up a poster and a Wii for your nephew.
     packages = [
-      Package.new(  100,                        # 100 grams
-                    [93,10],                    # 93 cm long, 10 cm diameter
-                    :cylinder => true),         # cylinders have different volume calculations
-    
-      Package.new(  (7.5 * 16),                 # 7.5 lbs, times 16 oz/lb.
-                    [15, 10, 4.5],              # 15x10x4.5 inches
-                    :units => :imperial)        # not grams, not centimetres
+      ActiveShipping::Package.new( 100,                  # 100 grams
+                                   [93,10],              # 93 cm long, 10 cm diameter
+                                   :cylinder => true),   # cylinders have different volume calculations
+
+      ActiveShipping::Package.new( 7.5 * 16,             # 7.5 lbs, times 16 oz/lb.
+                                   [15, 10, 4.5],        # 15x10x4.5 inches
+                                   :units => :imperial)  # not grams, not centimetres
     ]
-  
+
     # You live in Beverly Hills, he lives in Ottawa
-    origin = Location.new(      :country => 'US',
-                                :state => 'CA',
-                                :city => 'Beverly Hills',
-                                :zip => '90210')
-  
-    destination = Location.new( :country => 'CA',
-                                :province => 'ON',
-                                :city => 'Ottawa',
-                                :postal_code => 'K1P 1J1')
-                              
+    origin = ActiveShipping::Location.new( :country => 'US',
+                                           :state => 'CA',
+                                           :city => 'Beverly Hills',
+                                           :zip => '90210')
+
+    destination = ActiveShipping::Location.new( :country => 'CA',
+                                                :province => 'ON',
+                                                :city => 'Ottawa',
+                                                :postal_code => 'K1P 1J1')
+
     # Find out how much it'll be.
-    ups = UPS.new(:login => 'auntjudy', :password => 'secret', :key => 'xml-access-key')
+    ups = ActiveShipping::UPS.new(:login => 'auntjudy', :password => 'secret', :key => 'xml-access-key')
     response = ups.find_rates(origin, destination, packages)
-  
+
     ups_rates = response.rates.sort_by(&:price).collect {|rate| [rate.service_name, rate.price]}
     # => [["UPS Standard", 3936],
     #     ["UPS Worldwide Expedited", 8682],
     #     ["UPS Saver", 9348],
     #     ["UPS Express", 9702],
     #     ["UPS Worldwide Express Plus", 14502]]
-  
+
     # Check out USPS for comparison...
-    usps = USPS.new(:login => 'developer-key')
+    usps = ActiveShipping::USPS.new(:login => 'developer-key')
     response = usps.find_rates(origin, destination, packages)
-  
+
     usps_rates = response.rates.sort_by(&:price).collect {|rate| [rate.service_name, rate.price]}
     # => [["USPS Priority Mail International", 4110],
     #     ["USPS Express Mail International (EMS)", 5750],
@@ -76,26 +79,26 @@ Active Shipping is currently being used and improved in a production environment
     #     ["USPS GXG Envelopes", 9400],
     #     ["USPS Global Express Guaranteed Non-Document Rectangular", 9400],
     #     ["USPS Global Express Guaranteed", 9400]]
-    
+
 ### Track a FedEx package
 
-    fedex = FedEx.new(:login => '999999999', :password => '7777777', key: '1BXXXXXXXXXxrcB', account: '51XXXXX20')
+    fedex = ActiveShipping::FedEx.new(login: '999999999', password: '7777777', key: '1BXXXXXXXXXxrcB', account: '51XXXXX20')
     tracking_info = fedex.find_tracking_info('tracking-number', :carrier_code => 'fedex_ground') # Ground package
-    
+
     tracking_info.shipment_events.each do |event|
       puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
     end
-    # => Package information transmitted to FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 00:00:00 UTC 2008. 
-    # Picked up by FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 17:30:00 UTC 2008. 
-    # Scanned at FedEx sort facility at NASHVILLE, TN on Thu Oct 23 18:50:00 UTC 2008. 
-    # Departed FedEx sort facility at NASHVILLE, TN on Thu Oct 23 22:33:00 UTC 2008. 
-    # Arrived at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 02:45:00 UTC 2008. 
-    # Scanned at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 05:56:00 UTC 2008. 
+    # => Package information transmitted to FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 00:00:00 UTC 2008.
+    # Picked up by FedEx at NASHVILLE LOCAL, TN on Thu Oct 23 17:30:00 UTC 2008.
+    # Scanned at FedEx sort facility at NASHVILLE, TN on Thu Oct 23 18:50:00 UTC 2008.
+    # Departed FedEx sort facility at NASHVILLE, TN on Thu Oct 23 22:33:00 UTC 2008.
+    # Arrived at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 02:45:00 UTC 2008.
+    # Scanned at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 05:56:00 UTC 2008.
     # Delivered at Knoxville, TN on Fri Oct 24 16:45:00 UTC 2008. Signed for by: T.BAKER
 
 ## Running the tests
 
-After installing dependencies with `bundle install`, you can run the unit tests with `rake test:units` and the remote tests with `rake test:remote`. The unit tests mock out requests and responses so that everything runs locally, while the remote tests actually hit the carrier servers. For the remote tests, you'll need valid test credentials for any carriers' tests you want to run. The credentials should go in ~/.active_merchant/fixtures.yml, and the format of that file can be seen in the included [fixtures.yml](https://github.com/Shopify/active_shipping/blob/master/test/fixtures.yml).
+After installing dependencies with `bundle install`, you can run the unit tests with `rake test:units` and the remote tests with `rake test:remote`. The unit tests mock out requests and responses so that everything runs locally, while the remote tests actually hit the carrier servers. For the remote tests, you'll need valid test credentials for any carriers' tests you want to run. The credentials should go in ~/.active_shipping/credentials.yml, and the format of that file can be seen in the included [credentials.yml](https://github.com/Shopify/active_shipping/blob/master/test/credentials.yml).
 
 ## Contributing
 
@@ -109,31 +112,12 @@ https://github.com/Shopify/active_shipping/tree/master/test/fixtures/xml/usps
 
 To log requests and responses, just set the `logger` on your carrier class to some kind of `Logger` object:
 
-    USPS.logger = Logger.new($stdout)
+    ActiveShipping::USPS.logger = Logger.new($stdout)
 
-(This logging functionality is provided by the [`PostsData` module](https://github.com/Shopify/active_utils/blob/master/lib/active_utils/common/posts_data.rb) in the `active_utils` dependency.)
+(This logging functionality is provided by the [`PostsData` module](https://github.com/Shopify/active_utils/blob/master/lib/active_utils/posts_data.rb) in the `active_utils` dependency.)
 
 After you've pushed your well-tested changes to your github fork, make a pull request and we'll take it from there!
 
-## Contributors
-
-* James MacAulay (<http://jmacaulay.net>)
-* Tobias Luetke (<http://blog.leetsoft.com>)
-* Cody Fauser (<http://codyfauser.com>)
-* Jimmy Baker (<http://jimmyville.com/>)
-* William Lang (<http://williamlang.net/>)
-* Cameron Fowler
-* Christopher Saunders (<http://christophersaunders.ca>)
-* Denis Odorcic
-* Dennis O'Connor
-* Dennis Theisen
-* Edward Ocampo-Gooding
-* Isaac Kearse
-* John Duff
-* Nigel Ramsay
-* Philip Arndt
-* Vikram Oberoi
-
 ## Legal Mumbo Jumbo
 
-Unless otherwise noted in specific files, all code in the Active Shipping project is under the copyright and license described in the included MIT-LICENSE file.
+Unless otherwise noted in specific files, all code in the ActiveShipping project is under the copyright and license described in the included MIT-LICENSE file.

data/lib/active_shipping.rb

@@ -21,33 +21,25 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-$:.unshift File.dirname(__FILE__)
-
-begin
-  require 'active_support/all'
-rescue LoadError
-  require 'rubygems'
-  gem "activesupport", ">= 2.3.5"
-  require "active_support/all"
-end
-
-autoload :XmlNode, 'vendor/xml_node/lib/xml_node'
-autoload :Quantified, 'vendor/quantified/lib/quantified'
-
-require 'net/https'
+require 'active_support'
+require 'active_support/json'
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/class/attribute_accessors'
 require 'active_utils'
 
-require 'active_shipping/shipping/base'
-require 'active_shipping/shipping/response'
-require 'active_shipping/shipping/rate_response'
-require 'active_shipping/shipping/tracking_response'
-require 'active_shipping/shipping/shipping_response'
-require 'active_shipping/shipping/label_response'
-require 'active_shipping/shipping/package'
-require 'active_shipping/shipping/location'
-require 'active_shipping/shipping/rate_estimate'
-require 'active_shipping/shipping/shipment_event'
-require 'active_shipping/shipping/shipment_packer'
-require 'active_shipping/shipping/carrier'
-require 'active_shipping/shipping/carriers'
-require 'active_shipping/shipping/errors'
+require 'vendor/quantified/lib/quantified'
+require 'vendor/xml_node/lib/xml_node'
+
+require 'active_shipping/response'
+require 'active_shipping/rate_response'
+require 'active_shipping/tracking_response'
+require 'active_shipping/shipping_response'
+require 'active_shipping/label_response'
+require 'active_shipping/package'
+require 'active_shipping/location'
+require 'active_shipping/rate_estimate'
+require 'active_shipping/shipment_event'
+require 'active_shipping/shipment_packer'
+require 'active_shipping/carrier'
+require 'active_shipping/carriers'
+require 'active_shipping/errors'

data/lib/active_shipping/carrier.rb

@@ -0,0 +1,82 @@
+module ActiveShipping
+  class Carrier
+    include ActiveUtils::RequiresParameters
+    include ActiveUtils::PostsData
+    include Quantified
+
+    attr_reader :last_request
+    attr_accessor :test_mode
+    alias_method :test_mode?, :test_mode
+
+    # Credentials should be in options hash under keys :login, :password and/or :key.
+    def initialize(options = {})
+      requirements.each { |key| requires!(options, key) }
+      @options = options
+      @last_request = nil
+      @test_mode = @options[:test]
+    end
+
+    # Override to return required keys in options hash for initialize method.
+    def requirements
+      []
+    end
+
+    # Override with whatever you need to get the rates
+    def find_rates(origin, destination, packages, options = {})
+    end
+
+    # Override with whatever you need to get a shipping label
+    def create_shipment(origin, destination, packages, options = {})
+    end
+
+    # Validate credentials with a call to the API. By default this just does a find_rates call
+    # with the orgin and destination both as the carrier's default_location. Override to provide
+    # alternate functionality, such as checking for test_mode to use test servers, etc.
+    def valid_credentials?
+      location = self.class.default_location
+      find_rates(location, location, Package.new(100, [5, 15, 30]), :test => test_mode)
+    rescue ActiveShipping::ResponseError
+      false
+    else
+      true
+    end
+
+    def maximum_weight
+      Mass.new(150, :pounds)
+    end
+
+    protected
+
+    def node_text_or_nil(xml_node)
+      xml_node ? xml_node.text : nil
+    end
+
+    # Override in subclasses for non-U.S.-based carriers.
+    def self.default_location
+      Location.new( :country => 'US',
+                    :state => 'CA',
+                    :city => 'Beverly Hills',
+                    :address1 => '455 N. Rexford Dr.',
+                    :address2 => '3rd Floor',
+                    :zip => '90210',
+                    :phone => '1-310-285-1013',
+                    :fax => '1-310-275-8159')
+    end
+
+    # Use after building the request to save for later inspection. Probably won't ever be overridden.
+    def save_request(r)
+      @last_request = r
+    end
+
+    def timestamp_from_business_day(days)
+      return unless days
+      date = DateTime.now.utc
+      days.times do
+        begin
+          date = date + 1
+        end while [0, 6].include?(date.wday)
+      end
+      date
+    end
+  end
+end

data/lib/active_shipping/carriers.rb

@@ -0,0 +1,33 @@
+module ActiveShipping
+  module Carriers
+    extend self
+
+    attr_reader :registered
+    @registered = []
+
+    def register(class_name, autoload_require)
+      ActiveShipping.autoload(class_name, autoload_require)
+      self.registered << class_name
+    end
+
+    def all
+      ActiveShipping::Carriers.registered.map { |name| ActiveShipping.const_get(name) }
+    end
+
+    def find(name)
+      all.find { |c| c.name.downcase == name.to_s.downcase } or raise NameError, "unknown carrier #{name}"
+    end
+  end
+end
+
+ActiveShipping::Carriers.register :BenchmarkCarrier, 'active_shipping/carriers/benchmark_carrier'
+ActiveShipping::Carriers.register :BogusCarrier,     'active_shipping/carriers/bogus_carrier'
+ActiveShipping::Carriers.register :UPS,              'active_shipping/carriers/ups'
+ActiveShipping::Carriers.register :USPS,             'active_shipping/carriers/usps'
+ActiveShipping::Carriers.register :FedEx,            'active_shipping/carriers/fedex'
+ActiveShipping::Carriers.register :Shipwire,         'active_shipping/carriers/shipwire'
+ActiveShipping::Carriers.register :Kunaki,           'active_shipping/carriers/kunaki'
+ActiveShipping::Carriers.register :CanadaPost,       'active_shipping/carriers/canada_post'
+ActiveShipping::Carriers.register :NewZealandPost,   'active_shipping/carriers/new_zealand_post'
+ActiveShipping::Carriers.register :CanadaPostPWS,    'active_shipping/carriers/canada_post_pws'
+ActiveShipping::Carriers.register :Stamps,           'active_shipping/carriers/stamps'

data/lib/active_shipping/carriers/benchmark_carrier.rb

@@ -0,0 +1,31 @@
+# The time a 3rd-party shipping provider takes to respond to a request varies greatly.
+# This class simulates these unpredictable delays in shipping rate retrieval so that
+# load-testing tools run into situations that more accurately reflect the real world.
+
+module ActiveShipping
+  class BenchmarkCarrier < Carrier
+    cattr_reader :name
+    @@name = "Benchmark Carrier"
+
+    def find_rates(origin, destination, packages, options = {})
+      origin = Location.from(origin)
+      destination = Location.from(destination)
+      packages = Array(packages)
+
+      delay_time = generate_simulated_lag
+
+      bogus_estimate = RateEstimate.new(
+        origin, destination, @@name,
+        "Free Benchmark Shipping", :total_price => 0, :currency => 'USD',
+                                   :packages => packages, :delivery_range => [Time.now.utc.strftime("%Y-%d-%m"), Time.now.utc.strftime("%Y-%d-%m")]
+        )
+      RateResponse.new(true, "Success (delayed #{delay_time} seconds)", {:rate => 'free'}, :rates => [bogus_estimate], :xml => "<rate>free</rate>")
+    end
+
+    private
+
+    def generate_simulated_lag(max_delay = 30)
+      sleep Random.rand * max_delay
+    end
+  end
+end