Initial commit

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: sshaw

.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=

.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      SHOPIFY_DOMAIN: "${{ secrets.SHOPIFY_DOMAIN }}"
+      SHOPIFY_TOKEN: "${{ secrets.SHOPIFY_TOKEN }}"
+      BULK_SUCCESS_ID: "${{ secrets.BULK_SUCCESS_ID }}"
+      BULK_FAILED_ID_ERRORS: "${{ secrets.BULK_FAILED_ID_ERRORS }}"
+      BULK_FAILED_ID_USER_ERRORS: "${{ secrets.BULK_FAILED_ID_USER_ERRORS }}"
+      BULK_CANCELED_ID: "${{ secrets.BULK_CANCELED_ID }}"
+      BULK_PARTIAL_ID: "${{ secrets.BULK_PARTIAL_ID }}"
+
+    strategy:
+      matrix:
+        ruby: ['3.4', '3.3', '3.2', '3.1', '3.0', '2.7']
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+          bundler: '2.4.22'
+
+      - run: bundle install
+      - run: bundle exec rake

.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+.env.test

.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shopify_api-graphql-bulk.gemspec
+gemspec
+
+gem "irb"

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.

README.md

@@ -0,0 +1,81 @@
+# ShopifyAPI::GraphQL::Bulk
+
+Bulk import data with the [Shopify GraphQL Admin Bulk API](https://shopify.dev/docs/api/usage/bulk-operations/imports)
+
+## Usage
+
+```rb
+# Mutation parameters. Here we'll use 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) # ShopifyAPI::GraphQL::Bulk::Operation instance
+p operation.id
+p operation.completed_at
+p operation.url
+# etc...
+
+if operation.completed?
+  operation.results[:data].each { }
+  operation.results[:errors].each { }
+  operation.results[:user_errors].each { }
+end
+```
+
+`#create` also accepts a block:
+
+```rb
+id = bulk.create("mutationName") do |args|
+  args << input1
+  args << input2 # etc...
+end
+```
+
+Cancel a pending request:
+
+```rb
+operation = bulk.cancel(id) # returns 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`
+
+## See Also
+
+- [`ShopifyAPI::GraphQL::Request`](https://github.com/ScreenStaring/shopify_api-graphql-request/) - Simplify 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)

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

bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "shopify_api/graphql/bulk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here