shopify_api 4.12.0 → 12.4.0

data/lib/shopify_api/limits.rb

@@ -1,76 +0,0 @@
-module ShopifyAPI
-  module Limits
-    class LimitUnavailable < StandardError; end
-
-    def self.included(klass)
-      klass.send(:extend, ClassMethods)
-    end
-
-    module ClassMethods
-
-      # Takes form num_requests_executed/max_requests
-      # Eg: 101/3000
-      CREDIT_LIMIT_HEADER_PARAM = {
-        :shop => 'http_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/metafields.rb

@@ -1,20 +0,0 @@
-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/resources/access_scope.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class AccessScope < Base
-    self.prefix = '/admin/oauth/'
-  end
-end

data/lib/shopify_api/resources/access_token.rb

@@ -1,8 +0,0 @@
-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,4 +0,0 @@
-module ShopifyAPI
-  class Address < Base
-  end
-end

data/lib/shopify_api/resources/announcement.rb

@@ -1,4 +0,0 @@
-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,15 +0,0 @@
-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,4 +0,0 @@
-module ShopifyAPI
-  class ApplicationCredit < Base
-  end
-end

data/lib/shopify_api/resources/article.rb

@@ -1,21 +0,0 @@
-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,96 +0,0 @@
-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] ? "/admin/themes/#{params[:theme_id]}" : "/admin"
-        resource = find(:one, :from => "#{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/base.rb

@@ -1,89 +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(' ')
-
-    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
-      if ActiveResource::Base.respond_to?(:_headers) && ActiveResource::Base.respond_to?(:_headers_defined?)
-        def headers
-          if _headers_defined?
-            _headers
-          elsif superclass != Object && superclass.headers
-            superclass.headers
-          else
-            _headers ||= {}
-          end
-        end
-      else
-        def headers
-          if defined?(@headers)
-            @headers
-          elsif superclass != Object && superclass.headers
-            superclass.headers
-          else
-            @headers ||= {}
-          end
-        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)
-      end
-
-      def clear_session
-        self.site = nil
-        self.password = nil
-        self.user = nil
-        self.headers.delete('X-Shopify-Access-Token')
-      end
-
-      def init_prefix(resource)
-        init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
-      end
-
-      def init_prefix_explicit(resource_type, resource_id)
-        self.prefix = "/admin/#{resource_type}/:#{resource_id}/"
-
-        define_method resource_id.to_sym do
-          @prefix_options[resource_id]
-        end
-      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,4 +0,0 @@
-module ShopifyAPI
-  class Checkout < Base
-  end
-end

data/lib/shopify_api/resources/collect.rb

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

data/lib/shopify_api/resources/collection_listing.rb

@@ -1,9 +0,0 @@
-module ShopifyAPI
-  class CollectionListing < Base
-    self.primary_key = :collection_id
-
-    def product_ids
-      get(:product_ids)
-    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/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,9 +0,0 @@
-require 'shopify_api/resources/customer'
-
-module ShopifyAPI
-  class CustomerSavedSearch < Base
-    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/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,7 +0,0 @@
-module ShopifyAPI
-  class Event < Base
-    include DisablePrefixCheck
-
-    conditional_prefix :resource, true
-  end
-end

data/lib/shopify_api/resources/fulfillment.rb

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

data/lib/shopify_api/resources/fulfillment_event.rb

@@ -1,15 +0,0 @@
-module ShopifyAPI
-  class FulfillmentEvent < Base
-    self.prefix = '/admin/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_request.rb

@@ -1,15 +0,0 @@
-module ShopifyAPI
-  class FulfillmentRequest < Base
-    init_prefix :order
-
-    def order_id
-      @prefix_options[:order_id]
-    end
-
-    def mark_as_failed
-      options = {}
-      options[:message] = failure_message if failure_message
-      load_attributes_from_response(put(:mark_as_failed, options))
-    end
-  end
-end

data/lib/shopify_api/resources/fulfillment_service.rb

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

data/lib/shopify_api/resources/gift_card.rb

@@ -1,7 +0,0 @@
-module ShopifyAPI
-  class GiftCard < Base
-    def disable
-      load_attributes_from_response(post(:disable))
-    end
-  end
-end

data/lib/shopify_api/resources/graphql.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-require 'graphql/client'
-require 'graphql/client/http'
-
-module ShopifyAPI
-  # GraphQL API.
-  class GraphQL
-    def initialize
-      uri = Base.site.dup
-      uri.path = '/admin/api/graphql.json'
-      @http = ::GraphQL::Client::HTTP.new(uri.to_s) do
-        define_method(:headers) do |_context|
-          Base.headers
-        end
-      end
-      @schema = ::GraphQL::Client.load_schema(@http)
-      @client = ::GraphQL::Client.new(schema: @schema, execute: @http)
-    end
-
-    delegate :parse, :query, to: :@client
-  end
-end

data/lib/shopify_api/resources/image.rb

@@ -1,16 +0,0 @@
-module ShopifyAPI
-  class Image < Base
-    init_prefix :product
-
-    # generate a method for each possible image variant
-    [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|
-      reg_exp_match = "/\\1_#{m}.\\2"
-      define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
-    end
-
-    def attach_image(data, filename = nil)
-      attributes['attachment'] = Base64.encode64(data)
-      attributes['filename'] = filename unless filename.nil?
-    end
-  end
-end

data/lib/shopify_api/resources/inventory_item.rb

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