shopify-client 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996fd4c7f7e89ddeff22da53168828c5d8bd1a87ad3d965a512c10aee7c99850
-  data.tar.gz: 0c2829baff3a2518d6a4ab44544a975a7f72dcb8614d75b703e0da46f3238b25
+  metadata.gz: 818841a24a7d51fd3a425b4a0c55f42ee67c00ce4c63266bb9ca3c1b1d5ba9e7
+  data.tar.gz: 18b286b836e472ea6842082012f57e3b6c762d32999cb9e4e3f3c03ea01225d0
 SHA512:
-  metadata.gz: 93aa4de201357efbf4a51f5924bf1f547d85ee822f5fe35f34b2a1e7cc23645849026bb309de43f48644a94ff6772f63b967e98dad5ca1670d305c1877f411c2
-  data.tar.gz: 2930f0d23bb145629ab392015142b213d4470d81c69675890ad9594983f8acf6fcac91ce1fabb68acb7207d779f9282faa6d261b9ee3249d021dad58dda101e9
+  metadata.gz: b71e062da5ded3d0689375261147a516eeb6b6135f9ca9cb94cc1a47fb4440aabc050e81b4cc64838f35f825d98af9cafec896354d4c80a6221a7f68cab75e21
+  data.tar.gz: 55adbc9bed92f981a939fb64a3bff3e743d4967164545bc9fe7d7820f7498c51a376594abd96f07274a124020f36ffb1c859df7cb44f5cdf46074f38af242ba6

data/README.md

@@ -24,6 +24,8 @@ shopify-client
     * [Create a resource](#create-a-resource)
     * [Update a resource](#update-a-resource)
     * [Delete a resource](#delete-a-resource)
+9. [Testing](#testing)
+    * [Integration tests](#integration-tests)
 
 
 Installation
@@ -44,7 +46,7 @@ Setup
       config.api_version = '...' # e.g. '2021-04'
       config.cache_ttl = 3600
       config.redirect_uri = '...' # for OAuth
-      config.logger = Logger.new(STDOUT) # defaults to a null logger
+      config.logger = Logger.new($stdout) # defaults to a null logger
       config.scope = '...'
       config.shared_secret = '...'
       config.webhook_uri = '...'
@@ -78,7 +80,7 @@ Calling the API
 
 Request logging is disabled by default. To enable it:
 
-    ShopifyClient.config.logger = Logger.new(STDOUT)
+    ShopifyClient.config.logger = Logger.new($stdout)
 
 Request throttling is enabled by default. If you're using Redis, throttling will
 automatically make use of it; otherwise, throttling will only be maintained
@@ -91,7 +93,7 @@ The gem wraps Shopify's bulk query API by writing the result to a temporary file
 and yielding an enumerator which itself streams each line of the result to limit
 memory usage.
 
-    client.grahql_bulk(%(
+    client.graphql_bulk(%(
       {
         products {
           edges {
@@ -298,7 +300,7 @@ Find a single result:
 
 Iterate over results (automatic pagination):
 
-    order_repo.all.each do |order|
+    order_repo.all(client).each do |order|
       # ...
     end
 
@@ -340,3 +342,21 @@ Iterate over results (automatic pagination):
     order_repo = OrderRepository.new
 
     order_repo.delete(client, id)
+
+
+Testing
+-------
+
+### Integration tests
+
+The integration tests require a private app with the scope `write_products`.
+Create a .env file specifying the test shop, private app password, and a valid
+webhook URI:
+
+    TEST_SHOP='test-shop.myshopify.com'
+    TEST_PASSWORD='shppa_...'
+    TEST_WEBHOOK_URI='https://.../webhooks'
+
+Run the suite:
+
+    $ bundle exec rake test:integration

data/lib/shopify-client/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'async/http/faraday'
 require 'faraday'
 require 'faraday_middleware'
 
@@ -18,6 +19,7 @@ module ShopifyClient
         },
         url: "https://#{myshopify_domain}/admin/api/#{ShopifyClient.config.api_version}",
       ) do |conn|
+        conn.adapter :async_http
         # Request throttling to avoid API rate limit.
         conn.use default_throttling_strategy
         # Retry for 429, too many requests.

data/lib/shopify-client/config_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  ConfigError = Class.new(Error)
+end

data/lib/shopify-client/create_all_webhooks.rb

@@ -6,18 +6,52 @@ module ShopifyClient
     #
     # @param client [Client]
     #
-    # @return [Array<Hash>] response data
+    # @return [Array<String>] GraphQL IDs
     def call(client)
-      create_webhook = CreateWebhook.new
+      raise ConfigError, 'webhook_uri is not set' unless ShopifyClient.config.webhook_uri
 
-      ShopifyClient.webhooks.map do |topic|
-        Thread.new do
-          create_webhook.(client, {
-            topic: topic,
-            fields: topic[:fields],
-          })
+      webhooks_with_index = ShopifyClient.webhooks.each_with_index
+
+      return [] unless webhooks_with_index.any?
+
+      client.graphql(%(
+        mutation webhookSubscriptionCreate(
+          #{webhooks_with_index.map { |_, i| %(
+            $topic#{i}: WebhookSubscriptionTopic!
+            $webhookSubscription#{i}: WebhookSubscriptionInput!
+          )}.join("\n")}
+        ) {
+          #{webhooks_with_index.map { |_, i| %(
+            webhookSubscriptionCreate#{i}: webhookSubscriptionCreate(
+              topic: $topic#{i}
+              webhookSubscription: $webhookSubscription#{i}
+            ) {
+              userErrors {
+                field
+                message
+              }
+              webhookSubscription {
+                id
+              }
+            }
+          )}.join("\n")}
+        }
+      ), webhooks_with_index.each_with_object({}) do |((topic, options), i), variables|
+        variables["topic#{i}"] = topic_to_graphql(topic)
+        variables["webhookSubscription#{i}"] = {}.tap do |subscription|
+          subscription['callbackUrl'] = ShopifyClient.config.webhook_uri
+          subscription['includeFields'] = options[:fields] unless options[:fields].empty?
         end
-      end.map(&:value)
+      end).data['data'].map do |_, mutation|
+        mutation['webhookSubscription']['id']
+      end
+    end
+
+    # @param topic [String]
+    #
+    # @return [String]
+    private def topic_to_graphql(topic)
+      topic.upcase.sub('/', '_')
     end
   end
 end

data/lib/shopify-client/create_webhook.rb

@@ -7,11 +7,13 @@ module ShopifyClient
     # @option webhook [String] :topic
     # @option webhook [Array<String>] :fields
     #
-    # @return [Hash] response data
+    # @return [Integer] ID
     def call(client, webhook)
-      client.post_json(credentials, 'webhooks', webhook: webhook.merge(
+      raise ConfigError, 'webhook_uri is not set' unless ShopifyClient.config.webhook_uri
+
+      client.post('webhooks', webhook: webhook.merge(
         address: ShopifyClient.config.webhook_uri,
-      ))
+      )).data['webhook']['id']
     rescue Response::Error => e
       raise e unless e.response.errors.message?([
         /has already been taken/,

data/lib/shopify-client/delete_all_webhooks.rb

@@ -5,18 +5,40 @@ module ShopifyClient
     # Delete any existing webhooks.
     #
     # @param client [Client]
-    #
-    # @return [Array<Hash>] response data
-    def call(client)
-      webhooks = client.get(credentials, 'webhooks')['webhooks']
+    # @param ids [Array<Integer>, nil] GraphQL IDs
+    def call(client, ids: nil)
+      ids ||= client.graphql(%({
+        webhookSubscriptions(first: 100) {
+          edges {
+            node {
+              id
+            }
+          }
+        }
+      })).data['data']['webhookSubscriptions']['edges'].map do |edge|
+        edge['node']['id']
+      end
 
-      delete_webhook = DeleteWebhook.new
+      return if ids.empty?
 
-      webhooks.map do |webhook|
-        Thread.new do
-          delete_webhook.(client, webhook['id'])
-        end
-      end.map(&:value)
+      client.graphql(%(
+        mutation webhookSubscriptionDelete(
+          #{ids.each_with_index.map { |_, i| %(
+            $id#{i}: ID!
+          )}.join("\n")}
+        ) {
+          #{ids.each_with_index.map { |_, i| %(
+            webhookSubscriptionDelete#{i}: webhookSubscriptionDelete(id: $id#{i}) {
+              userErrors {
+                field
+                message
+              }
+            }
+          )}.join("\n")}
+        }
+      ), ids.each_with_index.each_with_object({}) do |(id, i), variables|
+        variables["id#{i}"] = id
+      end)
     end
   end
 end

data/lib/shopify-client/delete_webhook.rb

@@ -4,10 +4,8 @@ module ShopifyClient
   class DeleteWebhook
     # @param client [Client]
     # @param id [Integer]
-    #
-    # @return [Hash] response data
     def call(client, id)
-      client.delete(credentials, "webhooks/#{id}")
+      client.delete("webhooks/#{id}")
     end
   end
 end

data/lib/shopify-client/response.rb

@@ -72,6 +72,15 @@ module ShopifyClient
         end
       when 423
         raise ShopError.new(request, self), 'Shop is locked'
+      when 430
+        # NOTE: This is an unofficial code used by Shopify. See:
+        #
+        # https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#Unofficial_codes
+        #
+        # It's undocumented unfortunately, but seems to be like a 429 response,
+        # except where the app is making too many API calls (rather than hitting
+        # the per store rate limit).
+        raise TooManyRequestsError.new(request, self), 'Too many requests'
       when 400..499
         raise ClientError.new(request, self)
       when 500..599
@@ -183,6 +192,8 @@ module ShopifyClient
     InvalidAccessTokenError = Class.new(ClientError)
     # The shop is frozen/locked/unavailable.
     ShopError = Class.new(ClientError)
+    # The app is making too many requests to the API.
+    TooManyRequestsError = Class.new(ClientError)
 
     # The GraphQL API always responds with a status code of 200.
     GraphQLClientError = Class.new(ClientError) do

data/lib/shopify-client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShopifyClient
-  VERSION = '0.0.1'
+  VERSION = '0.0.6'
 end

data/lib/shopify-client/webhook_list.rb

@@ -12,7 +12,7 @@ module ShopifyClient
     # @param topic [String]
     # @param handler [#call]
     # @param fields [Array<String>] e.g. %w[id tags]
-    def register(topic, handler = nil, fields: nil, &block)
+    def register(topic, handler = nil, fields: [], &block)
       raise ArgumentError unless nil ^ handler ^ block
 
       handler = block if block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-03 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +181,7 @@ files:
 - lib/shopify-client/client.rb
 - lib/shopify-client/client/logging.rb
 - lib/shopify-client/client/normalise_path.rb
+- lib/shopify-client/config_error.rb
 - lib/shopify-client/cookieless/check_header.rb
 - lib/shopify-client/cookieless/decode_session_token.rb
 - lib/shopify-client/cookieless/middleware.rb
@@ -180,7 +209,7 @@ files:
 - lib/shopify-client/version.rb
 - lib/shopify-client/webhook.rb
 - lib/shopify-client/webhook_list.rb
-homepage: https://gitea.judson.nz/shopify-apps/shopify-client
+homepage: https://github.com/kj/shopify-client
 licenses:
 - ISC
 metadata: {}
@@ -199,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Shopify client library