shopify_api 9.0.3 → 12.5.0

data/lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -1,16 +0,0 @@
-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,162 +0,0 @@
-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.new("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.api_version = 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 = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
-      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.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,4 +0,0 @@
-module ShopifyAPI
-  class BillingAddress < Base
-  end
-end

data/lib/shopify_api/resources/blog.rb

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

data/lib/shopify_api/resources/carrier_service.rb

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

data/lib/shopify_api/resources/cart.rb

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

data/lib/shopify_api/resources/checkout.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class Checkout < Base
-    self.primary_key = :token
-
-    def self.headers
-      super.merge('X-Shopify-Checkout-Version' => '2016-09-06')
-    end
-
-    def complete
-      post(:complete)
-    end
-
-    def ready?
-      return false unless persisted?
-
-      reload
-      [200, 201].include?(ShopifyAPI::Base.connection.response.code.to_i)
-    end
-
-    def payments
-      Payment.find(:all, params: { checkout_id: id })
-    end
-
-    def shipping_rates
-      ShippingRate.find(:all, params: { checkout_id: id })
-    end
-  end
-end

data/lib/shopify_api/resources/collect.rb

@@ -1,6 +0,0 @@
-module ShopifyAPI
-  # For adding/removing products from custom collections
-  class Collect < Base
-    early_july_pagination_release!
-  end
-end

data/lib/shopify_api/resources/collection.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class Collection < Base
-    include Events
-    include Metafields
-
-    def products(options = {})
-      available_in_version = ShopifyAPI::ApiVersion.find_version('2020-01')
-      raise NotImplementedError unless ShopifyAPI::Base.api_version >= available_in_version
-      Product.find(:all, from: "#{self.class.prefix}collections/#{id}/products.json", params: options)
-    end
-  end
-end

data/lib/shopify_api/resources/collection_listing.rb

@@ -1,18 +0,0 @@
-module ShopifyAPI
-  class CollectionListing < Base
-    self.primary_key = :collection_id
-
-    early_july_pagination_release!
-
-    def product_ids
-      ProductId.all(params: { collection_id: collection_id })
-    end
-
-    class ProductId < ArrayBase
-      self.resource_prefix = 'collection_listings/:collection_id/'
-
-      early_july_pagination_release!
-    end
-    private_constant :ProductId
-  end
-end

data/lib/shopify_api/resources/collection_publication.rb

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

data/lib/shopify_api/resources/comment.rb

@@ -1,9 +0,0 @@
-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
-  end
-end

data/lib/shopify_api/resources/country.rb

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

data/lib/shopify_api/resources/currency.rb

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

data/lib/shopify_api/resources/custom_collection.rb

@@ -1,19 +0,0 @@
-module ShopifyAPI
-  class CustomCollection < Base
-    include Events
-    include Metafields
-
-    def products
-      Product.find(:all, :params => {:collection_id => self.id})
-    end
-
-    def add_product(product)
-      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.destroy if collect
-    end
-  end
-end

data/lib/shopify_api/resources/customer.rb

@@ -1,29 +0,0 @@
-module ShopifyAPI
-  class Customer < Base
-    include Metafields
-
-    def orders
-      Order.find(:all, params: {customer_id: self.id})
-    end
-
-    def self.search(params)
-      find(:all, from: :search, params: params)
-    end
-
-    def account_activation_url
-      resource = post(:account_activation_url, {}, only_id)
-      data = ActiveSupport::JSON.decode(resource.body.to_s)
-      result = nil
-
-      if data.key?('account_activation_url')
-        result = data['account_activation_url']
-      end
-      result
-    end
-
-    def send_invite(customer_invite = ShopifyAPI::CustomerInvite.new)
-      resource = post(:send_invite, {}, customer_invite.encode)
-      ShopifyAPI::CustomerInvite.new(ShopifyAPI::CustomerInvite.format.decode(resource.body))
-    end
-  end
-end

data/lib/shopify_api/resources/customer_group.rb

@@ -1,5 +0,0 @@
-require 'shopify_api/resources/customer_saved_search'
-
-module ShopifyAPI
-  CustomerGroup = CustomerSavedSearch
-end

data/lib/shopify_api/resources/customer_invite.rb

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

data/lib/shopify_api/resources/customer_saved_search.rb

@@ -1,11 +0,0 @@
-require 'shopify_api/resources/customer'
-
-module ShopifyAPI
-  class CustomerSavedSearch < Base
-    early_july_pagination_release!
-
-    def customers(params = {})
-      Customer.search(params.merge({:customer_saved_search_id => self.id}))
-    end
-  end
-end

data/lib/shopify_api/resources/discount_code.rb

@@ -1,9 +0,0 @@
-module ShopifyAPI
-  class DiscountCode < Base
-    init_prefix :price_rule
-
-    def price_rule_id
-      @prefix_options[:price_rule_id]
-    end
-  end
-end

data/lib/shopify_api/resources/discount_code_batch.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class DiscountCodeBatch < Base
-    init_prefix :price_rule
-
-    self.collection_name = 'batch'
-
-    def price_rule_id
-      @prefix_options[:price_rule_id]
-    end
-
-    def discount_code_job
-      @discount_codes ||= begin
-        if id
-          path = self.class.api_version.construct_api_path("price_rules/#{price_rule_id}/batch/#{id}/discount_codes.json")
-          discount_codes = ShopifyAPI::DiscountCode.find :all, from: path
-          discount_codes.each do |code|
-            errors = code.attributes['errors']
-            errors.attributes.each do |key, values|
-              values.each { |message| code.errors.add(key, message) }
-            end
-          end
-          discount_codes
-        end
-      end
-    end
-
-    def encode(options = {})
-      send("to_#{self.class.format.extension}", options)
-    end
-  end
-end

data/lib/shopify_api/resources/draft_order.rb

@@ -1,14 +0,0 @@
-module ShopifyAPI
-  class DraftOrder < Base
-    include Metafields
-
-    def send_invoice(draft_order_invoice = ShopifyAPI::DraftOrderInvoice.new)
-      resource = post(:send_invoice, {}, draft_order_invoice.encode)
-      ShopifyAPI::DraftOrderInvoice.new(ShopifyAPI::DraftOrder.format.decode(resource.body))
-    end
-
-    def complete(options = {})
-      load_attributes_from_response(put(:complete, options, nil))
-    end
-  end
-end

data/lib/shopify_api/resources/draft_order_invoice.rb

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

data/lib/shopify_api/resources/event.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class Event < Base
-    include DisablePrefixCheck
-
-    conditional_prefix :resource, true
-    early_july_pagination_release!
-  end
-end

data/lib/shopify_api/resources/fulfillment.rb

@@ -1,47 +0,0 @@
-module ShopifyAPI
-  class Fulfillment < Base
-    init_prefix :order
-
-    def order_id
-      @prefix_options[:order_id]
-    end
-
-    def cancel; load_attributes_from_response(post(:cancel, {}, only_id)); end
-    def complete; load_attributes_from_response(post(:complete, {}, only_id)); end
-    def open; load_attributes_from_response(post(:open, {}, only_id)); end
-
-    def order_id=(order_id)
-      prefix_options[:order_id] = order_id
-    end
-
-    def load(attributes, remove_root = false, persisted = false)
-      order_id = attributes['order_id']
-      prefix_options[:order_id] = order_id if order_id
-      super(attributes, remove_root, persisted)
-    end
-
-    def save
-      if prefix_options[:order_id].present?
-        super
-      else
-        line_items = attributes['line_items_by_fulfillment_order'] || attributes[:line_items_by_fulfillment_order]
-        if line_items.blank?
-          raise ShopifyAPI::ValidationException,
-                "either 'line_items_by_fulfillment_order' or prefix_options[:order_id] is required"
-        end
-
-        fulfillmentV2 = FulfillmentV2.new(attributes)
-        result = fulfillmentV2.save
-        load(fulfillmentV2.attributes, false, true)
-        result
-      end
-    end
-
-    def update_tracking(tracking_info:, notify_customer:)
-      fulfillmentV2 = FulfillmentV2.new(attributes)
-      result = fulfillmentV2.update_tracking(tracking_info: tracking_info, notify_customer: notify_customer)
-      load(fulfillmentV2.attributes, false, true)
-      result
-    end
-  end
-end

data/lib/shopify_api/resources/fulfillment_event.rb

@@ -1,15 +0,0 @@
-module ShopifyAPI
-  class FulfillmentEvent < Base
-    self.resource_prefix = "orders/:order_id/fulfillments/:fulfillment_id/"
-    self.collection_name = 'events'
-    self.element_name = 'event'
-
-    def order_id
-      @prefix_options[:order_id]
-    end
-
-    def fulfillment_id
-      @prefix_options[:fulfillment_id]
-    end
-  end
-end

data/lib/shopify_api/resources/fulfillment_order.rb

@@ -1,137 +0,0 @@
-module ShopifyAPI
-  class FulfillmentOrder < Base
-    MINIMUM_VERSION = '2020-01'
-
-    def initialize(attributes = {}, persisted = false)
-      ShopifyAPI::Base.version_validation!(MINIMUM_VERSION)
-      super(attributes, persisted)
-    end
-
-    def self.find(scope, *args)
-      ShopifyAPI::Base.version_validation!(MINIMUM_VERSION)
-
-      if scope == :all
-        order_id = args.first&.dig(:params, :order_id)
-        raise ShopifyAPI::ValidationException, "'order_id' is required" if order_id.blank?
-
-        order = ::ShopifyAPI::Order.new(id: order_id)
-        order.fulfillment_orders(args.first[:params].except(:order_id))
-      else
-        super(scope, *args)
-      end
-    end
-
-    def fulfillments(options = {})
-      fulfillment_hashes = get(:fulfillments, options)
-      fulfillment_hashes.map { |fulfillment_hash| Fulfillment.new(fulfillment_hash) }
-    end
-
-    def locations_for_move
-      locations_for_move_hashes = get(:locations_for_move, {})
-
-      locations_for_move_hashes.map do |locations_for_move_hash|
-        FulfillmentOrderLocationsForMove.new(locations_for_move_hash)
-      end
-    end
-
-    def move(new_location_id:)
-      body = {
-        fulfillment_order: {
-          new_location_id: new_location_id
-        }
-      }
-      keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:move, {}, body.to_json))
-      load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
-      keyed_fulfillment_orders
-    end
-
-    def cancel
-      keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:cancel, {}, only_id))
-      load_keyed_fulfillment_order(keyed_fulfillment_orders, 'fulfillment_order')
-      keyed_fulfillment_orders
-    end
-
-    def close(message: nil)
-      body = {
-        fulfillment_order: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post(:close, {}, body.to_json))
-    end
-
-    def request_fulfillment(fulfillment_order_line_items: nil, message: nil)
-      body = {
-        fulfillment_request: {
-          fulfillment_order_line_items: fulfillment_order_line_items,
-          message: message
-        }
-      }
-      keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:fulfillment_request, {}, body.to_json))
-      load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
-      keyed_fulfillment_orders
-    end
-
-    def accept_fulfillment_request(message: nil)
-      body = {
-        fulfillment_request: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post('fulfillment_request/accept', {}, body.to_json))
-    end
-
-    def reject_fulfillment_request(message: nil)
-      body = {
-        fulfillment_request: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post('fulfillment_request/reject', {}, body.to_json))
-    end
-
-    def request_cancellation(message: nil)
-      body = {
-        cancellation_request: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post(:cancellation_request, {}, body.to_json))
-    end
-
-    def accept_cancellation_request(message: nil)
-      body = {
-        cancellation_request: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post('cancellation_request/accept', {}, body.to_json))
-    end
-
-    def reject_cancellation_request(message: nil)
-      body = {
-        cancellation_request: {
-          message: message
-        }
-      }
-      load_attributes_from_response(post('cancellation_request/reject', {}, body.to_json))
-    end
-
-    private
-
-    def load_keyed_fulfillment_order(keyed_fulfillment_orders, key)
-      if keyed_fulfillment_orders[key]&.attributes
-        load(keyed_fulfillment_orders[key].attributes, false, true)
-      end
-    end
-
-    def keyed_fulfillment_orders_from_response(response)
-      return load_attributes_from_response(response) if response.code != '200'
-
-      keyed_fulfillment_orders = ActiveSupport::JSON.decode(response.body)
-      keyed_fulfillment_orders.transform_values do |fulfillment_order_attributes|
-        FulfillmentOrder.new(fulfillment_order_attributes) if fulfillment_order_attributes
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb

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