shopify_api 9.5.1 → 10.0.0

data/lib/shopify_api/hmac_params.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  module HmacParams
-    class << self
-      def encode(params)
-        params
-          .except(:signature, :hmac, :action, :controller)
-          .map { |k,v| sprintf("%s=%s", encode_key(k), encode_value(v)) }
-          .sort.join("&")
-      end
-
-      KEY_REGEXP = /([#{Regexp.escape("&=%")}])/n
-      def encode_key(key)
-        _escape(key.to_s, KEY_REGEXP)
-      end
-
-      VALUE_REGEXP = /([#{Regexp.escape("&%")}])/n
-      def encode_value(value)
-        _escape(value.to_s, VALUE_REGEXP)
-      end
-
-      private
-
-      def _escape(str, regex)
-        str = str.b
-        str.gsub!(regex) {"%%%02X" % $1.ord}
-        # %-escaped string should contain US-ASCII only
-        str.force_encoding(Encoding::US_ASCII)
-      end
-    end
-  end
-end

data/lib/shopify_api/limits.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  module Limits
-    class LimitUnavailable < StandardError; end
-
-    def self.included(klass)
-      klass.send(:extend, ClassMethods)
-    end
-
-    module ClassMethods
-      # Takes form <call count>/<bucket size>
-      # See https://help.shopify.com/en/api/getting-started/api-call-limit
-      # Eg: 2/40
-      CREDIT_LIMIT_HEADER_PARAM = {
-        shop: 'X-Shopify-Shop-Api-Call-Limit',
-      }
-
-      ##
-      # How many more API calls can I make?
-      # @return {Integer}
-      #
-      def credit_left
-        credit_limit(:shop) - credit_used(:shop)
-      end
-      alias_method :available_calls, :credit_left
-
-      ##
-      # Have I reached my API call limit?
-      # @return {Boolean}
-      #
-      def credit_maxed?
-        credit_left <= 0
-      end
-      alias_method :maxed?, :credit_maxed?
-
-      ##
-      # How many total API calls can I make?
-      # NOTE: subtracting 1 from credit_limit because I think ShopifyAPI cuts off at 299 or shop limits.
-      # @param {Symbol} scope [:shop]
-      # @return {Integer}
-      #
-      def credit_limit(scope = :shop)
-        api_credit_limit_param(scope).pop.to_i - 1
-      end
-      alias_method :call_limit, :credit_limit
-
-      ##
-      # How many API calls have I made?
-      # @param {Symbol} scope [:shop]
-      # @return {Integer}
-      #
-      def credit_used(scope = :shop)
-        api_credit_limit_param(scope).shift.to_i
-      end
-      alias_method :call_count, :credit_used
-
-      ##
-      # @return {HTTPResonse}
-      #
-      def response
-        Shop.current unless ShopifyAPI::Base.connection.response
-        ShopifyAPI::Base.connection.response
-      end
-
-      private
-
-      ##
-      # @return {Array}
-      #
-      def api_credit_limit_param(scope)
-        header = response[CREDIT_LIMIT_HEADER_PARAM[scope]]
-        raise LimitUnavailable unless header
-        header.split('/')
-      end
-    end
-  end
-end

data/lib/shopify_api/message_enricher.rb

@@ -1,25 +0,0 @@
-# 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)
-
-            if parsed_body['error']
-              parsed_body['error'].to_s
-            elsif parsed_body['errors']
-              Array(parsed_body['errors']).join('; ')
-            end
-          rescue JSON::ParserError
-            nil
-          end
-
-        detailed_error.present? ? "#{super} (#{detailed_error})" : super
-      end
-    end
-  end
-end

data/lib/shopify_api/meta.rb

@@ -1,14 +0,0 @@
-
-# frozen_string_literal: true
-module ShopifyAPI
-  class Meta < ActiveResource::Base
-    self.site = "https://app.shopify.com/services/"
-    self.element_name = 'api'
-    self.primary_key = :handle
-    self.timeout = 5
-
-    def self.admin_versions
-      all.find { |api| api.handle = :admin }.versions
-    end
-  end
-end

data/lib/shopify_api/metafields.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  module Metafields
-    def metafields(**options)
-      options.merge!(resource: self.class.collection_name, resource_id: id)
-
-      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,
-      }
-      metafield.save
-      metafield
-    end
-  end
-end

data/lib/shopify_api/paginated_collection.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class PaginatedCollection < ActiveResource::Collection
-    module CollectionPagination
-      def initialize(args)
-        @next_url = pagination_link_headers.next_link&.url&.to_s
-        @previous_url = pagination_link_headers.previous_link&.url&.to_s
-        super(args)
-      end
-
-      def next_page?
-        ensure_available
-        @next_url.present?
-      end
-
-      def previous_page?
-        ensure_available
-        @previous_url.present?
-      end
-
-      def fetch_next_page
-        fetch_page(@next_url)
-      end
-
-      def fetch_previous_page
-        fetch_page(@previous_url)
-      end
-
-      def next_page_info
-        extract_page_info(@next_url)
-      end
-
-      def previous_page_info
-        extract_page_info(@previous_url)
-      end
-
-      private
-
-      AVAILABLE_IN_VERSION = ShopifyAPI::ApiVersion.find_version('2019-10')
-      AVAILABLE_IN_VERSION_EARLY = ShopifyAPI::ApiVersion.find_version('2019-07')
-
-      def fetch_page(url)
-        ensure_available
-        return [] unless url.present?
-
-        resource_class.all(from: url)
-      end
-
-      def pagination_link_headers
-        @pagination_link_headers ||= ShopifyAPI::PaginationLinkHeaders.new(
-          ShopifyAPI::Base.connection.response["Link"]
-        )
-      end
-
-      def ensure_available
-        return if ShopifyAPI::Base.api_version >= AVAILABLE_IN_VERSION
-        return if ShopifyAPI::Base.api_version >= AVAILABLE_IN_VERSION_EARLY && resource_class.early_july_pagination?
-        raise NotImplementedError
-      end
-
-      def extract_page_info(url)
-        CGI.escape(Rack::Utils.parse_query(URI(url).query)['page_info']) if url.present?
-      end
-    end
-
-    include CollectionPagination
-  end
-end

data/lib/shopify_api/pagination_link_headers.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class InvalidPaginationLinksError < StandardError; end
-
-  class PaginationLinkHeaders
-    LinkHeader = Struct.new(:url, :rel)
-    attr_reader :previous_link, :next_link
-
-    def initialize(link_header)
-      links = parse_link_header(link_header)
-      @previous_link = links.find { |link| link.rel == :previous }
-      @next_link = links.find { |link| link.rel == :next }
-    end
-
-    private
-
-    def parse_link_header(link_header)
-      return [] unless link_header.present?
-      links = link_header.split(',')
-      links.map do |link|
-        parts = link.split('; ')
-        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
-
-        url = URI.parse(url).request_uri
-        LinkHeader.new(url, rel)
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/abandoned_checkout.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class AbandonedCheckout < Base
-    self.element_name = "checkout"
-  end
-end

data/lib/shopify_api/resources/access_scope.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class AccessScope < Base
-    class << self
-      def prefix(_options = {})
-        '/admin/oauth/'
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/access_token.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class AccessToken < Base
-    def self.delegate(access_scope, expires_in = nil)
-      resource = post(:delegate, delegate_access_scope: access_scope, expires_in: expires_in)
-      instantiate_record(format.decode(resource.body), {})
-    end
-  end
-end

data/lib/shopify_api/resources/address.rb

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

data/lib/shopify_api/resources/announcement.rb

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

data/lib/shopify_api/resources/api_permission.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ApiPermission < Base
-    def self.destroy
-      delete(:current)
-    end
-  end
-end

data/lib/shopify_api/resources/application_charge.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class ApplicationCharge < Base
-    undef_method :test
-
-    class << self
-      [:pending, :expired, :accepted, :declined].each do |status|
-        define_method(status) { (all || []).select { |c| c.status == status.to_s } }
-      end
-    end
-
-    def activate
-      load_attributes_from_response(post(:activate))
-    end
-  end
-end

data/lib/shopify_api/resources/application_credit.rb

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

data/lib/shopify_api/resources/array_base.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ArrayBase < Base
-    class << self
-      private
-
-      def instantiate_record(record, *)
-        record
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/article.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class Article < Base
-    include Events
-    include Metafields
-    include DisablePrefixCheck
-
-    conditional_prefix :blog
-
-    def comments
-      Comment.find(:all, params: { article_id: id })
-    end
-
-    def self.authors(options = {})
-      get(:authors, options)
-    end
-
-    def self.tags(options = {})
-      get(:tags, options)
-    end
-  end
-end

data/lib/shopify_api/resources/asset.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  # Assets represent the files that comprise your theme.
-  # There are different buckets which hold different kinds
-  # of assets, each corresponding to one of the folders
-  # within a theme's zip file: "layout", "templates",
-  # "snippets", "assets", and "config". The full key of an
-  # asset always starts with the bucket name, and the path
-  # separator is a forward slash, like layout/theme.liquid
-  # or assets/bg-body.gif.
-  #
-  # Initialize with a key:
-  #   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})
-  #
-  # Get the text or binary value:
-  #   asset.value # decodes from attachment attribute if necessary
-  #
-  # You can provide new data for assets in a few different ways:
-  #
-  #   * assign text data for the value directly:
-  #       asset.value = "div.special {color:red;}"
-  #
-  #   * provide binary data for the value:
-  #       asset.attach(File.read('image.png'))
-  #
-  #   * set a URL from which Shopify will fetch the value:
-  #       asset.src = "http://mysite.com/image.png"
-  #
-  #   * set a source key of another of your assets from which
-  #     the value will be copied:
-  #       asset.source_key = "assets/another_image.png"
-  class Asset < Base
-    include DisablePrefixCheck
-
-    self.primary_key = 'key'
-
-    conditional_prefix :theme
-
-    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 })
-    def self.find(*args)
-      if args[0].is_a?(Symbol)
-        super
-      else
-        params = { asset: { key: args[0] } }
-        params = params.merge(args[1][:params]) if args[1] && args[1][:params]
-        path_prefix = params[:theme_id] ? "themes/#{params[:theme_id]}/" : ""
-        resource = find(
-          :one,
-          from: api_version.construct_api_path("#{path_prefix}assets.#{format.extension}"),
-          params: params
-        )
-        resource.prefix_options[:theme_id] = params[:theme_id] if resource && params[:theme_id]
-        resource
-      end
-    end
-
-    # For text assets, Shopify returns the data in the 'value' attribute.
-    # For binary assets, the data is base-64-encoded and returned in the
-    # 'attachment' attribute. This accessor returns the data in both cases.
-    def value
-      attributes['value'] ||
-      (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
-    end
-
-    def attach(data)
-      self.attachment = Base64.encode64(data)
-    end
-
-    def destroy
-      connection.delete(element_path(prefix_options.merge(asset: { key: key })), self.class.headers)
-    end
-
-    def new?
-      false
-    end
-
-    def method_missing(method_symbol, *arguments) #:nodoc:
-      if %w{value= attachment= src= source_key=}.include?(method_symbol)
-        wipe_value_attributes
-      end
-      super
-    end
-
-    private
-
-    def wipe_value_attributes
-      %w{value attachment src source_key}.each do |attr|
-        attributes.delete(attr)
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class AssignedFulfillmentOrder < Base
-    def initialize(attributes = {}, persisted = false)
-      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
-      super(attributes, persisted)
-    end
-
-    def self.find(scope, *args)
-      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
-
-      assigned_fulfillment_orders = super(scope, *args)
-      assigned_fulfillment_orders.map { |afo| FulfillmentOrder.new(afo.attributes) }
-    end
-  end
-end

data/lib/shopify_api/resources/base.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-require 'shopify_api/version'
-
-module ShopifyAPI
-  class Base < ActiveResource::Base
-    class InvalidSessionError < StandardError; end
-    extend Countable
-
-    self.timeout = 90
-    self.include_root_in_json = false
-    self.headers['User-Agent'] = ["ShopifyAPI/#{ShopifyAPI::VERSION}",
-                                  "ActiveResource/#{ActiveResource::VERSION::STRING}",
-                                  "Ruby/#{RUBY_VERSION}"].join(' ')
-
-    self.collection_parser = ShopifyAPI::PaginatedCollection
-
-    def encode(options = {})
-      same = dup
-      same.attributes = { self.class.element_name => same.attributes } if self.class.format.extension == 'json'
-
-      same.send("to_#{self.class.format.extension}", options)
-    end
-
-    def as_json(options = nil)
-      root = options[:root] if options.try(:key?, :root)
-      if include_root_in_json
-        root = self.class.model_name.element if root == true
-        { root => serializable_hash(options) }
-      else
-        serializable_hash(options)
-      end
-    end
-
-    class << self
-      threadsafe_attribute(:_api_version)
-      def headers
-        if _headers_defined?
-          _headers
-        elsif superclass != Object && superclass.headers
-          superclass.headers
-        else
-          _headers ||= {}
-        end
-      end
-
-      def activate_session(session)
-        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
-      end
-
-      def clear_session
-        self.site = nil
-        self.password = nil
-        self.user = nil
-        self.headers.delete('X-Shopify-Access-Token')
-      end
-
-      def api_version
-        if _api_version_defined?
-          _api_version
-        elsif superclass != Object && superclass.site
-          superclass.api_version.dup.freeze
-        else
-          ApiVersion::NullVersion
-        end
-      end
-
-      def api_version=(version)
-        self._api_version = if ApiVersion::NullVersion.matches?(version)
-          ApiVersion::NullVersion
-        else
-          ApiVersion.find_version(version)
-        end
-      end
-
-      def prefix(options = {})
-        api_version.construct_api_path(resource_prefix(options))
-      end
-
-      def prefix_source
-        ''
-      end
-
-      def resource_prefix(_options = {})
-        ''
-      end
-
-      # Sets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>).
-      # Default value is <tt>site.path</tt>.
-      def resource_prefix=(value)
-        @prefix_parameters = nil
-
-        resource_prefix_call = value.gsub(/:\w+/) { |key| "\#{URI::DEFAULT_PARSER.escape options[#{key}].to_s}" }
-
-        silence_warnings do
-          # Redefine the new methods.
-          instance_eval(<<-RUBY_EVAL, __FILE__, __LINE__ + 1)
-            def prefix_source() "#{value}" end
-            def resource_prefix(options={}) "#{resource_prefix_call}" end
-          RUBY_EVAL
-        end
-      rescue => e
-        logger&.error("Couldn't set prefix: #{e}\n  #{code}")
-        raise
-      end
-
-      def prefix=(value)
-        if value.start_with?('/admin')
-          raise ArgumentError, "'#{value}' can no longer start /admin/. Change to using resource_prefix="
-        end
-
-        warn(
-          '[DEPRECATED] ShopifyAPI::Base#prefix= is deprecated and will be removed in a future version. ' \
-            'Use `self.resource_prefix=` instead.'
-        )
-        self.resource_prefix = value
-      end
-
-      alias_method :set_prefix, :prefix=
-
-      def init_prefix(resource)
-        init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
-      end
-
-      def init_prefix_explicit(resource_type, resource_id)
-        self.resource_prefix = "#{resource_type}/:#{resource_id}/"
-
-        define_method(resource_id.to_sym) do
-          @prefix_options[resource_id]
-        end
-      end
-
-      def early_july_pagination?
-        !!early_july_pagination
-      end
-
-      def version_validation!(minimum_version)
-        available_in_version = ShopifyAPI::ApiVersion.find_version(minimum_version)
-
-        unless ShopifyAPI::Base.api_version >= available_in_version
-          raise NotImplementedError, "The minimum supported version is #{minimum_version}."
-        end
-      end
-
-      private
-
-      attr_accessor :early_july_pagination
-
-      def early_july_pagination_release!
-        self.early_july_pagination = true
-      end
-    end
-
-    def persisted?
-      !id.nil?
-    end
-
-    private
-
-    def only_id
-      encode(only: :id, include: [], methods: [])
-    end
-  end
-end

data/lib/shopify_api/resources/billing_address.rb

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