shopify_api 9.2.0 → 9.3.0

data/RELEASING

@@ -2,12 +2,16 @@ Releasing ShopifyAPI
 
 1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
 2. Update the version of ShopifyAPI in lib/shopify_api/version.rb
-3. Add a CHANGELOG entry for the new release
-4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
-5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+3. Run `bundle`
+4. Add a CHANGELOG entry for the new release
+5. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+6. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
   $ git tag vX.Y.Z REV
-6. Push out the changes
+7. Push out the changes
   $ git push
-7. Push out the tags
+8. Push out the tags
   $ git push --tags
-8. Publish the gem using Shipit
+9. Publish the gem using Shipit
+10. Consider if the dependency in Shopify/shopify needs updated. It's used only by the tests so is a low risk change.
+Also consider Shopify/shopify_app whose gemspec depends on this.
+We don't need to do this for every release, but we should try to keep them relatively up to date.

data/Rakefile

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
 require 'rake'
 require "bundler/gem_tasks"
-
 require 'rake/testtask'
+require 'rubocop/rake_task'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
   test.warning = false
 end
 
+RuboCop::RakeTask.new
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
@@ -16,15 +20,15 @@ begin
     test.verbose = true
   end
 rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  task(:rcov) do
+    abort("RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov")
   end
 end
 
-task :default => [:test, :verify_docs]
+task(default: [:test, :rubocop, :verify_docs])
 
 require 'verify_docs'
-task :verify_docs do
+task(:verify_docs) do
   unless VerifyDocs.call
     abort("\nWARNING: docs/index.md and README.md no longer have identical content. Please correct this.")
   end
@@ -45,7 +49,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :docker do
+task(:docker) do
   cmd = "docker-compose up -d && docker exec -i -t shopify_api bash"
   exec(cmd, err: File::NULL)
 end

data/docs/graphql.md

@@ -32,7 +32,7 @@ result.data.shop.name
 ## Getting started
 
 1. [Dump the schema](#dump-the-schema)
-2. [Configure session/authencation](#sessions-and-authentication)
+2. [Configure session/authentication](#sessions-and-authentication)
 3. [Make queries](#make-queries)
 
 ### Dump the schema

data/docs/index.md

@@ -2,7 +2,7 @@
 layout: index
 ---
 
-[![Version][gem]][gem_url] [![Build Status](https://travis-ci.org/Shopify/shopify_api.svg?branch=master)](https://travis-ci.org/Shopify/shopify_api)
+[![Version][gem]][gem_url] [![Build Status](https://github.com/Shopify/shopify_api/workflows/CI/badge.svg?branch=master)](https://github.com/Shopify/shopify_api/actions)
 
 [gem]: https://img.shields.io/gem/v/shopify_api.svg
 [gem_url]: https://rubygems.org/gems/shopify_api

data/lib/active_resource/connection_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/connection'
 
 module ActiveResource

data/lib/active_resource/detailed_log_subscriber.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveResource
   class DetailedLogSubscriber < ActiveSupport::LogSubscriber
     VERSION_EOL_WARNING_HEADER = 'x-shopify-api-version-warning'
@@ -18,9 +19,9 @@ module ActiveResource
       headers = data.extract_options!
       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 +35,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 +43,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.rb

@@ -1,4 +1,5 @@
-$:.unshift File.dirname(__FILE__)
+# frozen_string_literal: true
+$:.unshift(File.dirname(__FILE__))
 require 'active_resource'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'digest/md5'
@@ -20,6 +21,7 @@ require 'shopify_api/metafields'
 require 'shopify_api/countable'
 require 'shopify_api/resources'
 require 'shopify_api/session'
+require 'shopify_api/api_access'
 require 'shopify_api/message_enricher'
 require 'shopify_api/connection'
 require 'shopify_api/pagination_link_headers'
@@ -31,3 +33,8 @@ if ShopifyAPI::Base.respond_to?(:connection_class)
 else
   require 'active_resource/connection_ext'
 end
+
+if ENV["SHOPIFY_LOG_PATH"]
+  ActiveResource::Base.logger = Logger.new(ENV["SHOPIFY_LOG_PATH"])
+  ActiveResource::DetailedLogSubscriber.attach_to(:active_resource_detailed)
+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/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