endeca_xml 0.5.1 → 0.5.3

data/README.rdoc

@@ -1,6 +1,6 @@
 = endeca_xml
 
-endeca_xml provides an interface between your web application and the Endeca (via thankxmedia) XML API
+endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
 
 == Features
 
@@ -30,22 +30,24 @@ Then bundle install:
 
 A lot more work has been done since the previous version. endeca_xml now constructs an XML query to send to thanxmedia via a form submission. An example of how the form is formatted is below:
 
-  <form action="/endeca" method="post">
+  <form method="post" action="/endeca">
     <input type="hidden" name="endeca[base]" value="{'RecordsSet' => true, 'Dimensions' => true, 'BusinessRulesResult' => true, 'AppliedFilters' => true}" />
-    <input type="hidden" name="endeca[nav]" value="{'type' => '', 'ids' => [1, 2, 3, 4]}" />
+    <input type="hidden" name="endeca[nav]" value="{'type' => 'category [or] dimension', 'ids' => [1, 2, 3, 4]}" />
     <input type="hidden" name="endeca[search]" value="{'search-key' => 'key', 'search-term' => 'term'}" />
     <input type="hidden" name="endeca[sort]" value="{'sort-key' => 'key', 'direction' => 'direction'}" />
     <input type="hidden" name="endeca[paging]" value="{'RecordsOffset' => 0, 'RecordsPerPage' => 10}" />
     <input type="hidden" name="endeca[parameters]" value="{'AggregationKey' => 'key'}" />
     <input type="hidden" name="endeca[profiles]" value="{'profiles' => [1, 2, 3, 4]}" />
-    <input type="hidden" name="endeca[filters]" value="{'filter' => {'option' => 'option', 'option' => 'option'}}" />
+    <input type="hidden" name="endeca[filters]" value="{'Between' => {'lower-bound' => 1, 'upper-bound' => 2, 'attribute-name' => 'test', 'lat-long' => 123.4, 'distance' => '100'}, 'LessThan' => {}, 'LessThanOrEqual' => {}, 'GreaterThan' => {}, 'GreaterThanOrEqual' => {}, 'GeocodeLessThan' => {}, 'GeocodeGreaterThan' => {}, 'GeocodeBetween' => {}}" />
     <input type="submit" />
   </form>
-	
+  
+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 input field, and if you don't need a value within an option don't include it.
+  
 == TODO
 
-* <s>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.</s>
-* <s>Have EndecaXml make the request after its all done constructing the query rather than requiring that the developer use the request method.</s>
+* (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

data/lib/endeca_xml/version.rb

@@ -1,3 +1,3 @@
 class EndecaXml
-  VERSION = "0.5.1"
+  VERSION = "0.5.3"
 end

data/lib/endeca_xml.rb

@@ -7,41 +7,49 @@ require 'uri'
 # each input name corresponds to a function that is called when building the XML. It is important that the names stay the same (for now)!
 #
 # <form action="/endeca" method="post">
+#   <input type="hidden" name="endeca[host]" value="{'host' => 'http://eodhc.endecaondemand.net:35828/ws/main'}">
 #   <input type="hidden" name="endeca[base]" value="{'RecordsSet' => true, 'Dimensions' => true, 'BusinessRulesResult' => true, 'AppliedFilters' => true}" />
-#   <input type="hidden" name="endeca[nav]" value="{'type' => '', 'ids' => [1, 2, 3, 4]}" />
+#   <input type="hidden" name="endeca[nav]" value="{'type' => 'category [or] dimension', 'ids' => [1, 2, 3, 4]}" />
 #   <input type="hidden" name="endeca[search]" value="{'search-key' => 'key', 'search-term' => 'term'}" />
 #   <input type="hidden" name="endeca[sort]" value="{'sort-key' => 'key', 'direction' => 'direction'}" />
 #   <input type="hidden" name="endeca[paging]" value="{'RecordsOffset' => 0, 'RecordsPerPage' => 10}" />
 #   <input type="hidden" name="endeca[parameters]" value="{'AggregationKey' => 'key'}" />
 #   <input type="hidden" name="endeca[profiles]" value="{'profiles' => [1, 2, 3, 4]}" />
-#   <input type="hidden" name="endeca[filters]" value="{'filter' => {'option' => 'option', 'option' => 'option'}}" />
+#   <input type="hidden" name="endeca[filters]" value="{'Between' => {'lower-bound' => 1, 'upper-bound' => 2, 'attribute-name' => 'test', 'lat-long' => 123.4, 'distance' => 100}, 'LessThan' => {}, 'LessThanOrEqual' => {}, 'GreaterThan' => {}, 'GreaterThanOrEqual' => {}, 'GeocodeLessThan' => {}, 'GeocodeGreaterThan' => {}, 'GeocodeBetween' => {}}" />
 #   <input type="submit" />
 # </form>
 
 class EndecaXml
-  
+
   def initialize(params)
     @body = Builder::XmlMarkup.new(:indent => 2)
-    
+
     # puts "PARAMS: #{params}"
-    
+
     # take the parameters past in a form post and creates the options hash out of each key|value pair, using the key as root key in a new hash, and the value as that hash's value
     options = {}
     params.each do |key, value|
       options.update(Hash[key, eval(value)])
     end
-    
+
     # puts "OPTIONS: #{options}"
-    
+
     # call a corresponding function based off the root key created for each hash in the options hash to build the endeca query
     options.each do |key, value|
       self.send(key.to_sym, value)
     end
-    
+
     # once the XML request is built send it off
     send_request
   end
-  
+
+  def host(options)
+    options.each do |key, value|
+      @uri = URI.parse(value)
+    end
+    @http = Net::HTTP.new(uri.host, uri.port)
+  end
+
   def base(options)
     # puts "BASE: #{options}"
     options.each do |key, value|
@@ -49,7 +57,7 @@ class EndecaXml
     end
     # print @body.target!
   end
-  
+
   def nav(options)
     # puts "NAV: #{options}"
     case options['type']
@@ -70,7 +78,7 @@ class EndecaXml
     end
     # puts @body.target!
   end
-  
+
   def search(options)
     # puts "SEARCH: #{options}"
     @body.Searches do
@@ -82,11 +90,11 @@ class EndecaXml
     end
     # puts @body.target!
   end
-  
+
   def sort(options)
     # puts "SORT: #{options}"
     @body.Sorts do
-      @body.Sort do 
+      @body.Sort do
         options.each do |key, value|
           @body.tag!(key, value)
         end
@@ -94,7 +102,7 @@ class EndecaXml
     end
     # puts @body.target!
   end
-  
+
   def paging(options)
     # puts "PAGING: #{options}"
     options.each do |key, value|
@@ -102,17 +110,17 @@ class EndecaXml
     end
     # puts @body.target!
   end
-  
+
   def parameters(options)
-    # puts "PARAMETERS: #{parameters}"
+    # puts "PARAMETERS: #{options}"
     options.each do |key, value|
       @body.tag!(key, value)
     end
     # puts @body.target!
   end
-  
+
   def profiles(options)
-    # puts "PROFILES: #{profiles}"
+    # puts "PROFILES: #{options}"
     @body.UserProfiles do
       options.each do |key, value|
         # puts "#{key}: #{value}"
@@ -123,56 +131,40 @@ class EndecaXml
     end
     # puts @body.target!
   end
-  
-  # FILTERS                   VALUE                   DEFAULT
-  # ---------------------------------------------------------
-  # Between
-  # LessThan
-  # LessThanOrEqual
-  # GreaterThan
-  # GreaterThanOrEqual
-  # GeocodeLessThan
-  # GeocodeGreaterThan
-  # GeocodeBetween
-    
-  # OPTIONS                   VALUE                   DEFAULT
-  # ---------------------------------------------------------
-  # attribute-name
-  # lower-bound
-  # upper-bound
-  # lat-long
-  # distance
-  def filters(filters)
-    puts "FILTERS: #{filters}"
-    # filters.each do |filter|
-    #   @body.RangeFilters do
-    #     @body.tag!(filter[0], filter[1]) do
-    #       filters[2].each do |option|
-    #         @body.tag!(option[0], option[1])
-    #       end
-    #     end
-    #   end
-    # end
+
+  def 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 get_records
-    @blarg['RecordsSet']['Record'].each do |record|
+    @response['RecordsSet']['Record'].each do |record|
       record.each do |key, value|
         puts "#{key}: #{value}"
       end
     end unless response['RecordsSet'].nil?
   end
-  
+
   def get_breadcrumbs
-    @blarg['Breadcrumbs']['Breads'].each do |crumb|
+    @response['Breadcrumbs']['Breads'].each do |crumb|
       crumb.each do |key, value|
         puts "#{key}: #{value}"
       end
     end unless response['Breadcrumbs'].nil?
   end
-  
+
   def get_dimensions
-    @blarg['Dimensions']['Dimension'].each do |dimension|
+    @response['Dimensions']['Dimension'].each do |dimension|
       dimension.each do |key, value|
         puts "#{key}: #{value}"
         if key == 'DimensionValues'
@@ -187,19 +179,19 @@ class EndecaXml
               puts "  #{key}: #{value}"
             end
           end
-        end 
+        end
       end
     end unless response['Dimensions'].nil?
   end
-  
+
   def get_business_rules
-    @blarg['BusinessRulesResult']['BusinessRules']['BusinessRule'].each do |rule|
+    @response['BusinessRulesResult']['BusinessRules']['BusinessRule'].each do |rule|
       rule.each do |key, value|
         puts "#{key}: #{value}"
         value.each do |key, value|
           puts "  #{key}: #{value}"
         end if key == 'properties'
-        
+
         if key == 'RecordSet'
           if value.instance_of?(Array)
             value['Record'].each do |record|
@@ -216,15 +208,15 @@ class EndecaXml
       end
     end unless response['BusinessRulesResult'].nil?
   end
-  
+
   def get_applied_filters
-    @blarg['AppliedFilters'].each do |filter|
+    @response['AppliedFilters'].each do |filter|
       puts "FILTER: #{filter}"
     end unless response['AppliedFilters'].nil?
   end
-  
+
   private
-  
+
   # complete the endeca XML reqeust and send the request to the endeca API
   def send_request
     # insert all of the XML blocks that have been included in the request into the endeca Query XML tag
@@ -232,26 +224,21 @@ class EndecaXml
     query.Query do
       query << @body.target!
     end
-    
+
     # puts "QUERY: #{query.target!}"
-    
-    uri = URI.parse('http://workbench.deliverframework.net:4000/ws/main')
-    http = Net::HTTP.new(uri.host, uri.port)
-    
+
     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(Crack::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
-  
-  # get the request response
-  def response
-    # parse XML response into an hash
-    response = Crack::XML.parse(@response)
+
+  # get the request response and parse it into an hash
+  def handle_response(response)
     # puts "RESPONSE: #{response}"
-    
-    @blarg = response['Final']
+    @response = response['Final']
   end
-  
+
 end

metadata

@@ -2,7 +2,7 @@
 name: endeca_xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors: 
 - sdomino
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-23 00:00:00 Z
+date: 2011-07-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: crack