gsa 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a14fd20e6eab24e62e9bdf79bdc7633d8100f2e
-  data.tar.gz: acdd16a7b561e11cc310a773a8ac3211ae8d1c31
+  metadata.gz: 570dde0bff59cfa5ce35235ecba50b7581c8e253
+  data.tar.gz: e472fddce0452384ad4818989d1d09ca47af7ca5
 SHA512:
-  metadata.gz: 8e4b4221ea6dbd2005af2d51e69da8d6f9555fd65d26f5469e09acb2590670b6be1d649b800c528346cd6f1a0182423747a084e53e82e756cecce5a66adda1c5
-  data.tar.gz: 9369cc86c10f1a5a69d541be21b6680930f0be6929ea40a32c85db8f5b2810098bcfebc9e3a1f65865e35954a4643a14328e8551c013b13146915c45832fe45e
+  metadata.gz: beb89c2f1e48329712e0228e302b52b39368a1b5a9695a6d15ced91ffc75e00f4c1049834d9d4121d24ff4bd7bc1032c6f60e12509a16b844bdff4217a4aa4b8
+  data.tar.gz: fe4a75383e1abd105fc2a8d92e1406334d359342eb5e32251d7739e82a6ec67c85d21c5d0fcb137cad4244fce8010df8e376d3475012ee534bc329635a21ffe3

data/README.md

@@ -74,7 +74,7 @@ GSA.search( query )
 To extract the UIDs from the search results, use the uids method on the search results:
 
 ```ruby
-GSA.uids( search_results )
+GSA.uids( search_results, "id" )
 ```
 
 To filter results using GSA filters, pass in an optional 'filters' key-value pair:
@@ -121,16 +121,22 @@ Optional Parameters:
 >* Default value: "*"
 
 :sort
->* Maps to the GSA 'sort' parameter.
+>* Maps to the GSA 'sort' parameter
 >* Accepted values: 'relevance', 'date'
 >* Default value: 'relevance'
 
 :num
->* Maps to the GSA 'num' parameter.
+>* 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

data/fixtures/cassette_library/many_results_no_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/cassette_library/many_results_with_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Sylvania&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Sylvania&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -65,7 +65,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 13:00:08 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/cassette_library/no_result_no_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=FooBar&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=FooBar&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/cassette_library/no_result_with_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:FooBar&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:FooBar&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/cassette_library/single_result_no_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20bulb&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20bulb&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -201,7 +201,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 12:24:26 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -288,7 +288,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 12:27:07 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20Incandescent%20bulb%20excellent%20and%20haunting&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20Incandescent%20bulb%20excellent%20and%20haunting&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -354,7 +354,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 12:39:05 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20Incandescent%20bulb%20excellent%20and%20haunting%20blue%20bulb&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=blue%20Incandescent%20bulb%20excellent%20and%20haunting%20blue%20bulb&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -420,7 +420,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 12:40:12 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=amazing%20and%20heavenly%20red%20bulb&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=amazing%20and%20heavenly%20red%20bulb&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/fixtures/cassette_library/single_result_with_filters.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Fiberglass&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Fiberglass&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -56,7 +56,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 13:41:27 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Glass&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Glass&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''
@@ -121,7 +121,7 @@ http_interactions:
   recorded_at: Wed, 18 Sep 2013 13:41:58 GMT
 - request:
     method: get
-    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Brass&sort=relevance
+    uri: http://dev-gsa.1000bulbs.com/search?filter=0&getfields=*&num=1000&output=xml_no_dtd&q=excellent%20blue%20bulb&requiredfields=brand:Philips.material:Brass&sort=relevance&start=0
     body:
       encoding: US-ASCII
       string: ''

data/lib/defaults.rb

@@ -19,6 +19,7 @@ module Defaults
   DEFAULT_GETFIELDS      = "*"           # OPTIONS: * || names of specific metadatum. ie: price || name.price.description
   DEFAULT_SORT           = "relevance"   # OPTIONS: relevance, date
   DEFAULT_OUTPUT         = "xml_no_dtd"  # OPTIONS: xml_no_dtd, xml
+  DEFAULT_START          = "0"           # OPTIONS: 0..max_search_results
   NO_RESULTS             = 0
 
   # values for making xml files

data/lib/gsa/searcher.rb

@@ -7,9 +7,10 @@ module GSA
       sort            = args[:sort]      || GSA::DEFAULT_SORT
       num             = args[:num]       || GSA::DEFAULT_NUM  
       output          = args[:output]    || GSA::DEFAULT_OUTPUT
+      start           = args[:start]     || GSA::DEFAULT_START
       requiredfields  = args[:filters]   || nil
 
-      search = "#{GSA.base_uri}/search?q=#{query}&filter=#{filter}&getfields=#{getfields}&sort=#{sort}&num=#{num}&output=#{output}"
+      search = "#{GSA.base_uri}/search?q=#{query}&filter=#{filter}&getfields=#{getfields}&sort=#{sort}&num=#{num}&start=#{start}&output=#{output}"
       search = "#{search}&requiredfields=#{clean_query(requiredfields)}" if requiredfields
 
       search_results = parsed_json( RestClient.get(search) )

data/lib/gsa/version.rb

@@ -1,3 +1,3 @@
 module GSA
-  VERSION = "0.5.4"
+  VERSION = "0.6.0"
 end

metadata

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