lucid-shopify 0.61.0 → 0.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffa0adb3d84baa78fe2fdbde5edfa2b7197a0a0edc9787eae34c3421b593a89f
-  data.tar.gz: e06b3011191e2a29568ea4472a585142e4efea6907b9a61c40767bcba08f2cda
+  metadata.gz: 1b0b5d01a7f0169127f5cb34c55771e87790f9e15059e384874321566cb257c4
+  data.tar.gz: fac44b65de85d005f9affe1532892a2b3baaa85b066ca407ffcadfe880c3d785
 SHA512:
-  metadata.gz: ff81335689e3fd841c1971eda673028ecfb3d050cd37239459618e9ff3e1f69899496a638ccc371596d2fecaced6df24468727b3a36f005487219522a2acc0ed
-  data.tar.gz: 877b4689633a3c0535fbee9d412eace6c0d888f85117e998e68b4288ae19c59d59168bef43588ba94e3359abdf7316c01ab4c3669aa63194dc8c69470a6b7ebd
+  metadata.gz: 1087a99b8ad46cb6fe571a4812dfc47eb3c67cfba2dd85d4d0c9bc069913f0ff9c8e869ed8b2e9a0a172307751a156eef080e0d560d573076946a32345f90fc8
+  data.tar.gz: 929282d2d2b752515a143cd06fcb26b66b1209594be0785c1cd9cc2418476f55c7ee63f7f95d975ca8530f276e2592269ee822f5dba5c99f56ed032fcffafdcb

data/README.md

@@ -35,7 +35,7 @@ Setup
 
     Lucid::Shopify.configure do |config|
       config.api_key = '...'
-      config.api_version = '...' # e.g. '2020-01'
+      config.api_version = '...' # e.g. '2020-04'
       config.billing_callback_uri = '...'
       config.callback_uri = '...' # (for OAuth; unused by this gem)
       config.logger = Logger.new(STDOUT)

data/lib/lucid/shopify.rb

@@ -45,7 +45,7 @@ module Lucid
     extend Dry::Configurable
 
     setting :api_key
-    setting :api_version, '2020-01'
+    setting :api_version, '2020-04'
     setting :billing_callback_uri
     setting :callback_uri
     setting :logger, Logger.new(File::NULL).freeze

data/lib/lucid/shopify/bulk_request.rb

@@ -2,6 +2,7 @@
 
 require 'json'
 require 'lucid/shopify'
+require 'timeout'
 
 module Lucid
   module Shopify
@@ -13,6 +14,8 @@ module Lucid
       FailedOperationError = Class.new(OperationError)
       ObsoleteOperationError = Class.new(OperationError)
 
+      TimeoutError = Class.new(Error)
+
       class Operation
         include Dry::Initializer.define -> do
           # @return [Client]
@@ -31,6 +34,11 @@ module Lucid
         # @param http [HTTP::Client]
         #
         # @yield [Enumerator<Hash>] yields each parsed line of JSONL
+        #
+        # @raise CanceledOperationError
+        # @raise ExpiredOperationError
+        # @raise FailedOperationError
+        # @raise ObsoleteOperationError
         def call(delay: 1, http: Container[:http], &block)
           url = loop do
             status, url = poll
@@ -70,23 +78,52 @@ module Lucid
         end
 
         # Cancel the bulk operation.
+        #
+        # @raise ObsoleteOperationError
+        # @raise TimeoutError
         def cancel
-          client.post_graphql(credentials, <<~QUERY)
-            mutation {
-              bulkOperationCancel(id: "#{id}") {
-                userErrors {
-                  field
-                  message
+          begin
+            client.post_graphql(credentials, <<~QUERY)
+              mutation {
+                bulkOperationCancel(id: "#{id}") {
+                  userErrors {
+                    field
+                    message
+                  }
                 }
               }
-            }
-          QUERY
+            QUERY
+          rescue Response::GraphQLClientError => e
+            return if e.response.error_message?([
+              /cannot be canceled when it is completed/,
+            ])
+
+            raise e
+          end
 
-          loop do
-            status, _ = poll
+          poll_until(['CANCELED', 'COMPLETED'])
+        end
 
-            break unless status == 'CANCELING'
+        # Poll until operation status is met.
+        #
+        # @param statuses [Array<String>] to terminate polling on
+        # @param timeout [Integer] in seconds
+        #
+        # @raise ObsoleteOperationError
+        # @raise TimeoutError
+        def poll_until(statuses, timeout: 60)
+          Timeout.timeout(timeout) do
+            loop do
+              status, _ = poll
+
+              break if statuses.any? { |expected_status| status == expected_status }
+            end
           end
+        rescue Timeout::Error
+          raise TimeoutError, 'exceeded %s seconds polling for status %s' % [
+            timeout,
+            statuses.join(', '),
+          ]
         end
 
         # @return [Array(String, String | nil)] the operation status and the
@@ -155,7 +192,12 @@ module Lucid
           }
         QUERY
 
-        Operation.new(client, credentials, op['id']).cancel if op && op['status'] == 'RUNNING'
+        case op&.fetch('status')
+        when 'CANCELING'
+          Operation.new(client, credentials, op['id']).poll_until(['CANCELED'])
+        when 'CREATED', 'RUNNING'
+          Operation.new(client, credentials, op['id']).cancel
+        end
 
         id = client.post_graphql(credentials, <<~QUERY)['data']['bulkOperationRunQuery']['bulkOperation']['id']
           mutation {

data/lib/lucid/shopify/parse_link_header.rb

@@ -15,7 +15,7 @@ module Lucid
         case link_header
         # NOTE: There is a strange behaviour where it seems that if the header
         # value exceeds a certain length, it is split into chunks. It seems that
-        # if you use {HTTP::Headers#get}, you will always get {Array<String},
+        # if you use {HTTP::Headers#get}, you will always get {Array<String>},
         # and it is the special behaviour of {HTTP::Headers#[]} causing this.
         #
         # However, why is it split in the first place? Does Shopify send

data/lib/lucid/shopify/response.rb

@@ -29,8 +29,8 @@ module Lucid
       ClientError = Class.new(Error)
       ServerError = Class.new(Error)
       ShopError = Class.new(Error)
-
-      class GraphQLClientError < ClientError
+      AccessTokenError = Class.new(ClientError)
+      GraphQLClientError = Class.new(ClientError) do
         def message
           case
           when response.errors?
@@ -111,11 +111,24 @@ module Lucid
       # @raise [ClientError] for status 4xx
       # @raise [ServerError] for status 5xx
       #
-      # @note https://help.shopify.com/en/api/getting-started/response-status-codes
+      # @note https://shopify.dev/concepts/about-apis/response-codes
       def assert!
         case status_code
+        when 401
+          if error_message?([/access token/i])
+            raise AccessTokenError.new(request, self), 'Invalid access token'
+          else
+            raise ClientError.new(request, self)
+          end
         when 402
           raise ShopError.new(request, self), 'Shop is frozen, awaiting payment'
+        when 403
+          # NOTE: Not sure what this one means (undocumented).
+          if error_message?([/unavailable shop/i])
+            raise ShopError.new(request, self), 'Shop is unavailable'
+          else
+            raise ClientError.new(request, self)
+          end
         when 423
           raise ShopError.new(request, self), 'Shop is locked'
         when 400..499
@@ -222,12 +235,14 @@ module Lucid
       #
       # @return [Boolean]
       def error_message?(messages)
+        all_messages = error_messages + user_error_messages
+
         messages.any? do |message|
           case message
           when Regexp
-            error_messages.any? { |other_message| other_message.match?(message) }
+            all_messages.any? { |other_message| other_message.match?(message) }
           when String
-            error_messages.include?(message)
+            all_messages.include?(message)
           end
         end
       end

data/lib/lucid/shopify/version.rb

@@ -2,6 +2,6 @@
 
 module Lucid
   module Shopify
-    VERSION = '0.61.0'
+    VERSION = '0.64.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.61.0
+  version: 0.64.0
 platform: ruby
 authors:
 - Kelsey Judson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-description: 
+description:
 email: kelsey@lucid.nz
 executables: []
 extensions: []
@@ -179,7 +179,7 @@ homepage: https://github.com/lucidnz/gem-lucid-shopify
 licenses:
 - ISC
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Shopify client library
 test_files: []