endeca_on_demand 1.0.1 → 1.1.0

data/endeca_on_demand.gemspec

@@ -20,6 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
   
   s.add_dependency 'nokogiri'
+  s.add_dependency 'builder'
+  s.add_dependency 'activesupport', '~> 3.1'
+  s.add_dependency 'i18n'
 end

data/lib/endeca_on_demand/client.rb

@@ -0,0 +1,24 @@
+class EndecaOnDemand::Client
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :api, :default_options ]; end
+
+  ## fields ##
+
+  attr_reader :api, :default_options, :query
+
+  def initialize(api, default_options = {})
+    @api, @default_options = api, default_options.dup.with_indifferent_access
+  end
+
+  ## associations ##
+
+  def query(options = {})
+    @query = nil if options.present?
+    @query ||= EndecaOnDemand::Query.new(self, options)
+  end
+
+  ##
+
+end

data/lib/endeca_on_demand/collection.rb

@@ -0,0 +1,41 @@
+class EndecaOnDemand::Collection < EndecaOnDemand::Proxy
+
+  attr_reader :klass, :target
+
+  def initialize(klass, target, mapping = nil)
+    @klass, @target = klass, target
+    @target = target.map { |object| @klass.new(mapping, object) } if mapping.present?
+    extend klass.collection_class if klass.respond_to?(:collection_class)
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Collection
+  end
+
+  def inspect
+    target.to_a.inspect
+  end
+
+  ##
+
+  def where(conditions = {})
+    target.select do |object|
+      conditions.all? do |key,value|
+        value.is_a?(Regexp) ? object.send(key) =~ value : object.send(key) == value
+      end
+    end
+  end
+
+  protected
+
+  def wrap_collection(collection)
+    EndecaOnDemand::Collection.new(klass, collection)
+  end
+
+  def method_missing(name, *args, &block)
+    target.send(name, *args, &block)
+  end
+
+end

data/lib/endeca_on_demand/pp.rb

@@ -0,0 +1,48 @@
+module EndecaOnDemand::PP
+
+  def inspect # :nodoc:
+    return super if not respond_to?(:inspect_attributes) or inspect_attributes.blank?
+    attributes = inspect_attributes.reject { |x|
+      begin
+        attribute = send x
+        attribute.blank?
+      rescue NoMethodError
+        true
+      end
+    }.map { |attribute|
+      "#{attribute.to_s.sub(/_\w+/, 's')}=#{send(attribute).inspect}"
+    }.join ' '
+    "#<#{self.class.name}:#{sprintf("0x%x", object_id)} #{attributes}>"
+  end
+
+  def pretty_print pp # :nodoc:
+    return super if not respond_to?(:inspect_attributes) or inspect_attributes.blank?
+    nice_name = self.class.name
+    pp.group(2, "#(#{nice_name}:#{sprintf("0x%x", object_id)} {", '})') do
+
+      pp.breakable
+      attrs = inspect_attributes.map { |t|
+        [t, send(t)] if respond_to?(t)
+      }.compact.find_all { |x|
+        x.last.present?
+      }
+
+      pp.seplist(attrs) do |v|
+        if v.last.class == EndecaOnDemand::Collection
+          pp.group(2, "#{v.first} = [", "]") do
+            pp.breakable
+            pp.seplist(v.last) do |item|
+              pp.pp item
+            end
+          end
+        else
+          pp.text "#{v.first} = "
+          pp.pp v.last
+        end
+      end
+      pp.breakable
+
+    end
+  end
+
+end

data/lib/endeca_on_demand/proxy.rb

@@ -1,11 +1,61 @@
-class EndecaOnDemand
-  class Proxy
-    
-    def method_missing(method, *args, &block)
-      unless self.instance_variables.include?(:"@#{method}")
-        "#{method} is unavailable."
+class EndecaOnDemand::Proxy
+
+  # We undefine most methods to get them sent through to the target.
+  instance_methods.each do |method|
+    undef_method(method) unless
+      method =~ /(^__|^send$|^object_id$|^extend$|^respond_to\?$|^tap$|^inspect$|^pretty_)/
+  end
+
+  attr_accessor :xml
+
+  # def inspect
+  #   respond_to?(:inspection) ?
+  #     "#<#{self.class.name} #{inspection.kind_of?(Hash) ? inspection.inspect : (inspection * ', ')}>" :
+  #     super
+  # end
+
+  def inspect # :nodoc:
+    return super if not respond_to?(:inspect_attributes) or inspect_attributes.blank?
+    attributes = inspect_attributes.reject { |x|
+      begin
+        attribute = send x
+        attribute.blank?
+      rescue NoMethodError
+        true
       end
-    end
-    
+    }.map { |attribute|
+      "#{attribute.to_s.sub(/_\w+/, 's')}=#{send(attribute).inspect}"
+    }.join ' '
+    "#<#{self.class.name}:#{sprintf("0x%x", object_id)} #{attributes}>"
+  end
+
+  # def pretty_inspect
+  #   respond_to?(:inspection) ?
+  #     "#(#{self.class.name} {\n  #{inspection.pretty_inspect}\n})" :
+  #     super
+  # end
+
+  # def inspect
+  #   inspection = []
+  #   inspection.concat(options.dup.delete_if { |k,v| v.blank? }.sort_by(&:first).map { |k,v| "#{k}: #{v.inspect}" })
+  #   "#<#{self.class.name} #{inspection * ', '}>"
+  # end
+
+  protected
+
+  # Default behavior of method missing should be to delegate all calls
+  # to the target of the proxy. This can be overridden in special cases.
+  #
+  # @param [ String, Symbol ] name The name of the method.
+  # @param [ Array ] *args The arguments passed to the method.
+  def method_missing(name, *args, &block)
+    xml.send(name, *args, &block)
   end
+
+  # def method_missing(method, *args, &block)
+  #   unless self.instance_variables.include?(:"@#{method}")
+  #     "#{method} is unavailable."
+  #   end
+  # end
+  
 end

data/lib/endeca_on_demand/query.rb

@@ -0,0 +1,187 @@
+class EndecaOnDemand::Query
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :uri, :xml, :errors, :options ]; end
+
+  ## fields ##
+
+  attr_reader :body, :client, :errors, :http, :options, :response, :uri, :xml
+
+  def initialize(client, options = {})
+    @client, @options = client, options.dup.with_indifferent_access
+
+    process_options!
+  end
+
+  ## associations ##
+
+  def body
+    @body ||= to_xml
+  end
+
+  def http
+    @http ||= Net::HTTP.new(uri.host, uri.port)
+  end
+
+  def response
+    @response ||= EndecaOnDemand::Response.new(self, http.post(uri.path, body, 'Content-type' => 'application/xml'))
+  end
+
+  def uri
+    @uri ||= URI.parse(client.api)
+  end
+
+  def xml
+    @xml ||= Nokogiri::XML(body) { |config| config.strict.noblanks }
+  end
+
+  ##
+
+  ## xml builder ##
+
+  def to_xml
+    Builder::XmlMarkup.new(indent: 2).tag!(:Query) do |xml|
+
+      Flags(xml)
+      KeywordSearch(xml)
+      NavigationQuery(xml)
+      CategoryNavigationQuery(xml)
+      Sorting(xml)
+      Paging(xml)
+      AdvancedParameters(xml)
+
+    end
+  #   @query.Query do
+  #     @query << @body.target!
+  #   end
+    
+  #   begin
+  #     # ask Domino what this is?
+  #     # @request, @raw_response = @http.post(@uri.path, @query.target!, 'Content-type' => 'application/xml')
+
+  #     @response = Nokogiri::XML(fetch_response.body)
+
+  #     build_records
+  #     build_breadcrumbs
+  #     build_dimensions
+  #     build_business_rules
+  #     build_search_reports
+  #     build_selected_dimension_value_ids
+  #     build_keyword_redirect
+  #   rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
+  #     @error = error
+  #   end
+  end
+
+  ### data ###
+
+  def flags
+    @flags ||= options[:flags] = (options[:flags] || {}).inject({}.with_indifferent_access) do |hash,(key,value)|
+        hash.tap do
+          hash[key.to_s.underscore] = value
+        end
+      end
+  end
+
+  def searches
+    @searches ||= options[:searches]
+  end
+
+  def dimensions
+    @dimensions ||= [*options[:dimensions]]
+  end
+
+  def category
+    @category ||= options[:category]
+  end
+
+  def sorts
+    @sorts ||= options[:sorts]
+  end
+
+  def paging
+    @paging ||= options[:paging] = (options[:paging] || {}).tap do |paging|
+        if paging.has_key?(:page) and paging.has_key?(:per_page)
+          paging[:offset] = (paging[:page].to_i * paging[:per_page].to_i rescue 0)
+        end
+      end
+  end
+
+  def advanced_parameters
+    @advanced_parameters ||= options[:advanced] = (options[:advanced] || {}).inject({}.with_indifferent_access) do |hash,(key,value)|
+        hash.tap do
+          hash[key.to_s.underscore] = value
+        end
+      end
+  end
+
+  ###
+
+  protected
+
+  def Flags(xml)
+    return if flags.blank?
+    flags.each do |flag,value|
+      xml.tag!(flag.to_s.camelcase, value)
+    end
+  end
+
+  def KeywordSearch(xml)
+    return if searches.blank?
+    xml.tag!(:Searches) do
+      searches.each do |key,term|
+        xml.tag!(:Search) do
+          xml.tag!('search-key',  key)
+          xml.tag!('search-term', term)
+        end
+      end
+    end
+  end
+
+  def NavigationQuery(xml)
+    return if dimensions.blank?
+    xml.tag!(:SelectedDimensionValueIds) do
+      dimensions.each do |dimension|
+        xml.tag!(:DimensionValueId, dimension)
+      end
+    end
+  end
+
+  def CategoryNavigationQuery(xml)
+    return if category.blank?
+    xml.tag!(:Category) do
+      xml.tag!(:CategoryId, category)
+    end
+  end
+
+  def Sorting(xml)
+    return if sorts.blank?
+    xml.tag!(:Sorts) do
+      sorts.each do |key,direction|
+        xml.tag!(:Sort) do
+          xml.tag!('sort-key',       key)
+          xml.tag!('sort-direction', direction.to_s.capitalize)
+        end
+      end
+    end
+  end
+
+  def Paging(xml)
+    return if paging.blank?
+    xml.tag!(:RecordOffset,   paging[:offset])   if paging.has_key?(:offset)
+    xml.tag!(:RecordsPerPage, paging[:per_page]) if paging.has_key?(:per_page)
+  end
+
+  def AdvancedParameters(xml)
+
+  end
+
+  def process_options!
+    default_options = client.default_options[:query] || {}
+    @options = default_options.dup.merge(options)
+  end
+
+  ##
+
+end

data/lib/endeca_on_demand/response/applied_filters/keyword_redirect.rb

@@ -0,0 +1,42 @@
+class EndecaOnDemand::Response::AppliedFilters::KeywordRedirect < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :options ]; end
+
+  ## fields ##
+
+  attr_reader :applied_filters
+
+  def initialize(applied_filters, xml)
+    @applied_filters, @xml = applied_filters, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::AppliedFilters::KeywordRedirect
+  end
+
+  ##
+
+  ## data ##
+
+  def options
+    @options ||= xml.children.inject({}.with_indifferent_access) do |hash,child|
+      hash.tap do
+        hash[child.name] = child.content
+      end
+    end
+  end
+
+  ##
+
+  protected
+
+  def method_missing(method, *args, &block)
+    return options[method] if @options.present? and options.has_key?(method)
+    super(method, *args, &block)
+  end
+
+end

data/lib/endeca_on_demand/response/applied_filters/search_report/search.rb

@@ -0,0 +1,42 @@
+class EndecaOnDemand::Response::AppliedFilters::SearchReport::Search < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :options ]; end
+
+  ## fields ##
+
+  attr_reader :search_report
+
+  def initialize(search_report, xml)
+    @search_report, @xml = search_report, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::AppliedFilters::SearchReport::Search
+  end
+
+  ##
+
+  ## data ##
+
+  def options
+    @options ||= xml.children.inject({}.with_indifferent_access) do |hash,child|
+      hash.tap do
+        hash[child.name] = child.content
+      end
+    end
+  end
+
+  ##
+
+  protected
+
+  def method_missing(method, *args, &block)
+    return options[method] if @options.present? and options.has_key?(method)
+    super(method, *args, &block)
+  end
+
+end

data/lib/endeca_on_demand/response/applied_filters/search_report.rb

@@ -0,0 +1,50 @@
+class EndecaOnDemand::Response::AppliedFilters::SearchReport < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :options, :search ]; end
+
+  ## fields ##
+
+  attr_reader :applied_filters, :search
+  
+  def initialize(applied_filters, xml)
+    @applied_filters, @xml = applied_filters, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::AppliedFilters::SearchReport
+  end
+
+  ##
+
+  ## associations ##
+
+  def search
+    @search ||= EndecaOnDemand::Response::AppliedFilters::SearchReport::Search.new(self, xml.children.css('Search'))
+  end
+
+  ##
+
+  ## data ##
+
+  def options
+    @options ||= xml.xpath('child::node()[not(local-name() = "Search")]').inject({}.with_indifferent_access) do |hash,child|
+      hash.tap do
+        hash[child.name] = child.content
+      end
+    end
+  end
+
+  ##
+
+  protected
+
+  def method_missing(method, *args, &block)
+    return options[method] if @options.present? and options.has_key?(method)
+    super(method, *args, &block)
+  end
+
+end

data/lib/endeca_on_demand/response/applied_filters/selected_dimension_value_id.rb

@@ -0,0 +1,32 @@
+class EndecaOnDemand::Response::AppliedFilters::SelectedDimensionValueId < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :value ]; end
+
+  ## fields ##
+
+  attr_reader :applied_filters
+
+  def initialize(applied_filters, xml)
+    @applied_filters, @xml = applied_filters, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::AppliedFilters::SelectedDimensionValueId
+  end
+
+  ##
+
+  ## data ##
+
+  def to_s
+    xml.content
+  end
+  alias :value :to_s
+
+  ##
+  
+end

data/lib/endeca_on_demand/response/applied_filters.rb

@@ -0,0 +1,39 @@
+class EndecaOnDemand::Response::AppliedFilters < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :keyword_redirects, :search_reports, :selected_dimension_value_ids ]; end
+
+  ## fields ##
+
+  attr_reader :response, :search_reports
+
+  def initialize(response, xml)
+    @response, @xml = response, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::AppliedFilters
+  end
+
+  ##
+
+  ## associations ##
+
+  def search_reports
+    @search_reports ||= EndecaOnDemand::Collection.new(EndecaOnDemand::Response::AppliedFilters::SearchReport, xml.children.css('SearchReports > SearchReport'), self)
+  end
+
+  def selected_dimension_value_ids
+    @selected_dimension_value_ids ||= EndecaOnDemand::Collection.new(EndecaOnDemand::Response::AppliedFilters::SelectedDimensionValueId, xml.children.css('SelectedDimensionValueIds > DimensionValueId'), self)
+  end
+
+  def keyword_redirects
+    @keyword_redirects ||= EndecaOnDemand::Collection.new(EndecaOnDemand::Response::AppliedFilters::KeywordRedirect, xml.children.css('KeywordRedirects'), self)
+  end
+
+  ##
+  
+end

data/lib/endeca_on_demand/response/breadcrumb/bread.rb

@@ -0,0 +1,42 @@
+class EndecaOnDemand::Response::Breadcrumb::Bread < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :options ]; end
+
+  ## fields ##
+
+  attr_reader :breadcrumb
+
+  def initialize(breadcrumb, xml)
+    @breadcrumb, @xml = breadcrumb, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::Breadcrumb::Bread
+  end
+
+  ##
+
+  ## data ##
+
+  def options
+    xml.children.inject({}.with_indifferent_access) do |hash,child|
+      hash.tap do
+        hash[child.name] = child.content
+      end
+    end
+  end
+
+  ##
+
+  protected
+
+  def method_missing(method, *args, &block)
+    return options[method] if options.has_key?(method)
+    super(method, *args, &block)
+  end
+  
+end

data/lib/endeca_on_demand/response/breadcrumb.rb

@@ -0,0 +1,35 @@
+class EndecaOnDemand::Response::Breadcrumb < EndecaOnDemand::Proxy
+
+  include EndecaOnDemand::PP
+
+  def inspect_attributes; [ :breads ]; end
+
+  ## fields ##
+
+  attr_reader :response
+
+  def initialize(response, xml)
+    @response, @xml = response, xml
+  end
+
+  ## override proxy ##
+
+  def class
+    EndecaOnDemand::Response::Breadcrumb
+  end
+
+  # def inspection
+  #   [ "breads: #{breads.inspect}" ]
+  # end
+
+  ##
+
+  ## associations ##
+
+  def breads
+    @breads ||= EndecaOnDemand::Collection.new(EndecaOnDemand::Response::Breadcrumb::Bread, xml.children.css('Bread'), self)
+  end
+
+  ##
+  
+end