lucid-shopify 0.51.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bde6faec2cf0c1f3aebaa448053cfd08de85aaf84886fc4dfac7ee54c9b16d4
-  data.tar.gz: 9d88ca4bf4e318ecb84095c11e6ed4a7cf1466851a67bbbf9737f2be9c612040
+  metadata.gz: 507adadf48406a163883bd19d27f719b1e08c79449d62b02c3ed4489d34cf337
+  data.tar.gz: c9e9b5b1b9b07fce620b124739b572cac79eddc9a3a333fa89f662aa940f9e87
 SHA512:
-  metadata.gz: 15792eae82caf1d7b9990a9c18c8ef4d38a5c1a42ce9b644e2628db014d38b9316fe6c3ecc007581a0c8022ba4e93c0763b1c1ddffc69a72e2a802da21966a34
-  data.tar.gz: 9b85663e3679692a27ad2022527f101a4ac00586f044b85c3e68fae3851425c6c20d29cfa9ebe6ea55f3b45055642ad845f024d8e59ea2d7df20dd7a350fe19d
+  metadata.gz: 0a8301132bce1d3b8a11715eb9184cd948022edc1f509c270490d39d0923cf449dab1fb45eac7a6422c6b65794377c89697332fa285759e85aff5356cdb8a2f1
+  data.tar.gz: 7fafaa11ece1d2358468fad162a2ece4cfced8c1cc4525b67f065ac1e144c8043ff44dedfc9d3e760bd6301b760f9476721d5ff885368b033232c1ff86aef14d

data/README.md

@@ -101,20 +101,24 @@ 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, <<~QUERY) do |product|
+    client.bulk(credentials).around do |&y|
+      db.transaction { y.() }
+    end.(<<~QUERY) do |product|
       {
         products {
           edges {
             node {
               id
-              title
+              handle
             }
           }
         }
       }
     QUERY
-      puts product['id']
-      puts product['title']
+      db[:products].insert(
+        id: product['id'],
+        handle: product['handle'],
+      )
     end
 
 

data/lib/lucid/shopify/bulk_request.rb

@@ -13,102 +13,145 @@ module Lucid
       FailedOperationError = Class.new(OperationError)
       ObsoleteOperationError = Class.new(OperationError)
 
-      # @param http [HTTP::Client]
-      def initialize(http: Container[:http])
-        @http = http
+      class Operation
+        include Dry::Initializer.define -> do
+          # @return [Client]
+          param :client
+          # @return [Credentials]
+          param :credentials
+        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.
+        #
+        # @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 http [HTTP::Client]
+        #
+        # @yield [Hash] each parsed line of JSONL (streamed to limit memory usage)
+        def call(query, 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)
+
+          # TODO: Verify signature?
+
+          begin
+            file = Tempfile.new(mode: 0600)
+            body = http.get(url).body
+            until (chunk = body.readpartial).nil?
+              file.write(chunk)
+            end
+            file.rewind
+            call_around do
+              file.each_line do |line|
+                block.(JSON.parse(line))
+              end
+            end
+          ensure
+            file.close
+            file.unlink
+          end
+        end
+
+        # @param id [Integer] of the bulk operation
+        #
+        # @return [String] the download URL
+        private def poll(id)
+          op = client.post_graphql(credentials, <<~QUERY)['data']['currentBulkOperation']
+            {
+              currentBulkOperation {
+                id
+                status
+                url
+              }
+            }
+          QUERY
+
+          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
+            poll(id)
+          end
+        end
       end
 
       # @param client [Client]
       # @param credentials [Credentials]
-      # @param query [String]
       #
-      # @yield [String] each parsed line of JSONL (streamed to limit memory usage)
+      # @return [Operation]
       #
       # @example
-      #   bulk_request.(client, credentials, <<~QUERY)
+      #   bulk_request.(client, credentials).around do |&y|
+      #     db.transaction { y.() }
+      #   end.(<<~QUERY) do |product|
       #     {
       #       products {
       #         edges {
       #           node {
       #             id
       #             handle
-      #             publishedAt
       #           }
       #         }
       #       }
       #     }
       #   QUERY
-      def call(client, credentials, query, &block)
+      #     db[:products].insert(
+      #       id: product['id'],
+      #       handle: product['handle'],
+      #     )
+      #   end
+      def call(client, credentials)
         Shopify.assert_api_version!('2019-10')
 
-        id = client.post_graphql(credentials, <<~QUERY)['data']['bulkOperationRunQuery']['bulkOperation']['id']
-          mutation {
-            bulkOperationRunQuery(
-              query: """
-                #{query}
-              """
-            ) {
-              bulkOperation {
-                id
-              }
-              userErrors {
-                field
-                message
-              }
-            }
-          }
-        QUERY
-
-        url = poll(client, credentials, id)
-
-        # TODO: Verify signature?
-
-        begin
-          file = Tempfile.new(mode: 0600)
-          body = @http.get(url).body
-          until (chunk = body.readpartial).nil?
-            file.write(chunk)
-          end
-          file.rewind
-          file.each_line do |line|
-            block.call(JSON.parse(line))
-          end
-        ensure
-          file.close
-          file.unlink
-        end
-      end
-
-      # @param client [Client]
-      # @param credentials [Credentials]
-      # @param id [Integer] of the bulk operation
-      #
-      # @return [String] the download URL
-      private def poll(client, credentials, id)
-        op = client.post_graphql(credentials, <<~QUERY)['data']['currentBulkOperation']
-          {
-            currentBulkOperation {
-              id
-              status
-              url
-            }
-          }
-        QUERY
-
-        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
-          poll(client, credentials, id)
-        end
+        Operation.new(client, credentials)
       end
     end
   end

data/lib/lucid/shopify/client.rb

@@ -63,8 +63,8 @@ module Lucid
       end
 
       # @see BulkRequest#call
-      def bulk(*args, &block)
-        @bulk_request.(self, *args, &block)
+      def bulk(*args)
+        @bulk_request.(self, *args)
       end
 
       # @see DeleteRequest#initialize

data/lib/lucid/shopify/version.rb

@@ -2,6 +2,6 @@
 
 module Lucid
   module Shopify
-    VERSION = '0.51.0'
+    VERSION = '0.52.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.52.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement