endeca_xml 0.5.0 → 0.5.1

data/README.rdoc

@@ -1,10 +1,12 @@
 = endeca_xml
 
-endeca_xml provides a way for you to make http requests via the endeca XML API.
+endeca_xml provides an interface between your web application and the Endeca (via thankxmedia) XML API
 
 == Features
 
-not much right now, but it will get there... hopefully
+* Builds an XML query, formatted to thanxmedia specifications, via form filed hidden inputs which specify all the desired settings
+* Parses the settings parameters and sends a completed XML query to thanxmedia API
+* Handles the response XML and exposes methods to retrieve response data 
 	
 == Install
 
@@ -22,20 +24,31 @@ Then bundle install:
 	
 === Non Rails
 
- gem install compressit
+ gem install endeca_xml
  
 == 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.
+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">
+    <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>
 	
 == 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.
+* <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>
 * 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
 
 == Copyright
 

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     = '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.summary     = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
+  s.description = 'endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API'
 
   s.rubyforge_project = 'endeca_xml'
   

data/lib/endeca_xml/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: endeca_xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - sdomino
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: "endeca_xml provides a way for you to make http requests via the endeca XML API. "
+description: endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
 email: 
 - sdomino@pagodabox.com
 executables: []
@@ -89,6 +89,6 @@ rubyforge_project: endeca_xml
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: endeca_xml provides a way for you to make http requests via the endeca XML API.
+summary: endeca_xml provides an interface between your web application and the thanxmedia Endeca XML API
 test_files: []