lucid-shopify 0.60.0 → 0.63.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2000b0881f8f32a1ae28c1e81f75c4e10c99fb386e090087c930835453a7c20
-  data.tar.gz: 871ddf85d10f96e5f03c253436d4fb49f76da54ed0e1bca68428fa2ae4cd095e
+  metadata.gz: ffe59e48e1d046fa4eb07460911384691bda6c07981b056cb3c89dd48d95514f
+  data.tar.gz: 778d7a488544cb0452290010eff0ff59db765afd55abd8bbdefd674b38984a79
 SHA512:
-  metadata.gz: 17cbb58d6af88ebe841ff7ad8d2217512a7a11c78f40763a9061ef85e4e132d0334cce964235eed844d7d231a2657107ac3a493a091b6b2aba360d8f4042f925
-  data.tar.gz: bfebbb6f59bb8592827a6b3264c00bef9d3839e9236628d4e8eb91da30af9cc032e15500d389f366d4c8c7b967b8bbe75612d28d3de8658e3124fc13d1495661
+  metadata.gz: 9ed2477757ec40d6464699bc8a930604f21b5aee5ccabaef0eebd1113fa4a73a1edbb76db8bfc50cb35a53f11440fda704535e0e982daa490f9e6e03deab66d8
+  data.tar.gz: 03d6ea262fc118da219fb18f11478da1d4a384c0d50b7a67e6b4941abd6112d82c854a4dd57f5de7b5510d28b781d0e647f28cd8ed1f14dffa6cca71753dc126

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
@@ -111,7 +148,8 @@ module Lucid
         end
       end
 
-      # Create and start a new bulk operation via the GraphQL API.
+      # Create and start a new bulk operation via the GraphQL API. Any currently
+      # running bulk operations are cancelled.
       #
       # @param client [Client]
       # @param credentials [Credentials]
@@ -154,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/response.rb

@@ -111,11 +111,18 @@ 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 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
@@ -207,7 +214,7 @@ module Lucid
       # @return [Array<String>]
       def error_messages
         errors.map do |field, message|
-          "#{field} #{message}"
+          "#{message} [#{field}]"
         end
       end
 
@@ -222,12 +229,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.60.0'
+    VERSION = '0.63.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.60.0
+  version: 0.63.1
 platform: ruby
 authors:
 - Kelsey Judson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-06-06 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: []