shopify_api 9.2.0 → 9.5

data/lib/active_resource/detailed_log_subscriber.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
 module ActiveResource
   class DetailedLogSubscriber < ActiveSupport::LogSubscriber
     VERSION_EOL_WARNING_HEADER = 'x-shopify-api-version-warning'
     VERSION_DEPRECATION_HEADER = 'x-shopify-api-deprecated-reason'
+    SHOPIFY_ACCESS_TOKEN = 'X-Shopify-Access-Token'
+    FILTERED = '[FILTERED]'
+
     def request(event)
       log_request_response_details(event)
       warn_on_deprecated_header_or_version_eol_header(event)
@@ -16,11 +20,12 @@ module ActiveResource
     def log_request_response_details(event)
       data = event.payload[:data]
       headers = data.extract_options!
+      headers[SHOPIFY_ACCESS_TOKEN] = FILTERED
       request_body = data.first
 
-      info "Request:\n#{request_body}" if request_body
-      info "Headers: #{headers.inspect}"
-      info "Response:\n#{event.payload[:response].body}"
+      info("Request:\n#{request_body}") if request_body
+      info("Headers: #{headers.inspect}")
+      info("Response:\n#{event.payload[:response].body}")
     end
 
     def warn_on_deprecated_header_or_version_eol_header(event)
@@ -34,7 +39,7 @@ module ActiveResource
           use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
           MSG
 
-          warn warning_message
+          warn(warning_message)
 
         when VERSION_EOL_WARNING_HEADER
           warning_message = <<-MSG
@@ -42,11 +47,9 @@ module ActiveResource
           an API version that is unsupported or will become unsupported within 30 days. See #{header_value} for more details.
           MSG
 
-          warn warning_message
+          warn(warning_message)
         end
       end
     end
   end
 end
-
-ActiveResource::DetailedLogSubscriber.attach_to :active_resource_detailed

data/lib/active_resource/json_errors.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
 require 'active_resource/base'
 
 module ActiveResource
   class Errors < ActiveModel::Errors
     def from_json(json, save_cache = false)
-      data = ActiveSupport::JSON.decode(json)['errors'] || {} rescue {}
+      data =
+        begin
+          ActiveSupport::JSON.decode(json)['errors'] || {}
+        rescue
+          {}
+        end
       case data
       when String
         from_string(data, save_cache)
@@ -15,7 +21,7 @@ module ActiveResource
     def from_hash(messages, save_cache = false)
       clear unless save_cache
 
-      messages.each do |key,errors|
+      messages.each do |key, errors|
         errors.each do |error|
           add(key, error)
         end

data/lib/shopify_api/api_access.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class ApiAccess
+    SCOPE_DELIMITER = ','
+
+    def initialize(scope_names)
+      if scope_names.is_a?(String)
+        scope_names = scope_names.to_s.split(SCOPE_DELIMITER)
+      end
+
+      store_scopes(scope_names)
+    end
+
+    def covers?(scopes)
+      scopes.compressed_scopes <= expanded_scopes
+    end
+
+    def to_s
+      to_a.join(SCOPE_DELIMITER)
+    end
+
+    def to_a
+      compressed_scopes.to_a
+    end
+
+    def ==(other)
+      other.class == self.class &&
+        compressed_scopes == other.compressed_scopes
+    end
+
+    alias :eql? :==
+
+    def hash
+      compressed_scopes.hash
+    end
+
+    protected
+
+    attr_reader :compressed_scopes, :expanded_scopes
+
+    private
+
+    def store_scopes(scope_names)
+      scopes = scope_names.map(&:strip).reject(&:empty?).to_set
+      implied_scopes = scopes.map { |scope| implied_scope(scope) }.compact
+
+      @compressed_scopes = scopes - implied_scopes
+      @expanded_scopes = scopes + implied_scopes
+    end
+
+    def implied_scope(scope)
+      is_write_scope = scope =~ /\A(unauthenticated_)?write_(.*)\z/
+      "#{$1}read_#{$2}" if is_write_scope
+    end
+  end
+end

data/lib/shopify_api/api_version.rb

@@ -54,8 +54,8 @@ module ShopifyAPI
 
       def define_known_versions
         warn(
-          '[DEPRECATED] ShopifyAPI::ApiVersion.define_known_versions is deprecated and will be removed in a future version. ' \
-            'Use `fetch_known_versions` instead.'
+          '[DEPRECATED] ShopifyAPI::ApiVersion.define_known_versions is deprecated and will be ' \
+            'removed in a future version. Use `fetch_known_versions` instead.'
         )
         fetch_known_versions
       end
@@ -70,15 +70,16 @@ module ShopifyAPI
 
       def clear_defined_versions
         warn(
-          '[DEPRECATED] ShopifyAPI::ApiVersion.clear_defined_versions is deprecated and will be removed in a future version. ' \
-            'Use `clear_known_versions` instead.'
+          '[DEPRECATED] ShopifyAPI::ApiVersion.clear_defined_versions is deprecated and will be ' \
+            'removed in a future version. Use `clear_known_versions` instead.'
         )
         clear_known_versions
       end
 
       def latest_stable_version
         warn(
-          '[DEPRECATED] ShopifyAPI::ApiVersion.latest_stable_version is deprecated and will be removed in a future version.'
+          '[DEPRECATED] ShopifyAPI::ApiVersion.latest_stable_version is deprecated and will be ' \
+            'removed in a future version.'
         )
         versions.values.find(&:latest_supported?)
       end

data/lib/shopify_api/connection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Connection < ActiveResource::Connection
     attr_reader :response

data/lib/shopify_api/countable.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Countable
     def count(options = {})
       data = get(:count, options)
 
       count = case data
-        when Hash then data["count"]
-        else data
+      when Hash then data["count"]
+      else data
       end
 
       Integer(count)

data/lib/shopify_api/disable_prefix_check.rb

@@ -14,13 +14,13 @@ module ShopifyAPI
 
         init_prefix_explicit(resource_type, resource_id)
 
-        define_singleton_method :resource_prefix do |options = {}|
+        define_singleton_method(:resource_prefix) do |options = {}|
           resource_type = options[resource] if flexible
 
           options[resource_id].nil? ? '' : "#{resource_type}/#{options[resource_id]}/"
         end
 
-        define_singleton_method :instantiate_record do |record, prefix_options = {}|
+        define_singleton_method(:instantiate_record) do |record, prefix_options = {}|
           new(record, true).tap do |resource_instance|
             resource_instance.prefix_options = prefix_options unless prefix_options.blank?
           end

data/lib/shopify_api/events.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Events
     def events
-      Event.find(:all, :params => {:resource => self.class.collection_name, :resource_id => id})
+      Event.find(:all, params: { resource: self.class.collection_name, resource_id: id })
     end
   end
 end

data/lib/shopify_api/graphql.rb

@@ -30,7 +30,10 @@ module ShopifyAPI
               To dump the schema file, use the `rake shopify_api:graphql:dump` task.
             MSG
           else
-            puts '[WARNING] Client was not pre-initialized. Ensure `ShopifyAPI::GraphQL.initialize_clients` is called during app initialization.'
+            puts(
+              '[WARNING] Client was not pre-initialized. Ensure `ShopifyAPI::GraphQL.initialize_clients` ' \
+                'is called during app initialization.'
+            )
             initialize_clients
             @_client_cache[api_version]
           end
@@ -50,12 +53,11 @@ module ShopifyAPI
 
           if matches
             api_version = ShopifyAPI::ApiVersion.new(handle: matches[1])
+          elsif raise_on_invalid_schema
+            raise InvalidSchema,
+              "Invalid schema file name `#{schema_file}`. Does not match format of: `<version>.json`."
           else
-            if raise_on_invalid_schema
-              raise InvalidSchema, "Invalid schema file name `#{schema_file}`. Does not match format of: `<version>.json`."
-            else
-              next
-            end
+            next
           end
 
           schema = graphql_client.load_schema(schema_file.to_s)

data/lib/shopify_api/hmac_params.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'webrick/httputils'
+
+module ShopifyAPI
+  module HmacParams
+    extend WEBrick::HTTPUtils
+
+    def self.encode(params)
+      params
+        .except(:signature, :hmac, :action, :controller)
+        .map { |k,v| sprintf("%s=%s", encode_key(k), encode_value(v)) }
+        .sort.join("&")
+    end
+
+    def self.encode_key(key)
+      _escape(key.to_s, _make_regex('&=%'))
+    end
+
+    def self.encode_value(value)
+      _escape(value.to_s, _make_regex('&%'))
+    end
+  end
+end

data/lib/shopify_api/limits.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Limits
     class LimitUnavailable < StandardError; end
@@ -38,7 +39,7 @@ module ShopifyAPI
       # @param {Symbol} scope [:shop]
       # @return {Integer}
       #
-      def credit_limit(scope=:shop)
+      def credit_limit(scope = :shop)
         api_credit_limit_param(scope).pop.to_i - 1
       end
       alias_method :call_limit, :credit_limit
@@ -48,7 +49,7 @@ module ShopifyAPI
       # @param {Symbol} scope [:shop]
       # @return {Integer}
       #
-      def credit_used(scope=:shop)
+      def credit_used(scope = :shop)
         api_credit_limit_param(scope).shift.to_i
       end
       alias_method :call_count, :credit_used

data/lib/shopify_api/message_enricher.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class MessageEnricher < SimpleDelegator
     def message
       return super unless (400...500).include?(code.to_i)
 
       @_cached_message ||= begin
-        detailed_error = begin
-          parsed_body = JSON.parse(body)
+        detailed_error =
+          begin
+            parsed_body = JSON.parse(body)
 
-          if parsed_body['error']
-            parsed_body['error'].to_s
-          elsif parsed_body['errors']
-            Array(parsed_body['errors']).join('; ')
+            if parsed_body['error']
+              parsed_body['error'].to_s
+            elsif parsed_body['errors']
+              Array(parsed_body['errors']).join('; ')
+            end
+          rescue JSON::ParserError
+            nil
           end
-        rescue JSON::ParserError
-          nil
-        end
 
         detailed_error.present? ? "#{super} (#{detailed_error})" : super
       end

data/lib/shopify_api/meta.rb

@@ -12,4 +12,3 @@ module ShopifyAPI
     end
   end
 end
-

data/lib/shopify_api/metafields.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 module ShopifyAPI
   module Metafields
     def metafields(**options)
-      options.merge! resource: self.class.collection_name, resource_id: id
+      options.merge!(resource: self.class.collection_name, resource_id: id)
 
-      Metafield.find :all, params: options
+      Metafield.find(:all, params: options)
     end
 
     def add_metafield(metafield)
       raise ArgumentError, "You can only add metafields to resource that has been saved" if new?
 
       metafield.prefix_options = {
-        :resource => self.class.collection_name,
-        :resource_id => id
+        resource: self.class.collection_name,
+        resource_id: id,
       }
       metafield.save
       metafield

data/lib/shopify_api/pagination_link_headers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class InvalidPaginationLinksError < StandardError; end
 
@@ -9,8 +10,6 @@ module ShopifyAPI
       links = parse_link_header(link_header)
       @previous_link = links.find { |link| link.rel == :previous }
       @next_link = links.find { |link| link.rel == :next }
-
-      self
     end
 
     private
@@ -20,7 +19,9 @@ module ShopifyAPI
       links = link_header.split(',')
       links.map do |link|
         parts = link.split('; ')
-        raise ShopifyAPI::InvalidPaginationLinksError.new("Invalid link header: url and rel expected") unless parts.length == 2
+        unless parts.length == 2
+          raise ShopifyAPI::InvalidPaginationLinksError, "Invalid link header: url and rel expected"
+        end
 
         url = parts[0][/<(.*)>/, 1]
         rel = parts[1][/rel="(.*)"/, 1]&.to_sym

data/lib/shopify_api/resources/access_scope.rb

@@ -2,7 +2,7 @@
 module ShopifyAPI
   class AccessScope < Base
     class << self
-      def prefix(_options={})
+      def prefix(_options = {})
         '/admin/oauth/'
       end
     end

data/lib/shopify_api/resources/access_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AccessToken < Base
     def self.delegate(access_scope, expires_in = nil)

data/lib/shopify_api/resources/address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Address < Base
   end

data/lib/shopify_api/resources/announcement.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Announcement < Base
   end
-end
+end

data/lib/shopify_api/resources/application_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ApplicationCharge < Base
     undef_method :test

data/lib/shopify_api/resources/application_credit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ApplicationCredit < Base
   end

data/lib/shopify_api/resources/article.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Article < Base
     include Events
@@ -7,14 +8,14 @@ module ShopifyAPI
     conditional_prefix :blog
 
     def comments
-      Comment.find(:all, :params => { :article_id => id })
+      Comment.find(:all, params: { article_id: id })
     end
 
     def self.authors(options = {})
       get(:authors, options)
     end
 
-    def self.tags(options={})
+    def self.tags(options = {})
       get(:tags, options)
     end
   end

data/lib/shopify_api/resources/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # Assets represent the files that comprise your theme.
   # There are different buckets which hold different kinds
@@ -9,10 +10,10 @@ module ShopifyAPI
   # or assets/bg-body.gif.
   #
   # Initialize with a key:
-  #   asset = ShopifyAPI::Asset.new(:key => 'assets/special.css', :theme_id => 12345)
+  #   asset = ShopifyAPI::Asset.new(key: 'assets/special.css', theme_id: 12345)
   #
   # Find by key:
-  #   asset = ShopifyAPI::Asset.find('assets/image.png', :params => {:theme_id => 12345})
+  #   asset = ShopifyAPI::Asset.find('assets/image.png', params: {theme_id: 12345})
   #
   # Get the text or binary value:
   #   asset.value # decodes from attachment attribute if necessary
@@ -38,13 +39,13 @@ module ShopifyAPI
 
     conditional_prefix :theme
 
-    def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
+    def self.element_path(_id, prefix_options = {}, query_options = nil) #:nodoc:
       prefix_options, query_options = split_options(prefix_options) if query_options.nil?
       "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
     end
 
     # find an asset by key:
-    #   ShopifyAPI::Asset.find('layout/theme.liquid', :params => { theme_id: 99 })
+    #   ShopifyAPI::Asset.find('layout/theme.liquid', params: { theme_id: 99 })
     def self.find(*args)
       if args[0].is_a?(Symbol)
         super
@@ -75,7 +76,7 @@ module ShopifyAPI
     end
 
     def destroy
-      connection.delete(element_path(prefix_options.merge(:asset => {:key => key})), self.class.headers)
+      connection.delete(element_path(prefix_options.merge(asset: { key: key })), self.class.headers)
     end
 
     def new?

data/lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AssignedFulfillmentOrder < Base
-
     def initialize(attributes = {}, persisted = false)
       ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
       super(attributes, persisted)

data/lib/shopify_api/resources/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/version'
 
 module ShopifyAPI
@@ -15,7 +16,7 @@ module ShopifyAPI
 
     def encode(options = {})
       same = dup
-      same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'
+      same.attributes = { self.class.element_name => same.attributes } if self.class.format.extension == 'json'
 
       same.send("to_#{self.class.format.extension}", options)
     end
@@ -43,7 +44,7 @@ module ShopifyAPI
       end
 
       def activate_session(session)
-        raise InvalidSessionError.new("Session cannot be nil") if session.nil?
+        raise InvalidSessionError, "Session cannot be nil" if session.nil?
         self.site = session.site
         self.headers.merge!('X-Shopify-Access-Token' => session.token)
         self.api_version = session.api_version
@@ -67,7 +68,11 @@ module ShopifyAPI
       end
 
       def api_version=(version)
-        self._api_version = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
+        self._api_version = if ApiVersion::NullVersion.matches?(version)
+          ApiVersion::NullVersion
+        else
+          ApiVersion.find_version(version)
+        end
       end
 
       def prefix(options = {})
@@ -91,7 +96,7 @@ module ShopifyAPI
 
         silence_warnings do
           # Redefine the new methods.
-          instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          instance_eval(<<-RUBY_EVAL, __FILE__, __LINE__ + 1)
             def prefix_source() "#{value}" end
             def resource_prefix(options={}) "#{resource_prefix_call}" end
           RUBY_EVAL
@@ -122,7 +127,7 @@ module ShopifyAPI
       def init_prefix_explicit(resource_type, resource_id)
         self.resource_prefix = "#{resource_type}/:#{resource_id}/"
 
-        define_method resource_id.to_sym do
+        define_method(resource_id.to_sym) do
           @prefix_options[resource_id]
         end
       end
@@ -155,7 +160,7 @@ module ShopifyAPI
     private
 
     def only_id
-      encode(:only => :id, :include => [], :methods => [])
+      encode(only: :id, include: [], methods: [])
     end
   end
 end

data/lib/shopify_api/resources/billing_address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class BillingAddress < Base
   end

data/lib/shopify_api/resources/blog.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Blog < Base
     include Events
     include Metafields
 
     def articles
-      Article.find(:all, :params => { :blog_id => id })
+      Article.find(:all, params: { blog_id: id })
     end
   end
 end

data/lib/shopify_api/resources/carrier_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CarrierService < Base
   end

data/lib/shopify_api/resources/cart.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Cart < Base
   end
-end
+end

data/lib/shopify_api/resources/collect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # For adding/removing products from custom collections
   class Collect < Base

data/lib/shopify_api/resources/collection_listing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CollectionListing < Base
     self.primary_key = :collection_id

data/lib/shopify_api/resources/comment.rb

@@ -1,9 +1,24 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Comment < Base
-    def remove;   load_attributes_from_response(post(:remove, {}, only_id)); end
-    def spam;     load_attributes_from_response(post(:spam, {}, only_id)); end
-    def approve;  load_attributes_from_response(post(:approve, {}, only_id)); end
-    def restore;  load_attributes_from_response(post(:restore, {}, only_id)); end
-    def not_spam; load_attributes_from_response(post(:not_spam, {}, only_id)); end
+    def remove
+      load_attributes_from_response(post(:remove, {}, only_id))
+    end
+
+    def spam
+      load_attributes_from_response(post(:spam, {}, only_id))
+    end
+
+    def approve
+      load_attributes_from_response(post(:approve, {}, only_id))
+    end
+
+    def restore
+      load_attributes_from_response(post(:restore, {}, only_id))
+    end
+
+    def not_spam
+      load_attributes_from_response(post(:not_spam, {}, only_id))
+    end
   end
 end

data/lib/shopify_api/resources/country.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Country < Base
   end

data/lib/shopify_api/resources/custom_collection.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CustomCollection < Base
     include Events
     include Metafields
 
     def products
-      Product.find(:all, :params => {:collection_id => self.id})
+      Product.find(:all, params: { collection_id: self.id })
     end
 
     def add_product(product)
-      Collect.create(:collection_id => self.id, :product_id => product.id)
+      Collect.create(collection_id: self.id, product_id: product.id)
     end
 
     def remove_product(product)
-      collect = Collect.find(:first, :params => {:collection_id => self.id, :product_id => product.id})
+      collect = Collect.find(:first, params: { collection_id: self.id, product_id: product.id })
       collect.destroy if collect
     end
   end