Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1000Bulbs/gsa
Ruby library for working with a Google Search Appliance
https://github.com/1000Bulbs/gsa
Last synced: 3 months ago
JSON representation
Ruby library for working with a Google Search Appliance
- Host: GitHub
- URL: https://github.com/1000Bulbs/gsa
- Owner: 1000Bulbs
- License: mit
- Created: 2013-09-17T19:03:05.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-10T14:37:16.000Z (over 9 years ago)
- Last Synced: 2024-07-27T18:53:06.265Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 825 KB
- Stars: 5
- Watchers: 11
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# The GSA Ruby Gem
Quickly and easily harness GSA indexing power with one-line feeding, searching, and faceting.
## Installation
```
gem install gsa
```
## Default Port
the default port is set to the secure port 19902
to change the port to http, set the feed extension to the following:
```ruby
GSA::FEED_EXTENSION = ":19900/xmlfeed"
```
## 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, "id" )
```
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')
```
You can also do an embedded request, which means that you receive the search results in HTML. By setting the proxystylesheet parameter you define which stylesheet is used to style the results. You can set this up in your GSA.
```ruby
GSA.search( query, embedded: true, proxystylesheet: "default_frontend")
```
### 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
:start
>* Maps to the GSA 'start' parameter
>* Use this parameter alongside 'num' for pagination of search results
>* Accepted values: 0..results_set_last_result
>* Default value: 0 ( starts with first result )
: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 to the GSA 'requiredfields' parameter
>* Filters search results to conform to specific required attributes
>* Example: 'name:Foo'
>* Example: 'name:Foo.price:12'
:client
>* Maps to the GSA 'client' parameter
>* Determines which Front End you want to search against
>* Default value: 'default_frontend'
:collection
>* Maps to GSA 'site' parameter
>* Determines which collection you want to search against
>* Default value: 'default_collection'
:proxystylesheet
>* Maps to the GSA 'proxystylesheet' parameter
>* Determines which frontend styling you want to style your embedded results with
>* If the value of the output parameter is xml_no_dtd, the output format is modified by the proxystylesheet value
>* Example: 'default_frontend'
:proxyreload
>* Maps to the GSA 'proxyreload' parameter
>* Instructs the Google Search Appliance when to refresh the XSL stylesheet cache
>* Default: '0'
>* NOTE: Set this to 1 if you change the stylesheet in your GSA, this should be an environment variable so you can refresh the stylesheet without deploying new code. Setting this to 1 by default is not advised since it will slow down your application.
:emmain
>* Maps to the GSA 'emmain' parameter
>* Incoming query parameter identifying root path prefix to be used for links that should refresh the main page.
>* Example: 'search/'
:emsingleres
>* Maps to the GSA 'emsingleres' parameter
>* Incoming query parameter identifying root path prefix to be used for resources that should be loaded in isolation
>* Example: 'search/'
:emdstyle
>* Maps to the GSA 'emdstyle' parameter
>* Incoming query parameter for enabling/disabling style for embedded mode, either true or false.
>* Example: 'true'
:entqr
>* Maps to the GSA 'entqr' parameter
>* This parameter sets the query expansion policy
>* Default: '0'
:entsp
>* Maps to the GSA 'entsp' parameter
>* The entsp parameter controls the use of the advanced relevance scoring parameters that you set under Result Biasing on the Admin Console. (XXX is name rule)
>* Default: '0'
:tlen
>* Maps to the GSA 'tlen' parameter
>* Specifies the number of bytes that would be used to return the search results title.
>* Default: '70'
## Faceting
To leverage faceting, you need to enable Dynamic Navigation and
configure a Front End on your GSA box.
[Read more information here.](https://www.google.com/support/enterprise/static/gsa/docs/admin/72/admin_console_help/serve_dynamic_navigation.html)
## Copyright
Copyright (c) 2013 1000Bulbs.com.
See [LICENSE][] for details.
[license]: LICENSE.txt