lucid-shopify 0.37.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 514e2e06b6f26b6bb7cf487e1c8bdf15ced2d6f22edc0999bb938d80ed56b84e
-  data.tar.gz: '00976c459f606e71d097a016b1529f2e735366a49ff0972da489522638501170'
+  metadata.gz: 98281c9fea5c19507b29e96c9ac8d5ccaf1c1f94b902cd3f736c28514913228a
+  data.tar.gz: 5e7c2d62db39d4ca105666fccc329b255d3e20e4de7730d2d75f8dd031d3cd77
 SHA512:
-  metadata.gz: 4a90a8ecb406a9ebdd61d3605a278a5a1f9de09133b26561b406f8fefa4bbeccea2db2d46f060b55bf5c54a9b8a01ba5b1f97b345b1d582578bedcafdb514cfb
-  data.tar.gz: 8b3649891e6cc04e146b8e793cd959c52169b94bb1deb06ae65191fe40e91b87ac31d713be6db50f97176c7f8e7c105dd9955a7413a6aa7723b9f64e690ed99b
+  metadata.gz: 9461458119fca0aafc7fe4ebe00366a544ca63aba55588beec3d86d749f26ae9b2e7f31da3460511ea471b4f0fdbfb04c05a35ff0906fbb4809d7b5c00cc84a7
+  data.tar.gz: 6912e93c75a6c708b7da8e31b778fe266ce26e823473c3a6a5859b73e716feb73b307bab2b7dd0ddfe90ab88fde65bb7e219349705656ef9b7cda715db4719c6

data/README.md

@@ -16,7 +16,7 @@ Usage
 
     Lucid::Shopify.configure do |config|
       config.api_key = '...'
-      config.api_version = '...' # e.g. '2019-07'
+      config.api_version = '...' # e.g. '2020-01'
       config.billing_callback_uri = '...'
       config.callback_uri = '...' # (for OAuth; unused by this gem)
       config.logger = Logger.new(STDOUT)
@@ -135,11 +135,26 @@ Request logging is disabled by default. To enable it:
 
     Lucid::Shopify.config.logger = Logger.new(STDOUT)
 
+Request throttling is enabled by default. If you're using Redis, throttling
+will automatically make use of it; otherwise, throttling will only be
+maintained across a single thread.
 
-### Make throttled API requests
 
-    client.throttled.get(credentials, 'orders')
-    client.throttled.post_json(credentials, 'orders', new_order)
+### Make unthrottled API requests
 
-Note that throttling currently uses a naive implementation that is
-only maintained across a single thread.
+    client.unthrottled.get(credentials, 'orders')
+    client.unthrottled.post_json(credentials, 'orders', new_order)
+
+
+### Pagination
+
+Since API version 2019-07, Shopify has encouraged a new method for
+pagination based on the Link header. When you make a GET request,
+you can request the next or the previous page directly from the
+response object.
+
+    page_1 = client.get(credentials, 'orders')
+    page_2 = page_1.next
+    page_1 = page_2.previous
+
+When no page is available, `nil` will be returned.

data/lib/lucid/shopify/client.rb

@@ -9,9 +9,10 @@ module Lucid
     class Client
       # @param send_request [#call]
       # @param send_throttled_request [#call]
+      # @param throttling [Boolean]
       def initialize(send_request: Container[:send_request],
                      send_throttled_request: Container[:send_throttled_request],
-                     throttling: false)
+                     throttling: true)
         @send_request = send_request
         @send_throttled_request = send_throttled_request
         @throttling = throttling

data/lib/lucid/shopify/container.rb

@@ -19,6 +19,7 @@ module Lucid
     Container.register(:delete_all_webhooks) { DeleteAllWebhooks.new }
     Container.register(:delete_webhook) { DeleteWebhook.new }
     Container.register(:http) { ::HTTP::Client.new }
+    Container.register(:parse_link_header) { ParseLinkHeader.new }
     Container.register(:send_request) { SendRequest.new }
     Container.register(:send_throttled_request) do
       if defined?(Redis)

data/lib/lucid/shopify/parse_link_header.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'lucid/shopify'
+
+module Lucid
+  module Shopify
+    class ParseLinkHeader
+      # Parse a Link header into query params for each pagination link (e.g.
+      # :next, :previous).
+      #
+      # @param link_header [String, nil]
+      #
+      # @return [Hash]
+      def call(link_header)
+        return {} if link_header.nil?
+
+        link_header.split(',').map do |link|
+          url, rel = link.split(';') # rel should be the first param
+          url = url[/<(.*)>/, 1]
+          rel = rel[/rel="?(\w+)"?/, 1]
+
+          [rel.to_sym, query_params(url)]
+        end.to_h
+      end
+
+      # @param url [String]
+      #
+      # @return [Hash]
+      private def query_params(url)
+        url.split('?').last.split('&').map do |param|
+          name, value = param.split('=')
+          name == 'limit' && value = value.to_i
+
+          [name.to_sym, value]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/lucid/shopify/request.rb

@@ -13,7 +13,7 @@ module Lucid
       # @return [Symbol]
       param :http_method
       # @return [String] the endpoint relative to the base URL
-      param :path, reader: :private
+      param :path
       # @return [Hash]
       param :options, default: -> { {} }
 

data/lib/lucid/shopify/response.rb

@@ -43,6 +43,42 @@ module Lucid
       # @return [String]
       param :data
 
+      # @return [Hash]
+      param :link, default: -> { build_link }
+
+      # @return [Hash]
+      def build_link
+        Container[:parse_link_header].(headers['Link'])
+      end
+
+      # Request the next page of a GET request, if any.
+      #
+      # @param client [Client]
+      #
+      # @return [Response, nil]
+      def next(client: Container[:client], limit: nil)
+        return nil unless link[:next]
+
+        limit = limit ||
+                request.options.dig(:params, :limit) ||
+                link[:next][:limit]
+        client.get(request.credentials, request.path, {**link[:next], limit: limit})
+      end
+
+      # Request the previous page of a GET request, if any.
+      #
+      # @param client [Client]
+      #
+      # @return [Response, nil]
+      def previous(client: Container[:client], limit: nil)
+        return nil unless link[:previous]
+
+        limit = limit ||
+                request.options.dig(:params, :limit) ||
+                link[:previous][:limit]
+        client.get(request.credentials, request.path, {**link[:previous], limit: limit})
+      end
+
       # The parsed response body.
       #
       # @return [Hash]

data/lib/lucid/shopify/version.rb

@@ -2,6 +2,6 @@
 
 module Lucid
   module Shopify
-    VERSION = '0.37.0'
+    VERSION = '0.40.0'
   end
 end

data/lib/lucid/shopify.rb

@@ -23,6 +23,7 @@ module Lucid
     autoload :DeleteWebhook, 'lucid/shopify/delete_webhook'
     autoload :Error, 'lucid/shopify/error'
     autoload :GetRequest, 'lucid/shopify/get_request'
+    autoload :ParseLinkHeader, 'lucid/shopify/parse_link_header'
     autoload :PostRequest, 'lucid/shopify/post_request'
     autoload :PutRequest, 'lucid/shopify/put_request'
     autoload :RedisThrottledStrategy, 'lucid/shopify/redis_throttled_strategy'
@@ -42,7 +43,7 @@ module Lucid
     extend Dry::Configurable
 
     setting :api_key
-    setting :api_version, '2019-07'
+    setting :api_version, '2020-01'
     setting :billing_callback_uri
     setting :callback_uri
     setting :logger, Logger.new(File::NULL).freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -158,6 +158,7 @@ files:
 - lib/lucid/shopify/delete_webhook.rb
 - lib/lucid/shopify/error.rb
 - lib/lucid/shopify/get_request.rb
+- lib/lucid/shopify/parse_link_header.rb
 - lib/lucid/shopify/post_request.rb
 - lib/lucid/shopify/put_request.rb
 - lib/lucid/shopify/redis_throttled_strategy.rb