lucid-shopify 0.57.0 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1fdb1699b2550ff42c9e707fca8a483281910066b4454c0a46472325f9ac9b
-  data.tar.gz: fb18e1fa4164cc1753bdeae3cb6c7b7c1120fe4437faf8d270ca9b3e547a4e61
+  metadata.gz: a2000b0881f8f32a1ae28c1e81f75c4e10c99fb386e090087c930835453a7c20
+  data.tar.gz: 871ddf85d10f96e5f03c253436d4fb49f76da54ed0e1bca68428fa2ae4cd095e
 SHA512:
-  metadata.gz: 1bcf5b74b4bd51e62df057b9280208439a376109497845794dddc78d2523ce92cc5f7dedc7385e1fc61d74d234f39db0c71f41fdeb8a3e6a98fc0a27f7788f0a
-  data.tar.gz: 78c4ec7ec01c43338f17fc5b25129285e2a28371da9afb20c8bedbd47ec5ae5379954d66f834b4740159d69a32110cfc48f27e7eabab101a6fca36e4ac260ac8
+  metadata.gz: 17cbb58d6af88ebe841ff7ad8d2217512a7a11c78f40763a9061ef85e4e132d0334cce964235eed844d7d231a2657107ac3a493a091b6b2aba360d8f4042f925
+  data.tar.gz: bfebbb6f59bb8592827a6b3264c00bef9d3839e9236628d4e8eb91da30af9cc032e15500d389f366d4c8c7b967b8bbe75612d28d3de8658e3124fc13d1495661

data/README.md

@@ -101,9 +101,7 @@ Since API version 2019-10, Shopify has offered an API for bulk requests (using
 the GraphQL API). The gem wraps this API, by writing the result to a temporary
 file and yielding each line of the result to limit memory usage.
 
-    client.bulk(credentials).around do |&y|
-      db.transaction { y.() }
-    end.(<<~QUERY) do |product|
+    client.bulk(credentials, <<~QUERY) do |products|
       {
         products {
           edges {
@@ -115,12 +113,19 @@ file and yielding each line of the result to limit memory usage.
         }
       }
     QUERY
-      db[:products].insert(
-        id: product['id'],
-        handle: product['handle'],
-      )
+      db.transaction do
+        products.each do |product|
+          db[:products].insert(
+            id: product['id'],
+            handle: product['handle'],
+          )
+        end
+      end
     end
 
+Bulk requests are limited to one per shop at any one time. Calling a new bulk
+request via lucid-shopify will cancel any request in progress for the shop.
+
 
 ### Pagination
 

data/lib/lucid/shopify/bulk_request.rb

@@ -19,59 +19,35 @@ module Lucid
           param :client
           # @return [Credentials]
           param :credentials
+          # @return [String]
+          param :id
         end
 
-        # Set a block which is called after the file is downloaded, and around
-        # the line by line iteration in {#call}. The block must yield control
-        # back to the caller.
+        # Wait for the operation to complete, then download the JSONL result
+        # data which is yielded as an {Enumerator} to the block. The data is
+        # streamed and parsed line by line to limit memory usage.
         #
-        # @return [self]
-        #
-        # @example
-        #   operation.around do |&y|
-        #     puts 'Before iteration'
-        #     y.()
-        #   ensure
-        #     puts 'After iteration'
-        #   end
-        def around(&block)
-          @around = block
-
-          self
-        end
-
-        # Call the block set by {#around}.
-        #
-        # @yield inside the wrapper block
-        private def call_around(&block)
-          @around.respond_to?(:call) ? @around.(&block) : block.()
-        end
-
-        # @param query [String] the GraphQL query
         # @param delay [Integer] delay between polling requests in seconds
         # @param http [HTTP::Client]
         #
-        # @yield [Hash] each parsed line of JSONL (streamed to limit memory usage)
-        def call(query, delay: 1, http: Container[:http], &block)
-          id = client.post_graphql(credentials, <<~QUERY)['data']['bulkOperationRunQuery']['bulkOperation']['id']
-            mutation {
-              bulkOperationRunQuery(
-                query: """
-                  #{query}
-                """
-              ) {
-                bulkOperation {
-                  id
-                }
-                userErrors {
-                  field
-                  message
-                }
-              }
-            }
-          QUERY
-
-          url = poll(id, delay: delay)
+        # @yield [Enumerator<Hash>] yields each parsed line of JSONL
+        def call(delay: 1, http: Container[:http], &block)
+          url = loop do
+            status, url = poll
+
+            case status
+            when 'CANCELED'
+              raise CanceledOperationError
+            when 'EXPIRED'
+              raise ExpiredOperationError
+            when 'FAILED'
+              raise FailedOperationError
+            when 'COMPLETED'
+              break url
+            else
+              sleep(delay)
+            end
+          end
 
           return if url.nil?
 
@@ -84,22 +60,38 @@ module Lucid
               file.write(chunk)
             end
             file.rewind
-            call_around do
-              file.each_line do |line|
-                block.(JSON.parse(line))
-              end
-            end
+            block.(Enumerator.new do |y|
+              file.each_line { |line| y << JSON.parse(line) }
+            end)
           ensure
             file.close
             file.unlink
           end
         end
 
-        # @param id [Integer] of the bulk operation
-        # @param delay [Integer]
-        #
-        # @return [String, nil] the download URL, or nil if the result data is empty
-        private def poll(id, delay:)
+        # Cancel the bulk operation.
+        def cancel
+          client.post_graphql(credentials, <<~QUERY)
+            mutation {
+              bulkOperationCancel(id: "#{id}") {
+                userErrors {
+                  field
+                  message
+                }
+              }
+            }
+          QUERY
+
+          loop do
+            status, _ = poll
+
+            break unless status == 'CANCELING'
+          end
+        end
+
+        # @return [Array(String, String | nil)] the operation status and the
+        #   download URL, or nil if the result data is empty
+        private def poll
           op = client.post_graphql(credentials, <<~QUERY)['data']['currentBulkOperation']
             {
               currentBulkOperation {
@@ -112,32 +104,23 @@ module Lucid
 
           raise ObsoleteOperationError if op['id'] != id
 
-          case op['status']
-          when 'CANCELED'
-            raise CanceledOperationError
-          when 'EXPIRED'
-            raise ExpiredOperationError
-          when 'FAILED'
-            raise FailedOperationError
-          when 'COMPLETED'
-            op['url']
-          else
-            sleep(delay)
-
-            poll(id, delay: delay)
-          end
+          [
+            op['status'],
+            op['url'],
+          ]
         end
       end
 
+      # Create and start a new bulk operation via the GraphQL API.
+      #
       # @param client [Client]
       # @param credentials [Credentials]
+      # @param query [String] the GraphQL query
       #
       # @return [Operation]
       #
       # @example
-      #   bulk_request.(client, credentials).around do |&y|
-      #     db.transaction { y.() }
-      #   end.(<<~QUERY) do |product|
+      #   bulk_request.(client, credentials, <<~QUERY).() do |products|
       #     {
       #       products {
       #         edges {
@@ -149,15 +132,49 @@ module Lucid
       #       }
       #     }
       #   QUERY
-      #     db[:products].insert(
-      #       id: product['id'],
-      #       handle: product['handle'],
-      #     )
+      #     db.transaction do
+      #       products.each do |product|
+      #         db[:products].insert(
+      #           id: product['id'],
+      #           handle: product['handle'],
+      #         )
+      #       end
+      #     end
       #   end
-      def call(client, credentials)
+      def call(client, credentials, query)
         Shopify.assert_api_version!('2019-10')
 
-        Operation.new(client, credentials)
+        op = client.post_graphql(credentials, <<~QUERY)['data']['currentBulkOperation']
+          {
+            currentBulkOperation {
+              id
+              status
+              url
+            }
+          }
+        QUERY
+
+        Operation.new(client, credentials, op['id']).cancel if op && op['status'] == 'RUNNING'
+
+        id = client.post_graphql(credentials, <<~QUERY)['data']['bulkOperationRunQuery']['bulkOperation']['id']
+          mutation {
+            bulkOperationRunQuery(
+              query: """
+                #{query}
+              """
+            ) {
+              bulkOperation {
+                id
+              }
+              userErrors {
+                field
+                message
+              }
+            }
+          }
+        QUERY
+
+        Operation.new(client, credentials, id)
       end
     end
   end

data/lib/lucid/shopify/client.rb

@@ -62,9 +62,15 @@ module Lucid
         AuthenticatedClient.new(self, credentials)
       end
 
+      # If called with a block, calls {BulkRequest::Operation#call} immediately,
+      # else, returns the {BulkRequest::Operation}.
+      #
       # @see BulkRequest#call
-      def bulk(*args)
-        @bulk_request.(self, *args)
+      # @see BulkRequest::Operation#call
+      def bulk(*args, &block)
+        op = @bulk_request.(self, *args)
+
+        block ? op.(&block) : op
       end
 
       # @see DeleteRequest#initialize

data/lib/lucid/shopify/version.rb

@@ -2,6 +2,6 @@
 
 module Lucid
   module Shopify
-    VERSION = '0.57.0'
+    VERSION = '0.60.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.60.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv