shopify_api 14.6.0 → 14.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adedcbd54d0a4bff1dfeef88fc867ddf3813f6f619c8f4ad75345a9669c468b
-  data.tar.gz: 2b5b7115e1a9d469cb62b23f18a9ff41f45216a6e4d76ad07dcd110460271391
+  metadata.gz: 2594b938c059a24c4f17f5a435612a01fe880eb4ab5096f25ac0d0513129c71c
+  data.tar.gz: 3b584fffb9213fefaf5f1a603c76de8292ecb30e7434ccc63af7265ab3377987
 SHA512:
-  metadata.gz: 2ee3b4ff5f00993b64a5dc89c3618da8c757ae3451d34c298b6da01ea4659d38c3c56f70ca066662059147b67e23c0816539ca9d5e2526c270a28e91c903b166
-  data.tar.gz: 3018dc46d85e99cff6821d8057b8a61cb59adeb41f856db18a0ecab0e47f17aecc86ffeb23c45a722121988c97f6bb262d6913a88d2bc1a5fdc572fb7b0fca05
+  metadata.gz: 5e565a15428752c7838332f42d02c6aad73fe837dcc1c91774ed2cd523c81b6cd440e82dc0f2d8d65494a0d7715bb75f8533a3105304d2a510b1cd104690b1f2
+  data.tar.gz: e3625bc9e1e17ef36162fcc8c416478dbdf9f8b7bc868fb228d07ba4c2878bedb72738765e82737da9cd59b4c5d7197ba81c15d9013a38f13987e5ba3fbdf93d

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 ## Unreleased
 
+## 14.7.0
+
+- [#1347](https://github.com/Shopify/shopify-api-ruby/pull/1347) Extend webhook registration to support filters
+- [#1344](https://github.com/Shopify/shopify-api-ruby/pull/1344) Allow ShopifyAPI::Webhooks::Registry to update a webhook when fields or metafield_namespaces are changed.
+- [#1343](https://github.com/Shopify/shopify-api-ruby/pull/1343) Make ShopifyAPI::Context::scope parameter optional. `scope` defaults to empty list `[]`.
+
 ## 14.6.0
 
 - [#1337](https://github.com/Shopify/shopify-api-ruby/pull/1337) Fix type for Shop#google_apps_login_enabled

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (14.6.0)
+    shopify_api (14.7.0)
       activesupport
       concurrent-ruby
       hash_diff
@@ -16,20 +16,24 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.4)
+    activesupport (7.1.5)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
       mutex_m
+      securerandom (>= 0.3)
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     base64 (0.2.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -50,21 +54,22 @@ GEM
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
-    jwt (2.9.1)
+    jwt (2.9.3)
       base64
     language_server-protocol (3.17.0.3)
+    logger (1.6.1)
     method_source (1.0.0)
     mini_mime (1.1.5)
     minitest (5.15.0)
     mocha (1.13.0)
     multi_xml (0.6.0)
-    mutex_m (0.2.0)
+    mutex_m (0.3.0)
     netrc (0.11.0)
-    oj (3.16.6)
+    oj (3.16.7)
       bigdecimal (>= 3.0)
       ostruct (>= 0.2)
     openssl (3.2.0)
-    ostruct (0.6.0)
+    ostruct (0.6.1)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -104,7 +109,7 @@ GEM
     rubocop-sorbet (0.6.11)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
+    securerandom (0.3.2)
     sorbet (0.5.11230)
       sorbet-static (= 0.5.11230)
     sorbet-runtime (0.5.11230)

data/docs/usage/oauth.md

@@ -123,6 +123,19 @@ class ShopifyCallbackController < ApplicationController
 ```
 
 #### 3. Begin OAuth
+To request access scopes from the shop during authorization code grant OAuth flow, 
+configure access scopes needed by adding the `scope` parameter to the `ShopifyAPI::Context.setup` method in your configuration.
+
+```ruby
+ShopifyAPI::Context.setup(
+  api_key: <SHOPIFY_API_KEY>,
+  api_secret_key: <SHOPIFY_API_SECRET>,
+  api_version: <SHOPIFY_API_VERSION>,
+  scope: <SHOPIFY_API_SCOPES>, # Accepts array or string: "read_orders, write_products" or ["read_orders", "write_products"]
+  ...
+  )
+```
+
 Use [`ShopifyAPI::Auth::Oauth.begin_auth`](https://github.com/Shopify/shopify-api-ruby/blob/main/lib/shopify_api/auth/oauth.rb#L22) method to start OAuth process for your app.
 
 #### Input
@@ -131,6 +144,7 @@ Use [`ShopifyAPI::Auth::Oauth.begin_auth`](https://github.com/Shopify/shopify-ap
 | `shop`          | `String`               |    Yes    |       -       | A Shopify domain name in the form `{exampleshop}.myshopify.com`.                                            |
 | `redirect_path` | `String`               |    Yes    |       -       | The redirect path used for callback with a leading `/`. The route should be allowed under the app settings. |
 | `is_online`     | `Boolean`              |    No     |    `true`     | `true` if the session is online and `false` otherwise.                                                      |
+| `scope_override`| `String` or `[String]` |    No     |     `nil`     |  `nil` will request access scopes configured in `ShopifyAPI::Context.setup` during OAuth flow. Modify this to override the access scopes being requested. Accepts array or string: "read_orders, write_products" or ["read_orders", "write_products"]. |
 
 #### Output
 `begin_auth` method will return a hash result in the form of:

data/docs/usage/webhooks.md

@@ -82,6 +82,17 @@ registration = ShopifyAPI::Webhooks::Registry.add_registration(
 )
 ```
 
+If you need to filter the webhooks you want to receive, you can use a [webhooks filter](https://shopify.dev/docs/apps/build/webhooks/customize/filters), which can be specified on registration through the `filter` parameter.
+
+```ruby
+registration = ShopifyAPI::Webhooks::Registry.add_registration(
+  topic: "products/update",
+  delivery_method: :http,
+  handler: WebhookHandler,
+  filter: "variants.price:>=10.00"
+)
+```
+
 **Note**: The webhooks you register with Shopify are saved in the Shopify platform, but the local `ShopifyAPI::Webhooks::Registry` needs to be reloaded whenever your server restarts.
 
 ### EventBridge and PubSub Webhooks

data/lib/shopify_api/context.rb

@@ -33,9 +33,9 @@ module ShopifyAPI
           api_key: String,
           api_secret_key: String,
           api_version: String,
-          scope: T.any(T::Array[String], String),
           is_private: T::Boolean,
           is_embedded: T::Boolean,
+          scope: T.any(T::Array[String], String),
           log_level: T.any(String, Symbol),
           logger: T.untyped,
           host_name: T.nilable(String),
@@ -51,9 +51,9 @@ module ShopifyAPI
         api_key:,
         api_secret_key:,
         api_version:,
-        scope:,
         is_private:,
         is_embedded:,
+        scope: [],
         log_level: :info,
         logger: ::Logger.new($stdout),
         host_name: nil,

data/lib/shopify_api/rest/resources/2024_07/webhook.rb

@@ -23,6 +23,7 @@ module ShopifyAPI
       @api_version = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
       @fields = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @filter = T.let(nil, T.nilable(String))
       @format = T.let(nil, T.nilable(String))
       @id = T.let(nil, T.nilable(Integer))
       @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))

data/lib/shopify_api/rest/resources/2024_10/webhook.rb

@@ -23,6 +23,7 @@ module ShopifyAPI
       @api_version = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
       @fields = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @filter = T.let(nil, T.nilable(String))
       @format = T.let(nil, T.nilable(String))
       @id = T.let(nil, T.nilable(Integer))
       @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))

data/lib/shopify_api/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ShopifyAPI
-  VERSION = "14.6.0"
+  VERSION = "14.7.0"
 end

data/lib/shopify_api/webhooks/registration.rb

@@ -22,18 +22,23 @@ module ShopifyAPI
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :metafield_namespaces
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :filter
+
       sig do
         params(topic: String, path: String, handler: T.nilable(T.any(Handler, WebhookHandler)),
           fields: T.nilable(T.any(String, T::Array[String])),
-          metafield_namespaces: T.nilable(T::Array[String])).void
+          metafield_namespaces: T.nilable(T::Array[String]),
+          filter: T.nilable(String)).void
       end
-      def initialize(topic:, path:, handler: nil, fields: nil, metafield_namespaces: nil)
+      def initialize(topic:, path:, handler: nil, fields: nil, metafield_namespaces: nil, filter: nil)
         @topic = T.let(topic.gsub("/", "_").upcase, String)
         @path = path
         @handler = handler
         fields_array = fields.is_a?(String) ? fields.split(FIELDS_DELIMITER) : fields
         @fields = T.let(fields_array&.map(&:strip)&.compact, T.nilable(T::Array[String]))
         @metafield_namespaces = T.let(metafield_namespaces&.map(&:strip)&.compact, T.nilable(T::Array[String]))
+        @filter = filter
       end
 
       sig { abstract.returns(String) }
@@ -48,7 +53,15 @@ module ShopifyAPI
       sig { abstract.returns(String) }
       def build_check_query; end
 
-      sig { abstract.params(body: T::Hash[String, T.untyped]).returns(T::Hash[Symbol, String]) }
+      sig do
+        abstract.params(body: T::Hash[String, T.untyped]).returns({
+          webhook_id: T.nilable(String),
+          current_address: T.nilable(String),
+          fields: T::Array[String],
+          metafield_namespaces: T::Array[String],
+          filter: T.nilable(String),
+        })
+      end
       def parse_check_result(body); end
 
       sig { params(webhook_id: T.nilable(String)).returns(String) }
@@ -81,6 +94,7 @@ module ShopifyAPI
         attributes = ["id"]
         attributes << "includeFields" if @fields
         attributes << "metafieldNamespaces" if @metafield_namespaces
+        attributes << "filter" if @filter
         attributes
       end
     end

data/lib/shopify_api/webhooks/registrations/event_bridge.rb

@@ -14,7 +14,8 @@ module ShopifyAPI
 
         sig { override.returns(T::Hash[Symbol, String]) }
         def subscription_args
-          { arn: callback_address, includeFields: fields, metafieldNamespaces: metafield_namespaces }.compact
+          { arn: callback_address, includeFields: fields,
+            metafieldNamespaces: metafield_namespaces, filter: filter, }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }
@@ -30,6 +31,9 @@ module ShopifyAPI
                 edges {
                   node {
                     id
+                    includeFields
+                    metafieldNamespaces
+                    filter
                     endpoint {
                       __typename
                       ... on WebhookEventBridgeEndpoint {
@@ -43,17 +47,32 @@ module ShopifyAPI
           QUERY
         end
 
-        sig { override.params(body: T::Hash[String, T.untyped]).returns(T::Hash[Symbol, String]) }
+        sig do
+          override.params(body: T::Hash[String, T.untyped]).returns({
+            webhook_id: T.nilable(String),
+            current_address: T.nilable(String),
+            fields: T::Array[String],
+            metafield_namespaces: T::Array[String],
+            filter: T.nilable(String),
+          })
+        end
         def parse_check_result(body)
           edges = body.dig("data", "webhookSubscriptions", "edges") || {}
           webhook_id = nil
+          fields = []
+          metafield_namespaces = []
+          filter = nil
           current_address = nil
           unless edges.empty?
             node = edges[0]["node"]
             webhook_id = node["id"].to_s
             current_address = node["endpoint"]["arn"].to_s
+            fields = node["includeFields"] || []
+            metafield_namespaces = node["metafieldNamespaces"] || []
+            filter = node["filter"].to_s
           end
-          { webhook_id: webhook_id, current_address: current_address }
+          { webhook_id: webhook_id, current_address: current_address, fields: fields,
+            metafield_namespaces: metafield_namespaces, filter: filter, }
         end
       end
     end

data/lib/shopify_api/webhooks/registrations/http.rb

@@ -20,7 +20,8 @@ module ShopifyAPI
 
         sig { override.returns(T::Hash[Symbol, String]) }
         def subscription_args
-          { callbackUrl: callback_address, includeFields: fields, metafieldNamespaces: metafield_namespaces }.compact
+          { callbackUrl: callback_address, includeFields: fields,
+            metafieldNamespaces: metafield_namespaces, filter: filter, }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }
@@ -36,6 +37,9 @@ module ShopifyAPI
                 edges {
                   node {
                     id
+                    includeFields
+                    metafieldNamespaces
+                    filter
                     endpoint {
                       __typename
                       ... on WebhookHttpEndpoint {
@@ -49,10 +53,21 @@ module ShopifyAPI
           QUERY
         end
 
-        sig { override.params(body: T::Hash[String, T.untyped]).returns(T::Hash[Symbol, String]) }
+        sig do
+          override.params(body: T::Hash[String, T.untyped]).returns({
+            webhook_id: T.nilable(String),
+            current_address: T.nilable(String),
+            fields: T::Array[String],
+            metafield_namespaces: T::Array[String],
+            filter: T.nilable(String),
+          })
+        end
         def parse_check_result(body)
           edges = body.dig("data", "webhookSubscriptions", "edges") || {}
           webhook_id = nil
+          fields = []
+          metafield_namespaces = []
+          filter = nil
           current_address = nil
           unless edges.empty?
             node = edges[0]["node"]
@@ -63,8 +78,12 @@ module ShopifyAPI
               else
                 node["callbackUrl"].to_s
               end
+            fields = node["includeFields"] || []
+            metafield_namespaces = node["metafieldNamespaces"] || []
+            filter = node["filter"].to_s
           end
-          { webhook_id: webhook_id, current_address: current_address }
+          { webhook_id: webhook_id, current_address: current_address, fields: fields,
+            metafield_namespaces: metafield_namespaces, filter: filter, }
         end
       end
     end

data/lib/shopify_api/webhooks/registrations/pub_sub.rb

@@ -18,7 +18,7 @@ module ShopifyAPI
           project = project_topic_pair[0]
           topic = project_topic_pair[1]
           { pubSubProject: project, pubSubTopic: topic, includeFields: fields,
-            metafieldNamespaces: metafield_namespaces, }.compact
+            metafieldNamespaces: metafield_namespaces, filter: filter, }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }
@@ -34,6 +34,9 @@ module ShopifyAPI
                 edges {
                   node {
                     id
+                    includeFields
+                    metafieldNamespaces
+                    filter
                     endpoint {
                       __typename
                       ... on WebhookPubSubEndpoint {
@@ -48,17 +51,33 @@ module ShopifyAPI
           QUERY
         end
 
-        sig { override.params(body: T::Hash[String, T.untyped]).returns(T::Hash[Symbol, String]) }
+        sig do
+          override.params(body: T::Hash[String, T.untyped]).returns({
+            webhook_id: T.nilable(String),
+            current_address: T.nilable(String),
+            fields: T::Array[String],
+            metafield_namespaces: T::Array[String],
+            filter: T.nilable(String),
+          })
+        end
         def parse_check_result(body)
           edges = body.dig("data", "webhookSubscriptions", "edges") || {}
           webhook_id = nil
+          fields = []
+          metafield_namespaces = []
+          filter = nil
           current_address = nil
           unless edges.empty?
             node = edges[0]["node"]
             webhook_id = node["id"].to_s
-            current_address = "pubsub://#{node["endpoint"]["pubSubProject"]}:#{node["endpoint"]["pubSubTopic"]}"
+            current_address =
+              "pubsub://#{node["endpoint"]["pubSubProject"]}:#{node["endpoint"]["pubSubTopic"]}"
+            fields = node["includeFields"] || []
+            metafield_namespaces = node["metafieldNamespaces"] || []
+            filter = node["filter"].to_s
           end
-          { webhook_id: webhook_id, current_address: current_address }
+          { webhook_id: webhook_id, current_address: current_address, fields: fields,
+            metafield_namespaces: metafield_namespaces, filter: filter, }
         end
       end
     end

data/lib/shopify_api/webhooks/registry.rb

@@ -19,23 +19,25 @@ module ShopifyAPI
             path: String,
             handler: T.nilable(T.any(Handler, WebhookHandler)),
             fields: T.nilable(T.any(String, T::Array[String])),
+            filter: T.nilable(String),
             metafield_namespaces: T.nilable(T::Array[String])).void
         end
-        def add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil, metafield_namespaces: nil)
+        def add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil, filter: nil,
+          metafield_namespaces: nil)
           @registry[topic] = case delivery_method
           when :pub_sub
             Registrations::PubSub.new(topic: topic, path: path, fields: fields,
-              metafield_namespaces: metafield_namespaces)
+              metafield_namespaces: metafield_namespaces, filter: filter)
           when :event_bridge
             Registrations::EventBridge.new(topic: topic, path: path, fields: fields,
-              metafield_namespaces: metafield_namespaces)
+              metafield_namespaces: metafield_namespaces, filter: filter)
           when :http
             unless handler
               raise Errors::InvalidWebhookRegistrationError, "Cannot create an Http registration without a handler."
             end
 
             Registrations::Http.new(topic: topic, path: path, handler: handler,
-              fields: fields, metafield_namespaces: metafield_namespaces)
+              fields: fields, metafield_namespaces: metafield_namespaces, filter: filter)
           else
             raise Errors::InvalidWebhookRegistrationError,
               "Unsupported delivery method #{delivery_method}. Allowed values: {:http, :pub_sub, :event_bridge}."
@@ -219,8 +221,16 @@ module ShopifyAPI
           check_response = client.query(query: registration.build_check_query, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to check if webhook was already registered" unless check_response.ok?
+
           parsed_check_result = registration.parse_check_result(T.cast(check_response.body, T::Hash[String, T.untyped]))
-          must_register = parsed_check_result[:current_address] != registration.callback_address
+          registration_fields = registration.fields || []
+          registration_metafield_namespaces = registration.metafield_namespaces || []
+          registration_filter = registration.filter
+
+          must_register = parsed_check_result[:current_address] != registration.callback_address ||
+            parsed_check_result[:fields].sort != registration_fields.sort ||
+            parsed_check_result[:metafield_namespaces].sort != registration_metafield_namespaces.sort ||
+            parsed_check_result[:filter] != registration_filter
 
           { webhook_id: parsed_check_result[:webhook_id], must_register: must_register }
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 14.6.0
+  version: 14.7.0
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -1157,7 +1157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: The gem for accessing the Shopify API