7digital 0.1.2 → 0.1.5

data/lib/sevendigital/api_operator_cached.rb

@@ -1,62 +1,91 @@
-module Sevendigital
-  #@private
-  #Cached version of ApiOperator
-  #If response for an API request is already in cache and
-  #and it hasn't expired returns the cached response is returned instead of making an API call
-  #otherwise uses methods inherited from ApiOperator to make an HTTP call to the API
-  class ApiOperatorCached < ApiOperator # :nodoc:
-    def initialize(client, cache)
-      @cache = cache
-      super(client)
-    end
-
-    def call_api(api_request)
-      api_response = retrieve_from_cache(api_request)
-      api_response = cache_response(api_request) if response_out_of_date?(api_response)
-
-      api_response.tap do |api_response|
-        @client.log(:very_verbose) { "ApiOperatorCached: API Response: #{api_response}" }
-      end
-    end
-
-
-    def response_out_of_date?(api_response, current_time=nil)
-      (api_response.nil? || header_invalid?(api_response.headers) || cache_expired?(api_response.headers, current_time)).tap do |expired|
-        @client.log(:verbose) { "ApiOperatorCached: Cache response out of date" if expired }
-      end
-    end
-
-  private
-
-    def header_invalid?(header)
-      header["Date"].nil? || header["cache-control"].nil? || !(header["cache-control"] =~ /max-age=([0-9]+)/)
-    end
-
-    def cache_expired?(header, current_time=nil)
-      (Time.parse(header["Date"]) + (/max-age=([0-9]+)/.match(header["cache-control"])[1].to_i)) < (current_time || Time.now.utc)
-    end
-
-    def cache_response(api_request)
-      digest_http_response(make_http_request(api_request)).tap do |api_response|
-        unless api_request.requires_signature?
-          key = request_cache_key(api_request)
-          @cache.respond_to?(:write) ? @cache.write(key, api_response) : @cache.set(key, api_response)
-          @client.log(:verbose) { "ApiOperatorCached: Storing response in cache..." }
-        end
-      end
-    end
-
-    def request_cache_key(api_request)
-      create_request_uri(api_request).to_s
-    end
-
-    def retrieve_from_cache(api_request)
-      unless api_request.requires_signature?
-        key = request_cache_key(api_request)
-        (@cache.respond_to?(:read) ? @cache.read(key) : @cache.get(key)).tap do |response|
-          @client.log(:verbose) { "ApiOperatorCached: Got from cache #{key}" if response }
-        end
-      end
-    end
-  end
-end
+require 'time'
+
+module Sevendigital
+  #@private
+  #Cached version of ApiOperator
+  #If response for an API request is already in cache and
+  #and it hasn't expired returns the cached response is returned instead of making an API call
+  #otherwise uses methods inherited from ApiOperator to make an HTTP call to the API
+  class ApiOperatorCached < ApiOperator # :nodoc:
+    def initialize(client, cache)
+      @cache = cache
+      super(client)
+    end
+
+    def call_api(api_request)
+      @client.log(:very_verbose) { "ApiOperatorCached: API Request: #{api_request.inspect}" }
+      api_response = retrieve_from_cache(api_request)
+      api_response = cache_response(api_request) if response_out_of_date?(api_response, default_cache_max_age(api_request))
+      api_response.tap do |api_response|
+        @client.log(:very_verbose) { "ApiOperatorCached: API Response: #{api_response}" }
+      end
+    end
+
+
+=begin
+    def response_out_of_date?(api_response, current_time=nil)
+      (api_response.nil? || header_invalid?(api_response.headers) || cache_expired?(api_response.headers, current_time)).tap do |expired|
+        @client.log(:verbose) { "ApiOperatorCached: Cache response out of date" if expired }
+      end
+    end
+=end
+
+    def response_out_of_date?(api_response, cache_max_age, current_time=nil)
+      if api_response.nil?
+        @client.log(:verbose) { "ApiOperatorCached: Response not found in cache" }
+        return true
+      end
+      if header_invalid?(api_response.headers)
+        @client.log(:verbose) { "ApiOperatorCached: Ignoring cached response - invalid cache-control header" }
+        return true
+      end
+      (cache_expired?(api_response.headers, cache_max_age, current_time)).tap do |expired|
+        @client.log(:verbose) { "ApiOperatorCached: Cache response out of date (max age #{cache_max_age})" } if expired
+      end
+    end
+
+    def default_cache_max_age(api_request)
+      return api_request.options[:cache_max_age] if api_request.options[:cache_max_age]
+      if @client.configuration.cache_max_age
+        return @client.configuration.cache_max_age[api_request.api_method.to_sym] || @client.configuration.cache_max_age[:"*"]
+      end
+      nil
+    end
+
+    private
+
+    def header_invalid?(header)
+      header["Date"].nil? || header["cache-control"].nil? || !(header["cache-control"] =~ /max-age=([0-9]+)/)
+    end
+
+    def cache_expired?(header, max_age_override, current_time=nil)
+      max_age = max_age_override || /max-age=([0-9]+)/.match(header["cache-control"])[1].to_i
+      (Time.parse(header["Date"]) + max_age) < (current_time || Time.now.utc)
+    end
+
+    def cache_response(api_request)
+      digest_http_response(make_http_request(api_request)).tap do |api_response|
+        @client.log(:very_verbose) { "ApiOperatorCached: API Request (cache_response): #{api_request.inspect}" }
+        unless api_request.requires_signature? # || response_out_of_date?(api_response, api_request.options[:cache_max_age])
+          key = request_cache_key(api_request)
+          @cache.respond_to?(:write) ? @cache.write(key, api_response) : @cache.set(key, api_response)
+          @client.log(:verbose) { "ApiOperatorCached: Storing response in cache..." }
+        end
+      end
+    end
+
+    def request_cache_key(api_request)
+      create_request_uri(api_request).to_s
+    end
+
+    def retrieve_from_cache(api_request)
+      unless api_request.requires_signature?
+        key = request_cache_key(api_request)
+        (@cache.respond_to?(:read) ? @cache.read(key) : @cache.get(key)).tap do |response|
+          @client.log(:verbose) { "ApiOperatorCached: Got from cache #{key}" } if response
+        end
+      end
+    end
+
+  end
+end

data/lib/sevendigital/api_request.rb

@@ -1,62 +1,72 @@
-module Sevendigital
-  #@private
-  #Abstraction of a HTTP API request, ApiOperator uses this ApiRequest to build a real HTTP requests
-  class ApiRequest # :nodoc:
-
-    attr_reader :api_method, :parameters, :signed
-    attr_accessor :token, :api_service, :http_method
-    attr_accessor :signature_scheme
-    attr_writer :form_parameters
-
-    def initialize(http_method, api_method, parameters, options={})
-      @api_method = api_method
-      @parameters = parameters
-      @signature_scheme = :header
-      @http_method = http_method
-      comb_parameters(parameters)
-      @form_parameters = Hash.new
-    end
-
-    def form_parameters
-      comb_parameters(@form_parameters)
-    end
-
-    def requires_signature?
-      @signed == true
-    end
-
-    def require_signature
-      @signed = true
-    end
-
-    def requires_secure_connection?
-      @secure == true
-    end
-
-    def require_secure_connection
-      @secure = true
-    end
-
-    def comb_parameters(parameters)
-      comb_parameter(parameters, :pageSize, [:page_size, :per_page])
-      comb_parameter(parameters, :shopId, :shop_id)
-      comb_parameter(parameters, :imageSize, :image_size)
-      remove_empty_parameters(parameters)
-      parameters
-    end
-
-    def comb_parameter(parameters, correct_name, alternative_names)
-      param_value = nil
-      alternative_names = [alternative_names] unless alternative_names.is_a?(Array)
-      alternative_names.each do |alternative_name|
-        param_value ||= parameters[alternative_name]
-        parameters.delete(alternative_name)
-      end
-      parameters[correct_name] ||= param_value if param_value
-    end
-
-    def remove_empty_parameters(parameters)
-      parameters.delete_if { |key, value| value.nil? }
-    end
-  end
-end
+module Sevendigital
+  #@private
+  #Abstraction of a HTTP API request, ApiOperator uses this ApiRequest to build a real HTTP requests
+  class ApiRequest # :nodoc:
+
+    attr_reader :api_method, :parameters, :signed, :options
+    attr_accessor :token, :api_service, :http_method
+    attr_accessor :signature_scheme
+    attr_writer :form_parameters
+
+    WRAPPER_PARAMETERS = [:cache_max_age]
+
+    def initialize(http_method, api_method, parameters, options=nil)
+      @api_method = api_method
+      @parameters = parameters
+      @options = options || Hash.new
+      @signature_scheme = :header
+      @http_method = http_method
+      comb_parameters(parameters)
+      @form_parameters = Hash.new
+    end
+
+    def form_parameters
+      comb_parameters(@form_parameters)
+    end
+
+    def requires_signature?
+      @signed == true
+    end
+
+    def require_signature
+      @signed = true
+    end
+
+    def requires_secure_connection?
+      @secure == true
+    end
+
+    def require_secure_connection
+      @secure = true
+    end
+
+    def comb_parameters(params)
+      comb_parameter(params, :pageSize, [:page_size, :per_page])
+      comb_parameter(params, :shopId, :shop_id)
+      comb_parameter(params, :imageSize, :image_size)
+      remove_empty_parameters(params)
+      remove_wrapper_options(params)
+      params
+    end
+
+    def comb_parameter(parameters, correct_name, alternative_names)
+      param_value = nil
+      alternative_names = [alternative_names] unless alternative_names.is_a?(Array)
+      alternative_names.each do |alternative_name|
+        param_value ||= parameters[alternative_name]
+        parameters.delete(alternative_name)
+      end
+      parameters[correct_name] ||= param_value if param_value
+    end
+
+    def remove_empty_parameters(parameters)
+      parameters.delete_if { |key, value| value.nil? }
+    end
+
+    def remove_wrapper_options(parameters)
+      @options.merge!(parameters.select{|key, value| WRAPPER_PARAMETERS.include?(key) })
+      parameters.delete_if { |key| WRAPPER_PARAMETERS.include?(key) }
+    end
+
+  end
+end

data/lib/sevendigital/client.rb

@@ -1,122 +1,122 @@
-module Sevendigital
-
-  class Client
-
-  #if default values for any of these parameters are set in configuration, they will be passed along with every single API request
-  COMMON_REQUEST_PARAMETERS = [:shop_id, :country, :page, :page_size, :image_size]
-
-    def initialize(*args)
-      @configuration = Sevendigital::ClientConfiguration.new(*args)
-      yield @configuration if block_given?
-      @api_operator = hire_api_operator
-    end
-
-    def create_api_request(http_method, api_method, parameters, options = {})
-      parameters = options.merge(parameters)
-      parameters = add_default_parameters(parameters)
-      if http_method != :POST then
-        request = ApiRequest.new(http_method, api_method, parameters)
-      else
-        request = ApiRequest.new(http_method, api_method, {})
-        request.form_parameters = parameters
-      end
-      request
-    end
-
-    def make_api_request(http_method, api_method, parameters, options = {})
-      api_request = create_api_request(http_method, api_method, parameters, options)
-      operator.call_api(api_request)
-    end
-
-    def make_signed_api_request(http_method, api_method, parameters, options = {}, token = nil)
-      api_request = create_api_request(http_method, api_method, parameters, options)
-      api_request.require_signature
-      api_request.require_secure_connection
-      api_request.token = token
-
-      operator.call_api(api_request)
-    end
-
-    def oauth_consumer
-      host, version = api_host_and_version(:account)
-
-      consumer_options = {
-        :authorize_path     => "https://#{host}/#{version}/oauth/authorise",
-        :http_method   => :get
-      }
-
-      @oauth_consumer ||= OAuth::Consumer.new( \
-              @configuration.oauth_consumer_key, \
-              @configuration.oauth_consumer_secret, \
-              consumer_options \
-      )
-    end
-
-    def configuration
-      @configuration
-    end
-
-    def log(severity, &block)
-      if self.send("#{severity}?")
-        logger.info(yield) if block_given?
-      end
-    end
-
-    def operator
-      @api_operator
-    end
-
-    def verbose?
-     very_verbose? || !!@verbose || !!@configuration.verbose
-    end
-
-    def very_verbose?
-      @very_verbose || @configuration.verbose.to_s == "very_verbose"
-    end
-
-  #@private
-  def api_host_and_version(api_service=nil)
-     service = api_service && !api_service.to_s.empty? ? "#{api_service}_" : ""
-     [configuration.send("#{service}api_url".to_sym), configuration.send("#{service}api_version".to_sym)]
-  end
-
-  #@private
-  def user_agent_info
-    app_info = @configuration.app_name ? "/#{@configuration.app_name}" : nil
-    app_info += " #{@configuration.app_version}" if app_info && @configuration.app_version
-    "#{Sevendigital::NAME} Gem #{Sevendigital::VERSION}#{app_info}"
-  end
-
-  private
-
-    #@private
-    def default_parameters
-      params = {}
-      COMMON_REQUEST_PARAMETERS.each do |param|
-        value = @configuration.send(param)
-        params[param] = value if value
-      end
-      params
-    end
-
-    #@private
-    def hire_api_operator
-       @configuration.cache ? ApiOperatorCached.new(self, @configuration.cache) : ApiOperator.new(self)
-    end
-
-    #@private
-    def add_default_parameters(parameters)
-      params = parameters
-      default_parameters.each do |name, value|
-        params[name] ||= value
-      end
-      params
-    end
-
-    #@private
-    def logger
-      path = (@configuration.logfile_path.nil? || @configuration.logfile_path.blank?) ? STDOUT : @configuration.logfile_path
-      @logger ||= Logger.new(path)
-    end
-  end
-end
+module Sevendigital
+
+  class Client
+
+  #if default values for any of these parameters are set in configuration, they will be passed along with every single API request
+  COMMON_REQUEST_PARAMETERS = [:shop_id, :country, :page, :page_size, :image_size]
+
+    def initialize(*args)
+      @configuration = Sevendigital::ClientConfiguration.new(*args)
+      yield @configuration if block_given?
+      @api_operator = hire_api_operator
+    end
+
+    def create_api_request(http_method, api_method, parameters, options = {})
+      parameters = options.merge(parameters)
+      parameters = add_default_parameters(parameters)
+      if http_method != :POST then
+        request = ApiRequest.new(http_method, api_method, parameters)
+      else
+        request = ApiRequest.new(http_method, api_method, {})
+        request.form_parameters = parameters
+      end
+      request
+    end
+
+    def make_api_request(http_method, api_method, parameters, options = {})
+      api_request = create_api_request(http_method, api_method, parameters, options)
+      operator.call_api(api_request)
+    end
+
+    def make_signed_api_request(http_method, api_method, parameters, options = {}, token = nil)
+      api_request = create_api_request(http_method, api_method, parameters, options)
+      api_request.require_signature
+      api_request.require_secure_connection
+      api_request.token = token
+
+      operator.call_api(api_request)
+    end
+
+    def oauth_consumer
+      host, version = api_host_and_version(:account)
+
+      consumer_options = {
+        :authorize_path     => "https://#{host}/#{version}/oauth/authorise",
+        :http_method   => :get
+      }
+
+      @oauth_consumer ||= OAuth::Consumer.new( \
+              @configuration.oauth_consumer_key, \
+              @configuration.oauth_consumer_secret, \
+              consumer_options \
+      )
+    end
+
+    def configuration
+      @configuration
+    end
+
+    def log(severity, &block)
+      if self.send("#{severity}?")
+        logger.info(yield) if block_given?
+      end
+    end
+
+    def operator
+      @api_operator
+    end
+
+    def verbose?
+     very_verbose? || !!@verbose || !!@configuration.verbose
+    end
+
+    def very_verbose?
+      @very_verbose || @configuration.verbose.to_s == "very_verbose"
+    end
+
+  #@private
+  def api_host_and_version(api_service=nil)
+     service = api_service && !api_service.to_s.empty? ? "#{api_service}_" : ""
+     [configuration.send("#{service}api_url".to_sym), configuration.send("#{service}api_version".to_sym)]
+  end
+
+  #@private
+  def user_agent_info
+    app_info = @configuration.app_name ? "/#{@configuration.app_name}" : nil
+    app_info += " #{@configuration.app_version}" if app_info && @configuration.app_version
+    "#{Sevendigital::NAME} Gem #{Sevendigital::VERSION}#{app_info}"
+  end
+
+  private
+
+    #@private
+    def default_parameters
+      params = {}
+      COMMON_REQUEST_PARAMETERS.each do |param|
+        value = @configuration.send(param)
+        params[param] = value if value
+      end
+      params
+    end
+
+    #@private
+    def hire_api_operator
+       @configuration.cache ? ApiOperatorCached.new(self, @configuration.cache) : ApiOperator.new(self)
+    end
+
+    #@private
+    def add_default_parameters(parameters)
+      params = parameters
+      default_parameters.each do |name, value|
+        params[name] ||= value
+      end
+      params
+    end
+
+    #@private
+    def logger
+      path = (@configuration.logfile_path.nil? || @configuration.logfile_path.blank?) ? STDOUT : @configuration.logfile_path
+      @logger ||= Logger.new(path)
+    end
+  end
+end