shopify_api-graphql-tiny 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18495ff517670050b05536c1ef5fda702e689a4ffab229eba78fd2aba055dce5
-  data.tar.gz: c374cf2ae48b8ed7de70b5ec8501841593535ad21ef2d5591deb17c7dc96fdef
+  metadata.gz: 28d098f2ad608cf375916eb9efdf9c3278b514fc632058a835c1566989a4538b
+  data.tar.gz: 0a1b2d891a11116279b0169d2d093589148538f3c8abecaa35a5bd0d3bb2363a
 SHA512:
-  metadata.gz: 3388c846e2190e5996f780bf847d28f66c9336e0a96d53a8b6eed051fe8e38ffb18f3b32cc0abb15dfb15373d9f254eb6c8afbd2fbc050b3c19aea9c690db4de
-  data.tar.gz: e29a9dd41cd963bd96e8025ee31c5c4ec5b6b2726164655707c214fa73062f4e30e72545ea2df0c1b2ce54c90816c564776f509e4b9e3a51ef672290d35d2aec
+  metadata.gz: c0a66340735b1fc42126eda00b52598cbb4f1668da9e2680d99eab359e840865a6082568e53a71550f7e2edf936c7b78e1b15998391b6485d09958c7ae9cbfd2
+  data.tar.gz: b1ad6ca96b39d5c5a1e06c4d4a6b5e893a3236034b10426bbd9822f25e11bd9f03deddbc0125577abf3f126c5b2d78c4176f8913aa03f68f38362529e9ac0e2b

data/.env.template

@@ -7,7 +7,8 @@
 
 # Must be full domain as it's used in test assertions
 SHOPIFY_DOMAIN=
-SHOPIFY_TOKEN=
+SHOPIFY_ADMIN_TOKEN=
+SHOPIFY_STOREFRONT_TOKEN=
 
 # Will result in the creation of a metadafield on the customer. write_customers permission required
 SHOPIFY_CUSTOMER_ID=

data/Changes

@@ -1,3 +1,7 @@
+2026-06-25  v1.1.0
+--------------------
+* Add support for requests against the storefront API
+
 2026-06-23  v1.0.2
 --------------------
 * Add :raise_on_warnings option to raise a WarningError when a response contains warnings

data/README.md

@@ -1,6 +1,6 @@
 # ShopifyAPI::GraphQL::Tiny
 
-Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in pagination and retry
+Lightweight, no-nonsense, Shopify Admin & Storefront GraphQL API client with built-in pagination and retry
 
 [![CI](https://github.com/ScreenStaring/shopify_api-graphql-tiny/actions/workflows/ci.yml/badge.svg)](https://github.com/ScreenStaring/shopify_api-graphql-tiny/actions)
 
@@ -74,6 +74,24 @@ GQL
 p result.dig("data", "customerUpdate", "userErrors")
 ```
 
+### Storefront API
+
+By default requests are made against the Admin API.
+To make requests against the Storefront API use the `:storefront => true` option:
+
+```rb
+gql = ShopifyAPI::GraphQL::Tiny.new("my-shop", token, :storefront => true)
+result = gql.execute(<<-GQL, :id => your_gid)
+  query($id: ID!) {
+    product(id: $id) {
+      selectedOrFirstAvailableVariant {
+        id
+      }
+    }
+  }
+GQL
+```
+
 ### Automatically Retrying Failed Requests
 
 There are 2 types of retries: 1) request is rate-limited by Shopify 2) request fails due to an exception or non-200 HTTP response.
@@ -311,7 +329,6 @@ bundle exec rake rate_limit SHOPIFY_DOMAIN=your-domain SHOPIFY_TOKEN=your-token
 
 - [`ShopifyAPI::GraphQL::Request`](https://github.com/ScreenStaring/shopify_api-graphql-request) - A higher-level wrapper around this class with improved exception handling and `:snake_case` hash key conversion
 - [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
 - [`TinyGID`](https://github.com/sshaw/tiny_gid/) - Build Global ID (gid://) URI strings from scalar values
 
 ## License
@@ -320,4 +337,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/tiny/version.rb

@@ -3,7 +3,7 @@
 module ShopifyAPI
   module GraphQL
     class Tiny
-      VERSION = "1.0.2"
+      VERSION = "1.1.0"
     end
   end
 end

data/lib/shopify_api/graphql/tiny.rb

@@ -8,7 +8,7 @@ require "shopify_api/graphql/tiny/version"
 module ShopifyAPI
   module GraphQL
     ##
-    # Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in pagination and retry
+    # Lightweight, no-nonsense, Shopify GraphQL Admin/Storefront API client with built-in pagination and retry
     #
     class Tiny
       Error = Class.new(StandardError)
@@ -45,6 +45,8 @@ module ShopifyAPI
       SHOPIFY_DOMAIN = ".myshopify.com"
 
       ACCESS_TOKEN_HEADER = "X-Shopify-Access-Token"
+      STOREFRONT_ACCESS_TOKEN_HEADER = "X-Shopify-Storefront-Access-Token"
+      STOREFRONT_BUYER_IP_HEADER = "X-Shopify-Storefront-Buyer-IP"
       QUERY_COST_HEADER = "X-GraphQL-Cost-Include-Fields"
 
       DEFAULT_HEADERS = { "Content-Type" => "application/json" }.freeze
@@ -64,7 +66,7 @@ module ShopifyAPI
         *NetHttpTimeoutErrors.all
       ]
 
-      ENDPOINT = "https://%s/admin/api%s/graphql.json"       # Note that we omit the "/" after API for the case where there's no version.
+      ENDPOINT = "https://%s%s/api%s/graphql.json"       # We omit the "/" after API for the case where there's no version
 
       ##
       #
@@ -73,13 +75,15 @@ module ShopifyAPI
       # === Arguments
       #
       # [shop (String)] Shopify domain to make requests against
-      # [token (String)] Shopify Admin API GraphQL token
+      # [token (String)] Shopify Admin API or Storefront Access Token, depending on options
       # [options (Hash)] Client options. Optional.
       #
       # === Options
       #
       # [:retry (Boolean|Array)] If +false+ disable retries or an +Array+ of errors to retry. Can be HTTP status codes, GraphQL errors, or exception classes.
       # [:version (String)] Shopify API version to use. Defaults to the latest version.
+      # [:storefront (Boolean)] If +true+ use the Storefront API instead of Admin API. Defaults to +false+.
+      # [:ip (String)] Optional buyer IP address for Storefront API (sets X-Shopify-Storefront-Buyer-IP header). Only used when :storefront is +true+.
       # [:max_attempts (Integer)] Maximum number of retry attempts across all errors. Defaults to +10+
       # [:base_delay (Float)] Exponential backoff base delay. Defaults to +0.5+
       # [:jitter (Boolean)] Exponential backoff jitter (random delay added to backoff). Defaults to +true+
@@ -98,13 +102,23 @@ module ShopifyAPI
 
         @domain = shopify_domain(shop)
         @options = options || {}
+
         @raise_on_warnings = @options[:raise_on_warnings]
+        @storefront = !!@options[:storefront]
 
         @headers = DEFAULT_HEADERS.dup
-        @headers[ACCESS_TOKEN_HEADER] = token
+
+        if @storefront
+          @headers[STOREFRONT_ACCESS_TOKEN_HEADER] = token
+          @headers[STOREFRONT_BUYER_IP_HEADER] = @options[:ip] if @options[:ip]
+        else
+          @headers[ACCESS_TOKEN_HEADER] = token
+        end
+
         @headers[QUERY_COST_HEADER] = "true" unless @options[:retry] == false
 
-        @endpoint = URI(sprintf(ENDPOINT, @domain, !@options[:version].to_s.strip.empty? ? "/#{@options[:version]}" : ""))
+        admin_path = @storefront ? "" : "/admin"
+        @endpoint = URI(sprintf(ENDPOINT, @domain, admin_path, !@options[:version].to_s.strip.empty? ? "/#{@options[:version]}" : ""))
         @backoff_options = DEFAULT_BACKOFF_OPTIONS.merge(@options.slice(*DEFAULT_BACKOFF_OPTIONS.keys))
 
         if @options[:debug]

data/shopify_api-graphql-tiny.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Skye Shaw"]
   spec.email         = ["skye.shaw@gmail.com"]
 
-  spec.summary       = %q{Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in pagination and retry}
+  spec.summary       = %q{Lightweight, no-nonsense, Shopify Admin & Storefront GraphQL API client with built-in pagination and retry}
   spec.homepage      = "https://github.com/ScreenStaring/shopify_api-graphql-tiny"
   spec.license       = "MIT"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api-graphql-tiny
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Skye Shaw
 bindir: exe
 cert_chain: []
-date: 2026-06-23 00:00:00.000000000 Z
+date: 2026-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net_http_timeout_errors
@@ -123,6 +123,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in
-  pagination and retry
+summary: Lightweight, no-nonsense, Shopify Admin & Storefront GraphQL API client with
+  built-in pagination and retry
 test_files: []