spiffy_stores_api 4.11.0

data/lib/active_resource/to_query.rb

@@ -0,0 +1,10 @@
+# ActiveSupport 3.0 doesn't URL-encode paths with arrays as params properly.
+# Backported from ActiveSupport > 3.0
+if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR == 0
+  class Object
+    def to_query(key)
+      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    end
+  end
+end

data/lib/spiffy_stores_api.rb

@@ -0,0 +1,29 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'active_resource'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'digest/md5'
+require 'base64'
+require 'active_resource/detailed_log_subscriber'
+require 'spiffy_stores_api/limits'
+require 'spiffy_stores_api/json_format'
+require 'active_resource/json_errors'
+require 'active_resource/disable_prefix_check'
+require 'active_resource/base_ext'
+require 'active_resource/to_query'
+
+module SpiffyStoresAPI
+  include Limits
+end
+
+require 'spiffy_stores_api/metafields'
+require 'spiffy_stores_api/countable'
+require 'spiffy_stores_api/resources'
+require 'spiffy_stores_api/session'
+require 'spiffy_stores_api/connection'
+
+if SpiffyStoresAPI::Base.respond_to?(:connection_class)
+  SpiffyStoresAPI::Base.connection_class = SpiffyStoresAPI::Connection
+else
+  require 'active_resource/connection_ext'
+end

data/lib/spiffy_stores_api/connection.rb

@@ -0,0 +1,33 @@
+module SpiffyStoresAPI
+  class Connection < ActiveResource::Connection
+    attr_reader :response
+
+    module ResponseCapture
+      def handle_response(response)
+        @response = super
+      end
+    end
+
+    include ResponseCapture
+
+    module RequestNotification
+      def request(method, path, *arguments)
+        super.tap do |response|
+          notify_about_request(response, arguments)
+        end
+      rescue => e
+        notify_about_request(e.response, arguments) if e.respond_to?(:response)
+        raise
+      end
+
+      def notify_about_request(response, arguments)
+        ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
+          payload[:response] = response
+          payload[:data]     = arguments
+        end
+      end
+    end
+
+    include RequestNotification
+  end
+end

data/lib/spiffy_stores_api/countable.rb

@@ -0,0 +1,14 @@
+module SpiffyStoresAPI
+  module Countable
+    def count(options = {})
+      data = get(:count, options)
+
+      count = case data
+        when Hash then data["count"]
+        else data
+      end
+
+      Integer(count)
+    end
+  end
+end

data/lib/spiffy_stores_api/json_format.rb

@@ -0,0 +1,18 @@
+module ActiveResource
+
+  # ActiveResource 3.1 removes root on decoding, so this patch is only needed in 3.0
+  if ActiveResource::VERSION::MAJOR == 3 && ActiveResource::VERSION::MINOR == 0
+    module Formats
+      module JsonFormat
+        def decode(json)
+          data = ActiveSupport::JSON.decode(json)
+          if data.is_a?(Hash) && data.keys.size == 1
+            data.values.first
+          else
+            data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spiffy_stores_api/limits.rb

@@ -0,0 +1,86 @@
+module SpiffyStoresAPI
+  module Limits
+    class LimitUnavailable < StandardError; end
+
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+
+      # The ratelimit header comes from rack-ratelimit
+      # The parameters provided are
+      # name
+      # period
+      # limit
+      # remaining
+      # until
+      # {"name":"API","period":300,"limit":500,"remaining":496,"until":"2014-11-28T03:45:00Z"}
+      CREDIT_LIMIT_HEADER_PARAM = {
+        :store => 'http_x_ratelimit'
+      }
+
+      ##
+      # How many more API calls can I make?
+      # @return {Integer}
+      #
+      def credit_left
+        credit_limit(:store) - credit_used(:store)
+      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 SpiffyStoresAPI cuts off at 299 or store limits.
+      # @param {Symbol} scope [:store]
+      # @return {Integer}
+      #
+      def credit_limit(scope=:store)
+        @api_credit_limit ||= {}
+        @api_credit_limit[scope] ||= 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 [:store]
+      # @return {Integer}
+      #
+      def credit_used(scope=:store)
+        api_credit_limit_param(scope).shift.to_i
+      end
+      alias_method :call_count, :credit_used
+
+      ##
+      # @return {HTTPResonse}
+      #
+      def response
+        Store.current unless SpiffyStoresAPI::Base.connection.response
+        SpiffyStoresAPI::Base.connection.response
+      end
+
+      private
+
+      ##
+      # @return {Array}
+      #
+      def api_credit_limit_param(scope)
+        header = response[CREDIT_LIMIT_HEADER_PARAM[scope]]
+        raise LimitUnavailable unless header
+        p = JSON.parse(header)
+        p_limit = p['limit'].to_i
+        p_used = p_limit - p['remaining'].to_i
+        [p_used, p_limit]
+      end
+    end
+  end
+end

data/lib/spiffy_stores_api/metafields.rb

@@ -0,0 +1,19 @@
+module SpiffyStoresAPI
+  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/spiffy_stores_api/resources.rb

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

data/lib/spiffy_stores_api/resources/address.rb

@@ -0,0 +1,4 @@
+module SpiffyStoresAPI
+  class Address < Base
+  end
+end

data/lib/spiffy_stores_api/resources/article.rb

@@ -0,0 +1,20 @@
+module SpiffyStoresAPI
+  class Article < Base
+    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/spiffy_stores_api/resources/base.rb

@@ -0,0 +1,86 @@
+require 'spiffy_stores_api/version'
+
+module SpiffyStoresAPI
+  class Base < ActiveResource::Base
+    class InvalidSessionError < StandardError; end
+    extend Countable
+    self.timeout = 90
+    self.include_root_in_json = false
+    self.headers['User-Agent'] = ["SpiffyStoresAPI/#{SpiffyStoresAPI::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!('Authorization' => "Bearer #{session.token}")
+      end
+
+      def clear_session
+        self.site = nil
+        self.headers.delete('Authorization')
+      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 = "/api/#{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/spiffy_stores_api/resources/blog.rb

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

data/lib/spiffy_stores_api/resources/collect.rb

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

data/lib/spiffy_stores_api/resources/country.rb

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

data/lib/spiffy_stores_api/resources/customer.rb

@@ -0,0 +1,24 @@
+module SpiffyStoresAPI
+  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
+  end
+end

data/lib/spiffy_stores_api/resources/image.rb

@@ -0,0 +1,16 @@
+module SpiffyStoresAPI
+  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/spiffy_stores_api/resources/metafield.rb

@@ -0,0 +1,12 @@
+module SpiffyStoresAPI
+  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/spiffy_stores_api/resources/order.rb

@@ -0,0 +1,23 @@
+module SpiffyStoresAPI
+  class Order < Base
+    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/spiffy_stores_api/resources/page.rb

@@ -0,0 +1,5 @@
+module SpiffyStoresAPI
+  class Page < Base
+    include Metafields
+  end
+end