endeca_on_demand 1.0.1 → 1.1.0

data/lib/endeca_on_demand.rb

@@ -1,4 +1,9 @@
+require 'active_support/core_ext/hash'
+
+require 'endeca_on_demand/pp'
 require 'endeca_on_demand/proxy'
+require 'endeca_on_demand/query'
+require 'endeca_on_demand/response'
 
 Dir["#{File.dirname(__FILE__)}/endeca_on_demand/**/*"].each {|file| require(file)}
 
@@ -6,293 +11,296 @@ require 'builder'
 require 'nokogiri'
 require 'net/http'
 require 'uri'
+require 'open-uri'
 
-class EndecaOnDemand
-  
-  def initialize(host, options)
-    unless host.blank?
-      @body = Builder::XmlMarkup.new(:indent => 2)
+module EndecaOnDemand
+
+  ##
+
+  # def initialize(host, options)
+  #   unless host.blank?
+  #     @body = Builder::XmlMarkup.new(:indent => 2)
 
-      #
-      set_host(host)
+  #     #
+  #     set_host(host)
       
-      #
-      options.each do |key, value|
-        self.send(key.to_sym, value) unless value.blank?
-      end
+  #     #
+  #     options.each do |key, value|
+  #       self.send(key.to_sym, value) unless value.blank?
+  #     end
       
-      #
-      send_request
+  #     #
+  #     send_request
       
-      self.instance_variables.each do |instance_variable|
-        # puts "VARS: #{instance_variable}"
-        # self.class_eval("attr_reader :#{instance_variable}")
-      end
-    else
-      puts "Unable to continue... Make sure \"#{host}\" is a valid thanxmedia host."
-    end
-  end
+  #     self.instance_variables.each do |instance_variable|
+  #       # puts "VARS: #{instance_variable}"
+  #       # self.class_eval("attr_reader :#{instance_variable}")
+  #     end
+  #   else
+  #     puts "Unable to continue... Make sure \"#{host}\" is a valid thanxmedia host."
+  #   end
+  # end
   
-  ### API
-    attr_reader :records
-    attr_reader :breadcrumbs, :filtercrumbs
-    attr_reader :dimensions
-    attr_reader :rules
-    attr_reader :search_reports, :keyword_redirect
-    attr_reader :selected_dimension_value_ids
+  # ### API
+  #   attr_reader :records
+  #   attr_reader :breadcrumbs, :filtercrumbs
+  #   attr_reader :dimensions
+  #   attr_reader :rules
+  #   attr_reader :search_reports, :keyword_redirect
+  #   attr_reader :selected_dimension_value_ids
   
-    ## DEBUG
-      attr_reader :uri, :http
-      attr_reader :base, :query, :request, :response, :error
-    ## /DEBUG
-  ### /API
+  #   ## DEBUG
+  #     attr_reader :uri, :http
+  #     attr_reader :base, :query, :request, :response, :error
+  #   ## /DEBUG
+  # ### /API
   
-  def success?
-    @error.blank?
-  end
+  # def success?
+  #   @error.blank?
+  # end
   
-  private
+  # private
   
-  def method_missing(method, *args, &block)
-    unless self.instance_variables.include?(:"@#{method}")
-      puts "#{method} is unavailable."
-    else
-      puts "Unable to retrieve #{method} because: #{@error.message}."
-    end
-  end
+  # def method_missing(method, *args, &block)
+  #   unless self.instance_variables.include?(:"@#{method}")
+  #     puts "#{method} is unavailable."
+  #   else
+  #     puts "Unable to retrieve #{method} because: #{@error.message}."
+  #   end
+  # end
   
-  ## SEND REQUEST
+  # ## 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
-    @query = Builder::XmlMarkup.new(:indent => 2)
-    @query.Query do
-      @query << @body.target!
-    end
+  # # 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
+  #   @query = Builder::XmlMarkup.new(:indent => 2)
+  #   @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')
+  #   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)
+  #     @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
+  #     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
   
-  ### XML REQUEST ###
+  # ### XML REQUEST ###
   
-  ## SET REQUEST HOST
-  def set_host(host)
-    @uri  = URI.parse(host)
-    @http = Net::HTTP.new(@uri.host, @uri.port)
-  end
+  # ## 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
+  # ## ADD BASE OPTIONS TO REQUEST
+  # def add_base(options)
+  #   options.each do |key, value|
+  #     @body.tag!(key, value)
+  #   end
     
-    @base = options
-  end
+  #   @base = options
+  # end
   
-  def fetch_response
-    @http.post(@uri.path, @query.target!, 'Content-type' => 'application/xml')
-  end
+  # def fetch_response
+  #   @http.post(@uri.path, @query.target!, 'Content-type' => 'application/xml')
+  # end
 
-  ## BUILD REQUEST BODY
+  # ## 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 |option|
-        @body.tag!('DimensionValueId', option)
-      end
-    end
-  end
+  # # 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 |option|
+  #       @body.tag!('DimensionValueId', option)
+  #     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
+  # # (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 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 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
+  # # Adds RecordOffset and RecordsPerPage to the request.
+  # def add_paging(options)
+  #   options.each do |key, value|
+  #     @body.tag!(key, value)
+  #   end
+  # 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)
-    options.each do |key, value|
-      @body.tag!(key, value)
-    end
-  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)
+  #   options.each do |key, value|
+  #     @body.tag!(key, value)
+  #   end
+  # end
   
-  # Adds UserProfile(s) to the request.
-  def add_profiles(options)
-    @body.UserProfiles do
-      options.each do |option|
-        @body.tag!('UserProfile', option)
-      end
-    end
-  end
+  # # Adds UserProfile(s) to the request.
+  # def add_profiles(options)
+  #   @body.UserProfiles do
+  #     options.each do |option|
+  #       @body.tag!('UserProfile', option)
+  #     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
+  # #
+  # 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
   
-  ### RESPONSE XML ###
+  # ### RESPONSE XML ###
   
-  ## BUILD RESPONSE
+  # ## BUILD RESPONSE
   
-  # Builds an array of RECORDS
-  def build_records
-    @records = []
+  # # Builds an array of RECORDS
+  # def build_records
+  #   @records = []
     
-    @record_offset = @response.xpath("//RecordsSet//offset")
-    @records_per_page = @response.xpath("//RecordsSet//recordsperpage")
-    @total_record_count = @response.xpath("//RecordsSet//totalrecordcount")
+  #   @record_offset = @response.xpath("//RecordsSet//offset")
+  #   @records_per_page = @response.xpath("//RecordsSet//recordsperpage")
+  #   @total_record_count = @response.xpath("//RecordsSet//totalrecordcount")
     
-    unless @response.xpath("//RecordsSet").blank?
-      @response.xpath("//RecordsSet//Record").each do |record|
-        @records.push(EndecaOnDemand::Record.new(record))
-      end
-    else
-      puts 'There are no records with this response!'
-    end
-  end
+  #   unless @response.xpath("//RecordsSet").blank?
+  #     @response.xpath("//RecordsSet//Record").each do |record|
+  #       @records.push(EndecaOnDemand::Record.new(record))
+  #     end
+  #   else
+  #     puts 'There are no records with this response!'
+  #   end
+  # end
   
-  # Builds an array of BREADCRUMBS
-  def build_breadcrumbs
-    @filtercrumbs = []
-    @breadcrumbs  = []
+  # # Builds an array of BREADCRUMBS
+  # def build_breadcrumbs
+  #   @filtercrumbs = []
+  #   @breadcrumbs  = []
 
-    unless @response.xpath("//Breadcrumbs").blank?
-      @response.xpath("//Breadcrumbs//Breads").each do |node|
-        filtercrumbs = []
-        node.xpath("./Bread").each do |node|
-          breadcrumb = EndecaOnDemand::BreadCrumb.new(node)
-          filtercrumbs.push(breadcrumb)
-          @breadcrumbs.push(breadcrumb)
-        end
-        @filtercrumbs.push(filtercrumbs)
-      end
-    else  
-      puts 'There are no breadcrumbs with this response!'
-    end
-  end
+  #   unless @response.xpath("//Breadcrumbs").blank?
+  #     @response.xpath("//Breadcrumbs//Breads").each do |node|
+  #       filtercrumbs = []
+  #       node.xpath("./Bread").each do |node|
+  #         breadcrumb = EndecaOnDemand::BreadCrumb.new(node)
+  #         filtercrumbs.push(breadcrumb)
+  #         @breadcrumbs.push(breadcrumb)
+  #       end
+  #       @filtercrumbs.push(filtercrumbs)
+  #     end
+  #   else  
+  #     puts 'There are no breadcrumbs with this response!'
+  #   end
+  # end
   
-  # Builds an array of DIMENSIONS
-  def build_dimensions
-    @dimensions = []
+  # # Builds an array of DIMENSIONS
+  # def build_dimensions
+  #   @dimensions = []
     
-    unless @response.xpath("//Dimensions").blank?
-      @response.xpath("//Dimensions//Dimension").each do |node|
-        @dimensions.push(EndecaOnDemand::Dimension.new(node))
-      end
-    else
-      puts 'There are no dimensions with this response!'
-    end
-  end
+  #   unless @response.xpath("//Dimensions").blank?
+  #     @response.xpath("//Dimensions//Dimension").each do |node|
+  #       @dimensions.push(EndecaOnDemand::Dimension.new(node))
+  #     end
+  #   else
+  #     puts 'There are no dimensions with this response!'
+  #   end
+  # end
   
-  # Builds an array of BUSINESS RULES
-  def build_business_rules
-    @business_rules_results = []
+  # # Builds an array of BUSINESS RULES
+  # def build_business_rules
+  #   @business_rules_results = []
     
-    unless @response.xpath("//BusinessRulesResult").blank?
-      @response.xpath("//BusinessRulesResult//BusinessRules//BusinessRule").each do |node|
-        @business_rules_results.push(EndecaOnDemand::BusinessRulesResult.new(node))
-      end
-    else
-      puts 'There are no business rules with this response!'
-    end
-  end
+  #   unless @response.xpath("//BusinessRulesResult").blank?
+  #     @response.xpath("//BusinessRulesResult//BusinessRules//BusinessRule").each do |node|
+  #       @business_rules_results.push(EndecaOnDemand::BusinessRulesResult.new(node))
+  #     end
+  #   else
+  #     puts 'There are no business rules with this response!'
+  #   end
+  # end
 
-  # Builds an array of SEARCH REPORTS includes SEARCH
-  def build_search_reports
-    @search_reports = []
+  # # Builds an array of SEARCH REPORTS includes SEARCH
+  # def build_search_reports
+  #   @search_reports = []
     
-    unless @response.xpath("//AppliedFilters").blank?
-      unless @response.xpath("//AppliedFilters//SearchReports").blank?
-        @search_reports.push(EndecaOnDemand::SearchReport.new(@response.xpath("//AppliedFilters//SearchReports//SearchReport")))
-      else
-        puts "There are no search reports with this response!"
-      end
-    end
-  end
+  #   unless @response.xpath("//AppliedFilters").blank?
+  #     unless @response.xpath("//AppliedFilters//SearchReports").blank?
+  #       @search_reports.push(EndecaOnDemand::SearchReport.new(@response.xpath("//AppliedFilters//SearchReports//SearchReport")))
+  #     else
+  #       puts "There are no search reports with this response!"
+  #     end
+  #   end
+  # end
 
-  # Builds an array of SELECTED DIMENSION VALUE IDS
-  def build_selected_dimension_value_ids
-    @selected_dimension_value_ids = []
+  # # Builds an array of SELECTED DIMENSION VALUE IDS
+  # def build_selected_dimension_value_ids
+  #   @selected_dimension_value_ids = []
 
-    unless @response.xpath("//AppliedFilters").blank?
-      unless @response.xpath("//AppliedFilters//SelectedDimensionValueIds").blank?
-        @response.xpath("//AppliedFilters//SelectedDimnesionValueIds").each do |node|
-          @selected_dimension_value_ids.push(EndecaOnDemand::SelectedDimensionValueId.new(node))
-        end
-      else
-        puts "There are no selected dimension value ids with this response!"
-      end
-    end
-  end
+  #   unless @response.xpath("//AppliedFilters").blank?
+  #     unless @response.xpath("//AppliedFilters//SelectedDimensionValueIds").blank?
+  #       @response.xpath("//AppliedFilters//SelectedDimnesionValueIds").each do |node|
+  #         @selected_dimension_value_ids.push(EndecaOnDemand::SelectedDimensionValueId.new(node))
+  #       end
+  #     else
+  #       puts "There are no selected dimension value ids with this response!"
+  #     end
+  #   end
+  # end
 
-  # Builds a KEYWORD REDIRECT for a given search term
-  def build_keyword_redirect
-    unless @response.xpath("//KeywordRedirects").blank?
-      @keyword_redirect = EndecaOnDemand::KeywordRedirect.new(@response.xpath("//KeywordRedirects"))
-    else
-      puts "There is no keyword redirectd with this r!"
-    end
-  end
+  # # Builds a KEYWORD REDIRECT for a given search term
+  # def build_keyword_redirect
+  #   unless @response.xpath("//KeywordRedirects").blank?
+  #     @keyword_redirect = EndecaOnDemand::KeywordRedirect.new(@response.xpath("//KeywordRedirects"))
+  #   else
+  #     puts "There is no keyword redirectd with this r!"
+  #   end
+  # end
   
 end