shopify-client 0.0.1

data/lib/shopify-client/response_errors.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  class ResponseErrors
+    class << self
+      # Certain error responses, such as 'Not Found', use a string rather than
+      # an object. For consistency, these messages are set under 'resource'.
+      #
+      # @param data [Hash] the complete response data
+      #
+      # @return [ResponseErrors]
+      def from_response_data(data)
+        errors = data['errors']
+
+        return new if errors.nil?
+
+        errors.is_a?(String) ? new('resource' => errors) : new(errors)
+      end
+    end
+
+    # @param errors [Hash]
+    def initialize(errors = {})
+      @errors = errors
+    end
+
+    # @return [Array<String]
+    def messages
+      @errors.map do |field, message|
+        "#{message} [#{field}]"
+      end
+    end
+
+    # message_patterns [Array<Regexp, String>]
+    #
+    # @return [Boolean]
+    def message?(message_patterns)
+      message_patterns.any? do |pattern|
+        case pattern
+        when Regexp
+          messages.any? { |message| message.match?(pattern) }
+        when String
+          messages.include?(pattern)
+        end
+      end
+    end
+
+    include Enumerable
+
+    # @see Hash#each
+    def each(...)
+      @errors.dup.each(...)
+    end
+
+    # @return [Hash]
+    def to_h
+      @errors.dup
+    end
+  end
+end

data/lib/shopify-client/response_user_errors.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  class ResponseUserErrors < ResponseErrors
+    class << self
+      # @param data [Hash] the complete response data
+      #
+      # @return [ResponseErrors]
+      def from_response_data(data)
+        errors = find_user_errors(data) || {}
+
+        return new if errors.empty?
+
+        new(errors.to_h do |error|
+          [
+            error['field'] ? error['field'].join('.') : '.',
+            error['message'],
+          ]
+        end)
+      end
+
+      # Find user errors recursively.
+      #
+      # @param data [Hash]
+      #
+      # @return [Hash, nil]
+      def find_errors(data)
+        data.each do |key, value|
+          return value if key == 'userErrors'
+
+          if value.is_a?(Hash)
+            errors = find_errors(value)
+
+            return errors if errors
+          end
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/shopify-client/struct.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  class Struct < ::Struct
+    # @param pp [PrettyPrint]
+    def pretty_print(pp)
+      pp.text(inspect)
+    end
+  end
+end

data/lib/shopify-client/throttling/redis_strategy.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  module Throttling
+    # Use Redis to maintain API call limit throttling across threads/processes.
+    #
+    # No delay for requests up to half of the call limit.
+    class RedisStrategy < Strategy
+      # @see Strategy#interval
+      def interval(interval_key)
+        num_requests, max_requests, header_timestamp = Redis.current.hmget(interval_key,
+          :num_requests,
+          :max_requests,
+          :header_timestamp,
+        ).map(&:to_i)
+
+        num_requests = leak(num_requests, header_timestamp)
+
+        max_unthrottled_requests = max_requests / 2
+
+        if num_requests > num_unthrottled_requests
+          Rational((num_requests - num_unthrottled_requests) * leak_rate, 1000)
+        else
+          0
+        end
+      end
+
+      # @see Strategy#after_sleep
+      def after_sleep(env, interval_key)
+        header = env[:response_headers]['X-Shopify-Shop-Api-Call-Limit']
+
+        return if header.nil?
+
+        num_requests, max_requests = header.split('/')
+
+        Redis.current.mapped_hmset(interval_key,
+          num_requests: num_requests,
+          max_requests: max_requests,
+          header_timestamp: header_timestamp,
+        )
+      end
+
+      # Find the actual number of requests by subtracting requests leaked by the
+      # leaky bucket algorithm since the last header timestamp.
+      #
+      # @param num_requests [Integer]
+      # @param header_timestamp [Integer]
+      #
+      # @return [Integer]
+      def leak(num_requests, header_timestamp)
+        n = Rational(timestamp - header_timestamp, leak_rate).floor
+
+        n > num_requests ? 0 : num_requests - n
+      end
+
+      # Leak rate of the leaky bucket algorithm in milliseconds.
+      def leak_rate
+        500
+      end
+    end
+  end
+end

data/lib/shopify-client/throttling/strategy.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  module Throttling
+    # @abstract
+    class Strategy < Faraday::Middleware
+      # @param env [Faraday::Env]
+      def on_request(env)
+        interval_key = build_interval_key(env)
+
+        sleep(interval(interval_key))
+
+        after_sleep(env, interval_key)
+      end
+
+      # @param env [Faraday::Env]
+      #
+      # @return [String]
+      def build_interval_key(env)
+        myshopify_domain = env.dig(:shopify, :myshopify_domain) || 'unknown'
+
+        format('shopify-client:throttling:%s', myshopify_domain)
+      end
+
+      # Sleep interval in seconds.
+      #
+      # @param interval_key [String]
+      #
+      # @return [Numeric]
+      def interval(interval_key)
+        0
+      end
+
+      # Hook for setting the interval key.
+      #
+      # @param env [Faraday::Env]
+      # @param interval_key [String]
+      def after_sleep(env, interval_key)
+        nil
+      end
+
+      # Time in milliseconds since the UNIX epoch.
+      #
+      # @return [Integer]
+      def timestamp
+        (Time.now.to_f * 1000).to_i
+      end
+    end
+  end
+end

data/lib/shopify-client/throttling/thread_local_strategy.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  module Throttling
+    # Maintain API call limit throttling across a single thread.
+    class ThreadLocalStrategy < Strategy
+      # @see Strategy#interval
+      def interval(interval_key)
+        return 0 if Thread.current[interval_key].nil?
+
+        ms = (timestamp - Thread.current[interval_key])
+
+        ms < minimum_interval ? Rational(minimum_interval - ms, 1000) : 0
+      end
+
+      # @see Strategy#after_sleep
+      def after_sleep(env, interval_key)
+        Thread.current[interval_key] = timestamp
+      end
+
+      # Minimum time between requests in milliseconds.
+      #
+      # @return [Integer]
+      def minimum_interval
+        500
+      end
+    end
+  end
+end

data/lib/shopify-client/verify_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module ShopifyClient
+  class VerifyRequest
+    Error = Class.new(Error)
+
+    # Verify that the request originated from Shopify.
+    #
+    # @param params [Hash] the request params
+    #
+    # @raise [Error] if signature is invalid
+    def call(params)
+      params = params.to_h.transform_keys(&:to_s)
+      digest = OpenSSL::Digest::SHA256.new
+      digest = OpenSSL::HMAC.hexdigest(digest, ShopifyClient.config.shared_secret, encoded_params(params))
+
+      raise Error, 'invalid signature' unless digest == params['hmac']
+    end
+
+    # @param params [Hash]
+    #
+    # @return [String]
+    private def encoded_params(params)
+      params.reject do |k, _|
+        k == 'hmac'
+      end.map do |k, v|
+        [].tap do |param|
+          param << k.gsub(/./) { |c| encode_key(c) }
+          param << '='
+          param << v.gsub(/./) { |c| encode_val(c) }
+        end.join
+      end.join('&')
+    end
+
+    # @param chr [String]
+    #
+    # @return [String]
+    private def encode_key(chr)
+      {'%' => '%25', '&' => '%26', '=' => '%3D'}[chr] || chr
+    end
+
+    # @param chr [String]
+    #
+    # @return [String]
+    private def encode_val(chr)
+      {'%' => '%25', '&' => '%26'}[chr] || chr
+    end
+  end
+end

data/lib/shopify-client/verify_webhook.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'openssl'
+
+module ShopifyClient
+  class VerifyWebhook
+    Error = Class.new(Error)
+
+    # Verify that the webhook request originated from Shopify.
+    #
+    # @param data [String] the signed request data
+    # @param hmac [String] the signature
+    #
+    # @raise [Error] if signature is invalid
+    def call(data, hmac)
+      digest = OpenSSL::Digest::SHA256.new
+      digest = OpenSSL::HMAC.digest(digest, ShopifyClient.config.shared_secret, data)
+      digest = Base64.encode64(digest).strip
+
+      raise Error, 'invalid signature' unless digest == hmac
+    end
+  end
+end

data/lib/shopify-client/version.rb

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

data/lib/shopify-client/webhook.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ShopifyClient
+  # @!attribute [rw] myshopify_domain
+  #   @return [String]
+  # @!attribute [rw] topic
+  #   @return [String]
+  # @!attribute [rw] raw_data
+  #   @return [String]
+  Webhook = Struct.new(:myshopify_domain, :topic, :raw_data) do
+    # @return [Hash]
+    def data
+      @data ||= JSON.parse(raw_data)
+    rescue JSON::ParserError
+      {}
+    end
+
+    alias_method :to_h, :data
+
+    # @return [String]
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
+    # @return [String]
+    def inspect
+      "#<ShopifyClient::Webhook (#{myshopify_domain}, #{topic})>"
+    end
+  end
+end

data/lib/shopify-client/webhook_list.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ShopifyClient
+  class WebhookList
+    def initialize
+      @webhooks = {}
+    end
+
+    # Register a handler for a webhook topic. The callable handler should
+    # receive a single {Webhook} argument.
+    #
+    # @param topic [String]
+    # @param handler [#call]
+    # @param fields [Array<String>] e.g. %w[id tags]
+    def register(topic, handler = nil, fields: nil, &block)
+      raise ArgumentError unless nil ^ handler ^ block
+
+      handler = block if block
+
+      self[topic][:handlers] << handler
+      self[topic][:fields] |= fields # merge fields with previous fields
+
+      nil
+    end
+
+    # Call each of the handlers registered for the given topic in turn.
+    #
+    # @param webhook [Webhook]
+    def delegate(webhook)
+      self[webhook.topic][:handlers].each do |handler|
+        handler.(webhook)
+      end
+    end
+
+    # @param topic [String]
+    def [](topic)
+      @webhooks[topic] ||= {
+        handlers: [],
+        fields: [],
+      }
+    end
+
+    include Enumerable
+
+    # @yield [Hash]
+    def each(&block)
+      @webhooks.each(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: shopify-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kelsey Judson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description:
+email: kelsey@kelseyjudson.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shopify-client.rb
+- lib/shopify-client/authorise.rb
+- lib/shopify-client/bulk_request.rb
+- lib/shopify-client/cache/redis_store.rb
+- lib/shopify-client/cache/store.rb
+- lib/shopify-client/cache/thread_local_store.rb
+- lib/shopify-client/cached_request.rb
+- lib/shopify-client/client.rb
+- lib/shopify-client/client/logging.rb
+- lib/shopify-client/client/normalise_path.rb
+- lib/shopify-client/cookieless/check_header.rb
+- lib/shopify-client/cookieless/decode_session_token.rb
+- lib/shopify-client/cookieless/middleware.rb
+- lib/shopify-client/create_all_webhooks.rb
+- lib/shopify-client/create_webhook.rb
+- lib/shopify-client/delete_all_webhooks.rb
+- lib/shopify-client/delete_webhook.rb
+- lib/shopify-client/error.rb
+- lib/shopify-client/parse_link_header.rb
+- lib/shopify-client/request.rb
+- lib/shopify-client/resource/base.rb
+- lib/shopify-client/resource/create.rb
+- lib/shopify-client/resource/delete.rb
+- lib/shopify-client/resource/read.rb
+- lib/shopify-client/resource/update.rb
+- lib/shopify-client/response.rb
+- lib/shopify-client/response_errors.rb
+- lib/shopify-client/response_user_errors.rb
+- lib/shopify-client/struct.rb
+- lib/shopify-client/throttling/redis_strategy.rb
+- lib/shopify-client/throttling/strategy.rb
+- lib/shopify-client/throttling/thread_local_strategy.rb
+- lib/shopify-client/verify_request.rb
+- lib/shopify-client/verify_webhook.rb
+- 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
+licenses:
+- ISC
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Shopify client library
+test_files: []