endeca_on_demand 0.9.9.7 → 1.0.0

data/README.rdoc

@@ -1,17 +1,22 @@
 == EndecaOnDemand
+---
 
 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.
 
-NOTE: There are aspects of this that I am unable to test simply because the implementation I used to create it wasn't using all available options. Please, if you run into issues let me know so I can add anything thats missing, or feel free to add it yourself.
-
 === 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
 
-=== Install
+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:
+* 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
 
 Add this line to your Gemfile:
@@ -22,14 +27,13 @@ Then bundle install:
 
  bundle install
 
----
-
 ==== Non Rails
 
  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
 
@@ -104,24 +108,24 @@ Each object will then have associated instance variables exposed that will allow
   - @endeca.records.each do |record|
     puts "----- RECORD NAME: #{record.p_name}"
   
-=== 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
-
-* [complete] More detail on breadcrumbs (and their suggested use as left nav filters)
-* Build in support for filters
 * 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
-* [complete] Review the classes and create any additional classes that might be useful where only an instance variable currently exists
+* I would love it if this could server for both XML and JSON (and whatever additional formats they offer)
+---
 
 === CONTACT
-
-Please contact me with any question, bugs, suggestions, etc.
+Please contact me with any question, bugs, additions, suggestions, etc.
+---
 
 === Copyright
-
 Copyright (c) 2011 Steve Domino. See LICENSE.txt for further details

data/lib/endeca_on_demand/version.rb

@@ -1,3 +1,3 @@
 class EndecaOnDemand
-  VERSION = "0.9.9.7"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: endeca_on_demand
 version: !ruby/object:Gem::Version
-  version: 0.9.9.7
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000Z
+date: 2011-10-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70200054861740 !ruby/object:Gem::Requirement
+  requirement: &70252400457400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70200054861740
+  version_requirements: *70252400457400
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70200054861100 !ruby/object:Gem::Requirement
+  requirement: &70252400456640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70200054861100
+  version_requirements: *70252400456640
 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.