7digital 0.0.5 → 0.0.6

data/lib/sevendigital/api_operator_cached.rb

@@ -1,29 +1,41 @@
-module Sevendigital
-
-#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)
-    request_cache_key = create_request_uri(api_request)
-    api_response = @cache.get(request_cache_key.to_s) if !api_request.requires_signature?
-    puts "ApiOperatorCached: Got from cache #{request_cache_key}" if @client.verbose? && api_response
-    puts "but the response is out of date" if @client.verbose? && api_response && api_response.out_of_date?
-    if (!api_response || api_response.out_of_date?) then
-      api_response = make_http_request_and_digest(api_request)
-      @cache.set(request_cache_key.to_s, api_response) if !api_request.requires_signature?
-    end
-    p api_response if @client.very_verbose?
-    api_response
-  end
-
-end
-
-end
+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)
+    request_cache_key = create_request_uri(api_request)
+    http_response = @cache.get(request_cache_key.to_s) if !api_request.requires_signature?
+    puts "ApiOperatorCached: Got from cache #{request_cache_key}" if @client.verbose? && http_response
+    puts "but the response is out of date" if @client.verbose? && http_response && response_out_of_date?(http_response)
+    if (!http_response || response_out_of_date?(http_response)) then
+      http_response = make_http_request(api_request)
+      @cache.set(request_cache_key.to_s, http_response) if !api_request.requires_signature?
+    end
+    api_response = digest_http_response(http_response)
+    p api_response if @client.very_verbose?
+    api_response
+  end
+
+  def response_out_of_date?(http_response, current_time=nil)
+    return true if http_response.header.nil? || http_response.header["Date"].nil? || http_response.header["cache-control"].nil?
+    puts "cache headers present"
+    return true if  !(http_response.header["cache-control"] =~ /max-age=([0-9]+)/)
+    current_time ||= Time.now.utc
+    response_time = Time.parse(http_response.header["Date"])
+    max_age = /max-age=([0-9]+)/.match(http_response.header["cache-control"])[1].to_i
+    response_time + max_age < current_time
+  end
+
+end
+
+end

data/lib/sevendigital/api_request.rb

@@ -1,65 +1,66 @@
-module Sevendigital
-
-#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(api_method, parameters, options={})
-    @api_method = api_method
-    @parameters = parameters
-    @signature_scheme = :header
-    @http_method = :GET
-    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
-
+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

data/lib/sevendigital/client.rb

@@ -1,98 +1,113 @@
-module Sevendigital
-
-  class Client
-
-  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 default_parameters
-      params = {}
-      COMMON_REQUEST_PARAMETERS.each do |param|
-        value = @configuration.send(param)
-        params[param] = value if value
-      end
-      params
-    end
-  
-    def hire_api_operator
-       @configuration.cache ? ApiOperatorCached.new(self, @configuration.cache) : ApiOperator.new(self)
-    end
-
-    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
-
-    def create_api_request(api_method, parameters, options = {})
-      parameters = options.merge(parameters)
-      parameters = add_default_parameters(parameters)
-      ApiRequest.new(api_method, parameters)
-    end
-
-    def make_api_request(api_method, parameters, options = {})
-      api_request = create_api_request(api_method, parameters, options)
-      operator.call_api(api_request)
-    end
-
-    def make_signed_api_request(api_method, parameters, options = {}, token = nil)
-      api_request = create_api_request(api_method, parameters, options)
-      api_request.require_signature
-      api_request.require_secure_connection
-      api_request.token = token
-
-      operator.call_api(api_request)
-    end
-
-    def add_default_parameters(parameters)
-      params = parameters
-      default_parameters.each do |name, value|
-        params[name] ||= value
-      end
-      params
-    end
-
-    def api_host_and_version(api_service=nil)
-       service = api_service && !api_service.to_s.empty? ? "#{api_service}_" : ""
-       return configuration.send("#{service}api_url".to_sym), configuration.send("#{service}api_version".to_sym)
-    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
-      return @configuration
-    end
-
-    def operator
-      @api_operator
-    end
-
-    def verbose?
-      !(@verbose || @configuration.verbose).nil?
-    end
-
-    def very_verbose?
-      verbose? && (@verbose || @configuration.verbose).to_s == "very_verbose"
-    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
+      return @configuration
+    end
+
+    def operator
+      @api_operator
+    end
+
+    def verbose?
+     !!(@verbose || @configuration.verbose)
+    end
+
+    def very_verbose?
+      verbose? && (@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}_" : ""
+     return 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
+
+
+  end
+
+end

data/lib/sevendigital/client_configuration.rb

@@ -1,86 +1,86 @@
-require 'ostruct'
-require 'yaml'
-
-module Sevendigital
-
-  DEFAULT_CONFIGURATION = {
-      :api_url =>  "api.7digital.com",
-      :api_version => "1.2",
-      :media_api_url =>  "media-eu.7digital.com",
-      :media_api_version => "media",
-      :account_api_url =>  "account.7digital.com",
-      :account_api_version => "web"
-    }.freeze
-  
-  class ClientConfiguration < OpenStruct
-
-    def initialize(*args)
-
-      super()
-
-      self.override_with(Sevendigital::DEFAULT_CONFIGURATION)
-
-      self.override_with(default_configuration_file)
-
-      args.each do |configuration_argument|
-        self.override_with(configuration_argument)
-      end
-      puts "Now: #{self.inspect}"
-  
-    end
-
-    def override_with(configuration)
-      puts "Now: #{self.inspect}"
-      puts "Overriding with #{configuration.class}: #{configuration.inspect}"
-      return self unless configuration
-      if configuration.kind_of? Hash then
-        table.merge!(configuration)
-        return self
-      end
-      if configuration.kind_of? OpenStruct then
-        table.merge!(configuration.marshal_dump)
-        return self
-      end
-      if (configuration.kind_of? String) && is_it_yml_file?(configuration) then
-        table.merge!(load_configuration_from_yml(configuration, current_environment))
-        return self
-      end
-
-    end
-    
-    def default_configuration_file
-      return nil unless defined?(RAILS_ROOT)
-      "#{RAILS_ROOT}/config/sevendigital.yml"
-    end
-
-    def current_environment
-      defined?(RAILS_ENV) ? RAILS_ENV  : nil
-    end
-
-    def load_configuration_from_yml(file_name, environment=nil)
-      plain_settings = transform_keys_to_symbols(YAML.load_file(file_name))
-      if (plain_settings[:common] || (environment && plain_settings[environment.to_sym])) then
-        environment_settings = plain_settings[:common] || {}
-        environment_settings.update(plain_settings[environment.to_sym]) if environment
-        environment_settings
-      else
-        plain_settings
-      end
-    end
-
-    private
-
-    def is_it_yml_file?(file_name)
-      file_name.include?('.yml')
-    end
-
-    def transform_keys_to_symbols(hash)
-      return hash if not hash.is_a?(Hash)
-      new_hash = hash.inject({}){|memo,(k,v)| memo[k.to_sym] = transform_keys_to_symbols(v); memo}
-      return new_hash
-    end
-
-
-  end
-
-end
+require 'ostruct'
+require 'yaml'
+
+module Sevendigital
+
+  DEFAULT_CONFIGURATION = {
+      :api_url =>  "api.7digital.com",
+      :api_version => "1.2",
+      :media_api_url =>  "media-eu.7digital.com",
+      :media_api_version => "media",
+      :account_api_url =>  "account.7digital.com",
+      :account_api_version => "web"
+    }.freeze
+  
+  class ClientConfiguration < OpenStruct
+
+    def initialize(*args)
+
+      super()
+
+      self.override_with(Sevendigital::DEFAULT_CONFIGURATION)
+
+      self.override_with(default_configuration_file)
+
+      args.each do |configuration_argument|
+        self.override_with(configuration_argument)
+      end
+      #puts "Now: #{self.inspect}"
+  
+    end
+
+    def override_with(configuration)
+      #puts "Now: #{self.inspect}"
+      #puts "Overriding with #{configuration.class}: #{configuration.inspect}"
+      return self unless configuration
+      if configuration.kind_of? Hash then
+        table.merge!(configuration)
+        return self
+      end
+      if configuration.kind_of? OpenStruct then
+        table.merge!(configuration.marshal_dump)
+        return self
+      end
+      if (configuration.kind_of? String) && is_it_yml_file?(configuration) then
+        table.merge!(load_configuration_from_yml(configuration, current_environment))
+        return self
+      end
+
+    end
+    
+    def default_configuration_file
+      return nil unless defined?(RAILS_ROOT)
+      "#{RAILS_ROOT}/config/sevendigital.yml"
+    end
+
+    def current_environment
+      defined?(RAILS_ENV) ? RAILS_ENV  : nil
+    end
+
+    def load_configuration_from_yml(file_name, environment=nil)
+      plain_settings = transform_keys_to_symbols(YAML.load_file(file_name))
+      if (plain_settings[:common] || (environment && plain_settings[environment.to_sym])) then
+        environment_settings = plain_settings[:common] || {}
+        environment_settings.update(plain_settings[environment.to_sym]) if environment
+        environment_settings
+      else
+        plain_settings
+      end
+    end
+
+    private
+
+    def is_it_yml_file?(file_name)
+      file_name.include?('.yml')
+    end
+
+    def transform_keys_to_symbols(hash)
+      return hash if not hash.is_a?(Hash)
+      new_hash = hash.inject({}){|memo,(k,v)| memo[k.to_sym] = transform_keys_to_symbols(v); memo}
+      return new_hash
+    end
+
+
+  end
+
+end