shopify_graphql 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb945b9c83cd848d26c0776a801f905edae8eca4e39ce8bc3c0e6dbd11d9d621
-  data.tar.gz: e0a97f24d9fa501a73187d81ecdabe68de614bce10a5bbbc65c1dd7f5b5bc6c0
+  metadata.gz: 676b35a53c5124709bcb8760437d53e16678bfae111ddb757036df4c07d01fa0
+  data.tar.gz: a32e7e86b6bb543e27d234098225a399e6f38e49e330f7d871f51547943a9eeb
 SHA512:
-  metadata.gz: 2181d36cb07500305b03cb6846d1c605b6d56e564914074dd562ea3485c9cc88020433b29aa803ec9a4acd278c65d2eab96bc1ea7c10f0db5d218ecc2e93d177
-  data.tar.gz: ec238e18c338f1ab644addf84e60bda19a71aa467e8af19f611c0dbab05fb970bdf4d6b240489886c7ba025ffba424b2edf5aa9e5803d194e7ada5355642fb8b
+  metadata.gz: c0f3ee5179384954a776d2afecc37a5377c123aecc99b352deb02fb71493792d911356c8a2a950ff9279cfaca0e39c2122d4f002e72ed43dee2e6e0e6e10de0b
+  data.tar.gz: ef42df04753e9acd8b3f7b37cddb4c35195dc443fd67300ff5fdbc69487602e3f7dcbda0f5b49f92af52272ac7e56a3db070b9dcff9914753639f3f4d9c07fc9

data/README.md

@@ -86,6 +86,68 @@ puts product.title
 ```
 </details>
 
+### Query with custom headers
+
+<details><summary>Click to expand</summary>
+You can pass custom headers to any GraphQL query or mutation by using the `headers` parameter. A common use case is setting the `Accept-Language` header to retrieve content in specific languages:
+
+```rb
+# Pass custom headers to a direct GraphQL call to get French content
+response = ShopifyGraphql.execute(QUERY, headers: { "Accept-Language" => "fr" })
+
+# Or create a language-aware query wrapper
+class GetProduct
+  include ShopifyGraphql::Query
+
+  QUERY = <<~GRAPHQL
+    query($id: ID!) {
+      product(id: $id) {
+        id
+        title
+        description
+        seo {
+          title
+          description
+        }
+      }
+    }
+  GRAPHQL
+
+  def call(id:, language: nil)
+    headers = language ? { "Accept-Language" => language } : nil
+    response = execute(QUERY, headers: headers, id: id)
+    response.data = response.data.product
+    response
+  end
+end
+
+# Then use it to get content in different languages
+french_product = GetProduct.call(
+  id: "gid://shopify/Product/12345",
+  language: "fr"
+).data
+
+puts french_product.title       # => "Le Produit"
+puts french_product.description # => "Description en français"
+
+# Get content in Japanese
+japanese_product = GetProduct.call(
+  id: "gid://shopify/Product/12345",
+  language: "ja"
+).data
+
+puts japanese_product.title     # => "商品名"
+puts japanese_product.description # => "商品の説明"
+```
+
+The `Accept-Language` header tells Shopify which language to return the content in. This is particularly useful for:
+- Retrieving translated content for products, collections, and pages
+- Building multi-language storefronts
+- Showing localized SEO content
+
+You can also use custom headers for other purposes like passing metadata or context with your GraphQL requests.
+</details>
+
 ### Query with data parsing
 
 <details><summary>Click to expand</summary>

data/app/graphql/shopify_graphql/create_bulk_mutation.rb

@@ -10,6 +10,7 @@ module ShopifyGraphql
             status
           }
           userErrors {
+            code
             field
             message
           }

data/app/graphql/shopify_graphql/create_bulk_query.rb

@@ -10,6 +10,7 @@ module ShopifyGraphql
             status
           }
           userErrors {
+            code
             field
             message
           }

data/app/graphql/shopify_graphql/get_bulk_operation.rb

@@ -13,6 +13,8 @@ module ShopifyGraphql
             completedAt
             fileSize
             url
+            objectCount
+            rootObjectCount
           }
         }
       }
@@ -37,7 +39,9 @@ module ShopifyGraphql
         error_code: data.errorCode,
         created_at: Time.find_zone("UTC").parse(data.createdAt),
         completed_at: data.completedAt ? Time.find_zone("UTC").parse(data.completedAt) : nil,
-        url: data.url
+        url: data.url,
+        object_count: data.objectCount.to_i,
+        root_object_count: data.rootObjectCount.to_i,
       )
     end
   end

data/lib/shopify_graphql/client.rb

@@ -29,8 +29,8 @@ module ShopifyGraphql
       @client ||= ShopifyAPI::Clients::Graphql::Admin.new(session: ShopifyAPI::Context.active_session)
     end
 
-    def execute(query, **variables)
-      response = client.query(query: query, variables: variables)
+    def execute(query, headers: nil, **variables)
+      response = client.query(query: query, variables: variables, headers: headers)
       Response.new(handle_response(response))
     rescue ShopifyAPI::Errors::HttpResponseError => e
       Response.new(handle_response(e.response, e))
@@ -114,6 +114,8 @@ module ShopifyGraphql
           ConnectionError.new(response: response)
         end
       exception.error_code = error_code
+      exception.error_codes = [ error_code ]
+      exception.messages = [ error.message ]
       raise exception, error_message
     end
 
@@ -121,27 +123,52 @@ module ShopifyGraphql
       return response if response.userErrors.blank?
 
       error = response.userErrors.first
-      error_code = error.code
-      error_message = generate_error_message(
-        message: error.message,
-        code: error_code,
-        fields: error.field,
+      errors = response.userErrors
+      error_message = generate_user_errors_message(
+        messages: errors.map(&:message),
+        codes: errors.map(&:code),
+        fields: errors.map(&:field),
       )
 
       exception = UserError.new(response: response)
-      exception.error_code = error_code
-      exception.fields = error.field
+      exception.error_code = error.code
+      exception.error_codes = errors.map(&:code)
+      exception.fields = errors.map(&:field)
+      exception.messages = errors.map(&:message)
       raise exception, error_message
     end
 
-    def generate_error_message(message: nil, code: nil, doc: nil, fields: nil)
+    def generate_error_message(message: nil, code: nil, doc: nil)
       string = "Failed.".dup
       string << " Response code = #{code}." if code
       string << " Response message = #{message}.".gsub("..", ".") if message
       string << " Documentation = #{doc}." if doc
-      string << " Fields = #{fields}." if fields
       string
     end
+
+    def generate_user_errors_message(messages: nil, codes: nil, fields: [])
+      if fields.any?
+        field_count = fields.size
+        result = ["#{field_count} #{"field".pluralize(field_count)} have failed:"]
+        
+        fields.each.with_index do |field, index|
+          field_details = ["\n-"]
+          field_details << "Response code = #{codes[index]}." if codes&.at(index)
+          field_details << "Response message = #{messages[index]}.".gsub("..", ".") if messages&.at(index)
+          field_details << "Field = #{field}." if field
+
+          result << field_details.join(" ")
+        end
+        
+        result.join("\n")
+      else
+        result = ["Failed."]
+        result << "Response code = #{codes.join(", ")}." if codes&.any?
+        result << "Response message = #{messages&.join(", ")}.".gsub("..", ".") if messages&.any?
+        
+        result.join(" ")
+      end
+    end
   end
 
   class << self

data/lib/shopify_graphql/exceptions.rb

@@ -1,6 +1,6 @@
 module ShopifyGraphql
   class ConnectionError < ShopifyAPI::Errors::HttpResponseError
-    attr_accessor :error_code, :fields
+    attr_accessor :error_code, :error_codes, :fields, :messages
 
     def initialize(response: nil)
       unless response

data/lib/shopify_graphql/version.rb

@@ -1,3 +1,3 @@
 module ShopifyGraphql
-  VERSION = "2.0.1"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_graphql
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails