endeca_xml 0.8.0 → 0.9.0

data/README.rdoc

@@ -1,135 +1,15 @@
 = endeca_xml
 
-endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
-
-== Features
-
-* Builds an XML query, formatted to thanxmedia specifications, from a query string
-* Parses the settings parameters and sends a completed XML query to thanxmedia API
-* Handles the response XML and exposes methods to retrieve response data
-
-== Install
-
-=== Rails
-
-Add this line to your Gemfile:
-
- gem 'endeca_xml'
-
-Then bundle install:
-
- bundle install
-
----
-
-=== Non Rails
-
- gem install endeca_xml
-
-== Usage
-
-A restructure has been done since previous versions. endeca_xml now constructs an XML query to send to thanxmedia via a query string:
-
-  <a href='.../url?search-key=primary&search-term=name&DimensionValueIds=1,2,3,4&sort-key=name&sort-direction=descending&RecordOffset=0&RecordsPerPage=9&AggregationKey=name&UserProfiles=1,2,3,4&filter=between'>FULL ENDECA REQUEST</a>
-
-The following is an example of an empty 'options' hash that would then need to be constructed from a query string, and sent to the module (any static values are added before, and not from a query string):
-
-  host = 'your/thanxmedia/api/url'
-  options = {
-              'add_base'                          => {'RecordsSet' => false, 'Dimensions' => true, 'BusinessRulesResult' => false, 'AppliedFilters' => true},
-              'add_keyword_search'                => {},
-              'add_dimension_value_id_navigation' => {},
-              'add_category_navigation_query'     => "current_category_id",
-              'add_sorting'                       => {},
-              'add_paging'                        => {},
-              'add_advanced_parameters'           => {},
-              'add_profiles'                      => {},
-              'add_filters'                       => {}
-            }
-            
-The following is what a prepared 'options' hash would look like, that is then passed into the module, using the above example query string:
-
-  options = {
-              'add_base'                          => {'RecordsSet' => true, 'Dimensions' => true, 'BusinessRulesResult' => true, 'AppliedFilters' => true},
-              'add_keyword_search'                => {'searh-key => 'key', search-term => 'term'},
-              'add_dimension_value_id_navigation' => {[1, 2, 3, 4]},
-              'add_category_navigation_query'     => 1,
-              'add_sorting'                       => {'sort-key' => 'key', 'sort-direction' => 'Descending'},
-              'add_paging'                        => {'RecordOffset' => 0, 'RecordsPerPage' => 9},
-              'add_advanced_parameters'           => {'AggregationKey' => 'key'},
-              'add_profiles'                      => {[1, 2, 3, 4]},
-              'add_filters'                       => {}
-            }
-            
-NOTE: add_dimension_value_id_navigation and add_category_navigation_query are mutually exclusive (the example doesn't reflect that)
-  
-This example is a complete example. It is not necessary to include anything that you don't intend to use (ie. blank or empty hash's/values). If you don't need an option, don't include the query string, and if you don't need a value within an option don't include it.
-
-This is the command that would then send the above request:
-  EndecaXml.new(host, options)
-
-Below are (ruby/rails) examples of how you could access the response data:
-
-Records:
-
-  EndecaXml.records.each do |record|
-    puts "---------- BEGIN RECORD"
-    puts "RECORD: #{record.inspect}"
-    puts "---------- END"
-  end
-
-Breadcrumbs:
-
-  EndecaXml.breadcrumbs.each do |crumb|
-    puts "---------- BEGIN CRUMB"
-    puts "CRUMB: #{crumb.inspect}"
-    puts "---------- END"
-  end
-
-Dimensions:
-
-  EndecaXml.dimensions.each do |dimension|
-    puts "---------- BEGIN DIMENSION"
-    puts "DIMENSION: #{dimension.inspect}"
-    puts "DIMENSION VALUES: #{dimension.dimensionvalues}"
-    puts "DIMENSION VALUES ARRAY: #{dimension.dimension_values}"
-    puts "---------- END"
-  end
-
-Rules:
-
-  EndecaXml.rules.each do |rule|
-    puts "---------- BEGIN RULE"
-    puts "RULE: #{rule.inspect}"
-    puts "RULE PROPERTIES: #{rule.properties}"
-    puts "RULE PROPERTIES_ARRAY: #{rule.properties_array}"
-    puts "RULE RECORDS: #{rule.records}"
-    puts "---------- END"
-  end
-
-Filters:
-
-  EndecaXml.filters.each do |filter|
-    puts "---------- BEGIN FILTER"
-    puts "FILTER: #{filter.inspect}"
-    puts "---------- END"
-  end
-  
-Each object will have associated instance variables that will allow you directly call any value on that object (the values below aren't actual response values):
-
-  EndecaXml.records.each do |record|
-    record.name
-    record.price
-    etc...
-  end
+This has since been renamed to endeca_on-demand and moved to that repo. Feel free to continue using this functioning, nearly complete version, or the awesome new, and complete, release version.
 
 == TODO
 
 * (complete) Pass all parameters into the initializer and have EndecaXml deconstruct the url and reconstruct it as XML rather than having the developer use each method individually.
 * (complete) Have EndecaXml make the request after its all done constructing the query rather than requiring that the developer use the request method.
-* Review the code and clean things up, making it nice and sugary sweet.
-* The add_filters method needs some documentation, an example, and to be tested in a query.
-* It occurred to me that the name is a little too ambiguous as this gem deals more specifically with thanxmedia's XML API and not Endeca directly, so a change of name is in order
+* (complete) Review the code and clean things up, making it nice and sugary sweet.
+* (complete) The add_filters method needs some documentation, an example, and to be tested in a query.
+* (complete) It occurred to me that the name is a little too ambiguous as this gem deals more specifically with thanxmedia's XML API and not Endeca directly, so a change of name is in order
+* (complete) Build in the assumption that the first index in the breadcrumbs array is the category/grouping, and the following indexes are values associated with that title (for left nav filters)
 
 == Copyright
 

data/endeca_xml.gemspec

@@ -9,13 +9,12 @@ Gem::Specification.new do |s|
   s.authors     = ['sdomino']
   s.email       = ['sdomino@pagodabox.com']
   s.homepage    = 'http://github.com/sdomino/endeca_xml'
-  s.summary     = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
-  s.description = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
+  s.summary     = 'This has been officially released as endeca_on_demand. Feel free to continue using this functioning, nearly complete version, or the awesome new, and complete, release version.'
+  s.description = 'This has been officially released as endeca_on_demand. Feel free to continue using this functioning, nearly complete version, or the awesome new, and complete, release version.'
 
   s.rubyforge_project = 'endeca_xml'
 
-  # s.add_dependency 'crack' # This was my initial choice for parsing xml but sadly I had to remove it because it messes with mongoid (see issue 20 at github).
-  s.add_dependency 'crackoid' # So I just fixed it :). I'll use crack again if he accepts my pull request.
+  s.add_dependency 'crackoid'
 
   s.add_development_dependency 'rspec'
 

data/lib/endeca_xml.rb

@@ -1,36 +1,18 @@
 Dir["#{File.dirname(__FILE__)}/endeca_xml/*"].each { |file| require(file)}
 
 require 'builder'
-# require 'crack' # NOTE: see .gemspec
 require 'crackoid'
 require 'net/http'
 require 'uri'
 
-# <a href='.../url?search-key=primary&search-term=name&DimensionValueIds=1,2,3,4&sort-key=name&sort-direction=descending&RecordOffset=0&RecordsPerPage=9&AggregationKey=name&UserProfiles=1,2,3,4&filter=between'>FULL ENDECA REQUEST</a>
-
-# host = 'http://eodhc.endecaondemand.net:30858/ws/main'
-# options = {
-#             'add_base'                          => {'RecordsSet' => true, 'Dimensions' => true, 'BusinessRulesResult' => true, 'AppliedFilters' => true},
-#             'add_keyword_search'                => {'searh-key => 'key', search-term => 'term'},
-#             'add_dimension_value_id_navigation' => {[1, 2, 3, 4]},
-#             'add_category_navigation_query'     => 1,
-#             'add_sorting'                       => {'sort-key' => 'key', 'sort-direction' => 'Descending'},
-#             'add_paging'                        => {'RecordOffset' => 0, 'RecordsPerPage' => 9},
-#             'add_advanced_parameters'           => {'AggregationKey' => 'key'},
-#             'add_profiles'                      => {[1, 2, 3, 4]},
-#             'add_filters'                       => {}
-#           }
-
 class EndecaXml
 
   def initialize(host, options)
     @body = Builder::XmlMarkup.new(:indent => 2)
-    
+
     #
     set_host(host)
     
-    puts "OPTIONS: #{options}"
-    
     #
     options.each do |key, value|
       self.send(key.to_sym, value) unless value.empty?
@@ -42,77 +24,61 @@ class EndecaXml
   
   ### API
   
-  def records
-    @records
-  end
+  attr_reader :records, :record_offset, :records_per_page, :total_record_count
+  attr_reader :breadcrumbs, :filtercrumbs
+  attr_reader :dimensions
+  attr_reader :rules
+  attr_reader :searchs, :matchedrecordcount, :matchedmode, :applied_search_adjustments, :suggested_search_adjustments
+  attr_reader :selected_dimension_value_ids
   
-  def breadcrumbs
-    @breadcrumbs
-  end
+    ## DEBUG
+    attr_reader :uri, :http
+    attr_reader :base, :query, :response
+    ## /DEBUG
   
-  def dimensions
-    @dimensions
-  end
-  
-  def rules
-    @business_rules
-  end
-  
-  def search_reports
-    @search_reports
-  end
-  
-  def selected_dimension_value_ids
-    @selected_dimension_value_ids
-  end
+  ### /API
   
   private
   
   ### XML REQUEST ###
   
-  ## 
+  ## SET REQUEST HOST
   def set_host(host)
-    # puts "HOST: #{host}"
     @uri  = URI.parse(host)
     @http = Net::HTTP.new(@uri.host, @uri.port)
-    # puts "URI: #{@uri}"
-    # puts "HTTP: #{@http}"
   end
   
-  ## 
+  ## ADD BASE OPTIONS TO REQUEST
   def add_base(options)
-    # puts "BASE: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
-    # print @body.target!
+    
+    @base = options
   end
   
   ## BUILD REQUEST BODY
   
-  # mutually exclusive to add_category_navigation_query
+  # Adds dimension_value_id_navigation to the request via one or more DimensionValueIds (DVID).
+  # NOTE: If the optional CategoryId (CID) is passed, all DVIDs must belong to the category.
   def add_dimension_value_id_navigation(options)
-    # puts "DIMENSIONS: #{options}"
     @body.SelectedDimensionValueIds do
       options.each do |dimension|
         @body.tag!('DimensionValueId', dimension)
       end
     end
-    # puts @body.target!
   end
   
-  # mutually exclusive to dimension_value_id_navigation
+  # (OPTIONAL) Adds category_navigation_query to the request via a CID.
+  # NOTE: If a CID is passed, all DVIDs must belong to the category. Passing a DVID that does not belong to this category will result in an endeca response error.
   def add_category_navigation_query(options)
-    # puts "CATEGORY: #{options}"
     @body.Category do
       @body.tag!('CategoryId', options)
     end
-    # puts @body.target!
   end
   
-  # 
+  # Adds search-key and search-term to the request.
   def add_keyword_search(options)
-    # puts "SEARCH: #{options}"
     @body.Searches do
       @body.Search do
         options.each do |key, value|
@@ -120,12 +86,10 @@ class EndecaXml
         end
       end
     end
-    # puts @body.target!
   end
   
-  #
+  # Adds sort-key and sort-direction to the request.
   def add_sorting(options)
-    # puts "SORT: #{options}"
     @body.Sorts do
       @body.Sort do
         options.each do |key, value|
@@ -133,36 +97,30 @@ class EndecaXml
         end
       end
     end
-    # puts @body.target!
   end
   
-  #
+  # Adds RecordOffset and RecordsPerPage to the request.
   def add_paging(options)
-    # puts "PAGING: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
-    # puts @body.target!
   end
   
-  #
+  # Adds advanced parameters to the request.
+  # NOTE: For this implementation I only had the default advanced parameter (AggregationKey) to test with. This has not been tested, and most likely will not work, with any other possible advanced parameters (if any)
   def add_advanced_parameters(options)
-    # puts "PARAMETERS: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
-    # puts @body.target!
   end
   
-  #
+  # Adds UserProfile(s) to the request.
   def add_profiles(options)
-    # puts "PROFILES: #{options}"
     @body.UserProfiles do
       options.each do |profile|
         @body.tag!('UserProfile', profile)
       end
     end
-    # puts @body.target!
   end
   
   #
@@ -181,108 +139,96 @@ class EndecaXml
     # puts @body.target!
   end
   
-  # complete the endeca XML reqeust and send the request to the endeca API
+  ## SEND REQUEST
+  
+  # Completes the endeca XML reqeust by inserting the XML body into the requred 'Query' tags, and sends the request to your hosted Endeca On-Demand Web API
   def send_request
-    # insert all of the XML blocks that have been included in the request into the endeca Query XML tag
-    query = Builder::XmlMarkup.new(:indent => 2)
-    query.Query do
-      query << @body.target!
+    @query = Builder::XmlMarkup.new(:indent => 2)
+    @query.Query do
+      @query << @body.target!
     end
-
-    puts "QUERY: #{query.target!}"
-
+    
     begin
-      request, response = @http.post(@uri.path, query.target!, 'Content-type' => 'application/xml')
+      request, response = @http.post(@uri.path, @query.target!, 'Content-type' => 'application/xml')
       handle_response(Crackoid::XML.parse(response))
     rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => error
       puts "ERROR: #{error.message}"
     end
   end
+  
+  ## HANDLE RESPONSE
 
-  # get the request response and parse it into an hash
   def handle_response(response)
-    puts "RESPONSE: #{response}"
     @response = response['Final']
-
     build_data
   end
   
   def build_data
     build_records
     build_breadcrumbs
+    build_filtercrumbs
     build_dimensions
     build_business_rules
-    build_search_reports
-    build_selected_dimension_value_ids
+    build_applied_filters
   end
   
-  # builds the RECORDS hash
+  # Builds an array of RECORDS
   def build_records
-    puts "RECORDS SET: #{@response['RecordsSet']}"
-    
-    # NOTE: this may need to be reworked a little. look in recordset for nodes that our outside of records...
     @records = []
-    unless @response['RecordsSet'].nil?
-      if @response['RecordsSet']['Record'].instance_of?(Hash)
-        @records.push(EndecaXml::Record.new(@response['RecordsSet']))
-      elsif @response['RecordsSet']['Record'].instance_of?(Array)
-        @response['RecordsSet']['Record'].each do |record|
+    
+    record_set = @response['RecordsSet']
+    
+    @record_offset = record_set.fetch('offset')
+    @records_per_page = record_set.fetch('recordsperpage')
+    @total_record_count = record_set.fetch('totalrecordcount')
+    
+    unless record_set.nil?
+      record = @response['RecordsSet']['Record']
+      if record.instance_of?(Hash)
+        @records.push(EndecaXml::Record.new(record_set))
+      elsif record.instance_of?(Array)
+        record.each do |record|
           @records.push(EndecaXml::Record.new(record))
         end
-      else
-        puts "This record is a(n): #{@response['RecordsSet'].class}"
       end
     else
       puts 'There are no records with this response!'
     end
   end
   
-  # builds the BREADCRUMBS hash
+  # Builds an array of BREADCRUMBS
   def build_breadcrumbs
-    @breadcrumbs = []
+    @breadcrumbs  = []
     
-    # puts "BREADCRUMBS: #{@response['Breadcrumbs'}"
     breadcrumbs = @response['Breadcrumbs']
     unless breadcrumbs.nil?
-      
-      # puts "BREADS: #{@response['Breadcrumbs']['Breads']}"
       breads = @response['Breadcrumbs']['Breads']
-      
       if breads.instance_of?(Hash)
-        # puts "HASH 1: #{breads}"
-        if breads.instance_of?(Hash)
-          # puts "HASH 2: #{breads}"
-          @breadcrumbs.push(EndecaXml::Crumb.new(breads))
+        bread = breads['Bread']
+        if bread.instance_of?(Hash)
+          bread.each do |key, value|
+            @breadcrumbs.push(EndecaXml::Crumb.new(bread))
+          end
         elsif bread.instance_of?(Array)
-          # puts "ARRAY 1: #{breads}"
-          breads.each do |crumb|
-            # puts "CRUMB: #{crumb}"
+          bread.each do |crumb|
             @breadcrumbs.push(EndecaXml::Crumb.new(crumb))
           end
         end
       elsif breads.instance_of?(Array)
-        # puts "ARRAY 1: #{breads}"
-        breads.each do |bread|
-          # puts "BREAD: #{bread}"
-          if bread.instance_of?(Hash)
-            # puts "HASH 1: #{bread}"
-            if bread['Bread'].instance_of?(Hash)
-              # puts "HASH 2: #{bread}"
-              bread['Bread'].each do |key, value|
-                # puts "#{key} :: #{value}"
-                @breadcrumbs.push(EndecaXml::Crumb.new(bread['Bread']))
+        breads.each do |breadz|
+          bread = breadz['Bread']
+          if breadz.instance_of?(Hash)
+            if bread.instance_of?(Hash)
+              bread.each do |key, value|
+                @breadcrumbs.push(EndecaXml::Crumb.new(bread))
               end
-            elsif bread['Bread'].instance_of?(Array)
-              # puts "ARRAY 2: #{bread}"
-              bread['Bread'].each do |crumb|
-                # puts "CRUMB 2: #{crumb}"
+            elsif bread.instance_of?(Array)
+              bread.each do |crumb|
                 @breadcrumbs.push(EndecaXml::Crumb.new(crumb))
               end
             end
-          elsif bread.instance_of?(Array)
-            # puts "ARRAY 3: #{bread}"
-            bread['Bread'].each do |crumb|
-              # puts "CRUMB 3: #{crumb}"
+          elsif breadz.instance_of?(Array)
+            bread.each do |crumb|
               @breadcrumbs.push(EndecaXml::Crumb.new(crumb))
             end
           end
@@ -293,134 +239,149 @@ class EndecaXml
     end
   end
   
-  # builds the DIMENSIONS hash
-  # NOTE: do what breadcrumbs is doing in terms of vars
+  # Builds an array of FILTERCRUMBS (BREADCRUMBS used as left nav filterables)
+  def build_filtercrumbs
+    @filtercrumbs = []
+    
+    breads = @response['Breadcrumbs']['Breads']
+    if breads.instance_of?(Hash)
+      breads.each do |key, value|
+        @filtercrumbs.push(value)
+      end
+    elsif breads.instance_of?(Array)
+      breads.each do |bread|
+        if bread.instance_of?(Hash)
+          @filtercrumbs.push(bread['Bread'])
+        elsif bread.instance_of?(Array)
+          bread['Bread'].each do |crumb|
+            @filtercrumbs.push(crumb)
+          end
+        end
+      end
+    end
+  end
+  
+  # Builds an array of DIMENSIONS
   def build_dimensions
     @dimensions = []
     
-    puts "DIMENSIONS: #{@response['Dimensions']}"
     dimensions = @response['Dimensions']
     unless @response['Dimensions'].nil?
-      
       dimension = @response['Dimensions']['Dimension']
       if dimension.instance_of?(Hash)
         @dimension = EndecaXml::Dimension.new(dimensions)
-        unless dimension['DimensionValues'].nil?
-          if dimension['DimensionValues']['DimensionValue'].instance_of?(Hash)
-            @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension['DimensionValues']))
-          elsif dimension['DimensionValues']['DimensionValue'].instance_of?(Array)
-            dimension['DimensionValues']['DimensionValue'].each do |dimension_value|
-              @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension_value))
-            end
-          else
-            puts "This dimension value is a(n): #{dimension['DimensionValues']['DimensionValue'].class}"
-          end
-          @dimensions.push(@dimension)
-        else
-          puts "There are no dimension values on this dimension!"
-        end
+        add_dimension_values(dimension)
       elsif dimension.instance_of?(Array)
         dimension.each do |dimension|
           @dimension = EndecaXml::Dimension.new(dimension)
-          unless dimension['DimensionValues'].nil?
-            if dimension['DimensionValues']['DimensionValue'].instance_of?(Hash)
-              @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension['DimensionValues']))
-            elsif dimension['DimensionValues']['DimensionValue'].instance_of?(Array)
-              dimension['DimensionValues']['DimensionValue'].each do |dimension_value|
-                @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension_value))
-              end
-            else
-              puts "This dimension value is a(n): #{dimension['DimensionValues']['DimensionValue'].class}"
-            end
-            @dimensions.push(@dimension)
-          else
-            puts 'There are no dimension values on this dimension!'
-          end
+          add_dimension_values(dimension)
         end
-      else
-        puts "This dimension is a(n): #{dimensions.class}"
       end
     else
       puts 'There are no dimensions with this response!'
     end
   end
   
-  # builds the BUSINESS RULES hash
+  # Adds an array of DIMENSION VALUES to each DIMENSION
+  def add_dimension_values(dimension)
+    unless dimension['DimensionValues'].nil?
+      if dimension['DimensionValues']['DimensionValue'].instance_of?(Hash)
+        @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension['DimensionValues']))
+      elsif dimension['DimensionValues']['DimensionValue'].instance_of?(Array)
+        dimension['DimensionValues']['DimensionValue'].each do |dimension_value|
+          @dimension.dimension_values.push(EndecaXml::Dimension.new(dimension_value))
+        end
+      end
+      @dimensions.push(@dimension)
+    else
+      puts "There are no dimension values on this dimension!"
+    end
+  end
+  
+  # Builds an array of BUSINESS RULES
   def build_business_rules
-    puts "BUSINESS RULES: #{@response['BusinessRulesResult']}"
-    
-    # NOTE: needs to be looked at again. look at where the array is being pushed
     @business_rules = []
-    unless @response['BusinessRulesResult'].nil?
-      if @response['BusinessRulesResult']['BusinessRules'].instance_of?(Hash)
-        @business_rule = EndecaXml::Rule.new(@response['BusinessRulesResult']['BusinessRules'])
-        @response['BusinessRulesResult']['BusinessRules'].each do |key, value|
-          @business_rule.properties_array.push(EndecaXml::Rule.new(value)) if key == 'properties'
-          if key == 'RecordSet'
-            @business_rule.records.push(EndecaXml::Record.new(value['Record'])) unless value.nil?
-          end
+    
+    business_rules_result = @response['BusinessRulesResult']
+    unless business_rules_result.nil?
+      business_rules = @response['BusinessRulesResult']['BusinessRules']
+      if business_rules.instance_of?(Hash)
+        business_rule = EndecaXml::Rule.new(business_rules)
+        business_rules.each do |key, value|
+          add_business_rule_properties(value) if key == 'properties'
+          add_business_rule_records(value) if key == 'RecordSet'
         end
-      elsif @response['BusinessRulesResult']['BusinessRules'].instance_of?(Array)
+      elsif business_rules.instance_of?(Array)
         @response['BusinessRulesResult']['BusinessRules']['BusinessRule'].each do |rule|
-          @business_rule = EndecaXml::Rule.new(rule)
+          business_rule = EndecaXml::Rule.new(rule)
           rule.each do |key, value|
-            @business_rule.properties_array.push(EndecaXml::Rule.new(value)) if key == 'properties'
-            if key == 'RecordSet'
-              @business_rule.records.push(EndecaXml::Record.new(value['Record'])) unless value.nil?
-            end
+            add_business_rule_properties(key) if key == 'properties'
+            add_business_rule_records(key) if key == 'RecordSet'
           end
         end
-      else
-        puts "This busniess rule is a(n): #{@response['RecordsSet'].class}"
       end
-      @business_rules.push(@business_rule)
+      @business_rules.push(business_rule)
     else
       puts 'There are no business rules with this response!'
     end
   end
   
-  # builds the SEARCH REPORTS hash
-  def build_search_reports
-    @search_reports = []
-    
-    # puts "APPLIED FILTERS: #{@response['AppliedFilters']}"
-    applied_filters = @response['AppliedFilters']
-    unless applied_filters.nil?
-      
-      # puts "SEARCH REPORTS: #{@response['AppliedFilters']['SearchReports']}"
-      search_reports = @response['AppliedFilters']['SearchReports']
-      unless search_reports.nil?
-        #do stuff
+  # Adds an array of PROPERTIES to each BUSINESS RULE
+  def add_business_rule_properties(value)
+    @business_rule.properties_array.push(EndecaXml::Rule.new(value)) unless value.nil?
+  end
+  
+  # Adds an array of RECORDS to each BUSINESS RULE
+  def add_business_rule_records(value)
+    @business_rule.records.push(EndecaXml::Record.new(value['Record'])) unless value.nil?
+  end
+  
+  # Builds the SEARCH REPORTS and SELECTED DIMENSION VALUE IDS if included in response
+  def build_applied_filters
+    unless @response['AppliedFilters'].nil?
+      unless @response['AppliedFilters']['SearchReports'].nil?
+        build_search_reports
       else
         puts 'There are no search reports with this response!'
       end
-      
+      unless @response['AppliedFilters']['SelectedDimensionValueIds'].nil?
+        build_selected_dimension_value_ids
+      else
+        puts "There are no selected dimension value ids with this response!"
+      end
     else
       puts 'There were not applied filters with this response!'
     end
   end
   
-  # builds the SELECTED DIMENSION VALUE IDS hash
+  # Builds an array of SEARCH REPORTS
+  def build_search_reports
+    @searchs = []
+    
+    search_report = @response['AppliedFilters']['SearchReports']['SearchReport']
+    
+    @matchedrecordcount           = search_report.fetch('matchedrecordcount')
+    @matchedmode                  = search_report.fetch('matchedmode')
+    @matchedtermscount            = search_report.fetch('matchedtermscount')
+    @applied_search_adjustments   = search_report.fetch('AppliedSearchAdjustments')
+    @suggested_search_adjustments = search_report.fetch('SuggestedSearchAdjustments')
+    
+    @searchs.push(EndecaXml::Search.new(search_report.fetch('Search')))
+  end
+  
+  # Builds an array of SELECTED DIMENSION VALUE IDS
   def build_selected_dimension_value_ids
     @selected_dimension_value_ids = []
     
-    # puts "SELECTED DIMENSION VALUE IDS: #{@response['AppliedFilters']['SelectedDimensionValueIds']}"
     selected_dimension_value_ids = @response['AppliedFilters']['SelectedDimensionValueIds']
-    unless selected_dimension_value_ids.nil?
-      
-      if selected_dimension_value_ids.instance_of?(Hash)
-        selected_dimension_value_id = EndecaXml::DimensionValueId.new(selected_dimension_value_ids)
-      elsif selected_dimension_value_ids.instance_of?(Array)
-        selected_dimension_value_ids.each do |key, value|
-          selected_dimension_value_id = EndecaXml::DimensionValueId.new(value)
-        end
+    if selected_dimension_value_ids.instance_of?(Hash)
+      selected_dimension_value_id = EndecaXml::DimensionValueId.new(selected_dimension_value_ids)
+    elsif selected_dimension_value_ids.instance_of?(Array)
+      selected_dimension_value_ids.each do |key, value|
+        selected_dimension_value_id = EndecaXml::DimensionValueId.new(value)
       end
-      
-      @selected_dimension_value_ids.push(selected_dimension_value_id)
-      
-    else
-      puts "There are no selected dimension value ids with this response!"
     end
+    @selected_dimension_value_ids.push(selected_dimension_value_id)
   end
   
 end

data/lib/endeca_xml/record.rb

@@ -2,9 +2,7 @@ class EndecaXml
   class Record
 
     def initialize(record)
-      # puts "RECORD: #{record}"
       record.each do |key, value|
-        # puts "#{key} | #{value}"
         self.instance_variable_set(:"@#{key.downcase}", value)
       end
     end

data/lib/endeca_xml/{search_report.rb → search.rb}

@@ -1,16 +1,14 @@
 class EndecaXml
-  class SearchReport
+  class Search
 
     def initialize(report)
-      # puts "REPORT: #{report}"
       report.each do |key, value|
-        # puts "#{key} | #{value}"
         self.instance_variable_set(:"@#{key.downcase}", value)
       end
     end
     
     # is there anyway to do this dynamically?
-    attr_reader :none
+    attr_reader :key, :mode, :relevancerankingsstrategy, :terms
 
   end
 end

data/lib/endeca_xml/version.rb

@@ -1,3 +1,3 @@
 class EndecaXml
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: endeca_xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - sdomino
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 Z
+date: 2011-07-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: crackoid
@@ -34,7 +34,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
+description: This has been officially released as endeca_on_demand. Feel free to continue using this functioning, nearly complete version, or the awesome new, and complete, release version.
 email: 
 - sdomino@pagodabox.com
 executables: []
@@ -56,7 +56,7 @@ files:
 - lib/endeca_xml/dimension_value_id.rb
 - lib/endeca_xml/record.rb
 - lib/endeca_xml/rule.rb
-- lib/endeca_xml/search_report.rb
+- lib/endeca_xml/search.rb
 - lib/endeca_xml/version.rb
 homepage: http://github.com/sdomino/endeca_xml
 licenses: []
@@ -84,6 +84,6 @@ rubyforge_project: endeca_xml
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
+summary: This has been officially released as endeca_on_demand. Feel free to continue using this functioning, nearly complete version, or the awesome new, and complete, release version.
 test_files: []