endeca_xml 0.2.5 → 0.5.0

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,42 @@
+= endeca_xml
+
+endeca_xml provides a way for you to make http requests via the endeca XML API.
+
+== Features
+
+not much right now, but it will get there... hopefully
+	
+== Install
+
+=== Rails
+
+Add this line to your Gemfile:
+
+ gem 'endeca_xml'
+
+Then bundle install:
+	
+ bundle install
+	
+---
+	
+=== Non Rails
+
+ gem install compressit
+ 
+== Usage
+
+The gem provides examples of each of the methods available. Right now its kind of clunky and you have to call each method individually to construct the XML request, then submit it. The response is returned as a 'cracked' ruby hash.
+	
+== TODO
+
+* 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.
+* 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.
+
+---
+
+== Copyright
+
+Copyright (c) 2011 Steve Domino. See LICENSE.txt for further details

data/endeca_xml.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['sdomino']
   s.email       = ['sdomino@pagodabox.com']
   s.homepage    = 'http://www.pagodabox.com'
-  s.summary     = ''
-  s.description = ''
+  s.summary     = 'endeca_xml provides a way for you to make http requests via the endeca XML API. '
+  s.description = 'endeca_xml provides a way for you to make http requests via the endeca XML API. '
 
   s.rubyforge_project = 'endeca_xml'
   

data/lib/endeca_xml/version.rb

@@ -1,3 +1,3 @@
 class EndecaXml
-  VERSION = "0.2.5"
+  VERSION = "0.5.0"
 end

data/lib/endeca_xml.rb

@@ -3,82 +3,125 @@ require 'crack'
 require 'net/http'
 require 'uri'
 
+# This is an example of the form used to post all the desired options that will be used to construct the endeca XML query,
+# 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[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[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="submit" />
+# </form>
+
 class EndecaXml
   
-  def initialize
+  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
   
-  # adds endeca base options to the endeca query (ex. endeca.add_base_options(['Dimensions', true], ['RecordsSet', true], ['BusinessRulesResult', true], ['AppliedFilters', true]))
-  def add_base_options(*options)
-    options.each do |option|
-      @body.tag!(option[0], option[1])
+  def base(options)
+    # puts "BASE: #{options}"
+    options.each do |key, value|
+      @body.tag!(key, value)
     end
+    # print @body.target!
   end
   
-  # IMPORTANT: this option is mutually exclusive with the add_search option
-  # makes the endeca query a type nav (ex. endeca.add_nav('category', [1, 2, 3, 4, 5]))
-  def add_nav(type, ids)
-    case type
+  def nav(options)
+    # puts "NAV: #{options}"
+    case options['type']
     when 'category'
-      @body.SelectedDimensionalValueIds do
-        ids.each do |id|
-          @body.tag!('DimensionValueId', id)
+      @body.Category do
+        options['ids'].each do |id|
+          @body.tag!('Category', id)
         end
       end
     when 'dimension'
-      @body.Category do
-        ids.each do |id|
-          @body.tag!('Category', id)
+      @body.SelectedDimensionalValueIds do
+        options['ids'].each do |id|
+          @body.tag!('DimensionValueId', id)
         end
       end
+    else
+      #
     end
+    # puts @body.target!
   end
   
-  # IMPORTANT: this option is mutually exclusive with the add_nav option
-  # makes the endeca query a type search (ex. endeca.add_searches(['searck-key', 'primary'], ['serach-term', 'gold']))
-  def add_searches(*options)
+  def search(options)
+    # puts "SEARCH: #{options}"
     @body.Searches do
       @body.Search do
-        options.each do |option|
-          @body.tag!(option[0], option[1])
+        options.each do |key, value|
+          @body.tag!(key, value)
         end
       end
     end
+    # puts @body.target!
   end
   
-  # add sorting to the endeca query (ex. endeca.add_sorting(['sort-key', 'p_price_sort'], ['sort-direction', 'Descending']))
-  def add_sorting(*options)
+  def sort(options)
+    # puts "SORT: #{options}"
     @body.Sorts do
       @body.Sort do 
-        options.each do |option|
-          @body.tag!(option[0], option[1])
+        options.each do |key, value|
+          @body.tag!(key, value)
         end
       end
     end
+    # puts @body.target!
   end
   
-  # adds paging to the endeca query (ex. endeca.add_paging(['RecrodOffset', 0], ['RecordsPerPage', 10]))
-  def add_paging(*options)
-    options.each do |option|
-      @body.tag!(option[0], option[1])
+  def paging(options)
+    # puts "PAGING: #{options}"
+    options.each do |key, value|
+      @body.tag!(key, value)
     end
+    # puts @body.target!
   end
   
-  # adds advanced parameters to the endeca query (ex. endeca.add_advanced_parameters(['AggregationKey', 'p_group_id']))
-  def add_advanced_parameters(*parameters)
-    parameters.each do |parameter|
-      @body.tag!(parameter[0], parameter[1])
+  def parameters(options)
+    # puts "PARAMETERS: #{parameters}"
+    options.each do |key, value|
+      @body.tag!(key, value)
     end
+    # puts @body.target!
   end
   
-  # adds user profiles to the endeca query (ex. endeca.add_user_profiles([1, 2, 3, 4, 5]))
-  def add_user_profiles(profiles)
+  def profiles(options)
+    # puts "PROFILES: #{profiles}"
     @body.UserProfiles do
-      profiles.each do |profile|
-        @body.tag!('UserProfile', profile)
+      options.each do |key, value|
+        # puts "#{key}: #{value}"
+        value.each do |profile|
+          @body.tag!('UserProfile', profile)
+        end
       end
     end
+    # puts @body.target!
   end
   
   # FILTERS                   VALUE                   DEFAULT
@@ -99,26 +142,99 @@ class EndecaXml
   # upper-bound
   # lat-long
   # distance
-  def add_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])
+  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
+  end
+  
+  def get_records
+    @blarg['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|
+      crumb.each do |key, value|
+        puts "#{key}: #{value}"
+      end
+    end unless response['Breadcrumbs'].nil?
+  end
+  
+  def get_dimensions
+    @blarg['Dimensions']['Dimension'].each do |dimension|
+      dimension.each do |key, value|
+        puts "#{key}: #{value}"
+        if key == 'DimensionValues'
+          if value['DimensionValue'].instance_of?(Array)
+            value['DimensionValue'].each do |value|
+              value.each do |key, value|
+                puts "  #{key}: #{value}"
+              end
+            end
+          elsif value['DimensionValue'].instance_of?(Hash)
+            value['DimensionValue'].each do |key, value|
+              puts "  #{key}: #{value}"
+            end
+          end
+        end 
+      end
+    end unless response['Dimensions'].nil?
+  end
+  
+  def get_business_rules
+    @blarg['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|
+              record.each do |key, value|
+                puts "  #{key}: #{value}"
+              end
+            end
+          elsif value.instance_of?(Hash)
+            value['Record'].each do |key, value|
+              puts "  #{key}: #{value}"
+            end
           end
         end
       end
-    end
+    end unless response['BusinessRulesResult'].nil?
+  end
+  
+  def get_applied_filters
+    @blarg['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 request
+  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!}"
+    
     uri = URI.parse('http://workbench.deliverframework.net:4000/ws/main')
     http = Net::HTTP.new(uri.host, uri.port)
     
@@ -129,10 +245,13 @@ class EndecaXml
     end
   end
   
-  # return the request response
+  # get the request response
   def response
-    # parse XML response into an hash and return
-    return Crack::XML.parse(@response)
+    # parse XML response into an hash
+    response = Crack::XML.parse(@response)
+    # puts "RESPONSE: #{response}"
+    
+    @blarg = response['Final']
   end
   
 end

metadata

@@ -2,7 +2,7 @@
 name: endeca_xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.5
+  version: 0.5.0
 platform: ruby
 authors: 
 - sdomino
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-22 00:00:00 Z
+date: 2011-06-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: crack
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: ""
+description: "endeca_xml provides a way for you to make http requests via the endeca XML API. "
 email: 
 - sdomino@pagodabox.com
 executables: []
@@ -57,7 +57,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- LICENSE.txt
+- README.rdoc
 - Rakefile
 - endeca_xml.gemspec
 - lib/endeca_xml.rb
@@ -88,6 +89,6 @@ rubyforge_project: endeca_xml
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: ""
+summary: endeca_xml provides a way for you to make http requests via the endeca XML API.
 test_files: []