lucid_shopify 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959629883e5fa5237962423d070d6553aec6455b06854ec2385cc99e07d069b7
-  data.tar.gz: 741fd2391fd995b4ddf48c59dd1cc428e81a6fd1c706980912de140172c548c3
+  metadata.gz: 2949f5da34bd486fe5ac4a76104577c730c5c086e36bde82c2bccc2925df3ade
+  data.tar.gz: c402dbe292c0b59a04e8b57d87b09017e666681e72dd99af180f7041a51c99d0
 SHA512:
-  metadata.gz: 234a167e82f1a58d4f3f494350c6b77e186ca9b75bad804a736f609650137a6861f39dcde9d0d80dd3441f426d51a5c2604e30b33723825c65f215fb91ee7b73
-  data.tar.gz: 02d491cea4b1b39c2ddd8a41963cf4ba3967d6c312b88da7eb333da2b52d41dc050974a250ebcf43418eb7139424692181fddaecad01a6bed608d64efa82c75f
+  metadata.gz: 1dc26e15a811b752753df1aeda9b1763de6edb8eef58e8277c691c9cf428578b7d0dd3742f03ff64d26d31eb04fd15f428ecfdec49b02f36763a23c2769969e4
+  data.tar.gz: efbdeeff6b99542cbe79ab72b0bcfdbd5b9f11c64ee19fc160fe80a5bc37c1aae6920b1b853463775a9b0d5b582fe9f5465c1ad1eb618b5b84935bec5df4888a

data/lib/lucid_shopify.rb

@@ -2,6 +2,11 @@
 
 require 'dry/initializer'
 
+begin
+  require 'redis'
+rescue LoadError
+end
+
 module LucidShopify
   autoload :ActivateCharge, 'lucid_shopify/activate_charge'
   autoload :Authorize, 'lucid_shopify/authorize'
@@ -18,6 +23,7 @@ module LucidShopify
   autoload :GetRequest, 'lucid_shopify/get_request'
   autoload :PostRequest, 'lucid_shopify/post_request'
   autoload :PutRequest, 'lucid_shopify/put_request'
+  autoload :RedisThrottledStrategy, 'lucid_shopify/redis_throttled_strategy'
   autoload :Request, 'lucid_shopify/request'
   autoload :Response, 'lucid_shopify/response'
   autoload :Result, 'lucid_shopify/result'

data/lib/lucid_shopify/container.rb

@@ -20,7 +20,13 @@ module LucidShopify
   Container.register(:delete_webhook) { DeleteWebhook.new }
   Container.register(:http) { ::HTTP::Client.new }
   Container.register(:send_request) { SendRequest.new }
-  Container.register(:send_throttled_request) { SendRequest.new(strategy: ThrottledStrategy.new) }
+  Container.register(:send_throttled_request) do
+    if defined?(Redis)
+      SendRequest.new(strategy: RedisThrottledStrategy.new)
+    else
+      SendRequest.new(strategy: ThrottledStrategy.new)
+    end
+  end
   Container.register(:verify_callback) { VerifyCallback.new }
   Container.register(:verify_webhook) { VerifyWebhook.new }
   Container.register(:webhook_handler_list) { LucidShopify.handlers }

data/lib/lucid_shopify/redis_throttled_strategy.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'lucid_shopify'
+
+if defined?(Redis)
+  module LucidShopify
+    #
+    # Use Redis to maintain API call limit throttling across threads/processes.
+    #
+    # No delay for requests up to half of the call limit.
+    #
+    class RedisThrottledStrategy < ThrottledStrategy
+      LEAK_RATE = 500
+
+      #
+      # @param redis_client [Redis]
+      #
+      def initialize(redis_client: Redis.current)
+        @redis_client = redis_client
+      end
+
+      #
+      # @param request [Request]
+      #
+      # @yieldreturn [Response]
+      #
+      # @return [Response]
+      #
+      def call(request, &send_request)
+        interval_key = build_interval_key(request)
+
+        interval(interval_key)
+
+        send_request.().tap do |res|
+          cur, max = res.headers['X-Shopify-Shop-Api-Call-Limit'].split('/')
+
+          @redis_client.mapped_hmset(interval_key,
+            cur: cur,
+            max: max,
+            at: timestamp
+          )
+        end
+      end
+
+      #
+      # If over half the call limit, sleep until requests leak back to the
+      # threshold.
+      #
+      # @param interval_key [String]
+      #
+      private def interval(interval_key)
+        cur, max, at = @redis_client.hmget(interval_key, :cur, :max, :at).map(&:to_i)
+
+        cur = leak(cur, at)
+
+        delay_threshold = max / 2 # no delay
+
+        if cur > delay_threshold
+          sleep(Rational((cur - delay_threshold) * LEAK_RATE, 1000))
+        end
+      end
+
+      #
+      # Find the actual value of {cur}, by subtracting requests leaked by the
+      # leaky bucket algorithm since the value was set.
+      #
+      # @param cur [Integer]
+      # @param at [Integer]
+      #
+      # @return [Integer]
+      #
+      private def leak(cur, at)
+        n = Rational(timestamp - at, LEAK_RATE).floor
+
+        n > cur ? 0 : cur - n
+      end
+    end
+  end
+end

data/lib/lucid_shopify/send_request.rb

@@ -75,7 +75,7 @@ module LucidShopify
         req.object_id,
         req.http_method.to_s.upcase,
         req.url,
-        req.options[:params]&.to_json || '{}'
+        req.options[:params]&.to_json || '{}',
       ])
     end
 
@@ -87,10 +87,11 @@ module LucidShopify
       req = request
       res = response
 
-      LucidShopify.config.logger.info('<%s> [%i] %i' % [
+      LucidShopify.config.logger.info('<%s> [%i] %i (%s)' % [
         self.class.to_s,
         req.object_id,
-        res.status_code
+        res.status_code,
+        res.headers['X-Shopify-Shop-Api-Call-Limit'],
       ])
     end
 

data/lib/lucid_shopify/throttled_strategy.rb

@@ -3,6 +3,9 @@
 require 'lucid_shopify'
 
 module LucidShopify
+  #
+  # Maintain API call limit throttling across a single thread.
+  #
   class ThrottledStrategy
     MINIMUM_INTERVAL = 500 # ms
 
@@ -20,13 +23,11 @@ module LucidShopify
     end
 
     #
-    # Sleep for the difference if time since the last request is less than the
-    # MINIMUM_INTERVAL.
+    # If time since the last request < {MINIMUM_INTERVAL}, then sleep for the
+    # difference.
     #
     # @param interval_key [String]
     #
-    # @note Throttling is only maintained across a single thread.
-    #
     private def interval(interval_key)
       if Thread.current[interval_key]
         (timestamp - Thread.current[interval_key]).tap do |n|

data/lib/lucid_shopify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucidShopify
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -132,6 +132,7 @@ files:
 - lib/lucid_shopify/get_request.rb
 - lib/lucid_shopify/post_request.rb
 - lib/lucid_shopify/put_request.rb
+- lib/lucid_shopify/redis_throttled_strategy.rb
 - lib/lucid_shopify/request.rb
 - lib/lucid_shopify/response.rb
 - lib/lucid_shopify/send_request.rb