active_fulfillment 0.10.0

data/CHANGELOG

@@ -0,0 +1,26 @@
+* Remove DHL from Webgistix shipping methods [Dennis Thiesen]
+* Update Amazon FBA to use AWS credentials [John Tajima]
+* Use new connection code from ActiveMerchant [cody]
+* Add #valid_credentials? support to all fulfillment services [cody]
+* Return 'Access Denied' message when Webgistix credenentials are invalid [cody]
+* Update Shipwire endpoint hostname [cody]
+* Add missing ISO countries [Edward Ocampo-Gooding]
+* Add support for Guernsey to country.rb [cody]
+* Use a Rails 2.3 compatible OrderedHash [cody]
+* Use :words_connector instead of connector in RequiresParameters [cody]
+* Provide Webgistix with a valid test sku to keep remote tests passing
+* Update PostsData to support get requests
+* Update Shipwire to latest version of dtd.
+* Use real addresses for Shipwire remote fulfillment tests
+* Pass Shipwire the ISO country code instead of the previous name and country combo. Always add the country element to the document
+* Update Shipwire warehouses and don't send unneeded Content-Type header
+* Add configurable timeouts from Active Merchant
+* Shipwire: Send the company in address1 if present. Otherwise send address1 in address1.
+* Always send address to Shipwire
+* Map company to address1 with Shipwire
+* Sync posts_data.rb with ActiveMerchant
+* Add support for fetching tracking numbers to Shipwire
+* Move email to the options hash. Refactor Shipwire commit method.
+* Package for initial upload to Google Code
+* Fix remote Webgistix test
+* Add support for Fulfillment by Amazon Basic Fulfillment

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+desc "Default Task"
+task :default => 'test:units'
+
+# Run the unit tests
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote) do |t|
+    t.pattern = 'test/remote/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ActiveFulfillment 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
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'active_fulfillment'
+    gemspec.summary = "Framework and tools for dealing with shipping, tracking and order fulfillment services."
+    gemspec.email = "cody@shopify.com"
+    gemspec.homepage = "http://github.com/shopify/active_fulfillment"
+    gemspec.authors = ["Cody Fauser", "James MacAulay"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+task :update_common do 
+  STDERR.puts "Updating common include from ../active_merchant. Please make sure this is up-to-date"
+  system("diff -u lib/active_merchant/common.rb ../active_merchant/lib/active_merchant/common.rb | patch -p0")
+  system("diff -ur lib/active_merchant/common ../active_merchant/lib/active_merchant/common | patch -p0")  
+  STDERR.puts "done.."
+end

data/VERSION

@@ -0,0 +1 @@
+0.10.0

data/active_fulfillment.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_fulfillment}
+  s.version = "0.10.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cody Fauser", "James MacAulay"]
+  s.date = %q{2010-07-06}
+  s.email = %q{cody@shopify.com}
+  s.files = [
+    "CHANGELOG",
+     "Rakefile",
+     "VERSION",
+     "active_fulfillment.gemspec",
+     "init.rb",
+     "lib/active_fulfillment.rb",
+     "lib/active_fulfillment/fulfillment/base.rb",
+     "lib/active_fulfillment/fulfillment/response.rb",
+     "lib/active_fulfillment/fulfillment/service.rb",
+     "lib/active_fulfillment/fulfillment/services.rb",
+     "lib/active_fulfillment/fulfillment/services/amazon.rb",
+     "lib/active_fulfillment/fulfillment/services/shipwire.rb",
+     "lib/active_fulfillment/fulfillment/services/webgistix.rb",
+     "lib/active_merchant/common.rb",
+     "lib/active_merchant/common/connection.rb",
+     "lib/active_merchant/common/country.rb",
+     "lib/active_merchant/common/error.rb",
+     "lib/active_merchant/common/post_data.rb",
+     "lib/active_merchant/common/posts_data.rb",
+     "lib/active_merchant/common/requires_parameters.rb",
+     "lib/active_merchant/common/utils.rb",
+     "lib/active_merchant/common/validateable.rb",
+     "lib/certs/cacert.pem",
+     "test/fixtures.yml",
+     "test/remote/amazon_test.rb",
+     "test/remote/shipwire_test.rb",
+     "test/remote/webgistix_test.rb",
+     "test/test_helper.rb",
+     "test/unit/base_test.rb",
+     "test/unit/services/amazon_test.rb",
+     "test/unit/services/shipwire_test.rb",
+     "test/unit/services/webgistix_test.rb"
+  ]
+  s.homepage = %q{http://github.com/shopify/active_fulfillment}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Framework and tools for dealing with shipping, tracking and order fulfillment services.}
+  s.test_files = [
+    "test/remote/amazon_test.rb",
+     "test/remote/shipwire_test.rb",
+     "test/remote/webgistix_test.rb",
+     "test/test_helper.rb",
+     "test/unit/base_test.rb",
+     "test/unit/services/amazon_test.rb",
+     "test/unit/services/shipwire_test.rb",
+     "test/unit/services/webgistix_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

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

data/lib/active_fulfillment/fulfillment/base.rb

@@ -0,0 +1,12 @@
+module ActiveMerchant
+  module Fulfillment
+    module Base
+      mattr_accessor :mode
+      self.mode = :production
+      
+      def self.service(name)
+        ActiveMerchant::Fulfillment.const_get("#{name.to_s.downcase}_service".camelize)
+      end
+    end
+  end
+end

data/lib/active_fulfillment/fulfillment/response.rb

@@ -0,0 +1,32 @@
+module ActiveMerchant
+  module Fulfillment
+  
+    class Error < StandardError
+    end
+  
+    class Response
+      attr_reader :params
+      attr_reader :message
+      attr_reader :test
+    
+      def success?
+        @success
+      end
+
+      def test?
+        @test
+      end
+        
+      def initialize(success, message, params = {}, options = {})
+        @success, @message, @params = success, message, params.stringify_keys
+        @test = options[:test] || false        
+      end
+      
+      private
+      def method_missing(method, *args)
+        @params[method.to_s] || super
+      end
+    end
+    
+  end
+end

data/lib/active_fulfillment/fulfillment/service.rb

@@ -0,0 +1,31 @@
+module ActiveMerchant
+  module Fulfillment
+    class Service
+      
+      include RequiresParameters
+      include PostsData
+      
+      def initialize(options = {})
+        check_test_mode(options)
+        
+        @options = {}
+        @options.update(options)
+      end
+      
+      def test_mode?
+        false
+      end
+      
+      def test?
+        @options[:test] || Base.mode == :test
+      end
+      
+      private
+      def check_test_mode(options)
+        if options[:test] and not test_mode?
+          raise ArgumentError, 'Test mode is not supported by this gateway'
+        end
+      end
+    end
+  end
+end

data/lib/active_fulfillment/fulfillment/services/amazon.rb

@@ -0,0 +1,230 @@
+require 'base64'
+require 'openssl'
+
+module ActiveMerchant
+  module Fulfillment
+    class AmazonService < Service
+      OUTBOUND_URL   = "https://fba-outbound.amazonaws.com"
+      OUTBOUND_XMLNS = 'http://fba-outbound.amazonaws.com/doc/2007-08-02/'
+      VERSION        = "2007-08-02"
+    
+      SUCCESS, FAILURE, ERROR = 'Accepted', 'Failure', 'Error'    
+      MESSAGES = {
+        :status => {
+          'Accepted' => 'Success',
+          'Failure'  => 'Failed',
+          'Error'    => 'An error occurred'          
+        },
+        :create => {
+          'Accepted' => 'Successfully submitted the order',
+          'Failure'  => 'Failed to submit the order',
+          'Error'    => 'An error occurred while submitting the order'
+        },
+        :list   => {
+          'Accepted' => 'Successfully submitted request',
+          'Failure'  => 'Failed to submit request',
+          'Error'    => 'An error occurred while submitting request'
+          
+        }
+      }
+      
+      ENV_NAMESPACES = { 'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                         'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+                         'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+                       }
+
+      AWS_SECURITY_ATTRIBUTES = {
+        "env:actor" => "http://schemas.xmlsoap.org/soap/actor/next",
+        "env:mustUnderstand" => "0",
+        "xmlns:aws" => "http://security.amazonaws.com/doc/2007-01-01/"
+      }
+
+      @@digest = OpenSSL::Digest::Digest.new("sha1")
+      
+      OPERATIONS = {
+        :status => 'GetServiceStatus',
+        :create => 'CreateFulfillmentOrder',
+        :list   => 'ListAllFulfillmentOrders'
+      }
+                   
+      # The first is the label, and the last is the code
+      # Standard:  3-5 business days
+      # Expedited: 2 business days
+      # Priority:  1 business day
+      def self.shipping_methods
+        [ 
+          [ 'Standard Shipping', 'Standard' ],
+          [ 'Expedited Shipping', 'Expedited' ],
+          [ 'Priority Shipping', 'Priority' ]
+        ].inject(ActiveSupport::OrderedHash.new){|h, (k,v)| h[k] = v; h}
+      end
+      
+      def self.sign(aws_secret_access_key, auth_string)
+        Base64.encode64(OpenSSL::HMAC.digest(@@digest, aws_secret_access_key, auth_string)).strip
+      end
+            
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+      end
+      
+      def status
+        commit :status, build_status_request
+      end
+
+      def fulfill(order_id, shipping_address, line_items, options = {})   
+        requires!(options, :order_date, :comment, :shipping_method)
+        commit :create, build_fulfillment_request(order_id, shipping_address, line_items, options)
+      end
+      
+      def fetch_current_orders
+        commit :list, build_get_current_fulfillment_orders_request
+      end
+      
+      def valid_credentials?
+        status.success?
+      end
+   
+      def test_mode?
+        false
+      end
+
+      private
+      def soap_request(request)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! "env:Envelope", ENV_NAMESPACES do
+          xml.tag! "env:Header" do
+            add_credentials(xml, request)
+          end
+          xml.tag! "env:Body" do
+            yield xml
+          end
+        end
+        xml.target!
+      end
+      
+      def build_status_request
+        request = OPERATIONS[:status]
+        soap_request(request) do |xml|
+          xml.tag! request, { 'xmlns' => OUTBOUND_XMLNS }
+        end
+      end
+      
+      def build_get_current_fulfillment_orders_request
+        request = OPERATIONS[:list]
+        soap_request(request) do |xml|
+          xml.tag! request, { 'xmlns' => OUTBOUND_XMLNS } do
+            xml.tag! "NumberOfResultsRequested", 5
+            xml.tag! "QueryStartDateTime", Time.now.utc.yesterday.strftime("%Y-%m-%dT%H:%M:%SZ")
+          end
+        end
+      end
+
+      def build_fulfillment_request(order_id, shipping_address, line_items, options)
+        request = OPERATIONS[:create]
+        soap_request(request) do |xml|
+          xml.tag! request, { 'xmlns' => OUTBOUND_XMLNS } do
+             xml.tag! "MerchantFulfillmentOrderId", order_id
+             xml.tag! "DisplayableOrderId", order_id
+             xml.tag! "DisplayableOrderDateTime", options[:order_date].strftime("%Y-%m-%dT%H:%M:%SZ")
+             xml.tag! "DisplayableOrderComment", options[:comment]
+             xml.tag! "ShippingSpeedCategory", options[:shipping_method]
+   
+             add_address(xml, shipping_address)
+             add_items(xml, line_items)
+          end
+        end
+      end
+
+      def add_credentials(xml, request)
+        login     = @options[:login]
+        timestamp = "#{Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S")}Z"
+        signature = self.class.sign(@options[:password], "#{request}#{timestamp}")
+      
+        xml.tag! 'aws:AWSAccessKeyId', login, AWS_SECURITY_ATTRIBUTES
+        xml.tag! 'aws:Signature', signature, AWS_SECURITY_ATTRIBUTES
+        xml.tag! 'aws:Timestamp', timestamp, AWS_SECURITY_ATTRIBUTES
+      end
+        
+      def add_items(xml, line_items) 
+        Array(line_items).each_with_index do |item, index|
+          xml.tag! 'Item' do
+            xml.tag! 'MerchantSKU', item[:sku]
+            xml.tag! "MerchantFulfillmentOrderItemId", index
+            xml.tag! "Quantity",  item[:quantity]
+            xml.tag! "GiftMessage", item[:gift_message] unless item[:gift_message].blank?
+            xml.tag! "DisplayableComment", item[:comment] unless item[:comment].blank?
+          end
+        end
+      end
+    
+      def add_address(xml, address)
+        xml.tag! 'DestinationAddress' do 
+          xml.tag! 'Name', address[:name]
+          xml.tag! 'Line1', address[:address1]
+          xml.tag! 'Line2', address[:address2] unless address[:address2].blank?
+          xml.tag! 'Line3', address[:address3] unless address[:address3].blank?
+          xml.tag! 'City', address[:city]
+          xml.tag! 'StateOrProvinceCode', address[:state]
+          xml.tag! 'CountryCode', address[:country]
+          xml.tag! 'PostalCode', address[:zip]
+          xml.tag! 'PhoneNumber', address[:phone]  unless address[:phone].blank?
+        end
+      end
+      
+      def commit(op, body)
+        data = ssl_post(OUTBOUND_URL, body, 'Content-Type' => 'application/soap+xml; charset=utf-8')
+        response = parse(op, data)   
+        Response.new(success?(response), message_from(response), response)
+      rescue ActiveMerchant::ResponseError => e        
+        response = parse_error(e.response)
+        Response.new(false, message_from(response), response)
+      end
+      
+      def success?(response)
+        response[:response_status] == SUCCESS
+      end
+      
+      def message_from(response)
+        response[:response_comment]
+      end
+      
+      def parse(op, xml)
+        response = {}
+        action   = OPERATIONS[op]                
+        document = REXML::Document.new(xml)
+        node     = REXML::XPath.first(document, "//ns1:#{action}Response")
+        
+        response[:response_status]  = SUCCESS
+        response[:response_comment] = MESSAGES[op][SUCCESS]
+        response
+      end
+      
+      def parse_error(http_response)
+        response = {}
+        response[:http_code] = http_response.code
+        response[:http_message] = http_response.message
+
+        document = REXML::Document.new(http_response.body)
+
+        node     = REXML::XPath.first(document, "//env:Fault")
+
+        failed_node = node.find_first_recursive {|sib| sib.name == "Fault" }
+        faultcode_node = node.find_first_recursive {|sib| sib.name == "faultcode" }
+        faultstring_node = node.find_first_recursive {|sib| sib.name == "faultstring" }
+          
+        response[:response_status]  = FAILURE
+        response[:faultcode]        = faultcode_node ? faultcode_node.text : ""
+        response[:faultstring]      = faultstring_node ? faultstring_node.text : ""
+        response[:response_comment] = "#{response[:faultcode]} #{response[:faultstring]}"
+        response
+      rescue REXML::ParseException => e
+        response[:http_body]        = http_response.body
+        response[:response_status]  = FAILURE
+        response[:response_comment] = "#{response[:http_code]}: #{response[:http_message]}"
+        response
+      end
+    end 
+  end
+end