endeca_on_demand 1.2.0 → 1.3.0

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+
+# MAC OS
+.DS_Store

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -2,3 +2,17 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in endeca_on_demand.gemspec
 gemspec
+
+require 'rbconfig'
+
+if RbConfig::CONFIG['target_os'] =~ /darwin/i
+  gem 'rb-fsevent', '>= 0.4.0', require: false
+  gem 'growl',      '~> 1.0.3', require: false
+elsif RbConfig::CONFIG['target_os'] =~ /linux/i
+  gem 'rb-inotify', '>= 0.8.5', require: false
+  gem 'libnotify',  '~> 0.1.3', require: false
+elsif RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+  gem 'win32console', require: false
+  gem 'rb-fchange', '>= 0.0.2', require: false
+  gem 'rb-notifu', '>= 0.0.4',  require: false
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, all_on_start: false, all_after_pass: false, cli: '--fail-fast --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')             { "spec" }
+end

data/{README.rdoc → README.md}

@@ -1,131 +1,157 @@
-== EndecaOnDemand
----
+# EndecaOnDemand
+
+[![Build Status](https://secure.travis-ci.org/sdomino/endeca_on_demand.png)](http://travis-ci.org/sdomino/endeca_on_demand)
+
+[![Dependency Status](https://gemnasium.com/sdomino/endeca_on_demand.png?travis)](https://gemnasium.com/sdomino/endeca_on_demand)
 
 This Endeca On-Demand Web API gem will take a query-string and construct an XML query and send it to an hosted Endeca On-Demand Cluster. It will then parse the response and expose an API for using the response data.
 
-=== Features
+## 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
 
 NOTE: Due to the implementation specific requirements used while creating this gem, I know there are missing features. If you find issues, or can provide me with any specifics about your implementation, I can add more support.
 
-==== What I would like to see:
+### What I would like to see:
+
 * Information reguarding the JSON equivelent of this implementation so I can add JSON support
 * Information reguarding filters, to enhance this functionality
 * Additional advanced parameters
----
 
-=== Install
-==== Rails
+## Install
+### Rails
 
 Add this line to your Gemfile:
 
- gem 'endeca_on_demand'
+```ruby
+gem 'endeca_on_demand'
+```
 
 Then bundle install:
 
- bundle install
+```bash
+bundle install
+```
 
-==== Non Rails
+### Non Rails
 
- gem install endeca_on_demand
+```ruby
+gem install endeca_on_demand
+```
 
----
+## Usage
 
-=== 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>
-  
+```html
+<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'                       => {}
-            }
-            
+```ruby
+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'                       => {}
-            }
-            
+```ruby
+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'
+```ruby
+host = 'your/EndecaOnDemand/hosted/cluster'
+```
 
 Pass your 'host' and 'options' hash to new EndecaOnDemand
 
-  @endeca = EndecaOnDemand.new(host, options)
+```ruby
+@endeca = EndecaOnDemand.new(host, options)
+```
   
 All of the following have been exposed as part of the API, most of them will also have sub api methods available which will become visible with a .inspect on the object:
-  
-  @endeca.records
-  @endeca.breadcrumbs
-  @endeca.filtercrumbs (Filtercrumbs are breadcrumbs that have been tailored for use as left nav filterables)
-  @endeca.dimensions
-  @endeca.rules
-  @endeca.search_reports
-  @endeca.keyword_redirect
-  @endeca.selected_dimension_value_ids
+
+```ruby
+@endeca.records
+@endeca.breadcrumbs
+@endeca.filtercrumbs (Filtercrumbs are breadcrumbs that have been tailored for use as left nav filterables)
+@endeca.dimensions
+@endeca.rules
+@endeca.search_reports
+@endeca.keyword_redirect
+@endeca.selected_dimension_value_ids
+```
 
 I also exposed some 'debug'-ish type options to the API so you can see a little of what your request/response looks like if your not getting back the results your expecting
-  
-  @endeca.uri
-  @endeca.http
-  @endeca.base
-  @endeca.query
-  @endeca.raw_response
-  @endeca.response
-  @endeca.error
+
+```ruby
+@endeca.uri
+@endeca.http
+@endeca.base
+@endeca.query
+@endeca.raw_response
+@endeca.response
+@endeca.error
+```
 
 Below is an example of how you could access the response data:
 
-  - @endeca.records.each do |record|
-    puts "----- RECORD: #{record.inspect}"
+```ruby
+@endeca.records.each do |record|
+  puts "----- RECORD: #{record.inspect}"
+end
+```
   
 Each object will then have associated instance variables exposed that will allow you directly call any value on that object:
 
-  - @endeca.records.each do |record|
-    puts "----- RECORD NAME: #{record.p_name}"
-  
----
+```ruby
+@endeca.records.each do |record|
+  puts "----- RECORD NAME: #{record.p_name}"
+end
+```
+
+## F.A.Q
 
-=== 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
+## TODO
+
 * Add tests
 * Build in support for filters
 * I don't have all the possible advanced parameters, so for now it only handles the default 'AggregationKey'
 * Search needs some more testing. Currently its only been setup with a basic search, so I'm not aware of what additional parameters might be coming in, and how I may need to handle them
 * I would love it if this could server for both XML and JSON (and whatever additional formats they offer)
----
 
-=== CONTACT
+## CONTACT
+
 Please contact me with any question, bugs, additions, suggestions, etc.
----
 
-=== Copyright
+## Copyright
 Copyright (c) 2011 Steve Domino. See LICENSE.txt for further details

data/Rakefile

@@ -1,2 +1,6 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/endeca_on_demand.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "endeca_on_demand/version"
+require File.expand_path('../lib/endeca_on_demand/version.rb', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "endeca_on_demand"
@@ -8,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['sdomino']
   s.email       = ['sdomino@pagodabox.com']
-  s.homepage    = 'http://github.com/sdomino/endeca_on-demand'
+  s.homepage    = 'https://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 and send it to an hosted Endeca On-Demand Cluster. It will then parse the response and expose an API for using the response data.'
 
@@ -19,12 +18,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.7.0'
   
   s.add_dependency 'nokogiri'
   s.add_dependency 'builder'
   s.add_dependency 'activesupport', '~> 3.1'
   s.add_dependency 'i18n'
-  s.add_dependency 'facets'
 end

data/lib/endeca_on_demand.rb

@@ -1,307 +1,19 @@
-require 'active_support/core_ext/hash'
-require 'facets/hash/recurse'
-
-require 'endeca_on_demand/pp'
-require 'endeca_on_demand/proxy'
-require 'endeca_on_demand/query'
-require 'endeca_on_demand/response'
+module EndecaOnDemand
+end
 
-Dir["#{File.dirname(__FILE__)}/endeca_on_demand/**/*"].each {|file| require(file)}
+require 'active_support/core_ext/hash'
 
 require 'builder'
 require 'nokogiri'
 require 'net/http'
 require 'uri'
-require 'open-uri'
-
-module EndecaOnDemand
-
-  ##
-
-  # def initialize(host, options)
-  #   unless host.blank?
-  #     @body = Builder::XmlMarkup.new(:indent => 2)
 
-  #     #
-  #     set_host(host)
-      
-  #     #
-  #     options.each do |key, value|
-  #       self.send(key.to_sym, value) unless value.blank?
-  #     end
-      
-  #     #
-  #     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
-  
-  # ### 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
-  
-  # def success?
-  #   @error.blank?
-  # end
-  
-  # 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
-  
-  # ## 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
-    
-  #   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
-  
-  # ### 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
-    
-  #   @base = options
-  # end
-  
-  # def fetch_response
-  #   @http.post(@uri.path, @query.target!, 'Content-type' => 'application/xml')
-  # 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 |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
-  
-  # # 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
-  
-  # # 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
-  
-  # #
-  # 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 ###
-  
-  # ## BUILD RESPONSE
-  
-  # # 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")
-    
-  #   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  = []
-
-  #   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 = []
-    
-  #   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 = []
-    
-  #   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 = []
-    
-  #   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 = []
-
-  #   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
+require 'endeca_on_demand/core_ext'
+require 'endeca_on_demand/pp'
+require 'endeca_on_demand/proxy'
 
-  # # 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
+require 'endeca_on_demand/client'
+require 'endeca_on_demand/collection'
+require 'endeca_on_demand/query'
+require 'endeca_on_demand/response'
+require 'endeca_on_demand/version'