shopify_api 4.13.0 → 12.2.1

data/lib/shopify_api/resources/inventory_level.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class InventoryLevel < Base
-
-    # The default path structure in ActiveResource for delete would result in:
-    # /admin/inventory_levels/#{ inventory_level.id }.json?#{ params }, but since
-    # InventroyLevels are a second class resource made up of a Where and a What
-    # (Location and InventoryItem), it does not have a resource ID. Here we
-    # redefine element_path to remove the id so HTTP DELETE requests go to
-    # /admin/inventory_levels.json?#{ params } instead.
-    #
-    def self.element_path(prefix_options = {}, query_options = nil)
-      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
-    end
-
-    def destroy
-      load_attributes_from_response(
-        self.class.delete('/', location_id: location_id, inventory_item_id: inventory_item_id)
-      )
-    end
-
-    def connect(relocate_if_necessary: nil)
-      body = { location_id: location_id, inventory_item_id: inventory_item_id }
-      body[:relocate_if_necessary] = relocate_if_necessary unless relocate_if_necessary.nil?
-      load_attributes_from_response(
-        self.class.post(:connect, {}, body.to_json)
-      )
-    end
-
-    def set(new_available, disconnect_if_necessary: nil)
-      body = {
-        location_id: location_id,
-        inventory_item_id: inventory_item_id,
-        available: new_available
-      }
-      body[:disconnect_if_necessary] = disconnect_if_necessary unless disconnect_if_necessary.nil?
-      load_attributes_from_response(
-        self.class.post(:set, {}, body.to_json)
-      )
-    end
-
-    def adjust(available_adjustment)
-      body = {
-        location_id: location_id,
-        inventory_item_id: inventory_item_id,
-        available_adjustment: available_adjustment
-      }
-      load_attributes_from_response(
-        self.class.post(:adjust, {}, body.to_json)
-      )
-    end
-  end
-end

data/lib/shopify_api/resources/line_item.rb

@@ -1,14 +0,0 @@
-module ShopifyAPI
-  class LineItem < Base
-    class Property < Base
-      def initialize(*args)
-        attributes = args[0] || {}
-        persisted = args[1] || false
-        super
-      rescue NameError
-        attributes = attributes.to_hash
-        self
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/location.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class Location < Base
-
-    def inventory_levels
-      ShopifyAPI::InventoryLevel.find(:all, from: "/admin/locations/#{id}/inventory_levels.json")
-    end
-  end
-end

data/lib/shopify_api/resources/marketing_event.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class MarketingEvent < Base
-    def add_engagements(engagements)
-      engagements = { engagements: Array.wrap(engagements) }
-      post(:engagements, {}, engagements.to_json)
-    end
-  end
-end

data/lib/shopify_api/resources/metafield.rb

@@ -1,12 +0,0 @@
-module ShopifyAPI
-  class Metafield < Base
-    include DisablePrefixCheck
-
-    conditional_prefix :resource, true
-
-    def value
-      return if attributes["value"].nil?
-      attributes["value_type"] == "integer" ? attributes["value"].to_i : attributes["value"]
-    end
-  end
-end

data/lib/shopify_api/resources/note_attribute.rb

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

data/lib/shopify_api/resources/o_auth.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-# This resource is deprecated and will be removed in a future version of this gem.
-# Use ShopifyAPI::ApiPermission.destroy instead
-
-module ShopifyAPI
-  class OAuth < Base
-    self.collection_name = 'oauth'
-
-    def self.revoke
-      warn '[DEPRECATED] ShopifyAPI::OAuth#revoke is deprecated and will be removed in a future version. ' \
-        'Use ShopifyAPI::ApiPermission#destroy instead.'
-
-      delete(:revoke)
-    end
-  end
-end

data/lib/shopify_api/resources/option.rb

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

data/lib/shopify_api/resources/order.rb

@@ -1,29 +0,0 @@
-module ShopifyAPI
-  class Order < Base
-    include Events
-    include Metafields
-
-    def close
-      load_attributes_from_response(post(:close, {}, only_id))
-    end
-
-    def open
-      load_attributes_from_response(post(:open, {}, only_id))
-    end
-
-    def cancel(options = {})
-      load_attributes_from_response(post(:cancel, {}, options.to_json))
-    end
-
-    def transactions
-      Transaction.find(:all, :params => { :order_id => id })
-    end
-
-    def capture(amount = "")
-      Transaction.create(:amount => amount, :kind => "capture", :order_id => id)
-    end
-
-    class ClientDetails < Base
-    end
-  end
-end

data/lib/shopify_api/resources/order_risk.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class OrderRisk < Base
-    init_prefix :order
-
-    self.collection_name = "risks"
-    self.element_name = "risk"
-  end
-end

data/lib/shopify_api/resources/page.rb

@@ -1,6 +0,0 @@
-module ShopifyAPI
-  class Page < Base
-    include Events
-    include Metafields
-  end
-end

data/lib/shopify_api/resources/payment_details.rb

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

data/lib/shopify_api/resources/ping/conversation.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  module Ping
-    class Conversation < Base
-      self.prefix = "/admin/api/ping-api/v1/"
-
-      def send_message(message_attrs)
-        message = ShopifyAPI::Ping::Message.new(
-          message_attrs.merge(conversation_id: id)
-        )
-
-        message.save
-        message
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/ping/message.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  module Ping
-    class Message < Base
-      self.prefix = "/admin/api/ping-api/v1/conversations/:conversation_id/"
-    end
-  end
-end

data/lib/shopify_api/resources/ping.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Dir.glob("#{File.dirname(__FILE__)}/ping/*").each { |file| require file }

data/lib/shopify_api/resources/policy.rb

@@ -1,7 +0,0 @@
-module ShopifyAPI
-  class Policy < Base
-    def self.all
-      find(:all)
-    end
-  end
-end

data/lib/shopify_api/resources/price_rule.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class PriceRule < Base
-
-    def discount_codes
-      DiscountCode.find(:all, params: { price_rule_id: id })
-    end
-  end
-end

data/lib/shopify_api/resources/product.rb

@@ -1,33 +0,0 @@
-module ShopifyAPI
-  class Product < Base
-    include Events
-    include Metafields
-
-    # 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 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
-  end
-end

data/lib/shopify_api/resources/product_listing.rb

@@ -1,9 +0,0 @@
-module ShopifyAPI
-  class ProductListing < Base
-    self.primary_key = :product_id
-
-    def self.product_ids
-      get(:product_ids)
-    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/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,13 +0,0 @@
-module ShopifyAPI
-  class Refund < Base
-    init_prefix :order
-
-    def self.calculate(*args)
-      options = { :refund => args[0] }
-      params = options.merge(args[1][:params]) if args[1] && args[1][:params]
-      self.prefix = "/admin/orders/#{params[:order_id]}/"
-      resource = post(:calculate, {}, 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_zone.rb

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

data/lib/shopify_api/resources/shop.rb

@@ -1,23 +0,0 @@
-module ShopifyAPI
-  # Shop object. Use Shop.current to receive
-  # the shop.
-  class Shop < Base
-    def self.current(options={})
-      find(:one, options.merge({from: "/admin/shop.#{format.extension}"}))
-    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 => self.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/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,8 +0,0 @@
-module ShopifyAPI
-  class Variant < Base
-    include Metafields
-    include DisablePrefixCheck
-
-    conditional_prefix :product
-  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,2 +0,0 @@
-require 'shopify_api/resources/base'
-Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) } 

data/lib/shopify_api/session.rb

@@ -1,144 +0,0 @@
-require 'openssl'
-require 'rack'
-
-module ShopifyAPI
-
-  class ValidationException < StandardError
-  end
-
-  class Session
-    cattr_accessor :api_key, :secret, :protocol, :myshopify_domain, :port
-    self.protocol = 'https'
-    self.myshopify_domain = 'myshopify.com'
-
-    attr_accessor :url, :token, :name, :extra
-
-    class << self
-
-      def setup(params)
-        params.each { |k,value| public_send("#{k}=", value) }
-      end
-
-      def temp(domain, token, &block)
-        session = new(domain, token)
-        original_site = ShopifyAPI::Base.site.to_s
-        original_token = ShopifyAPI::Base.headers['X-Shopify-Access-Token']
-        original_session = new(original_site, original_token)
-
-        begin
-          ShopifyAPI::Base.activate_session(session)
-          yield
-        ensure
-          ShopifyAPI::Base.activate_session(original_session)
-        end
-      end
-
-      def prepare_url(url)
-        return nil if url.blank?
-        # remove http:// or https://
-        url = url.strip.gsub(/\Ahttps?:\/\//, '')
-        # extract host, removing any username, password or path
-        shop = URI.parse("https://#{url}").host
-        # extract subdomain of .myshopify.com
-        if idx = shop.index(".")
-          shop = shop.slice(0, idx)
-        end
-        return nil if shop.empty?
-        shop = "#{shop}.#{myshopify_domain}"
-        port ? "#{shop}:#{port}" : shop
-      rescue URI::InvalidURIError
-        nil
-      end
-
-      def validate_signature(params)
-        params = 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
-    end
-
-    def initialize(url, token = nil, extra = {})
-      self.url = self.class.prepare_url(url)
-      self.token = token
-      self.extra = extra
-    end
-
-    def create_permission_url(scope, redirect_uri = nil)
-      params = {:client_id => api_key, :scope => scope.join(',')}
-      params[:redirect_uri] = redirect_uri if redirect_uri
-      "#{site}/oauth/authorize?#{parameterize(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
-      "#{protocol}://#{url}/admin"
-    end
-
-    def valid?
-      url.present? && token.present?
-    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
-
-    private
-      def parameterize(params)
-        URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
-      end
-
-      def access_token_request(code)
-        uri = URI.parse("#{protocol}://#{url}/admin/oauth/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
-  end
-end