active_fulfillment 2.1.6 → 2.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4362a1173e03f71bdcd1f26ca7a643f463ade18
-  data.tar.gz: 46c3b9a7179584e85496a07a204ceb5ace6d388b
+  metadata.gz: 36a68a21c6b752b4ed78e4d11fb5b4da3e05080a
+  data.tar.gz: 755d255c35294881ac9c1a815836f0adce457876
 SHA512:
-  metadata.gz: 5c071f80b06412e9cec9f4ff381b4853c758320ff3476331b3247437698c80f27157654931c5695e963765622f0b341db1279a043018c26d445ff2546bc9f0be
-  data.tar.gz: 1d85c23e9a29f9e86e9d5bd316a4126b3887f2735daaf3ebcfd3c3dab56bfabc9e0c3b916539d3959cdaf8f23b92332e323b78c4e835cd10726fc1a2458b51ba
+  metadata.gz: 4023404d90d16da1415227009f16348767890d6ea2f8799738e29cc801731f3cee43c50fd6c29b743672f4b6c7a99473383cd6c022129e4bf1112bd4838ec2f7
+  data.tar.gz: c15a97a53539e0d597aaa08c1760bcee3fbe751920e9e53ee92b121c824e9bd895a8463059c0e1dabb602624e148d5bdcbaf0db46291a5658612ac8b8612fee2

data/CHANGELOG

@@ -1,5 +1,10 @@
 = ActiveFulfillment CHANGELOG
 
+== Version 2.1.7
+
+* Add shopify_api service
+* Drop Ruby 1.9.3 support
+
 == 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

data/lib/active_fulfillment/fulfillment/service.rb

@@ -5,6 +5,8 @@ module ActiveMerchant
       include RequiresParameters
       include PostsData
 
+      attr_accessor :logger
+
       def initialize(options = {})
         check_test_mode(options)
 
@@ -20,12 +22,12 @@ module ActiveMerchant
         @options[:test] || Base.mode == :test
       end
 
-      # API Requirements for Implementors
-      def fulfill(order_id, shipping_address, line_items, options = {})
-        raise NotImplementedError.new("Subclasses must implement")
+      def valid_credentials?
+        true
       end
 
-      def fetch_stock_levels(options = {})
+      # API Requirements for Implementors
+      def fulfill(order_id, shipping_address, line_items, options = {})
         raise NotImplementedError.new("Subclasses must implement")
       end
 
@@ -44,15 +46,8 @@ module ActiveMerchant
         raise NotImplementedError.new("Subclasses must implement")
       end
 
-      def valid_credentials?
-        raise NotImplementedError.new("Subclasses must implement")
-      end
-
-      def test_mode?
-        raise NotImplementedError.new("Subclasses must implement")
-      end
-
       private
+
       def check_test_mode(options)
         if options[:test] and not test_mode?
           raise ArgumentError, 'Test mode is not supported by this gateway'

data/lib/active_fulfillment/fulfillment/services.rb

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

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

@@ -0,0 +1,123 @@
+module ActiveMerchant
+  module Fulfillment
+    class ShopifyAPIService < Service
+
+      RESCUABLE_CONNECTION_ERRORS = [
+        Net::ReadTimeout,
+        Net::OpenTimeout,
+        TimeoutError,
+        Errno::ETIMEDOUT,
+        Timeout::Error,
+        IOError,
+        EOFError,
+        SocketError,
+        Errno::ECONNRESET,
+        Errno::ECONNABORTED,
+        Errno::EPIPE,
+        Errno::ECONNREFUSED,
+        Errno::EAGAIN,
+        Errno::EHOSTUNREACH,
+        Errno::ENETUNREACH,
+        Resolv::ResolvError,
+        Net::HTTPBadResponse,
+        Net::HTTPHeaderSyntaxError,
+        Net::ProtocolError,
+        ActiveMerchant::ConnectionError,
+        ActiveMerchant::ResponseError,
+        ActiveMerchant::InvalidResponseError
+      ]
+
+      def initialize(options = {})
+        @name = options[:name]
+        @callback_url = options[:callback_url]
+        @format = options[:format]
+      end
+
+      def fulfill(order_id, shipping_address, line_items, options = {})
+        raise NotImplementedError.new("Shopify API Service must listen to fulfillment/create Webhooks")
+      end
+
+      def fetch_stock_levels(options = {})
+        response = send_app_request('fetch_stock', options.delete(:headers), options)
+        if response
+          stock_levels = parse_response(response, 'StockLevels', 'Product', 'Sku', 'Quantity') { |p| p.to_i }
+          Response.new(true, "API stock levels", {:stock_levels => stock_levels})
+        else
+          Response.new(false, "Unable to fetch remote stock levels")
+        end
+      end
+
+      def fetch_tracking_data(order_ids, options = {})
+        options.merge!({:order_ids => order_ids})
+        response = send_app_request('fetch_tracking_numbers', options.delete(:headers), options)
+        if response
+          tracking_numbers = parse_response(response, 'TrackingNumbers', 'Order', 'ID', 'Tracking') { |o| o }
+          Response.new(true, "API tracking_numbers", {:tracking_numbers => tracking_numbers,
+                                                      :tracking_companies => {},
+                                                      :tracking_urls => {}})
+        else
+          Response.new(false, "Unable to fetch remote tracking numbers #{order_ids.inspect}")
+        end
+      end
+
+      private
+
+      def request_uri(action, data)
+        URI.parse "#{@callback_url}/#{action}.#{@format}?#{data.to_param}"
+      end
+
+      def send_app_request(action, headers, data)
+        uri = request_uri(action, data)
+
+        logger.info "[" + @name.upcase + " APP] Post #{uri}"
+
+        response = nil
+        realtime = Benchmark.realtime do
+          begin
+            Timeout.timeout(20.seconds) do
+              response = ssl_get(uri, headers)
+            end
+          rescue *(RESCUABLE_CONNECTION_ERRORS) => e
+            logger.warn "[#{self}] Error while contacting fulfillment service error =\"#{e.message}\""
+          end
+        end
+
+        line = "[" + @name.upcase + "APP] Response from #{uri} --> "
+        line << "#{response} #{"%.4fs" % realtime}"
+        logger.info line
+
+        response
+      end
+
+      def parse_response(response, root, type, key, value)
+        case @format
+        when 'json'
+          response_data = ActiveSupport::JSON.decode(response)
+          return {} unless response_data.is_a?(Hash)
+          response_data[root.underscore] || response_data
+        when 'xml'
+          response_data = {}
+          document = REXML::Document.new(response)
+          document.elements[root].each do |node|
+            if node.name == type
+              response_data[node.elements[key].text] = node.elements[value].text
+            end
+          end
+          response_data
+        end
+
+      rescue ActiveSupport::JSON.parse_error, REXML::ParseException
+        {}
+      end
+
+      def encode_payload(payload, root)
+        case @format
+        when 'json'
+          {root => payload}.to_json
+        when 'xml'
+          payload.to_xml(:root => root)
+        end
+      end
+    end
+  end
+end

data/lib/active_fulfillment/fulfillment/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module ActiveMerchant
   module Fulfillment
-    VERSION = "2.1.6"
+    VERSION = "2.1.7"
   end
 end

data/test/test_helper.rb

@@ -9,6 +9,7 @@ require 'minitest/autorun'
 require 'digest/md5'
 require 'active_fulfillment'
 require 'active_utils'
+require 'timecop'
 
 require 'mocha/setup'
 
@@ -16,35 +17,35 @@ module Test
   module Unit
     class TestCase < MiniTest::Unit::TestCase
       include ActiveMerchant::Fulfillment
-      
+
       LOCAL_CREDENTIALS = ENV['HOME'] + '/.active_merchant/fixtures.yml' unless defined?(LOCAL_CREDENTIALS)
       DEFAULT_CREDENTIALS = File.dirname(__FILE__) + '/fixtures.yml' unless defined?(DEFAULT_CREDENTIALS)
 
       def all_fixtures
         @@fixtures ||= load_fixtures
       end
-      
+
       def fixtures(key)
         data = all_fixtures[key] || raise(StandardError, "No fixture data was found for '#{key}'")
-        
+
         data.dup
       end
-          
+
       def load_fixtures
         file = File.exists?(LOCAL_CREDENTIALS) ? LOCAL_CREDENTIALS : DEFAULT_CREDENTIALS
         yaml_data = YAML.load(File.read(file))
         symbolize_keys(yaml_data)
-      
+
         yaml_data
       end
 
       def xml_fixture(path) # where path is like 'usps/beverly_hills_to_ottawa_response'
         open(File.join(File.dirname(__FILE__),'fixtures','xml',"#{path}.xml")) {|f| f.read}
       end
-      
+
       def symbolize_keys(hash)
         return unless hash.is_a?(Hash)
-        
+
         hash.symbolize_keys!
         hash.each{|k,v| symbolize_keys(v)}
       end

data/test/unit/services/shopify_api_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+class ShopifyAPITest < Test::Unit::TestCase
+
+  def setup
+    @service = build_service()
+    @service.logger = stub(:info => nil, :debug => nil, :warn => nil, :error => nil)
+  end
+
+  def test_request_uri_is_correct_when_no_sku_passed
+    Timecop.freeze do
+      timestamp = Time.now.utc.to_i
+      uri = @service.send(:request_uri, 'fetch_stock', {timestamp: timestamp, shop: 'www.snowdevil.ca'})
+      assert_equal "http://supershopifyapptwin.com/fetch_stock.json?shop=www.snowdevil.ca&timestamp=#{timestamp}", uri.to_s
+    end
+  end
+
+  def test_request_uri_is_correct_when_sku_is_passed
+    Timecop.freeze do
+      timestamp = Time.now.utc.to_i
+      uri = @service.send(:request_uri, 'fetch_stock', {sku: '123', timestamp: timestamp, shop: 'www.snowdevil.ca'})
+      assert_equal "http://supershopifyapptwin.com/fetch_stock.json?shop=www.snowdevil.ca&sku=123&timestamp=#{timestamp}", uri.to_s
+    end
+  end
+
+  def test_response_from_failed_stock_request
+    mock_app_request('fetch_stock', anything, nil)
+    response = @service.fetch_stock_levels()
+    refute response.success?
+    assert_equal "Unable to fetch remote stock levels", response.message
+  end
+
+  def test_response_from_failed_tracking_request
+    mock_app_request('fetch_tracking_numbers', anything, nil)
+    response = @service.fetch_tracking_numbers([1,2])
+    refute response.success?
+    assert_equal "Unable to fetch remote tracking numbers [1, 2]", response.message
+  end
+
+  def test_response_with_invalid_json_is_parsed_to_empty_hash
+    bad_json = '{a: 9, 0}'
+    mock_app_request('fetch_stock', anything, bad_json)
+    assert_equal({}, @service.fetch_stock_levels().stock_levels)
+  end
+
+  def test_response_with_valid_but_incorrect_json_is_parsed_to_empty_hash
+    incorrect_json = '[]'
+    mock_app_request('fetch_stock', anything, incorrect_json)
+    assert_equal({}, @service.fetch_stock_levels().stock_levels)
+  end
+
+  def test_response_with_invalid_xml_is_parsed_to_empty_hash
+    service = build_service(format: 'xml')
+    bad_xml = '<A><B></C></A>'
+    mock_app_request('fetch_stock', anything, bad_xml)
+    assert_equal({}, service.fetch_stock_levels().stock_levels)
+  end
+
+  def test_parse_stock_level_response_parses_xml_correctly
+    service = build_service(format: 'xml')
+    xml = '<StockLevels><Product><Sku>sku1</Sku><Quantity>1</Quantity></Product><Product><Sku>sku2</Sku><Quantity>2</Quantity></Product></StockLevels>'
+    expected = {'sku1' => '1', 'sku2' => '2'}
+
+    mock_app_request('fetch_stock', anything, xml)
+    assert_equal expected, service.fetch_stock_levels().stock_levels
+  end
+
+  def test_parse_tracking_data_response_parses_xml_correctly
+    service = build_service(format: 'xml')
+    xml = '<TrackingNumbers><Order><ID>123</ID><Tracking>abc</Tracking></Order><Order><ID>456</ID><Tracking>def</Tracking></Order></TrackingNumbers>'
+    expected = {'123' => 'abc', '456' => 'def'}
+
+    mock_app_request('fetch_tracking_numbers', anything, xml)
+    assert_equal expected, service.fetch_tracking_data([1,2,4]).tracking_numbers
+  end
+
+  def test_parse_stock_level_response_parses_json_with_root_correctly
+    json = '{"stock_levels": {"998KIB":"10"}}'
+    expected = {'998KIB' => "10"}
+
+    mock_app_request('fetch_stock', anything, json)
+    assert_equal expected, @service.fetch_stock_levels().stock_levels
+  end
+
+  def test_parse_tracking_data_response_parses_json_with_root_correctly
+    json = '{"tracking_numbers": {"order1":"a","order2":"b"}}'
+    expected = {'order1' => 'a', 'order2' => 'b'}
+
+    mock_app_request('fetch_tracking_numbers', anything, json)
+    assert_equal expected, @service.fetch_tracking_data([1,2]).tracking_numbers
+  end
+
+  def test_parse_stock_level_response_parses_json_without_root_correctly
+    json = '{"998KIB":"10"}'
+    expected = {'998KIB' => "10"}
+
+    mock_app_request('fetch_stock', anything, json)
+    assert_equal expected, @service.fetch_stock_levels().stock_levels
+  end
+
+  def test_parse_tracking_data_response_parses_json_without_root_correctly
+    json = '{"order1":"a","order2":"b"}'
+    expected = {'order1' => 'a', 'order2' => 'b'}
+
+    mock_app_request('fetch_tracking_numbers', anything, json)
+    assert_equal expected, @service.fetch_tracking_data([1,2]).tracking_numbers
+  end
+
+  def test_send_app_request_rescues_response_errors
+    response = stub(code: "404", message: "Not Found")
+    @service.expects(:ssl_get).raises(ActiveMerchant::ResponseError, response)
+    refute @service.fetch_stock_levels().success?
+  end
+
+  def test_send_app_request_rescues_invalid_response_errors
+    @service.expects(:ssl_get).raises(ActiveMerchant::InvalidResponseError.new("error html"))
+    refute @service.fetch_stock_levels().success?
+  end
+
+  private
+
+  def mock_app_request(action, input, output)
+    ShopifyAPIService.any_instance.expects(:send_app_request).with(action, nil, input).returns(output)
+  end
+
+  def build_service(options = {})
+    options.reverse_merge!({
+      name: "fulfillment_app",
+      callback_url: 'http://supershopifyapptwin.com',
+      format: 'json'
+    })
+    ShopifyAPIService.new(options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_fulfillment
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.1.7
 platform: ruby
 authors:
 - Cody Fauser
@@ -31,7 +31,7 @@ cert_chain:
   fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
   TConQSX2BnZdhIEYW+cKzEC/bLc=
   -----END CERTIFICATE-----
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +174,7 @@ files:
 - lib/active_fulfillment/fulfillment/services/amazon.rb
 - lib/active_fulfillment/fulfillment/services/amazon_mws.rb
 - lib/active_fulfillment/fulfillment/services/shipwire.rb
+- lib/active_fulfillment/fulfillment/services/shopify_api.rb
 - lib/active_fulfillment/fulfillment/services/webgistix.rb
 - lib/active_fulfillment/fulfillment/version.rb
 - test/fixtures.yml
@@ -184,6 +213,7 @@ files:
 - test/unit/services/amazon_mws_test.rb
 - test/unit/services/amazon_test.rb
 - test/unit/services/shipwire_test.rb
+- test/unit/services/shopify_api_test.rb
 - test/unit/services/webgistix_test.rb
 homepage: http://github.com/shopify/active_fulfillment
 licenses: []
@@ -215,6 +245,7 @@ test_files:
 - test/remote/webgistix_test.rb
 - test/remote/shipwire_test.rb
 - test/remote/amazon_mws_test.rb
+- test/unit/services/shopify_api_test.rb
 - test/unit/services/amazon_test.rb
 - test/unit/services/webgistix_test.rb
 - test/unit/services/shipwire_test.rb