active_shipping 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+test.xml
+sample.rb
+*.orig
+*.swp
+.dotest

data/CHANGELOG

@@ -0,0 +1,23 @@
+* Remove ftools for Rails 1.9 compatibility and remove xml logging, as logging is now included in the connection [cody]
+* Update connection code from ActiveMerchant [cody]
+* Fix space-ridden USPS usernames when validating credentials [james]
+* Remove extra slash from USPS URLs [james]
+* Update Shipwire endpoint hostname [cody]
+* Add missing ISO countries [Edward Ocampo-Gooding]
+* Add support for Guernsey to country.rb [cody]
+* Use :words_connector instead of connector in RequiresParameters [cody]
+* Fix extra slash in UPS endpoints [cody]
+* Add name to Shipwire class [cody]
+* Improve FedEx handling of some error conditions [cody]
+* Add support for validating credentials to Shipwire [cody]
+* Add support for ssl_get to PostsData. Update Carriers to use PostsData module. Turn on retry safety for carriers [cody]
+* Add support for Shipwire Shipping Rate API [cody]
+* Cleanup package tests [cody]
+* Remove unused Carrier#setup method [cody]
+* Don't use Array splat in Regex comparisons in Package [cody]
+* Default the Location to use the :alpha2 country code format [cody]
+* Add configurable timeouts from Active Merchant [cody]
+* Update xml_node.rb from XML Node [cody]
+* Update requires_parameters from ActiveMerchant [cody]
+* Sync posts_data.rb with ActiveMerchant [cody]
+* Don't use credentials fixtures in local tests [cody]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 James MacAulay
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,173 @@
+# Active Shipping
+
+This library is meant to interface 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.
+
+We are starting out by only implementing the ability to list available shipping rates for a particular origin, destination, and set of packages. Further development could take advantage of other common features of carriers' web services such as tracking orders and printing labels.
+
+Active Shipping is currently being used and improved in a production environment for the e-commerce application [Shopify][]. Development is being done by [James MacAulay][] (<james@jadedpixel.com>). Discussion is welcome in the [Active Merchant Google Group][discuss].
+
+[Active Merchant]:http://www.activemerchant.org
+[Shopify]:http://www.shopify.com
+[James MacAulay]:http://jmacaulay.net
+[discuss]:http://groups.google.com/group/activemerchant
+
+## Supported Shipping Carriers
+
+* [UPS](http://www.ups.com)
+* [USPS](http://www.usps.com)
+* [FedEx](http://www.fedex.com)
+* more soon!
+
+## Prerequisites
+
+* [active_support](http://github.com/rails/rails/tree/master/activesupport)
+* [xml_node](http://github.com/tobi/xml_node/) (right now a version of it is actually included in this library, so you don't need to worry about it yet)
+* [mocha](http://mocha.rubyforge.org/) for the tests
+
+## Download & Installation
+
+Currently this library is available on GitHub:
+
+  <http://github.com/Shopify/active_shipping>
+
+You will need to get [Git][] if you don't have it. Then:
+
+  > git clone git://github.com/Shopify/active_shipping.git
+
+(That URL is case-sensitive, so watch out.)
+  
+Active Shipping includes an init.rb file. This means that Rails will automatically load it on startup. Check out [git-archive][] for exporting the file tree from your repository to your vendor directory.
+
+Gem and tarball forthcoming on rubyforge.
+  
+[Git]:http://git.or.cz/
+[git-archive]:http://www.kernel.org/pub/software/scm/git/docs/git-archive.html
+
+## Sample Usage
+
+    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
+    ]
+  
+    # 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')
+                              
+    # Find out how much it'll be.
+    ups = 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')
+    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],
+    #     ["USPS Global Express Guaranteed Non-Document Non-Rectangular", 9400],
+    #     ["USPS GXG Envelopes", 9400],
+    #     ["USPS Global Express Guaranteed Non-Document Rectangular", 9400],
+    #     ["USPS Global Express Guaranteed", 9400]]
+    
+    # FedEx
+    fdx = FedEx.new(:login => 'Your 9-digit FedEx Account #', :password => 'Your Meter Number')
+    response = fdx.find_rates(origin, destination, packages, :test => true)
+    response.rates.sort_by(&:price).collect {|rate| [rate.service_name, rate.price]}
+    # => [["FedEx Ground", 977], 
+    # ["FedEx Ground Home Delivery", 1388], 
+    # ["FedEx Express Saver", 2477], 
+    # ["FedEx 2 Day", 2718], 
+    # ["FedEx Standard Overnight", 4978], 
+    # ["FedEx Priority Overnight", 8636], 
+    # ["FedEx First Overnight", 12306]]
+    
+    # FedEx Tracking
+    fdx = FedEx.new(:login => '999999999', :password => '7777777')
+    tracking_info = fdx.find_tracking_info('tracking number here', :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. 
+    # Delivered at Knoxville, TN on Fri Oct 24 16:45:00 UTC 2008. Signed for by: T.BAKER
+    
+    tracking_info = fdx.find_tracking_info('tracking number here', :carrier_code => 'fedex_express') # Express package
+    
+    tracking_info.shipment_events.each do |event|
+      puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
+    end
+    # => Picked up by FedEx at NASHVILLE, TN on Wed Dec 03 16:46:00 UTC 2008. 
+    # Package status at MISSISSAUGA, ON on Wed Dec 03 18:00:00 UTC 2008. 
+    # Left FedEx Origin Location at NASHVILLE, TN on Wed Dec 03 20:27:00 UTC 2008. 
+    # Arrived at FedEx Ramp at NASHVILLE, TN on Wed Dec 03 20:43:00 UTC 2008. 
+    # Left FedEx Ramp at NASHVILLE, TN on Wed Dec 03 22:30:00 UTC 2008. 
+    # Arrived at Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 00:31:00 UTC 2008. 
+    # Left FedEx Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 01:14:00 UTC 2008. 
+    # Left FedEx Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 04:48:00 UTC 2008. 
+    # Arrived at FedEx Ramp at MISSISSAUGA, ON on Thu Dec 04 06:26:00 UTC 2008. 
+    # Package status at MISSISSAUGA, ON on Thu Dec 04 07:03:00 UTC 2008. 
+    # Left FedEx Ramp at MISSISSAUGA, ON on Thu Dec 04 07:37:00 UTC 2008. 
+    # Arrived at FedEx Destination Location at TORONTO, ON on Thu Dec 04 08:42:00 UTC 2008. 
+    # On FedEx vehicle for delivery at TORONTO, ON on Thu Dec 04 09:04:00 UTC 2008. 
+    # Delivered to Non-FedEx clearance broker at TORONTO, ON on Thu Dec 04 10:15:00 UTC 2008.
+
+## TODO
+
+* proper documentation
+* proper offline testing for carriers in addition to the remote tests
+* package into a gem
+* carrier code template generator
+* more carriers
+* integrate with ActiveMerchant
+* support more features for existing carriers
+* bin-packing algorithm (preferably implemented in ruby)
+* order tracking
+* label printing
+
+## Contributing
+
+Yes, please! Take a look at the tests and the implementation of the Carrier class to see how the basics work. At some point soon there will be a carrier template generator along the lines of the gateway generator included in Active Merchant, but carrier.rb outlines most of what's necessary. The other main classes that would be good to familiarize yourself with are Location, Package, and Response.
+
+The nicest way to submit changes would be to set up a GitHub account and fork this project, then initiate a pull request when you want your changes looked at. You can also make a patch (preferably with [git-diff][]) and email to james@jadedpixel.com.
+
+[git-diff]:http://www.kernel.org/pub/software/scm/git/docs/git-diff.html
+
+## Contributors
+
+* James MacAulay (<http://jmacaulay.net>)
+* Tobias Luetke (<http://blog.leetsoft.com>)
+* Cody Fauser (<http://codyfauser.com>)
+* Jimmy Baker (<http://jimmyville.com/>)
+
+## 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.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_shipping"
+    gem.summary = %Q{Shipping API extension for Active Merchant.}
+    gem.description = %Q{Shipping API extension for Active Merchant.}
+    gem.email = "jmacaulay@gmail.com"
+    gem.homepage = "http://github.com/Shopify/active_shipping"
+    gem.authors = ["James MacAulay", "Tobias Luetke", "Cody Fauser", "Jimmy Baker"]
+    gem.add_dependency "activesupport"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+desc "Default Task"
+task :default => 'test:units'
+task :test => ['test:units','test:remote']
+
+# Run the unit tests
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote) do |t|
+    t.pattern = 'test/remote/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.verbose = true
+  end
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ActiveShipping library"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :install => [:package] do
+  `gem install pkg/#{PKG_FILE_NAME}.gem`
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'active_shipping'

data/lib/active_shipping.rb

@@ -0,0 +1,50 @@
+#--
+# Copyright (c) 2009 Jaded Pixel
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'active_support'
+
+require 'vendor/xml_node/lib/xml_node'
+require 'vendor/quantified/lib/quantified'
+require 'quantified/mass'
+require 'quantified/length'
+
+require 'net/https'
+require 'active_shipping/lib/error'
+require 'active_shipping/lib/requires_parameters'
+require 'active_shipping/lib/connection'
+require 'active_shipping/lib/posts_data'
+require 'active_shipping/lib/country'
+
+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/package'
+require 'active_shipping/shipping/location'
+require 'active_shipping/shipping/rate_estimate'
+require 'active_shipping/shipping/shipment_event'
+require 'active_shipping/shipping/carrier'
+require 'active_shipping/shipping/carriers'

data/lib/active_shipping/lib/connection.rb

@@ -0,0 +1,170 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'benchmark'
+
+module ActiveMerchant  
+  class ConnectionError < ActiveMerchantError # :nodoc:
+  end
+  
+  class RetriableConnectionError < ConnectionError # :nodoc:
+  end
+  
+  class ResponseError < ActiveMerchantError # :nodoc:
+    attr_reader :response
+
+    def initialize(response, message = nil)
+      @response = response
+      @message  = message
+    end
+
+    def to_s
+      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
+    end
+  end
+  
+  class Connection
+    MAX_RETRIES = 3
+    OPEN_TIMEOUT = 60
+    READ_TIMEOUT = 60
+    VERIFY_PEER = true
+    RETRY_SAFE = false
+    RUBY_184_POST_HEADERS = { "Content-Type" => "application/x-www-form-urlencoded" }
+  
+    attr_accessor :endpoint
+    attr_accessor :open_timeout
+    attr_accessor :read_timeout
+    attr_accessor :verify_peer
+    attr_accessor :retry_safe
+    attr_accessor :pem
+    attr_accessor :pem_password
+    attr_accessor :wiredump_device
+    attr_accessor :logger
+    attr_accessor :tag
+    
+    def initialize(endpoint)
+      @endpoint     = endpoint.is_a?(URI) ? endpoint : URI.parse(endpoint)
+      @open_timeout = OPEN_TIMEOUT
+      @read_timeout = READ_TIMEOUT
+      @retry_safe   = RETRY_SAFE
+      @verify_peer  = VERIFY_PEER
+    end
+    
+    def request(method, body, headers = {})
+      retry_exceptions do 
+        begin
+          info "#{method.to_s.upcase} #{endpoint}", tag
+
+          result = nil
+          
+          realtime = Benchmark.realtime do
+            result = case method
+            when :get
+              raise ArgumentError, "GET requests do not support a request body" if body
+              http.get(endpoint.request_uri, headers)
+            when :post
+              debug body
+              http.post(endpoint.request_uri, body, RUBY_184_POST_HEADERS.merge(headers))
+            else
+              raise ArgumentError, "Unsupported request method #{method.to_s.upcase}"
+            end
+          end
+          
+          info "--> %d %s (%d %.4fs)" % [result.code, result.message, result.body ? result.body.length : 0, realtime], tag
+          response = handle_response(result)
+          debug response
+          response
+        rescue EOFError => e
+          raise ConnectionError, "The remote server dropped the connection"
+        rescue Errno::ECONNRESET => e
+          raise ConnectionError, "The remote server reset the connection"
+        rescue Errno::ECONNREFUSED => e
+          raise RetriableConnectionError, "The remote server refused the connection"
+        rescue Timeout::Error, Errno::ETIMEDOUT => e
+          raise ConnectionError, "The connection to the remote server timed out"
+        end
+      end
+    end
+    
+    private
+    def http
+      http = Net::HTTP.new(endpoint.host, endpoint.port)
+      configure_debugging(http)
+      configure_timeouts(http)
+      configure_ssl(http)
+      configure_cert(http)
+      http
+    end
+    
+    def configure_debugging(http)
+      http.set_debug_output(wiredump_device)
+    end
+    
+    def configure_timeouts(http)
+      http.open_timeout = open_timeout
+      http.read_timeout = read_timeout
+    end
+    
+    def configure_ssl(http)
+      return unless endpoint.scheme == "https"
+
+      http.use_ssl = true
+      
+      if verify_peer
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.ca_file     = File.dirname(__FILE__) + '/../../certs/cacert.pem'
+      else               
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+    
+    def configure_cert(http)
+      return if pem.blank?
+      
+      http.cert = OpenSSL::X509::Certificate.new(pem)
+      
+      if pem_password
+        http.key = OpenSSL::PKey::RSA.new(pem, pem_password)
+      else
+        http.key = OpenSSL::PKey::RSA.new(pem)
+      end
+    end
+        
+    def retry_exceptions
+      retries = MAX_RETRIES
+      begin
+        yield
+      rescue RetriableConnectionError => e
+        retries -= 1
+        retry unless retries.zero?
+        raise ConnectionError, e.message
+      rescue ConnectionError
+        retries -= 1
+        retry if retry_safe && !retries.zero?
+        raise
+      end
+    end
+    
+    def handle_response(response)
+      case response.code.to_i
+      when 200...300
+        response.body
+      else
+        raise ResponseError.new(response)
+      end
+    end
+    
+    def debug(message, tag = nil)
+      log(:debug, message, tag)
+    end
+    
+    def info(message, tag = nil)
+      log(:info, message, tag)
+    end
+    
+    def log(level, message, tag)
+      message = "[#{tag}] #{message}" if tag
+      logger.send(level, message) if logger
+    end
+  end
+end