shopify_api 9.2.0 → 12.2.0

data/lib/shopify_api/resources/product.rb

@@ -1,56 +0,0 @@
-module ShopifyAPI
-  class Product < Base
-    include Events
-    include Metafields
-
-    early_july_pagination_release!
-
-    # compute the price range
-    def price_range
-      prices = variants.collect(&:price).collect(&:to_f)
-      format =  "%0.2f"
-      if prices.min != prices.max
-        "#{format % prices.min} - #{format % prices.max}"
-      else
-        format % prices.min
-      end
-    end
-    
-    def total_inventory=(new_value)
-      raise_deprecated_inventory_call('total_inventory') unless allow_inventory_params?
-      super
-    end
-
-    def serializable_hash(options = {})
-      allow_inventory_params? ? super(options) : super(options).except('total_inventory')
-    end
-
-    def collections
-      CustomCollection.find(:all, :params => {:product_id => self.id})
-    end
-
-    def smart_collections
-      SmartCollection.find(:all, :params => {:product_id => self.id})
-    end
-
-    def add_to_collection(collection)
-      collection.add_product(self)
-    end
-
-    def remove_from_collection(collection)
-      collection.remove_product(self)
-    end
-    
-    private
-
-    def raise_deprecated_inventory_call(parameter)
-      raise(ShopifyAPI::ValidationException,
-        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
-        )
-    end
-
-    def allow_inventory_params?
-      Base.api_version < ApiVersion.find_version('2019-10')
-    end
-  end
-end

data/lib/shopify_api/resources/product_listing.rb

@@ -1,16 +0,0 @@
-module ShopifyAPI
-  class ProductListing < Base
-    self.primary_key = :product_id
-
-    early_july_pagination_release!
-
-    def self.product_ids
-      ProductId.all
-    end
-
-    class ProductId < ArrayBase
-      self.resource_prefix = 'product_listings/'
-    end
-    private_constant :ProductId
-  end
-end

data/lib/shopify_api/resources/product_publication.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class ProductPublication < Base
-    init_prefix :publication
-
-    def publication_id
-      @prefix_options[:publication_id]
-    end
-  end
-end

data/lib/shopify_api/resources/province.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class Province < Base
-    init_prefix :country
-  end
-end

data/lib/shopify_api/resources/publication.rb

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

data/lib/shopify_api/resources/receipt.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Receipt < Base
-  end
-end

data/lib/shopify_api/resources/recurring_application_charge.rb

@@ -1,31 +0,0 @@
-module ShopifyAPI
-  class RecurringApplicationCharge < Base
-    undef_method :test
-
-    class << self
-      def current
-        (all || []).find { |c| c.status == 'active' }
-      end
-
-      [:pending, :cancelled, :accepted, :declined].each do |status|
-        define_method(status) { (all || []).select { |c| c.status == status.to_s } }
-      end
-    end
-
-    def usage_charges
-      UsageCharge.find(:all, params: { recurring_application_charge_id: id })
-    end
-
-    def cancel
-      load_attributes_from_response(self.destroy)
-    end
-
-    def activate
-      load_attributes_from_response(post(:activate))
-    end
-
-    def customize(customize_recurring_app_charge_params = {})
-      load_attributes_from_response(put(:customize, recurring_application_charge: customize_recurring_app_charge_params ))
-    end
-  end
-end

data/lib/shopify_api/resources/redirect.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Redirect < Base
-  end
-end

data/lib/shopify_api/resources/refund.rb

@@ -1,14 +0,0 @@
-module ShopifyAPI
-  class Refund < Base
-    init_prefix :order
-
-    def self.calculate(*args)
-      options = { :refund => args[0] }
-      params = {}
-      params = args[1][:params] if args[1] && args[1][:params]
-
-      resource = post(:calculate, params, options.to_json)
-      instantiate_record(format.decode(resource.body), {})
-    end
-  end
-end

data/lib/shopify_api/resources/report.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Report < Base
-  end
-end

data/lib/shopify_api/resources/resource_feedback.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ResourceFeedback < Base
-    class ExistingFeedbackSaved < StandardError; end
-    include DisablePrefixCheck
-
-    self.collection_name = 'resource_feedback'
-    conditional_prefix :product, false
-
-    EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE = 'WARNING: Attempted call to ShopifyAPI::ResourceFeedback#save' \
-      'after it was already persisted. Updating an existing ShopifyAPI::ResourceFeedback is not supported.'
-
-    def save
-      return super unless persisted?
-      raise ExistingFeedbackSaved.new(EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE)
-    end
-  end
-end

data/lib/shopify_api/resources/rule.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Rule < Base
-  end
-end

data/lib/shopify_api/resources/script_tag.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ScriptTag < Base
-  end
-end

data/lib/shopify_api/resources/shipping_address.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingAddress < Base
-  end
-end

data/lib/shopify_api/resources/shipping_line.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingLine < Base
-  end
-end

data/lib/shopify_api/resources/shipping_rate.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ShippingRate < Base
-    self.resource_prefix = "checkouts/:checkout_id/"
-  end
-end

data/lib/shopify_api/resources/shipping_zone.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingZone < Base
-  end
-end

data/lib/shopify_api/resources/shop.rb

@@ -1,25 +0,0 @@
-module ShopifyAPI
-  # Shop object. Use Shop.current to receive
-  # the shop.
-  class Shop < Base
-    include ActiveResource::Singleton
-
-    def self.current(options = {})
-      find(options)
-    end
-
-    def metafields(**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.save
-      metafield
-    end
-
-    def events
-      Event.find(:all)
-    end
-  end
-end

data/lib/shopify_api/resources/smart_collection.rb

@@ -1,15 +0,0 @@
-module ShopifyAPI
-  class SmartCollection < Base
-    include Events
-    include Metafields
-
-    def products
-      Product.find(:all, params: { collection_id: id })
-    end
-
-    def order(options={})
-      load_attributes_from_response(put(:order, options, only_id))
-    end
-
-  end
-end

data/lib/shopify_api/resources/storefront_access_token.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class StorefrontAccessToken < Base
-  end
-end

data/lib/shopify_api/resources/tax_line.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class TaxLine < Base
-  end
-end

data/lib/shopify_api/resources/tax_service.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class TaxService < Base
-  end
-end

data/lib/shopify_api/resources/tender_transaction.rb

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

data/lib/shopify_api/resources/theme.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Theme < Base
-  end
-end

data/lib/shopify_api/resources/transaction.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class Transaction < Base
-    init_prefix :order
-  end
-end

data/lib/shopify_api/resources/usage_charge.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class UsageCharge < Base
-    init_prefix :recurring_application_charge
-  end
-end

data/lib/shopify_api/resources/user.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class User < Base
-  end
-end

data/lib/shopify_api/resources/variant.rb

@@ -1,45 +0,0 @@
-module ShopifyAPI
-  class Variant < Base
-    include Metafields
-    include DisablePrefixCheck
-
-    conditional_prefix :product
-    
-    def inventory_quantity_adjustment=(new_value)
-      raise_deprecated_inventory_call('inventory_quantity_adjustment') unless allow_inventory_params?
-      super
-    end
-
-    def inventory_quantity=(new_value)
-      raise_deprecated_inventory_call('inventory_quantity') unless allow_inventory_params?
-      super
-    end
-
-    def old_inventory_quantity=(new_value)
-      raise_deprecated_inventory_call('old_inventory_quantity') unless allow_inventory_params?
-      super
-    end
-
-    def serializable_hash(options = {})
-      if allow_inventory_params?
-        super(options)
-      else
-        super(options).tap do |resource|
-          (resource['variant'] || resource).except!('inventory_quantity', 'old_inventory_quantity')
-        end
-      end
-    end
-
-    private
-
-    def raise_deprecated_inventory_call(parameter)
-      raise(ShopifyAPI::ValidationException,
-        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
-        )
-    end
-
-    def allow_inventory_params?
-      Base.api_version < ApiVersion.find_version('2019-10')
-    end
-  end
-end

data/lib/shopify_api/resources/webhook.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Webhook < Base
-  end
-end

data/lib/shopify_api/resources.rb

@@ -1,3 +0,0 @@
-require 'shopify_api/resources/base'
-require 'shopify_api/resources/array_base'
-Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }

data/lib/shopify_api/session.rb

@@ -1,193 +0,0 @@
-require 'openssl'
-require 'rack'
-
-module ShopifyAPI
-
-  class ValidationException < StandardError
-  end
-
-  class Session
-    cattr_accessor :api_key, :secret, :myshopify_domain
-    self.myshopify_domain = 'myshopify.com'
-
-    attr_accessor :domain, :token, :name, :extra
-    attr_reader :api_version
-    alias_method :url, :domain
-
-    class << self
-
-      def setup(params)
-        params.each { |k,value| public_send("#{k}=", value) }
-      end
-
-      def temp(domain:, token:, api_version: ShopifyAPI::Base.api_version, &block)
-        session = new(domain: domain, token: token, api_version: api_version)
-
-        with_session(session, &block)
-      end
-
-      def with_session(session, &_block)
-        original_session = extract_current_session
-        original_user = ShopifyAPI::Base.user
-        original_password = ShopifyAPI::Base.password
-
-        begin
-          ShopifyAPI::Base.clear_session
-          ShopifyAPI::Base.activate_session(session)
-          yield
-        ensure
-          ShopifyAPI::Base.activate_session(original_session)
-          ShopifyAPI::Base.user = original_user
-          ShopifyAPI::Base.password = original_password
-        end
-      end
-
-      def with_version(api_version, &block)
-        original_session = extract_current_session
-        session = new(domain: original_session.site, token: original_session.token, api_version: api_version)
-
-        with_session(session, &block)
-      end
-
-      def prepare_domain(domain)
-        return nil if domain.blank?
-        # remove http:// or https://
-        domain = domain.strip.gsub(%r{\Ahttps?://}, '')
-        # extract host, removing any username, password or path
-        shop = URI.parse("https://#{domain}").host
-        # extract subdomain of .myshopify.com
-        if idx = shop.index(".")
-          shop = shop.slice(0, idx)
-        end
-        return nil if shop.empty?
-        "#{shop}.#{myshopify_domain}"
-      rescue URI::InvalidURIError
-        nil
-      end
-
-      def validate_signature(params)
-        params = (params.respond_to?(:to_unsafe_hash) ? params.to_unsafe_hash : params).with_indifferent_access
-        return false unless signature = params[:hmac]
-
-        calculated_signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new(), secret, encoded_params_for_signature(params))
-
-        Rack::Utils.secure_compare(calculated_signature, signature)
-      end
-
-      private
-
-      def encoded_params_for_signature(params)
-        params = params.except(:signature, :hmac, :action, :controller)
-        params.map{|k,v| "#{URI.escape(k.to_s, '&=%')}=#{URI.escape(v.to_s, '&%')}"}.sort.join('&')
-      end
-
-      def extract_current_session
-        site = ShopifyAPI::Base.site.to_s
-        token = ShopifyAPI::Base.headers['X-Shopify-Access-Token']
-        version = ShopifyAPI::Base.api_version
-        new(domain: site, token: token, api_version: version)
-      end
-    end
-
-    def initialize(domain:, token:, api_version: ShopifyAPI::Base.api_version, extra: {})
-      self.domain = self.class.prepare_domain(domain)
-      self.api_version = api_version
-      self.token = token
-      self.extra = extra
-    end
-
-    def create_permission_url(scope, redirect_uri, options = {})
-      params = { client_id: api_key, scope: scope.join(','), redirect_uri: redirect_uri }
-      params[:state] = options[:state] if options[:state]
-      construct_oauth_url("authorize", params)
-    end
-
-    def request_token(params)
-      return token if token
-
-      unless self.class.validate_signature(params) && params[:timestamp].to_i > 24.hours.ago.utc.to_i
-        raise ShopifyAPI::ValidationException, "Invalid Signature: Possible malicious login"
-      end
-
-      response = access_token_request(params[:code])
-      if response.code == "200"
-        self.extra = JSON.parse(response.body)
-        self.token = extra.delete('access_token')
-
-        if expires_in = extra.delete('expires_in')
-          extra['expires_at'] = Time.now.utc.to_i + expires_in
-        end
-        token
-      else
-        raise RuntimeError, response.msg
-      end
-    end
-
-    def shop
-      Shop.current
-    end
-
-    def site
-      "https://#{domain}"
-    end
-
-    def api_version=(version)
-      @api_version = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
-    end
-
-    def valid?
-      domain.present? && token.present? && api_version.is_a?(ApiVersion)
-    end
-
-    def expires_in
-      return unless expires_at.present?
-      [0, expires_at.to_i - Time.now.utc.to_i].max
-    end
-
-    def expires_at
-      return unless extra.present?
-      @expires_at ||= Time.at(extra['expires_at']).utc
-    end
-
-    def expired?
-      return false if expires_in.nil?
-      expires_in <= 0
-    end
-
-    def hash
-      state.hash
-    end
-
-    def ==(other)
-      self.class == other.class && state == other.state
-    end
-
-    alias_method :eql?, :==
-
-    protected
-
-    def state
-      [domain, token, api_version, extra]
-    end
-
-    private
-
-    def parameterize(params)
-      URI.escape(params.collect { |k, v| "#{k}=#{v}" }.join('&'))
-    end
-
-    def access_token_request(code)
-      uri = URI.parse(construct_oauth_url('access_token'))
-      https = Net::HTTP.new(uri.host, uri.port)
-      https.use_ssl = true
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.set_form_data('client_id' => api_key, 'client_secret' => secret, 'code' => code)
-      https.request(request)
-    end
-
-    def construct_oauth_url(path, query_params = {})
-      query_string = "?#{parameterize(query_params)}" unless query_params.empty?
-      "https://#{domain}/admin/oauth/#{path}#{query_string}"
-    end
-  end
-end

data/lib/verify_docs.rb

@@ -1,7 +0,0 @@
-class VerifyDocs
-  def self.call
-    readme_content = File.read("README.md").lines[2..-1]
-    docs_content = File.read("docs/index.md").lines[4..-1]
-    readme_content == docs_content
-  end
-end

data/test/abandoned_checkouts_test.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-require 'test_helper'
-
-class AbandonedCheckoutsTest < Test::Unit::TestCase
-  def setup
-    super
-
-    @expected_checkouts = JSON.parse(load_fixture('abandoned_checkouts'))['checkouts']
-    @expected_checkout_id = JSON.parse(load_fixture('abandoned_checkout'))['checkout']['id']
-  end
-
-  test ":create creates a checkout" do
-    fake 'checkouts', method: :post, status: 201, body: load_fixture('abandoned_checkout')
-
-    checkout = ShopifyAPI::AbandonedCheckout.create
-
-    assert_equal @expected_checkout_id, checkout.id
-    assert_equal true, checkout.attributes.include?(:abandoned_checkout_url)
-  end
-
-  test "get all checkouts indexed by token" do
-    fake 'checkouts', method: :get, status: 200, body: load_fixture('abandoned_checkouts')
-
-    checkouts = ShopifyAPI::AbandonedCheckout.all
-
-    assert_equal @expected_checkout_id, checkouts.first.id
-    assert_equal @expected_checkouts.size, checkouts.size
-  end
-end

data/test/access_scope_test.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-require 'test_helper'
-
-class AccessScopeTest < Test::Unit::TestCase
-  test 'access scope does not use the versioned resource urls' do
-    fake(
-      'access_scopes',
-      url: 'https://shop2.myshopify.com/admin/oauth/access_scopes.json',
-      method: :get,
-      status: 201,
-      body: load_fixture('access_scopes'),
-      extension: false
-    )
-
-    unstable_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: :unstable)
-
-    ShopifyAPI::Base.activate_session(unstable_version)
-
-    scope_handles = ShopifyAPI::AccessScope.find(:all).map(&:handle)
-
-    assert_equal(['write_product_listings', 'read_shipping'], scope_handles)
-  end
-end

data/test/access_token_test.rb

@@ -1,19 +0,0 @@
-require 'test_helper'
-
-class AccessTokenTest < Test::Unit::TestCase
-
-  def test_delegate_access_token
-    fake "access_tokens/delegate.json?delegate_access_scope%5B%5D=write_orders&" \
-      "delegate_access_scope%5B%5D=read_products&expires_in=",
-      method: :post,
-      status: 201,
-      body: load_fixture('access_token_delegate'),
-      extension: false
-
-    delegate_scope = ['write_orders', 'read_products']
-    token = ShopifyAPI::AccessToken.delegate(delegate_scope)
-
-    assert_equal 'abracadabra', token.access_token
-    assert_equal 'write_orders,read_products', token.scope
-  end
-end

data/test/active_resource/json_errors_test.rb

@@ -1,19 +0,0 @@
-require 'test_helper'
-
-module ActiveResource
-  class JsonErrorsTest < Test::Unit::TestCase
-
-    def test_parsing_of_error_json_hash
-      @model = ShopifyAPI::Order.new
-      @model.errors.from_json({errors: {name: ['missing']}}.to_json)
-      assert_equal ['missing'], @model.errors[:name]
-    end
-
-    def test_parsing_of_error_json_plain_string
-      @model = ShopifyAPI::Order.new
-      @model.errors.from_json({errors: 'some generic error'}.to_json)
-      assert_equal ['some generic error'], @model.errors[:base]
-      assert_equal 'some generic error', @model.errors.full_messages.to_sentence
-    end
-  end
-end