endeca_on_demand 0.9.9.7 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.rdoc +19 -15
  2. data/lib/endeca_on_demand/version.rb +1 -1
  3. metadata +6 -6
data/README.rdoc CHANGED
@@ -1,17 +1,22 @@
1
1
  == EndecaOnDemand
2
+ ---
2
3
 
3
4
  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.
4
5
 
5
- 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.
6
-
7
6
  === Features
8
-
9
7
  * Provides an easy way for you to use the Thanx Media, Endeca On-Demand Web API
10
8
  * Builds an XML query from a query-string, formatted for the Endeca On-Demand Service
11
9
  * Handles the Endeca On-Demand response XML and exposes methods to use response data
12
10
 
13
- === Install
11
+ 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.
12
+
13
+ ==== What I would like to see:
14
+ * Information reguarding the JSON equivelent of this implementation so I can add JSON support
15
+ * Information reguarding filters, to enhance this functionality
16
+ * Additional advanced parameters
17
+ ---
14
18
 
19
+ === Install
15
20
  ==== Rails
16
21
 
17
22
  Add this line to your Gemfile:
@@ -22,14 +27,13 @@ Then bundle install:
22
27
 
23
28
  bundle install
24
29
 
25
- ---
26
-
27
30
  ==== Non Rails
28
31
 
29
32
  gem install endeca_on_demand
30
33
 
31
- === Usage
34
+ ---
32
35
 
36
+ === Usage
33
37
  EndecaOnDemand constructs an XML query to send to a hosted Endeca On-Demand Cluster, via a query string:
34
38
  NOTE: This is a complete example. Any unneeded option should not be included in the query-string
35
39
 
@@ -104,24 +108,24 @@ Each object will then have associated instance variables exposed that will allow
104
108
  - @endeca.records.each do |record|
105
109
  puts "----- RECORD NAME: #{record.p_name}"
106
110
 
107
- === F.A.Q
111
+ ---
108
112
 
113
+ === F.A.Q
109
114
  * Q: I'm getting a response error saying something about multiple values for model Category
110
115
  * 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.
116
+ ---
111
117
 
112
118
  === TODO
113
-
114
- * [complete] More detail on breadcrumbs (and their suggested use as left nav filters)
115
- * Build in support for filters
116
119
  * Add tests
120
+ * Build in support for filters
117
121
  * I don't have all the possible advanced parameters, so for now it only handles the default 'AggregationKey'
118
122
  * 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
119
- * [complete] Review the classes and create any additional classes that might be useful where only an instance variable currently exists
123
+ * I would love it if this could server for both XML and JSON (and whatever additional formats they offer)
124
+ ---
120
125
 
121
126
  === CONTACT
122
-
123
- Please contact me with any question, bugs, suggestions, etc.
127
+ Please contact me with any question, bugs, additions, suggestions, etc.
128
+ ---
124
129
 
125
130
  === Copyright
126
-
127
131
  Copyright (c) 2011 Steve Domino. See LICENSE.txt for further details
data/lib/endeca_on_demand/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  class EndecaOnDemand
2
- VERSION = "0.9.9.7"
2
+ VERSION = "1.0.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: endeca_on_demand
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.9.7
4
+ version: 1.0.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2011-09-09 00:00:00.000000000Z
12
+ date: 2011-10-12 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rspec
16
- requirement: &70200054861740 !ruby/object:Gem::Requirement
16
+ requirement: &70252400457400 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '0'
22
22
  type: :development
23
23
  prerelease: false
24
- version_requirements: *70200054861740
24
+ version_requirements: *70252400457400
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: nokogiri
27
- requirement: &70200054861100 !ruby/object:Gem::Requirement
27
+ requirement: &70252400456640 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
32
32
  version: '0'
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *70200054861100
35
+ version_requirements: *70252400456640
36
36
  description: EndecaOnDemand will take a query-string and construct an XML query and
37
37
  send it to an hosted Endeca On-Demand Cluster. It will then parse the response and
38
38
  expose an API for using the response data.