endeca_on_demand 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in endeca_on_demand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 sdomino
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,144 @@
+= EndecaOnDemand
+
+The official unofficial Endeca On-Demand Web API gem, EndecaOnDemand will take a query-string and construct an XML query that it then sends to a hosted Endeca On-Demand Cluster. It will then parse the response and expose an API for using the response data.
+
+== Features
+
+* Provides an easy way for you to use the Thanx Media, Endeca On-Demand Web API
+* Builds an XML query from a query-string, formatted for the Endeca On-Demand Service
+* Handles the Endeca On-Demand response XML and exposes methods to use response data
+
+== Install
+
+=== Rails
+
+Add this line to your Gemfile:
+
+ gem 'EndecaOnDemand'
+
+Then bundle install:
+
+ bundle install
+
+---
+
+=== Non Rails
+
+ gem install EndecaOnDemand
+
+== Usage
+
+EndecaOnDemand constructs an XML query to send to a hosted Endeca On-Demand Cluster, via a query string:
+NOTE: This is a complete example. Any unneeded option should not be included in the query-string
+
+  <a href='www.example.com/example/catalog?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:
+NOTE: The base options and current category are set manually and not via a query-string
+
+  options = {
+              'add_base'                          => {'RecordsSet' => true, 'Dimensions' => true, 'BusinessRulesResult' => true, '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 (using the above example query-string):
+NOTE: This is a complete example. It is not necessary to include anything that you don't need, or you may choose to include it and just leave it blank.
+
+  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'                       => {}
+            }
+            
+Provide the location of your hosted Endeca On-Demand Cluster (this can be set as a variable or passed directly as a parameter)
+
+  host = 'your/EndecaOnDemand/hosted/cluster'
+
+Pass your 'host' and 'options' hash to new EndecaOnDemand
+
+  @endeca = EndecaOnDemand.new(host, options)
+
+Below are (ruby) examples of how you could access the response data:
+
+Records:
+
+  @endeca.records.each do |record|
+    puts "---------- BEGIN RECORD"
+    puts "RECORD: #{record.inspect}"
+    puts "---------- END"
+  end
+
+Breadcrumbs:
+
+  @endeca.breadcrumbs.each do |crumb|
+    puts "---------- BEGIN CRUMB"
+    puts "CRUMB: #{crumb.inspect}"
+    puts "---------- END"
+  end
+
+Dimensions:
+
+  @endeca.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:
+
+  @endeca.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:
+
+  @endeca.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:
+
+  @endeca.records.each do |record|
+    record.p_name
+    etc...
+  end
+  
+== F.A.Q
+
+* Q: I'm getting a response error saying something about multiple values for model Category
+  A: You are most likely trying to pass a CategoryId (CID) with DimensionValueId(s) (DVID) that don't match. The DVIDs must belong to the category passed as the CID.
+
+== TODO
+
+* More detail on breadcrumbs (and their suggested use as left nav filters)
+* More on filters
+
+== CONTACT
+
+Please contact me with any question, bugs, suggestions, or... donations? :)
+
+== Copyright
+
+Copyright (c) 2011 Steve Domino. See LICENSE.txt for further details

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/endeca_on_demand.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "endeca_on_demand/version"
+
+Gem::Specification.new do |s|
+  s.name        = "endeca_on_demand"
+  s.version     = EndecaOnDemand::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['sdomino']
+  s.email       = ['sdomino@pagodabox.com']
+  s.homepage    = 'http://github.com/sdomino/endeca_on_demand'
+  s.summary     = 'Formerly EndecaXml (endeca_xml), This gem provides an easy way for you to use the Thanx Media, Endeca On-Demand Web API'
+  s.description = 'EndecaOnDemand will take a query-string and construct an XML query that it then sends to a hosted Endeca On-Demand Cluster. It will then parse the response and expose an API for using the response data.'
+
+  s.rubyforge_project = "endeca_on_demand"
+  
+  s.add_dependency 'crackoid'
+
+  s.add_development_dependency 'rspec'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/endeca_on_demand/crumb.rb

@@ -0,0 +1,16 @@
+class EndecaOnDemand
+  class Crumb
+
+    def initialize(crumb)
+      # puts "CRUMB: #{crumb}"
+      crumb.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 :name, :original_id, :id
+
+  end
+end

data/lib/endeca_on_demand/dimension.rb

@@ -0,0 +1,18 @@
+class EndecaOnDemand
+  class Dimension
+    
+    def initialize(dimension)
+      # puts "DIMENSION: #{dimension}"
+      dimension.each do |key, value|
+        # puts "#{key} | #{value}"
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+      
+      @dimension_values = []
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :name, :id, :group_name, :hasmore, :count, :dimensionvalues, :dimension_values
+
+  end
+end

data/lib/endeca_on_demand/dimension_value_id.rb

@@ -0,0 +1,16 @@
+class EndecaOnDemand
+  class DimensionValueId
+
+    def initialize(id)
+      # puts "ID: #{id}"
+      id.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 :dimensionvalueid
+
+  end
+end

data/lib/endeca_on_demand/record.rb

@@ -0,0 +1,16 @@
+class EndecaOnDemand
+  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
+    
+    # is there anyway to do this dynamically?
+    attr_reader :p_name, :p_category_id, :p_dax_item_number, :p_image, :p_price_retail, :p_price_sale, :p_price_sort, :p_url_detail
+
+  end
+end

data/lib/endeca_on_demand/rule.rb

@@ -0,0 +1,17 @@
+class EndecaOnDemand
+  class Rule
+    
+    def initialize(rule)
+      rule.each do |key, value|
+        self.instance_variable_set(:"@#{key.downcase}", value)
+      end
+      
+      @properties_array   = []
+      @records            = []
+    end
+    
+    # is there anyway to do this dynamically?
+    attr_reader :title, :id, :style, :zone, :recordcount, :recordset, :properties, :properties_array, :records
+
+  end
+end

data/lib/endeca_on_demand/search_report.rb

@@ -0,0 +1,16 @@
+class EndecaOnDemand
+  class SearchReport
+
+    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
+
+  end
+end

data/lib/endeca_on_demand/version.rb

@@ -0,0 +1,3 @@
+class EndecaOnDemand
+  VERSION = "0.0.1"
+end

data/lib/endeca_on_demand.rb

@@ -0,0 +1,430 @@
+Dir["#{File.dirname(__FILE__)}/endeca_on_demand/*"].each { |file| require(file)}
+
+require 'builder'
+require 'crackoid'
+require 'net/http'
+require 'uri'
+
+class EndecaOnDemand
+  
+  def initialize(host, options)
+    @body = Builder::XmlMarkup.new(:indent => 2)
+
+    #
+    # puts "HOST: #{host}"
+    set_host(host)
+    
+    #
+    # puts "OPTIONS: #{options}"
+    options.each do |key, value|
+      self.send(key.to_sym, value) unless value.empty?
+    end
+    
+    #
+    send_request
+  end
+  
+  ### API
+  
+  def records
+    @records
+  end
+  
+  def breadcrumbs
+    @breadcrumbs
+  end
+  
+  def filtercrumbs
+    @filtercrumbs
+  end
+  
+  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)
+    @uri  = URI.parse(host)
+    @http = Net::HTTP.new(@uri.host, @uri.port)
+  end
+  
+  ## ADD BASE OPTIONS TO REQUEST
+  def add_base(options)
+    options.each do |key, value|
+      @body.tag!(key, value)
+    end
+  end
+  
+  ## BUILD REQUEST BODY
+  
+  # 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)
+    @body.SelectedDimensionValueIds do
+      options.each do |dimension|
+        @body.tag!('DimensionValueId', dimension)
+      end
+    end
+  end
+  
+  # (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)
+    @body.Category do
+      @body.tag!('CategoryId', options)
+    end
+  end
+  
+  # Adds search-key and search-term to the request.
+  def add_keyword_search(options)
+    @body.Searches do
+      @body.Search do
+        options.each do |key, value|
+          @body.tag!(key, value)
+        end
+      end
+    end
+  end
+  
+  # Adds sort-key and sort-direction to the request.
+  def add_sorting(options)
+    @body.Sorts do
+      @body.Sort do
+        options.each do |key, value|
+          @body.tag!(key, value)
+        end
+      end
+    end
+  end
+  
+  # Adds RecordOffset and RecordsPerPage to the request.
+  def add_paging(options)
+    options.each do |key, value|
+      @body.tag!(key, value)
+    end
+  end
+  
+  #
+  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.
+  #TODO: test and see what happens if profiles are passed and don't exist
+  def add_profiles(options)
+    @body.UserProfiles do
+      options.each do |profile|
+        @body.tag!('UserProfile', profile)
+      end
+    end
+  end
+  
+  #
+  def add_filters(options)
+    # puts "FILTERS: #{options}"
+    @body.RangeFilters do
+      options.each do |key, value|
+      # puts "#{key}: #{value}"
+        @body.tag!(key, value) do
+          value.each do |key, value|
+            @body.tag!(key, value)
+          end
+        end unless value.empty?
+      end
+    end
+    # puts @body.target!
+  end
+  
+  ## 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!
+    end
+
+    # puts "QUERY: #{query.target!}"
+
+    begin
+      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_dimensions
+    build_business_rules
+    build_search_reports
+    build_selected_dimension_value_ids
+  end
+  
+  # builds the RECORDS hash
+  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|
+          @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
+  # TODO: one final pass on this to make sure its awesome (do i need the has for each key/values?) readdress how the filtercrumbs are handles and see if it is the best way
+  def build_breadcrumbs
+    @breadcrumbs  = []
+    @filtercrumbs = []
+    
+    # puts "BREADCRUMBS: #{@response['Breadcrumbs'}"
+    breadcrumbs = @response['Breadcrumbs']
+    unless breadcrumbs.nil?
+      
+      # puts "BREADS: #{@response['Breadcrumbs']['Breads']}"
+      breads = @response['Breadcrumbs']['Breads']
+      
+      breads.each do |bread|
+        bread.each do |key, value|
+          @filtercrumbs.push(value)
+        end
+      end
+      
+      if breads.instance_of?(Hash)
+        # puts "HASH 1: #{breads}"
+        if breads.instance_of?(Hash)
+          # puts "HASH 2: #{breads}"
+          if breads['Bread'].instance_of?(Hash)
+            # puts "HASH 2: #{breads['Bread']}"
+            breads['Bread'].each do |key, value|
+              # puts "#{key} :: #{value}"
+              @breadcrumbs.push(EndecaXml::Crumb.new(breads['Bread']))
+            end
+          elsif breads['Bread'].instance_of?(Array)
+            # puts "ARRAY 2: #{breads['Bread']}"
+            breads['Bread'].each do |crumb|
+              # puts "CRUMB 2: #{crumb}"
+              @breadcrumbs.push(EndecaXml::Crumb.new(crumb))
+            end
+          end
+          @filtercrumbs.push(breads['Bread'])
+        elsif bread.instance_of?(Array)
+          # puts "ARRAY 1: #{breads}"
+          breads.each do |crumb|
+            # puts "CRUMB: #{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']))
+              end
+            elsif bread['Bread'].instance_of?(Array)
+              # puts "ARRAY 2: #{bread}"
+              bread['Bread'].each do |crumb|
+                # puts "CRUMB 2: #{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}"
+              @breadcrumbs.push(EndecaXml::Crumb.new(crumb))
+            end
+          end
+        end
+      end
+    else  
+      puts 'There are no breadcrumbs with this response!'
+    end
+  end
+  
+  # builds the DIMENSIONS hash
+  # NOTE: do what breadcrumbs is doing in terms of vars
+  def build_dimensions
+    @dimensions = []
+    
+    puts "DIMENSIONS: #{@response['Dimensions']}"
+    dimensions = @response['Dimensions']
+    
+    unless @response['Dimensions'].nil?
+      
+      # puts "DIMENSION: #{@response['Dimensions']['Dimension']}"
+      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
+      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
+        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
+  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
+        end
+      elsif @response['BusinessRulesResult']['BusinessRules'].instance_of?(Array)
+        @response['BusinessRulesResult']['BusinessRules']['BusinessRule'].each do |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
+          end
+        end
+      else
+        puts "This busniess rule is a(n): #{@response['RecordsSet'].class}"
+      end
+      @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
+      else
+        puts 'There are no search reports with this response!'
+      end
+      
+    else
+      puts 'There were not applied filters with this response!'
+    end
+  end
+  
+  # builds the SELECTED DIMENSION VALUE IDS hash
+  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
+      end
+      
+      @selected_dimension_value_ids.push(selected_dimension_value_id)
+      
+    else
+      puts "There are no selected dimension value ids with this response!"
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: endeca_on_demand
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- sdomino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crackoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: EndecaOnDemand will take a query-string and construct an XML query that it then sends to a hosted Endeca On-Demand Cluster. It will then parse the response and expose an API for using the response data.
+email: 
+- sdomino@pagodabox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- endeca_on_demand.gemspec
+- lib/endeca_on_demand.rb
+- lib/endeca_on_demand/crumb.rb
+- lib/endeca_on_demand/dimension.rb
+- lib/endeca_on_demand/dimension_value_id.rb
+- lib/endeca_on_demand/record.rb
+- lib/endeca_on_demand/rule.rb
+- lib/endeca_on_demand/search_report.rb
+- lib/endeca_on_demand/version.rb
+homepage: http://github.com/sdomino/endeca_on_demand
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: endeca_on_demand
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Formerly EndecaXml (endeca_xml), This gem provides an easy way for you to use the Thanx Media, Endeca On-Demand Web API
+test_files: []
+