gsa 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb7ab83987937bd6e2115d300a904349e76956b6
-  data.tar.gz: c8882dfaeda6c36d68204da988309cb21141ecfc
+  metadata.gz: b93fcf3b6efc2351766b21247a1ccfd3c277a7b7
+  data.tar.gz: e9f71ac590fd54b84c319125c1c2d1d848588a20
 SHA512:
-  metadata.gz: ae62141d18608f60d837ad1036d731988361b238c7d7f75a2b58280f12f6ffc8f2254771d96242d6ca64d4ff349418a153d3457d1e8e7d831bd67c233a70af74
-  data.tar.gz: b6c5745215040a1760f81a9aa5ec218dddb49c31f7f3fe609b33ebe9ae95fd39fc0bc2a608158bb1fc51b19117067fbd002a65895dccf3d9b060145fd4b3afb3
+  metadata.gz: d51c1c8d3aa4146748d6e3e5af4c98efb6721c65daab0e9d745d0bc9209a38aee44e774186e0a09a28ba9b477522a4ccb342aa48944a791c531f3decd264f75d
+  data.tar.gz: 4f68b3c840cfe33bb90ad2d1b6f15e99386c4b91d0d62b64161afe880a18f69a6301503ee58e284e7f452b98bbc34c3e43a59638b8fca9dd65c6384c0708da18

data/README.md

@@ -1,3 +1,182 @@
-## GSA Ruby Gem
-* Work in progress.
-* Documentation coming tomorrow (09/20/2013)
+# The GSA Ruby Gem
+
+Quickly and easily harness GSA indexing power with one-line feeding, searching, and faceting.
+
+## Installation
+```
+gem install gsa
+```
+
+## Getting Started
+Set the base uri to your GSA box
+```ruby
+GSA.base_uri = 'http://path-to-gsa-box.com/'
+```
+
+## Feeding
+
+1.) Structure the records you wish to feed to the GSA as an array of hashes
+```ruby
+@products = [ 
+{ :id => "1", :name => "Foo", :price => 12, :brand => 'BazBrand' },
+{ :id => "2", :name => "Bar", :price => 15, :brand => 'BazBrand' }
+]
+```
+
+2.) Feed the records to the GSA
+```ruby
+GSA.feed(
+  :records         => @products,
+  :searchable      => [:name, :price],
+  :datasource_name => "Baz",
+  :datasource_uri  => "http://your-app-base-url/products",
+  :datasource_uid  => "id",
+  :delete?         => false
+)
+```
+
+### Feed Parameters
+
+**Required**
+
+:records
+>The records source being pushed to the GSA index
+
+:searchable
+>Attributes on the record you want searched when a query is made
+
+:datasource_name
+>Name of the datasource on the GSA
+
+:datasource_uri
+>The URI for your records source
+
+:datasource_uid
+>The unique id of the record source
+
+**Optional**
+
+:delete?
+>Determines whether the feed is an "add" or a "delete" feed; defaults to "false"
+
+### Expected Feed result value
+
+If the feed is successful, the feed method will return "Success".
+
+## Searching
+
+To search, simply pass in a query:
+
+```ruby
+query = "Foo"
+GSA.search( query )
+```
+To extract the UIDs from the search results, use the uids method on the search results:
+
+```ruby
+GSA.uids( search_results )
+```
+
+To filter results using GSA filters, pass in an optional 'filters' key-value pair:
+
+```ruby
+# gets all search results for 'Foo' where the price is '12'
+query   = "Foo"
+filters = "price:12"
+GSA.search( query, :filters => filters)
+```
+
+Multiple filters can be passed in using a '.' in-between filters:
+
+```ruby
+filters = "price:12.name:Foo"
+```
+
+Multiple key-value pairs can be passed in as optional parameters to override defaults:
+
+```ruby
+GSA.search( query, :filters => filters, :num => 100, :sort => 'relevance', :output => 'xml')
+```
+
+### Search Parameters
+
+**Required**
+
+query
+>The query for the search
+
+Optional Parameters:
+
+:filter
+>* Maps to the GSA 'filter' parameter
+>* Accepted values: 0, 1, s, p
+>* Default value: 0
+
+:getfields
+>* Maps to the GSA 'getfields' parameter
+>* Pass in the names of specific attributes you want returned with the results
+>* Single attribute example: "name"
+>* Multiple attribute example: "name.price"
+>* Value to return all attributes: "*"
+>* Default value: "*"
+
+:sort
+>* Maps to the GSA 'sort' parameter.
+>* Accepted values: 'relevance', 'date'
+>* Default value: 'relevance'
+
+:num
+>* Maps to the GSA 'num' parameter.
+>* Use this parameter to limit the number of search results returned
+>* Accepted values: 1..1000
+>* Default value: 1000
+
+:output
+>* Maps to the GSA 'output' parameter.
+>* It is not recommended that you change this value from the default
+>* Accepted values: 'xml', 'no_dtd_xml'
+>* Default value: 'no_dtd_xml'
+
+:filters
+>* Maps the the GSA 'requiredfields' parameter
+>* Filters search results to conform to specific required attributes
+>* Example: 'name:Foo'
+>* Example: 'name:Foo.price:12'
+
+## Faceting
+
+To leverage faceting, simply pass in an array of symbols representing the attributes you want
+faceting for, alongside the search results you want faceted.
+
+```ruby
+categories = [:name, :brand]
+facets     = GSA.facet(search_results, categories)
+
+puts facets
+# {:name => [["Foo", 1], ["Bar", 1]], :brand => [["BazBrand", 2]]}
+```
+
+### Faceting Results
+
+The faceting method yields results in the following format:
+
+```ruby
+{
+  :category_one =>
+    [
+      ["Cluster 1", amount_of_records_in_cluster],
+      ["Cluster 2", amount_of_records_in_cluster],
+      ["Cluster 3", amount_of_records_in_cluster]
+    ],
+  :category_two =>
+    [
+      ["Cluster 1", amount_of_records_in_cluster]
+    ]
+}
+```
+
+## Copyright
+Copyright (c) 2013 1000Bulbs.com.
+See [LICENSE][] for details.
+
+[license]: LICENSE.txt

data/lib/gsa/modules/xmlizer.rb

@@ -18,7 +18,7 @@ module GSA
 
     # for creating attributes on tags
     def attributor(attributes)
-      inject_s(attributes) {|key, value| " #{key.to_s}='#{value.to_s}'"}
+      inject_s(attributes) {|key, value| " #{key.to_s}=\"#{value.to_s}\""}
     end
   end
 end

data/lib/gsa/version.rb

@@ -1,3 +1,3 @@
 module GSA
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gsa
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Daniel J. Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler