shopify_graphql 1.2.4 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a85b64907b2d5999db3a96db60838d6542c6f4e9fd0d90b49d26cb6226ffe7
-  data.tar.gz: 2d2d7ee2590f32dfeceba741ec228158dbb13dca3737063bde1f23e69f9196fd
+  metadata.gz: a20f7b85f9a4a22fd1c3ea0509ec496f3447a2764fedf105539cab20274ed221
+  data.tar.gz: 966022527dd821e837c200d6c1df8ca84236b05ed5e311c6ac13dbabe00322f9
 SHA512:
-  metadata.gz: aabf1fb4fb94328201f17873fdeba94667fc27f80fa3e265b3e103bf0decd01ca760c37f48b02698fcbc34242bd3a83b832d22bc644c319384a16fddf7ecaa91
-  data.tar.gz: 5d3dbf44116974a3d5db0a140a1b6487f35fb12d0be85eda46e8580be9c7fe002c25acb3fbcea0f3e840c52840536fc1548c75897cd46fe3ad5c0443aabef995
+  metadata.gz: 02c0027937db4125f3a1146275a999e1c6657ebe28682d5e0da81d34fcebac78796877abc4e7d1572de84599a82033d2140cabd8afbdd9b39951e428a9d4644f
+  data.tar.gz: 4eeb9be4a243c5bcba638857a6bfa29f28e20a94ba1d3aa236ac30fdf7a2a6587bd4d74a6b7a53349118a60072458fc87fc255c16560b76b07c0d64c33e2ae13

data/README.md

@@ -685,6 +685,30 @@ ShopifyGraphql.handle_user_errors(response)
 
 Built-in wrappers are located in [`app/graphql/shopify_graphql`](/app/graphql/shopify_graphql/) folder. You can use them directly in your apps or as an example to create your own wrappers.
 
+## Rate limits
+
+The gem exposes Graphql rate limit extensions in response object:
+
+- `points_left`
+- `points_limit`
+- `points_restore_rate`
+- `query_cost`
+
+And adds a helper to check if available points lower than threshold (useful for implementing API backoff):
+
+- `points_maxed?(threshold: 100)`
+
+Usage example:
+
+```rb
+response = GetProduct.call(id: "gid://shopify/Product/PRODUCT_GID")
+response.points_left # => 1999
+response.points_limit # => 2000.0
+response.points_restore_rate # => 100.0
+response.query_cost # => 1
+response.points_maxed?(threshold: 100) # => false
+```
+
 ## Graphql webhooks
 
 > Since version 10 `shopify_api` gem includes built-in support for Graphql webhooks. If you are using `shopify_api` version 10 or higher you don't need to use this gem to handle Graphql webhooks. See [`shopify_app` documentation](https://github.com/Shopify/shopify_app/blob/main/docs/shopify_app/webhooks.md) for more details.

data/lib/shopify_graphql/client.rb

@@ -11,7 +11,7 @@ module ShopifyGraphql
       Response.new(handle_response(e.response))
     rescue JSON::ParserError => e
       raise ServerError.new(e, "Invalid JSON response")
-    rescue Errno::ECONNRESET, Errno::EPIPE, Errno::ECONNREFUSED, Errno::ENETUNREACH, Net::ReadTimeout, Net::OpenTimeout, OpenSSL::SSL::SSLError, EOFError => e
+    rescue Errno::ECONNRESET, Errno::EPIPE, Errno::ECONNREFUSED, Errno::ENETUNREACH, Net::ReadTimeout, Net::OpenTimeout, OpenSSL::SSL::SSLError, EOFError, Socket::ResolutionError => e
       raise ServerError.new(e, "Network error")
     end
 
@@ -47,6 +47,8 @@ module ShopifyGraphql
         raise PreconditionFailed.new(parsed_body(response), code: response.code)
       when 422
         raise ResourceInvalid.new(parsed_body(response), code: response.code)
+      when 423
+        raise ShopLocked.new(parsed_body(response), code: response.code)
       when 429, 430
         raise TooManyRequests.new(parsed_body(response), code: response.code)
       when 401...500

data/lib/shopify_graphql/exceptions.rb

@@ -60,6 +60,10 @@ module ShopifyGraphql
   class PreconditionFailed < ClientError # :nodoc:
   end
 
+  # 423 Locked
+  class ShopLocked < ClientError # :nodoc:
+  end
+
   # 429 Too Many Requests
   class TooManyRequests < ClientError # :nodoc:
   end

data/lib/shopify_graphql/version.rb

@@ -1,3 +1,3 @@
 module ShopifyGraphql
-  VERSION = "1.2.4"
+  VERSION = "1.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_graphql
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.6
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails