active_fulfillment 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 143a9457ed3cbe9faff1de7fe049ba1061421d5d
-  data.tar.gz: fd48163baf2ed6c6388a25d2af6812630a75cf6b
+  metadata.gz: cba1390bb08c4c010debba62180ac2f00b2c1d33
+  data.tar.gz: e2b321fd688279d43ddc20127de4a9640c78cc1e
 SHA512:
-  metadata.gz: ef2ab9127ce387ada96e6dcb90c43b660957a3c0d5fa9da36c4c5d66f6518bdf21c48fcf811b6e1da9e269c19528053db8c011306558694abe0d72e6f821daa7
-  data.tar.gz: 37ce0735dcfaff356284a72dca0d7b8aadea81b42630f4fb5d5a517e99111993b0a41ee5706c4dccaefa8acfba44631937604535240accbba41261c96699f946
+  metadata.gz: 2915b119a9aa6b85050b6db4942680a773a7a9b992c5850e8d79836a8abfb9dde3396d7e8c1f91ca08a62b5ab782973f09586a1c4d8b05d1a8404e03ab0b2fc9
+  data.tar.gz: 05b69f636a0b59eefe4ae75f677cfc7ed6f5fe9cf567bfb60ed7cd14763d0d749df31ce5b2a8bf107f6751b186334ba5b62cfe183f8660f10c2a5bf3e23c65eb

data/CHANGELOG

@@ -1,5 +1,9 @@
 = ActiveFulfillment CHANGELOG
 
+== Version 2.1.0
+
+* Added fetch_tracking_data methods which returns tracking_companies and tracking_urls if available in addition to tracking_numbers for each service
+
 == Version 2.0.0 (Jan 5, 2013)
 
 * API Change on tracking numbers, returns array instead of single string [csaunders]

data/lib/active_fulfillment/fulfillment/service.rb

@@ -4,18 +4,18 @@ module ActiveMerchant
 
       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
@@ -34,6 +34,13 @@ module ActiveMerchant
       end
 
       def fetch_tracking_numbers(order_ids, options = {})
+        response = fetch_tracking_data(order_ids, options)
+        response.params.delete('tracking_companies')
+        response.params.delete('tracking_urls')
+        response
+      end
+
+      def fetch_tracking_data(order_ids, options = {})
         raise NotImplementedError.new("Subclasses must implement")
       end
 
@@ -44,7 +51,7 @@ module ActiveMerchant
       def test_mode?
         raise NotImplementedError.new("Subclasses must implement")
       end
-      
+
       private
       def check_test_mode(options)
         if options[:test] and not test_mode?
@@ -53,4 +60,4 @@ module ActiveMerchant
       end
     end
   end
-end
+end

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

@@ -13,16 +13,16 @@ module ActiveMerchant
         :inventory => {
           :url     => 'https://fba-inventory.amazonaws.com',
           :xmlns   => 'http://fba-inventory.amazonaws.com/doc/2009-07-31/',
-          :version => '2009-07-31'          
+          :version => '2009-07-31'
         }
       }
-    
-      SUCCESS, FAILURE, ERROR = 'Accepted', 'Failure', 'Error'    
+
+      SUCCESS, FAILURE, ERROR = 'Accepted', 'Failure', 'Error'
       MESSAGES = {
         :status => {
           'Accepted' => 'Success',
           'Failure'  => 'Failed',
-          'Error'    => 'An error occurred'          
+          'Error'    => 'An error occurred'
         },
         :create => {
           'Accepted' => 'Successfully submitted the order',
@@ -33,10 +33,10 @@ module ActiveMerchant
           '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'
@@ -48,8 +48,8 @@ module ActiveMerchant
         "xmlns:aws" => "http://security.amazonaws.com/doc/2007-01-01/"
       }
 
-      @@digest = OpenSSL::Digest::Digest.new("sha1")
-      
+      @@digest = OpenSSL::Digest.new("sha1")
+
       OPERATIONS = {
         :outbound => {
           :status => 'GetServiceStatus',
@@ -63,37 +63,37 @@ module ActiveMerchant
           :list_next => 'ListUpdatedInventorySupplyByNextToken'
         }
       }
-                   
+
       # 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 :outbound, :status, build_status_request
       end
 
-      def fulfill(order_id, shipping_address, line_items, options = {})   
+      def fulfill(order_id, shipping_address, line_items, options = {})
         requires!(options, :order_date, :comment, :shipping_method)
         commit :outbound, :create, build_fulfillment_request(order_id, shipping_address, line_items, options)
       end
-      
+
       def fetch_current_orders
         commit :outbound, :list, build_get_current_fulfillment_orders_request
       end
@@ -110,35 +110,30 @@ module ActiveMerchant
             next_page.stock_levels.merge!(response.stock_levels)
             response = next_page
           end
-          
+
           response
         end
       end
 
-      def fetch_tracking_numbers(order_ids, options = {})
+      def fetch_tracking_data(order_ids, options = {})
         order_ids.inject(nil) do |previous, o_id|
           response = commit :outbound, :tracking, build_tracking_request(o_id, options)
+          return response unless response.success?
 
-          if !response.success?
-            if response.faultstring =~ /Reason: requested order not found./
-              response = Response.new(true, nil, {
-                :status           => SUCCESS,
-                :tracking_numbers => {}
-              })
-            else
-              return response
-            end
+          if previous
+            response.tracking_numbers.merge!(previous.tracking_numbers)
+            response.tracking_companies.merge!(previous.tracking_companies)
+            response.tracking_urls.merge!(previous.tracking_urls)
           end
 
-          response.tracking_numbers.merge!(previous.tracking_numbers) if previous
           response
         end
       end
-      
+
       def valid_credentials?
         status.success?
       end
-   
+
       def test_mode?
         false
       end
@@ -157,14 +152,14 @@ module ActiveMerchant
         end
         xml.target!
       end
-      
+
       def build_status_request
         request = OPERATIONS[:outbound][:status]
         soap_request(request) do |xml|
           xml.tag! request, { 'xmlns' => SERVICES[:outbound][:xmlns] }
         end
       end
-      
+
       def build_get_current_fulfillment_orders_request
         request = OPERATIONS[:outbound][:list]
         soap_request(request) do |xml|
@@ -184,7 +179,7 @@ module ActiveMerchant
             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
@@ -236,13 +231,13 @@ module ActiveMerchant
         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) 
+
+      def add_items(xml, line_items)
         Array(line_items).each_with_index do |item, index|
           xml.tag! 'Item' do
             xml.tag! 'MerchantSKU', item[:sku]
@@ -253,9 +248,9 @@ module ActiveMerchant
           end
         end
       end
-    
+
       def add_address(xml, address)
-        xml.tag! 'DestinationAddress' do 
+        xml.tag! 'DestinationAddress' do
           xml.tag! 'Name', address[:name]
           xml.tag! 'Line1', address[:address1]
           xml.tag! 'Line2', address[:address2] unless address[:address2].blank?
@@ -267,26 +262,34 @@ module ActiveMerchant
           xml.tag! 'PhoneNumber', address[:phone]  unless address[:phone].blank?
         end
       end
-      
+
       def commit(service, op, body)
         data = ssl_post(SERVICES[service][:url], body, 'Content-Type' => 'application/soap+xml; charset=utf-8')
-        response = parse_response(service, op, data)   
+        response = parse_response(service, op, data)
         Response.new(success?(response), message_from(response), response)
-      rescue ActiveMerchant::ResponseError => e        
+      rescue ActiveMerchant::ResponseError => e
+        handle_error(e)
+      end
+
+      def handle_error(e)
         response = parse_error(e.response)
-        Response.new(false, message_from(response), response)
+        if response.fetch(:faultstring, "") =~ /Reason: requested order not found./
+          Response.new(true, nil, {:status => SUCCESS, :tracking_numbers => {}, :tracking_companies => {}, :tracking_urls => {}})
+        else
+          Response.new(false, message_from(response), response)
+        end
       end
-      
+
       def success?(response)
         response[:response_status] == SUCCESS
       end
-      
+
       def message_from(response)
         response[:response_comment]
       end
-      
+
       def parse_response(service, op, xml)
-        begin 
+        begin
           document = REXML::Document.new(xml)
         rescue REXML::ParseException
           return {:success => FAILURE}
@@ -306,12 +309,12 @@ module ActiveMerchant
           raise ArgumentError, "Unknown service #{service}"
         end
       end
-      
+
       def parse_fulfillment_response(op, document)
         response = {}
         action   = OPERATIONS[:outbound][op]
         node     = REXML::XPath.first(document, "//ns1:#{action}Response")
-        
+
         response[:response_status]  = SUCCESS
         response[:response_comment] = MESSAGES[op][SUCCESS]
         response
@@ -334,10 +337,12 @@ module ActiveMerchant
         response[:response_status] = SUCCESS
         response
       end
-      
+
       def parse_tracking_response(document)
         response = {}
         response[:tracking_numbers] = {}
+        response[:tracking_companies] = {}
+        response[:tracking_urls] = {}
 
         track_node = REXML::XPath.first(document, '//ns1:FulfillmentShipmentPackage/ns1:TrackingNumber')
         if track_node
@@ -345,10 +350,16 @@ module ActiveMerchant
           response[:tracking_numbers][id_node.text] = [track_node.text]
         end
 
+        company_node = REXML::XPath.first(document, '//ns1:FulfillmentShipmentPackage/ns1:CarrierCode')
+        if company_node
+          id_node = REXML::XPath.first(document, '//ns1:MerchantFulfillmentOrderId')
+          response[:tracking_companies][id_node.text] = [company_node.text]
+        end
+
         response[:response_status] = SUCCESS
         response
       end
-      
+
       def parse_error(http_response)
         response = {}
         response[:http_code] = http_response.code
@@ -361,7 +372,7 @@ module ActiveMerchant
         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 : ""
@@ -373,6 +384,6 @@ module ActiveMerchant
         response[:response_comment] = "#{response[:http_code]}: #{response[:http_message]}"
         response
       end
-    end 
+    end
   end
 end

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

@@ -20,7 +20,7 @@ module ActiveMerchant
         :status => {
           'Accepted' => 'Success',
           'Failure'  => 'Failed',
-          'Error'    => 'An error occurred'          
+          'Error'    => 'An error occurred'
         },
         :create => {
           'Accepted' => 'Successfully submitted the order',
@@ -31,7 +31,7 @@ module ActiveMerchant
           'Accepted' => 'Successfully submitted request',
           'Failure'  => 'Failed to submit request',
           'Error'    => 'An error occurred while submitting request'
-          
+
         }
       }
 
@@ -98,7 +98,7 @@ module ActiveMerchant
       # Expedited: 2 business days
       # Priority:  1 business day
       def self.shipping_methods
-        [ 
+        [
           [ 'Standard Shipping', 'Standard' ],
           [ 'Expedited Shipping', 'Expedited' ],
           [ 'Priority Shipping', 'Priority' ]
@@ -146,23 +146,18 @@ module ActiveMerchant
         response
       end
 
-      def fetch_tracking_numbers(order_ids, options = {})
+      def fetch_tracking_data(order_ids, options = {})
         order_ids.reduce(nil) do |previous, order_id|
-          response = commit :post, :outbound, :tracking, build_tracking_request(order_id, options)
-
-          if !response.success?
-            if response.faultstring.match(/^Requested order \'.+\' not found$/)
-              response = Response.new(true, nil, {
-                                        :status => SUCCESS,
-                                        :tracking_numbers => {}
-                                      })
-            else
-              return response
-            end
-          end
+        response = commit :post, :outbound, :tracking, build_tracking_request(order_id, options)
+        return response if !response.success?
 
-          response.tracking_numbers.merge!(previous.tracking_numbers) if previous
-          response
+        if previous
+          response.tracking_numbers.merge!(previous.tracking_numbers)
+          response.tracking_companies.merge!(previous.tracking_companies)
+          response.tracking_urls.merge!(previous.tracking_urls)
+        end
+
+        response
         end
       end
 
@@ -188,8 +183,16 @@ module ActiveMerchant
         response = parse_response(service, op, data)
         Response.new(success?(response), message_from(response), response)
       rescue ActiveMerchant::ResponseError => e
+        handle_error(e)
+      end
+
+      def handle_error(e)
         response = parse_error(e.response)
-        Response.new(false, message_from(response), response)
+        if response.fetch(:faultstring, "").match(/^Requested order \'.+\' not found$/)
+          Response.new(true, nil, {:status => SUCCESS, :tracking_numbers => {}, :tracking_companies => {}, :tracking_urls => {}})
+        else
+          Response.new(false, message_from(response), response)
+        end
       end
 
       def success?(response)
@@ -227,6 +230,8 @@ module ActiveMerchant
       def parse_tracking_response(document)
         response = {}
         response[:tracking_numbers] = {}
+        response[:tracking_companies] = {}
+        response[:tracking_urls] = {}
 
         tracking_numbers = REXML::XPath.match(document, "//FulfillmentShipmentPackage/member/TrackingNumber")
         if tracking_numbers.present?
@@ -234,6 +239,12 @@ module ActiveMerchant
           response[:tracking_numbers][order_id] = tracking_numbers.map{ |t| t.text.strip }
         end
 
+        tracking_companies = REXML::XPath.match(document, "//FulfillmentShipmentPackage/member/CarrierCode")
+        if tracking_companies.present?
+          order_id = REXML::XPath.first(document, "//FulfillmentOrder/SellerFulfillmentOrderId").text.strip
+          response[:tracking_companies][order_id] = tracking_companies.map{ |t| t.text.strip }
+        end
+
         response[:response_status] = SUCCESS
         response
       end
@@ -251,10 +262,10 @@ module ActiveMerchant
 
           response[:stock_levels][params['SellerSKU']] = params['InStockSupplyQuantity'].to_i
         end
-        
+
         next_token = REXML::XPath.first(document, '//NextToken')
         response[:next_token] = next_token ? next_token.text : nil
-        
+
         response[:response_status] = SUCCESS
         response
       end
@@ -312,7 +323,7 @@ module ActiveMerchant
       end
 
       def md5_content(content)
-        Base64.encode64(OpenSSL::Digest::Digest.new('md5', content).digest).chomp
+        Base64.encode64(OpenSSL::Digest.new('md5', content).digest).chomp
       end
 
       def build_query(query_params)
@@ -347,7 +358,7 @@ module ActiveMerchant
           :ShippingSpeedCategory => options[:shipping_method]
         }
         params[:DisplayableOrderComment] = options[:comment] if options[:comment]
-        
+
         request = build_basic_api_query(params.merge(options))
         request = request.merge build_address(shipping_address)
         request = request.merge build_items(line_items)
@@ -400,6 +411,7 @@ module ActiveMerchant
 
       def build_address(address)
         requires!(address, :name, :address1, :city, :state, :country, :zip)
+        address[:zip].upcase!
         ary = address.map{ |key, value| [LOOKUPS[:destination_address][key], value] if LOOKUPS[:destination_address].include?(key) && value.present? }
         Hash[ary.compact]
       end

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

@@ -4,9 +4,9 @@ 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'
+      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',
@@ -57,7 +57,7 @@ module ActiveMerchant
         commit :inventory, build_inventory_request(options)
       end
 
-      def fetch_tracking_numbers(order_ids)
+      def fetch_tracking_data(order_ids, options = {})
         commit :tracking, build_tracking_request(order_ids)
       end
 
@@ -225,8 +225,10 @@ module ActiveMerchant
       end
 
       def parse_tracking_response(xml)
-        response = Hash.new { |hash, key| hash[key] = {} }
+        response = {}
         response[:tracking_numbers] = {}
+        response[:tracking_companies] = {}
+        response[:tracking_urls] = {}
 
         document = REXML::Document.new(xml)
         document.root.elements.each do |node|
@@ -236,7 +238,7 @@ module ActiveMerchant
               response[:tracking_numbers][node.attributes['id']] = [tracking_number]
 
               tracking_company = node.elements['TrackingNumber'].attributes['carrier']
-              response[:tracking_company][node.attributes['id']] = tracking_company.strip if tracking_company
+              response[:tracking_companies][node.attributes['id']] = tracking_company.strip if tracking_company
 
               tracking_url = node.elements['TrackingNumber'].attributes['href']
               response[:tracking_urls][node.attributes['id']] = [tracking_url.strip] if tracking_url