shopify_api-graphql-request 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac24b90edcc2ac73f86627c06801e1ef9ae67a470cd466befaacc920009e9c3
-  data.tar.gz: 8f56fd88505e60ce25cd4287b7ac781e9874f8507cf76a83080277953bec152a
+  metadata.gz: 392d3a9629abbbe7f7c768b5d2af6597f90dfc5728c4c55d2908d41730b66497
+  data.tar.gz: 790ba7b6a275ef632d0a43b86e4b141065ebd2a6bde41bc5b90bff7961018b96
 SHA512:
-  metadata.gz: 5cbb9adffc7ce34f8a46eee7698955153402ca5bd72232bf25653409d99be4c766b8cddf302ec7e42506c0db26d3e76e877c08b640750aec7306c1424c5781ea
-  data.tar.gz: 5aa3ddc3ba5dca7315e3a1a9e3af2f80389f3391cd09dae55986f8ba47d43319f70dd134808a34819105616ca4e38bc31054a2611294d58e76a15a57e1f7d39d
+  metadata.gz: 65b742996ac8a08a6e878424c0f293ccc3d899cd55a7a562de76eccb559d63163738faf0a3dfe1cc6f87e7cb9104cd04473c549b5f802e86f2b336973d7001d0
+  data.tar.gz: d8644370482c62f2aa95d22eaf7e59e406d7e32754b6ce48d70a0f0ad5cc0753d38ca13c7770f0dfaddbfd9ef4edb6cd1a0f78dd48d14aaa20f108f1b915b84f

data/Changes

@@ -0,0 +1,4 @@
+v0.0.2  2026-04-19
+--------------------
+Require TinyGID >= 0.1.2. This version allows one to call #parse and #to_s methods on #gid.
+Make #transform_keys private to communicate to implementors that it should not be called

data/README.md

@@ -5,11 +5,36 @@ Comes with built-in retry, pagination, error handling, and more!
 
 ## Usage
 
-It's recommended to organize queries and mutations by subclassing `ShopifyAPI::GraphQL::Request`:
+Queries:
 
 ```rb
 require "shopify_api/graphql/request"
 
+request = ShopifyAPI::GraphQL::Request.new("a-shop", token)
+
+begin
+  product = request.execute(query, :id => "gid://shopify/Product/123").dig(:data, :product)
+  p product[:title]
+  p product[:description_html]
+rescue ShopifyAPI::GraphQL::Request::NotFoundError => e
+  p e
+end
+```
+
+And mutations:
+
+```rb
+begin
+  product = request.execute(mutation, :id => "gid://shopify/Product/123", :title => "Foo Hoo!").dig(:data, :product)
+rescue ShopifyAPI::GraphQL::Request::UserError => e
+  p e
+end
+```
+
+If your application contains a lot of query and/or mutations it's recommended to organize them by
+subclassing `ShopifyAPI::GraphQL::Request`:
+
+```rb
 class ShopifyProduct < ShopifyAPI::GraphQL::Request
   # Define your queries/mutations
   FIND =<<-GQL
@@ -149,37 +174,25 @@ class ShopifyProduct < ShopifyAPI::GraphQL::Request
 end
 ```
 
-### Making Requests Without Subclassing
-
-Of course you can make requests directly on an instance of `ShopifyAPI::GraphQL::Request`:
-
-```rb
-require "shopify_api/graphql/request"
+### More Info
 
-request = ShopifyAPI::GraphQL::Request.new("a-shop", token)
+For more information checkout [the API docs](https://rdoc.info/gems/shopify_api-graphql-request)
 
-begin
-  product = request.execute(query, :id => "gid://shopify/Product/123").dig(:data, :product)
-  p product[:title]
-  p product[:description_html]
-rescue ShopifyAPI::GraphQL::Request::NotFoundError => e
-  p e
-end
-```
+## Why Use This Instead of Shopify's API Client?
 
-And mutations:
+- Easy-to-use
+- Built-in retry
+- Built-in pagination
+- Improved exception handling
+- You can use `:snake_case` hash keys
+- Lightweight
 
-```rb
-begin
-  product = request.execute(mutation, :id => "gid://shopify/Product/123", :title => "Foo Hoo!").dig(:data, :product)
-rescue ShopifyAPI::GraphQL::Request::UserError => e
-  p e
-end
-```
+Overall, Shopify's API client is bloated trash that will give you development headaches and long-term maintenance nightmares.
 
-### More Info
+We used to use it, staring way back in 2015, but eventually had to pivot away from their Ruby libraries due to developer
+frustration and high maintenance cost (and don't get us started on the ShopifyApp gem!@#).
 
-For more information checkout [the API docs](https://rdoc.info/gems/shopify_api-graphql-request)
+For more information see: https://github.com/Shopify/shopify-api-ruby/issues/1181
 
 ## Testing
 
@@ -188,7 +201,6 @@ For more information checkout [the API docs](https://rdoc.info/gems/shopify_api-
 ## See Also
 
 - [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
-- [Shopify ID Export](https://github.com/ScreenStaring/shopify_id_export/) - Dump Shopify product and variant IDs —along with other identifiers— to a CSV or JSON file
 - [`ShopifyAPI::GraphQL::Tiny`](https://github.com/ScreenStaring/shopify_api-graphql-tiny/) - Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in pagination and retry
 - [`TinyGID`](https://github.com/sshaw/tiny_gid/) - Build Global ID (`gid://`) URI strings from scalar values
 
@@ -198,4 +210,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ---
 
-Made by [ScreenStaring](http://screenstaring.com)
+Made by [ScreenStaring](https://screenstaring.com)

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

@@ -3,7 +3,7 @@
 module ShopifyAPI
   module GraphQL
     class Request
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/lib/shopify_api/graphql/request.rb

@@ -89,9 +89,9 @@ module ShopifyAPI
       #
       #  These override the instance's defaults for a single query or mutation.
       #
-      # [:raise_if_not_found (Boolean)]
-      # [:raise_if_user_errors (Boolean)]
-      # [:snake_case (Boolean)]
+      # [:raise_if_not_found (Boolean)] - raise a `ShopifyAPI::GraphQL::Request::NotFoundError` if query target is not found; defaults to +true+
+      # [:raise_if_user_errors (Boolean)] - raise a `ShopifyAPI::GraphQL::Request::UserError` if the response contains them; defaults to +true+
+      # [:snake_case (Boolean)] - Accept `:snake_case`-style hash keys and returned response hash keys to be snake_case; defaults to +true+
       #
       # === Returns
       #
@@ -137,7 +137,7 @@ module ShopifyAPI
       #
       # === Errors
       #
-      #  See #execute
+      # See #execute
       #
       def paginate(query, variables = nil, options = nil)
         options = @options.merge(options || {})
@@ -189,6 +189,8 @@ module ShopifyAPI
         transform_keys(object) { |key| Strings::Case.snakecase(key).to_sym }
       end
 
+      private
+
       def transform_keys(object, &transformer)
         case object
         when Hash

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api-graphql-request
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Skye Shaw
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-24 00:00:00.000000000 Z
+date: 2026-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shopify_api-graphql-tiny
@@ -35,14 +36,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: strings-case
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +106,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+description:
 email:
 - skye.shaw@gmail.com
 executables: []
@@ -107,11 +115,13 @@ extra_rdoc_files: []
 files:
 - ".env.template"
 - ".rspec"
+- Changes
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/shopify_api/graphql/request.rb
 - lib/shopify_api/graphql/request/version.rb
+homepage:
 licenses:
 - MIT
 metadata:
@@ -119,6 +129,7 @@ metadata:
   changelog_uri: https://github.com/ScreenStaring/shopify_api-graphql-request/blob/master/Changes
   documentation_uri: https://rubydoc.info/gems/shopify_api-graphql-request
   source_code_uri: https://github.com/ScreenStaring/shopify_api-graphql-request
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,7 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Small class to simplify the writing and handling of GraphQL queries and mutations
   for the Shopify Admin API. Comes with built-in retry, pagination, error handling,