active_fulfillment 0.10.0

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

@@ -0,0 +1,236 @@
+require 'cgi'
+
+module ActiveMerchant
+  module Fulfillment
+    class ShipwireService < Service
+      SERVICE_URLS = { :fulfillment => 'https://api.shipwire.com/exec/FulfillmentServices.php',
+                       :inventory   => 'https://api.shipwire.com/exec/InventoryServices.php',
+                       :tracking    => 'https://api.shipwire.com/exec/TrackingServices.php'
+                     }
+                     
+      SCHEMA_URLS = { :fulfillment => 'http://www.shipwire.com/exec/download/OrderList.dtd',
+                      :inventory   => 'http://www.shipwire.com/exec/download/InventoryUpdate.dtd',
+                      :tracking    => 'http://www.shipwire.com/exec/download/TrackingUpdate.dtd'
+                    }
+                     
+      POST_VARS = { :fulfillment => 'OrderListXML',
+                    :inventory   => 'InventoryUpdateXML',
+                    :tracking    => 'TrackingUpdateXML'
+                  }
+  
+      WAREHOUSES = { 'CHI' => 'Chicago',
+                     'LAX' => 'Los Angeles',
+                     'REN' => 'Reno',
+                     'VAN' => 'Vancouver',
+                     'TOR' => 'Toronto',
+                     'UK'  => 'United Kingdom'
+                   }
+                   
+      INVALID_LOGIN = /Error with EmailAddress, valid email is required/
+                   
+      # The first is the label, and the last is the code
+      def self.shipping_methods
+        [ ['1 Day Service',   '1D'],
+          ['2 Day Service',   '2D'],
+          ['Ground Service',  'GD'],
+          ['Freight Service', 'FT'],
+          ['International', 'INTL']
+        ].inject(ActiveSupport::OrderedHash.new){|h, (k,v)| h[k] = v; h}
+      end
+                  
+      # Pass in the login and password for the shipwire account.
+      # Optionally pass in the :test => true to force test mode
+      def initialize(options = {})
+        requires!(options, :login, :password)
+       
+        super
+      end
+
+      def fulfill(order_id, shipping_address, line_items, options = {})
+        commit :fulfillment, build_fulfillment_request(order_id, shipping_address, line_items, options)
+      end
+      
+      def fetch_stock_levels(options = {})
+        commit :inventory, build_inventory_request(options)
+      end
+      
+      def fetch_tracking_numbers(options = {})
+        commit :tracking, build_tracking_request(options)
+      end
+      
+      def valid_credentials?
+        response = fetch_tracking_numbers
+        response.message !~ INVALID_LOGIN
+      end
+      
+      def test_mode?
+        true
+      end
+
+      private
+      def build_fulfillment_request(order_id, shipping_address, line_items, options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.declare! :DOCTYPE, :OrderList, :SYSTEM, SCHEMA_URLS[:fulfillment]
+        xml.tag! 'OrderList' do
+          add_credentials(xml)
+          xml.tag! 'Referer', 'Active Fulfillment'
+          add_order(xml, order_id, shipping_address, line_items, options) 
+        end
+        xml.target!
+      end
+      
+      def build_inventory_request(options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.declare! :DOCTYPE, :InventoryStatus, :SYSTEM, SCHEMA_URLS[:inventory]
+        xml.tag! 'InventoryUpdate' do
+          add_credentials(xml)
+          xml.tag! 'Warehouse', WAREHOUSES[options[:warehouse]]
+          xml.tag! 'ProductCode', options[:sku]
+        end
+      end
+      
+      def build_tracking_request(options)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.declare! :DOCTYPE, :InventoryStatus, :SYSTEM, SCHEMA_URLS[:inventory]
+        xml.tag! 'TrackingUpdate' do
+          add_credentials(xml)
+          xml.tag! 'Server', test? ? 'Test' : 'Production'
+          xml.tag! 'Bookmark', '3'
+        end
+      end
+
+      def add_credentials(xml)
+        xml.tag! 'EmailAddress', @options[:login]
+        xml.tag! 'Password', @options[:password]
+        xml.tag! 'Server', test? ? 'Test' : 'Production'
+      end
+
+      def add_order(xml, order_id, shipping_address, line_items, options)
+        xml.tag! 'Order', :id => order_id do
+          xml.tag! 'Warehouse', options[:warehouse] || '00'
+
+          add_address(xml, shipping_address, options)
+          xml.tag! 'Shipping', options[:shipping_method] unless options[:shipping_method].blank?
+
+          Array(line_items).each_with_index do |line_item, index|
+            add_item(xml, line_item, index)
+          end
+        end
+      end
+
+      def add_address(xml, address, options)
+        xml.tag! 'AddressInfo', :type => 'Ship' do
+          xml.tag! 'Name' do
+            xml.tag! 'Full', address[:name]
+          end
+          
+          if address[:company].blank?
+            xml.tag! 'Address1', address[:address1]
+            xml.tag! 'Address2', address[:address2]
+          else
+            xml.tag! 'Address1', address[:company]
+            xml.tag! 'Address2', address[:address1]
+            xml.tag! 'Address3', address[:address2]
+          end
+          
+          xml.tag! 'City', address[:city]
+          xml.tag! 'State', address[:state] unless address[:state].blank?
+          xml.tag! 'Country', address[:country]
+          
+          xml.tag! 'Zip', address[:zip]
+          xml.tag! 'Phone', address[:phone] unless address[:phone].blank?
+          xml.tag! 'Email', options[:email] unless options[:email].blank?
+        end
+      end
+
+      # Code is limited to 12 characters
+      def add_item(xml, item, index)
+        xml.tag! 'Item', :num => index do
+          xml.tag! 'Code', item[:sku]
+          xml.tag! 'Quantity', item[:quantity]
+        end
+      end
+
+      def commit(action, request)
+        data = ssl_post(SERVICE_URLS[action], "#{POST_VARS[action]}=#{CGI.escape(request)}")
+        
+        response = parse_response(action, data)
+        Response.new(response[:success], response[:message], response, :test => test?)
+      end
+      
+      def parse_response(action, data)
+        case action
+        when :fulfillment
+          parse_fulfillment_response(data)        
+        when :inventory
+          parse_inventory_response(data)
+        when :tracking
+          parse_tracking_response(data)
+        else
+          raise ArgumentError, "Unknown action #{action}"
+        end
+      end
+      
+      def parse_fulfillment_response(xml)
+        response = {}
+        
+        document = REXML::Document.new(xml)
+        document.root.elements.each do |node|
+          response[node.name.underscore.to_sym] = node.text
+        end
+        
+        response[:success] = response[:status] == '0'
+        response[:message] = response[:success] ? "Successfully submitted the order" : message_from(response[:error_message])        
+        response
+      end
+      
+      def parse_inventory_response(xml)
+        response = {}
+        response[:stock_levels] = {}
+        
+        document = REXML::Document.new(xml)
+        document.root.elements.each do |node|
+          if node.name == 'Product'
+            response[:stock_levels][node.attributes['code']] = node.attributes['quantity'].to_i
+          else
+            response[node.name.underscore.to_sym] = node.text
+          end
+        end
+        
+        response[:success] = test? ? response[:status] == 'Test' : response[:status] == '0'
+        response[:message] = response[:success] ? "Successfully received the stock levels" : message_from(response[:error_message])
+        
+        response
+      end
+      
+      def parse_tracking_response(xml)
+        response = {}
+        response[:tracking_numbers] = {}
+        
+        document = REXML::Document.new(xml)
+        
+        document.root.elements.each do |node|
+          if node.name == 'Order'
+            response[:tracking_numbers][node.attributes['id']] = node.attributes['trackingNumber'] if node.attributes["shipped"] == "YES"
+          else
+            response[node.name.underscore.to_sym] = node.text
+          end
+        end
+        
+        response[:success] = test? ? (response[:status] == '0' || response[:status] == 'Test') : response[:status] == '0'
+        response[:message] = response[:success] ? "Successfully received the tracking numbers" : message_from(response[:error_message])
+        response
+      end
+      
+      def message_from(string)
+        return if string.blank?
+        string.gsub("\n", '').squeeze(" ")
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,207 @@
+module ActiveMerchant
+  module Fulfillment
+    class WebgistixService < Service
+      TEST_URL = 'https://www.webgistix.com/XML/shippingTest.asp'
+      LIVE_URL = 'https://www.webgistix.com/XML/API.asp'
+      
+      SUCCESS, FAILURE = 'True', 'False'
+      SUCCESS_MESSAGE = 'Successfully submitted the order'
+      FAILURE_MESSAGE = 'Failed to submit the order'
+      INVALID_LOGIN = 'Access Denied'
+      
+      # The first is the label, and the last is the code
+      def self.shipping_methods
+        [ 
+          ["UPS Ground Shipping", "Ground"],
+          ["UPS Standard Shipping (Canada Only)", "Standard"],
+          ["UPS 3-Business Day", "3-Day Select"],
+          ["UPS 2-Business Day", "2nd Day Air"],
+          ["UPS 2-Business Day AM", "2nd Day Air AM"],
+          ["UPS Next Day", "Next Day Air"],
+          ["UPS Next Day Saver", "Next Day Air Saver"],
+          ["UPS Next Day Early AM", "Next Day Air Early AM"],
+          ["UPS Worldwide Express (Next Day)", "Worldwide Express"],
+          ["UPS Worldwide Expedited (2nd Day)", "Worldwide Expedited"],
+          ["UPS Worldwide Express Saver", "Worldwide Express Saver"],
+          ["FedEx Priority Overnight", "FedEx Priority Overnight"],
+          ["FedEx Standard Overnight", "FedEx Standard Overnight"],
+          ["FedEx First Overnight", "FedEx First Overnight"],
+          ["FedEx 2nd Day", "FedEx 2nd Day"],
+          ["FedEx Express Saver", "FedEx Express Saver"],
+          ["FedEx International Priority", "FedEx International Priority"],
+          ["FedEx International Economy", "FedEx International Economy"],
+          ["FedEx International First", "FedEx International First"],
+          ["FedEx Ground", "FedEx Ground"],
+          ["USPS Priority Mail & Global Priority Mail", "Priority"],
+          ["USPS Priority Mail & Global Priority Mail (flat rate)", "Flat Rate Priority"],
+          ["USPS First Class Mail", "First Class"],
+          ["USPS Express Mail & Global Express Mail", "Express"],
+          ["USPS Flat Rate Global Express Mail", "Global Express Mail Flat Rate"],
+          ["USPS Parcel Post", "Parcel"],
+          ["USPS First Class International", "First Class International"],
+          ["USPS Media Mail", "Media Mail"],
+          ["USPS Economy Parcel Post", "Economy Parcel"],
+          ["USPS Economy Air Letter Post", "Economy Letter"],
+        ].inject(ActiveSupport::OrderedHash.new){|h, (k,v)| h[k] = v; h}
+      end
+      
+      # Pass in the login and password for the shipwire account.
+      # Optionally pass in the :test => true to force test mode
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        super
+        @url = test? ? TEST_URL : LIVE_URL
+      end
+
+      def fulfill(order_id, shipping_address, line_items, options = {})  
+        requires!(options, :shipping_method) 
+        commit build_fulfillment_request(order_id, shipping_address, line_items, options)
+      end
+      
+      def valid_credentials?
+        response = fulfill('', {}, [], :shipping_method => '')
+        response.message != INVALID_LOGIN
+      end
+   
+      def test_mode?
+        true
+      end
+
+      private
+      #<?xml version="1.0"?> 
+      # <OrderXML> 
+      #   <Password>Webgistix</Password> 
+      #   <CustomerID>3</CustomerID> 
+      #   <Order> 
+      #     <ReferenceNumber></ReferenceNumber> 
+      #     <Company>Test Company</Company> 
+      #     <Name>Joe Smith</Name> 
+      #     <Address1>123 Main St.</Address1> 
+      #     <Address2></Address2> 
+      #     <Address3></Address3> 
+      #     <City>Olean</City> 
+      #     <State>NY</State> 
+      #     <ZipCode>14760</ZipCode> 
+      #     <Country>United States</Country> 
+      #     <Email>info@webgistix.com</Email> 
+      #     <Phone>1-123-456-7890</Phone> 
+      #     <ShippingInstructions>Ground</ShippingInstructions> 
+      #     <OrderComments>Test Order</OrderComments> 
+      #     <Approve>0</Approve> 
+      #     <Item> 
+      #      <ItemID>testitem</ItemID> 
+      #      <ItemQty>2</ItemQty> 
+      #     </Item> 
+      #   </Order> 
+      # </OrderXML>
+      def build_fulfillment_request(order_id, shipping_address, line_items, options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.tag! 'OrderXML' do
+          add_credentials(xml)
+          add_order(xml, order_id, shipping_address, line_items, options) 
+        end
+        xml.target!
+      end
+      
+      def add_credentials(xml)
+        xml.tag! 'CustomerID', @options[:login]
+        xml.tag! 'Password', @options[:password]
+      end
+
+      def add_order(xml, order_id, shipping_address, line_items, options)
+        xml.tag! 'Order' do
+          xml.tag! 'ReferenceNumber', order_id
+          xml.tag! 'ShippingInstructions', options[:shipping_method]
+          xml.tag! 'Approve', 1
+          xml.tag! 'OrderComments', options[:comment] unless options[:comment].blank?
+    
+          add_address(xml, shipping_address, options)
+
+          Array(line_items).each_with_index do |line_item, index|
+            add_item(xml, line_item, index)
+          end
+        end
+      end
+      
+      def add_address(xml, address, options)
+        xml.tag! 'Name', address[:name]
+        xml.tag! 'Address1', address[:address1]
+        xml.tag! 'Address2', address[:address2] unless address[:address2].blank?
+        xml.tag! 'Address3', address[:address3] unless address[:address3].blank?
+        xml.tag! 'City', address[:city]
+        xml.tag! 'State', address[:state]
+        xml.tag! 'ZipCode', address[:zip]
+        xml.tag! 'Company', address[:company]
+          
+        unless address[:country].blank?
+          country = Country.find(address[:country])
+          xml.tag! 'Country', country.name
+        end
+        
+        xml.tag! 'Phone', address[:phone]
+        xml.tag! 'Email', options[:email] unless options[:email].blank?
+      end
+
+      def add_item(xml, item, index)
+        xml.tag! 'Item' do
+          xml.tag! 'ItemID', item[:sku] unless item[:sku].blank?
+          xml.tag! 'ItemQty', item[:quantity] unless item[:quantity].blank?
+        end
+      end
+
+      def commit(request)
+        @response = parse(ssl_post(@url, request,
+                            'EndPointURL'  => @url,
+                            'Content-Type' => 'text/xml; charset="utf-8"')
+                         )
+        
+        Response.new(success?(@response), message_from(@response), @response, 
+          :test => test?
+        )
+      end
+      
+      def success?(response)
+        response[:success] == SUCCESS
+      end
+      
+      def message_from(response)
+        return SUCCESS_MESSAGE if success?(response)
+
+        if response[:error_0] == INVALID_LOGIN
+          INVALID_LOGIN
+        else
+          FAILURE_MESSAGE
+        end
+      end
+      
+      def parse(xml)
+        response = {}
+        
+        begin 
+          document = REXML::Document.new("<response>#{xml}</response>")
+        rescue REXML::ParseException
+          response[:success] = FAILURE
+          return response
+        end
+        # Fetch the errors
+        document.root.elements.to_a("Error").each_with_index do |e, i|
+          response["error_#{i}".to_sym] = e.text
+        end
+        
+        # Check if completed
+        if completed = REXML::XPath.first(document, '//Completed')
+          completed.elements.each do |e|
+            response[e.name.underscore.to_sym] = e.text
+          end
+        else
+          response[:success] = FAILURE
+        end
+        
+        response
+      end
+    end
+  end
+end
+
+

data/lib/active_fulfillment/fulfillment/services.rb

@@ -0,0 +1,3 @@
+require 'active_fulfillment/fulfillment/services/shipwire'
+require 'active_fulfillment/fulfillment/services/webgistix'
+require 'active_fulfillment/fulfillment/services/amazon'

data/lib/active_fulfillment.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__)
+
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  require 'active_support'
+end
+
+begin
+  require 'builder'
+rescue LoadError
+  require 'rubygems'
+  require_gem 'builder'
+end
+
+
+require 'cgi'
+require 'net/https'
+require 'rexml/document'
+require 'active_merchant/common'
+
+require 'active_fulfillment/fulfillment/base'
+require 'active_fulfillment/fulfillment/response'
+require 'active_fulfillment/fulfillment/service'
+require 'active_fulfillment/fulfillment/services'
+