shopify_api-graphql-bulk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 586c3d49043601a40e3ecdfa5810873d81b5655cfc2434742b2a568583b3f8e1
+  data.tar.gz: 262286a42dc2f5dc3ed773d184f0af946aea1717a7b8c01afc699ba9120a9145
+SHA512:
+  metadata.gz: 3081b0e7aecfbfe679f9b0d5289f5551b1aa43785569fd59a652a1f0237f9d72cbe2b6a3966cb6a515ea90bae99f0b585faafe33d1c98718a9a8ccbc0247b1e0
+  data.tar.gz: ae5e9ce73caa1aed82032ce85b360ddf051e0f3f88b4b179e55ee7b22441a2cdb40201e701ef09cff7c0ecaa7e601e4c96b75f5f7c3d8e0a8a7cd4a055dddb08

data/.env.example

@@ -0,0 +1,6 @@
+SHOPIFY_DOMAIN=
+SHOPIFY_TOKEN=
+BULK_SUCCESS_ID=
+BULK_FAILED_ID_ERRORS=
+BULK_FAILED_ID_USER_ERRORS=
+BULK_PARTIAL_ID=

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 sshaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# ShopifyAPI::GraphQL::Bulk
+
+Ruby Gem to Bulk import data using the [Shopify GraphQL Admin Bulk API](https://shopify.dev/docs/api/usage/bulk-operations/imports)
+
+## Install
+
+`Gemfile`:
+
+```rb
+gem "shopify_api-graphql-bulk"
+```
+
+Or via the `gem` command:
+
+```
+gem install "shopify_api-graphql-bulk"
+```
+
+## Usage
+
+```rb
+# Mutation parameters. In this example we're using the productSet mutation.
+params = [
+  {
+    :identifier => { :handle => "handle-1" },
+    :input => {
+      :title => "My New Title",
+      :handle => "handle-1",
+      # More params
+    }
+  },
+  {
+    :identifier => { :handle => "handle-2" },
+    :input => {
+      :title => "Another Title",
+      :handle => "handle-2",
+      # More params
+    }
+  },
+  # etc...
+]
+
+bulk = ShopifyAPI::GraphQL::Bulk.new(shop, token)
+id = bulk.create("productSet", params)
+
+# Wait a bit...
+
+operation = bulk.result(id)
+
+# returns a ShopifyAPI::GraphQL::Bulk::Operation instance
+p operation.id
+p operation.completed_at
+p operation.url
+# etc...
+
+if operation.completed?
+  operation.results.each do |result|
+    # Each element is a Hash with the appropriate response, if any
+    result.data.each { }
+    result.errors.each { }
+    result.user_errors.each { }
+  end
+end
+```
+
+`#create` also accepts a block:
+
+```rb
+id = bulk.create("productSet") do |args|
+  args << input1
+  args << input2 # etc...
+end
+```
+
+If you do not want the result to be fetched and parsed use `:parse_results => false`:
+
+```rb
+operation = bulk.result(id, :parse_results => false)
+p operation.id
+p operation.completed_at
+p operation.result # now nil
+```
+
+Cancel a pending request:
+
+```rb
+operation = bulk.cancel(id) # returns a ShopifyAPI::GraphQL::Bulk::Operation instance
+```
+
+`ShopifyAPI::GraphQL::Bulk::Operation` corresponds to the GraphQL `BulkOperation` type.
+Hashes returned by this gem have `Symbol` keys that are snake_cased.
+
+## Development
+
+Tests use VCR. To re-record you need to define bulk operation IDs in `.env`. `cp .env.example .env` and update `.env`
+
+There are Rake tasks to help with bulk request generation.
+
+## See Also
+
+- [`ShopifyAPI::GraphQL::Request`](https://github.com/ScreenStaring/shopify_api-graphql-request/) - Simplify Shopify API GraphQL handling. Comes with built-in retry, pagination, error handling, and more!
+- [`TinyGID`](https://github.com/sshaw/tiny_gid/) - Build Global ID (`gid://`) URI strings from scalar values
+- [Shopify Dev Tools](https://github.com/ScreenStaring/shopify-dev-tools/) - Command-line program to assist with the development and/or maintenance of Shopify apps and stores
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir.glob("lib/tasks/**/*.rake").each { |r| import r }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/shopify_api/graphql/bulk/cancel.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      class Cancel < ShopifyAPI::GraphQL::Request  # :nodoc:
+        BULK_OPERATION_CANCEL = <<~GQL
+          #{BULK_OPERATION_FIELDS}
+          mutation bulkOperationCancel($id: ID!) {
+            bulkOperationCancel(id: $id) {
+              bulkOperation {
+                ...BulkOperationFields
+              }
+              userErrors {
+                field
+                message
+              }
+            }
+          }
+        GQL
+
+        def execute(id, options = nil)
+          begin
+            data = super(BULK_OPERATION_CANCEL, :id => id).dig(:data, :bulk_operation_cancel, :bulk_operation)
+          rescue => e
+            raise Error, "cancel request failed: #{e}"
+          end
+
+          Operation.new(data, options)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk/create.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "net/http/post/multipart"
+require "tempfile"
+require "uri"
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      class Create < ShopifyAPI::GraphQL::Request  # :nodoc:
+        FILENAME = "bulk_import.jsonl"
+
+        STAGED_UPLOADS_CREATE = <<~GQL
+          mutation stagedUploadsCreate($input: [StagedUploadInput!]!) {
+            stagedUploadsCreate(input: $input) {
+              stagedTargets {
+                url
+                resourceUrl
+                parameters {
+                  name
+                  value
+                }
+              }
+              userErrors {
+                field
+                message
+              }
+            }
+          }
+        GQL
+
+        BULK_OPERATION_RUN_MUTATION = <<~GQL
+          #{BULK_OPERATION_FIELDS}
+          mutation bulkOperationRunMutation($mutation: String!, $stagedUploadPath: String!) {
+            bulkOperationRunMutation(mutation: $mutation, stagedUploadPath: $stagedUploadPath) {
+              bulkOperation {
+                ...BulkOperationFields
+              }
+              userErrors {
+                field
+                message
+              }
+            }
+          }
+        GQL
+
+        def initialize(shop, token, options = nil)
+          super
+
+          @shop = shop
+          @token = token
+          @file = Tempfile.new([self.class.name, ".jsonl"])
+        end
+
+        def execute(mutation, data = nil)
+          @file.truncate(0)
+          @file.rewind
+
+          @mutation = mutation
+
+          Array(data).map { |d| self << d } if data
+          yield self if block_given?
+
+          @file.flush
+          raise ArgumentError, "no data proviced to upload" if @file.size == 0
+
+          input = [
+            :resource => "BULK_MUTATION_VARIABLES",
+            :filename => FILENAME,
+            :mime_type => "text/jsonl",
+            :http_method => "POST",
+            :file_size => @file.size.to_s
+          ]
+
+          begin
+            target = super(STAGED_UPLOADS_CREATE, :input => input).dig(:data, :staged_uploads_create, :staged_targets, 0)
+          rescue => e
+            raise Error, "stage upload request failed: #{e.message}"
+          end
+
+          upload_jsonl(target)
+          upload_path = target[:parameters].find { |p| p[:name] == :key }
+
+          begin
+            data = super(BULK_OPERATION_RUN_MUTATION, :mutation => @mutation, :staged_upload_path => upload_path)
+            Operation.new(data.dig(:data, :bulk_operation_run_mutation, :bulk_operation))
+          rescue => e
+            raise Error, "bulk run mutation request failed: #{e.message}"
+          end
+        end
+
+        def <<(data)
+          @file.puts(JSON.generate(data))
+          nil
+        end
+
+        private
+
+        def stage_upload
+        end
+
+        def upload_jsonl(target)
+          uri = URI(target[:url])
+          @file.rewind
+          io = UploadIO.new(@file, "text/jsonl", FILENAME)
+
+          params = {}
+          target[:parameters].each { |p| params[p[:name]] = p[:value] }
+          params["file"] = io
+
+          request = Net::HTTP::Post::Multipart.new(uri.path, params)
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+
+          response = http.request(request)
+
+          unless response.is_a?(Net::HTTPSuccess)
+            raise Error, "file upload failed with status #{response.code}: #{response.body}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk/operation/result.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      class Operation
+        class Result
+          attr_reader :line, :data, :errors, :user_errors
+
+          def initialize(row)
+            @errors = []
+            @user_errors = []
+
+            @line = row["__lineNumber"]
+
+            if row.include?("errors")
+              @errors = row["errors"].map { |e| { :message => e["message"] } }
+            end
+
+            if row["data"]
+              data = row["data"].values.first
+              if data
+                errors = data["userErrors"] || []
+                @user_errors = errors.map { |e| { :field => e["field"], :message => e["message"] } } if errors.any?
+                @data = snake_case_keys(data.reject { |k, _| k == "userErrors" })
+              end
+            end
+          end
+
+          private
+
+          def snake_case_keys(object)
+            case object
+            when Hash
+              object.each_with_object({}) do |(key, value), result|
+                result[Strings::Case.snakecase(key).to_sym] = snake_case_keys(value)
+              end
+            when Array
+              object.map { |value| snake_case_keys(value) }
+            else
+              object
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk/operation.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "time"
+
+require_relative "operation/result"
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      class Operation
+        STATUSES = %w[
+          CANCELED
+          CANCELING
+          COMPLETED
+          CREATED
+          EXPIRED
+          FAILED
+          RUNNING
+        ].freeze
+
+        STATUSES.each do |status|
+          define_method("#{status.downcase}?") do
+            self.status == status
+          end
+        end
+
+        [
+          :id,
+          :status,
+          :error_code,
+          :object_count,
+          :partial_data_url,
+          :root_object_count,
+          :url
+        ].each do |name|
+          define_method(name) { @data[name] }
+        end
+
+        attr_reader :results, :created_at, :completed_at
+
+        def initialize(data, options = nil)
+          options ||= {}
+
+          url = data[:url] || data[:partial_data_url]
+
+          @data = data
+          @created_at = Time.parse(@data[:created_at])
+          @completed_at = Time.parse(@data[:completed_at]) if @data[:completed_at]
+
+          @results = parse_results(url) if url && options[:parse_results] != false
+        end
+
+        private
+
+        def parse_results(url)
+          response = Net::HTTP.get_response(URI(url))
+          raise Error, "failed to fetch bulk operation result: unsuccessful HTTP response #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+          results = []
+
+          response.body.each_line do |line|
+            row = JSON.parse(line)
+            results << Operation::Result.new(row)
+          end
+
+          results
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk/result.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      class Result < ShopifyAPI::GraphQL::Request    # :nodoc:
+        BULK_OPERATION_STATUS = <<~GQL
+          #{BULK_OPERATION_FIELDS}
+          query($id: ID!) {
+            bulkOperation(id: $id) {
+              ...BulkOperationFields
+            }
+          }
+        GQL
+
+        def execute(id, options = nil)
+          data = super(BULK_OPERATION_STATUS, :id => id).dig(:data, :bulk_operation)
+          Operation.new(data, options)
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/shopify_api/graphql/bulk.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "shopify_api/graphql/request"
+require "tiny_gid"
+
+require_relative "bulk/version"
+
+module ShopifyAPI
+  module GraphQL
+    module Bulk
+      Error = Class.new(Request::Error)
+
+      BULK_OPERATION_FIELDS = <<~GQL
+        fragment BulkOperationFields on BulkOperation {
+          id
+          status
+          errorCode
+          objectCount
+          partialDataUrl
+          rootObjectCount
+          url
+          createdAt
+          completedAt
+        }
+      GQL
+
+      class << self
+        def new(shop, token, options = nil)
+          Executor.new(shop, token, options)
+        end
+      end
+
+      class Executor            # :nodoc:
+        def initialize(shop, token, options)
+          raise ArgumentError, "shop required" if shop.to_s.strip.empty?
+          raise ArgumentError, "token required" if token.to_s.strip.empty?
+
+          @gid = TinyGID.new("shopify")
+
+          @create = Bulk::Create.new(shop, token, options)
+          @cancel = Bulk::Cancel.new(shop, token, options)
+          @result = Bulk::Result.new(shop, token, options)
+        end
+
+        def create(mutation, data = nil, &block)
+          @create.execute(mutation, data, &block)
+        end
+
+        def result(id, options = nil)
+          @result.execute(to_gid(id), options)
+        end
+
+        def cancel(id)
+          @cancel.execute(to_gid(id), options = nil)
+        end
+
+        private
+
+        def to_gid(id)
+          return id if id.to_s.start_with?("gid://")
+
+          @gid::BulkOperation(id)
+        end
+      end
+
+      private_constant :Executor
+    end
+  end
+end
+
+require_relative "bulk/create"
+require_relative "bulk/result"
+require_relative "bulk/cancel"
+require_relative "bulk/operation"

data/lib/tasks/bulk.rake

@@ -0,0 +1,68 @@
+require "shopify_api/graphql/bulk"
+
+namespace :bulk do
+  desc "Submit a bulk task that can be used in test cases"
+  task :create do
+    shop = ENV.fetch("SHOPIFY_DOMAIN")
+    token = ENV.fetch("SHOPIFY_TOKEN")
+
+    mutation = <<~GQL
+      mutation productSet($input: ProductSetInput!, $identifier: ProductSetIdentifiers) {
+        productSet(input: $input, identifier: $identifier) {
+          product {
+            id
+            handle
+            tags
+          }
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    GQL
+
+    params = [
+      {
+        :identifier => { :handle => "handle-1" },
+        :input => {
+          :title => "My New Title",
+          :handle => "handle-1",
+          :productOptions => [
+            { :name => "Title", :values => [{ :name => "Default Title" }] }
+          ],
+          :variants => [
+            {
+              :sku => "SKU-001",
+              :optionValues => [
+                { :optionName => "Title", :name => "Default Title" }
+              ]
+            }
+          ]
+        }
+      },
+      {
+        :identifier => { :handle => "handle-2" },
+        :input => {
+          :title => "Another Title",
+          :handle => "handle-2",
+          :productOptions => [
+            { :name => "Title", :values => [{ :name => "Default Title" }] }
+          ],
+          :variants => [
+            {
+              :sku => "SKU-002",
+              :optionValues => [
+                { :optionName => "Title", :name => "Default Title" }
+              ]
+            }
+          ]
+        }
+      }
+    ]
+
+    bulk = ShopifyAPI::GraphQL::Bulk.new(shop, token, :version => ENV["SHOPIFY_API_VERSION"] || "2026-01")
+    puts "Making bulk request..."
+    puts bulk.create(mutation, params).id
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: shopify_api-graphql-bulk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shopify_api-graphql-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: strings-case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shopify_api/graphql/bulk.rb
+- lib/shopify_api/graphql/bulk/cancel.rb
+- lib/shopify_api/graphql/bulk/create.rb
+- lib/shopify_api/graphql/bulk/operation.rb
+- lib/shopify_api/graphql/bulk/operation/result.rb
+- lib/shopify_api/graphql/bulk/result.rb
+- lib/shopify_api/graphql/bulk/version.rb
+- lib/tasks/bulk.rake
+homepage:
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ScreenStaring/shopify_api-graphql-bulk/issues
+  documentation_uri: https://rubydoc.info/gems/shopify_api-graphql-bulk
+  source_code_uri: https://github.com/ScreenStaring/shopify_api-graphql-bulk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Bulk import data using the Shopify GraphQL Admin Bulk API
+test_files: []