rawscsi 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 335008cad4298d74c3a008b6dc3d9e6ab0f52588
-  data.tar.gz: b1dae029204a1a1db586a9018f8e2d7c314d96f2
+  metadata.gz: 9a48727f1ce5747eb4e17b40c6f1c127ab6e9856
+  data.tar.gz: 0184aedf458884c6096147a4d567da364d7139f0
 SHA512:
-  metadata.gz: 34f19cb0137d62bf6d5ded203ae279f3d885aa42b1e3536865aff772e84f70a925f23d2add0a4ecf3125747aa25b870a91eab97c2aa9c8a7b16cc8d300023d7e
-  data.tar.gz: e4d1196c9b3473289cd69c42ee586739f0fd317873f2492e7e8aaec59721a10cf08dfac551b6f2045d180d5b31b892856c46a071cab1c3aa2d22bab63e79290c
+  metadata.gz: d1984ddc35a40d5e656a033aebaa8196f149f7273a0016b60be0a2f2476d65a1949063ea27f427ef438f5976930f0885353827326667bca7343e92a806e65e15
+  data.tar.gz: fd9f43df1cf9dac1d3a270ae159f94b7a76e84659e4b230f4d2473a030f0752e5149655483a0dbb807698333bb97d5e80bbf1e6c2f65db064c44ecdc26c9cb73

data/README.md

@@ -27,7 +27,7 @@ search_object.search(q: {
                                         }
                                  }]
                          },
-                      date: {release_date: "[1970-01-01,}"},
+                      date: {release_date: "['1970-01-01',}"},
                       sort: "rating desc",
                       limit: 3
                     )
@@ -40,7 +40,9 @@ In theory, if the query is allowed on Cloudsearch, this gem can construct it.
 
 4) Has some nice Active Record integration features.
 
-5) Supports Ruby 1.8.7, 1.9.3, 2.0.0, 2.1.0, and 2.1.2
+5) Supports Ruby 1.9.3, 2.0.0, 2.1.0, and 2.1.2
+
+6) Supports Pagination
 
 Here's the official aws cloud search documentation: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/what-is-cloudsearch.html
 
@@ -96,9 +98,10 @@ book_indexer = Rawscsi::Index.new('Book')
 # since Book is not an active record object, we upload hashes instead
 # Note the id key in the hash  will be used as the cloud search record id.
 book_indexer.upload([
-  {id: 1234, title: "Surely you're Joking, Mr. Feynman", author: "Richard Feynman"},
-  {id: 5546, title: "Zen and the Art of Motorcycle Maintanence", author: "Robert Pirsig"}
+  {id: 1234, title: "Surely you're Joking, Mr. Feynman", author: "Richard Feynman", publish_date: "1985-01-01T00:00:00Z"},
+  {id: 5546, title: "Zen and the Art of Motorcycle Maintanence", author: "Robert Pirsig", publish_date: "1974-04-01T00:00:00Z"}
 ])
+# Also note the date format
 ```
 
 ### Deleting indices
@@ -182,13 +185,13 @@ search_songs.search(q: {
                                 { title: "Street"}
                                ]
                          },
-                    date: { release_date: "[1995-01-01,}"}
+                    date: { release_date: "['1995-01-01',}"}
                     limit: 5,
                     sort: "rating desc"
                    ) 
 # Conjunction of two constraints and date constraint (Top 5 Hip Hop songs with Street in title released after 1995)
 # Note date syntax is working in conjunction (and) with the frist two constraints. This is always the case.
-# Also note syntax for searching date ranges: "[1995-01-01,}" is all dates after Jan 1 1995 while "{,1995-01-01]" is all dates before.
+# Also note syntax for searching date ranges: "['1995-01-01',}" is all dates after Jan 1 1995 while "{,'1995-01-01']" is all dates before.
 # Note we're limiting only 5 results and sorting by rating in descending order.
 => [{song_id: 54642, title: "Street Dreams", artist: "Nas"},
     {song_id: 98786, title: "Street Struck", artist: "Big L"},
@@ -253,6 +256,16 @@ search_songs.search(q: {and: [ {artist: "Cold Play"} ],
 
 ```
 
+### Pagination
+
+```ruby
+# paginate with the `start` and `limit` params
+search_songs.search(q: {and: [{artist: "Beatles"}]},
+                    start: 25,
+                    limit: 5)
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/rawscsi/query/compound.rb

@@ -11,6 +11,7 @@ module Rawscsi
           query,
           date,
           sort,
+          start,
           limit,
           fields,
           "q.parser=structured"
@@ -42,7 +43,12 @@ module Rawscsi
         return nil unless query_hash[:sort]
         encode("sort=#{query_hash[:sort]}")
       end
-      
+
+      def start
+        return nil unless query_hash[:start]
+        "start=#{query_hash[:start]}"
+      end
+     
       def limit
         return nil unless query_hash[:limit]
         "size=#{query_hash[:limit]}"

data/lib/rawscsi/version.rb

@@ -1,3 +1,3 @@
 module Rawscsi
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/lib/rawscsi/query/compound_spec.rb

@@ -76,5 +76,15 @@ describe Rawscsi::Query::Compound do
 
     expect(str).to eq("q=(and%20title:%27star%27(not%20title:%27wars%27))&q.parser=structured")
   end
+
+  it "constructs a query with pagination" do
+    arg = {
+      :q => {:and => [{:title => "star wars"}]},
+      :start => 2,
+      :limit => 3
+    }
+    str = Rawscsi::Query::Compound.new(arg).build
+    expect(str).to eq("q=(and%20title:%27star%20wars%27)&start=2&size=3&q.parser=structured")
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rawscsi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Steven Li
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler