cloud_search 0.0.3 → 0.0.4

data/README.md

@@ -2,7 +2,8 @@
 
 # CloudSearch
 
-TODO: Write a gem description
+This is a simple Ruby wrapper around the Amazon's CloudSearch API. It has support for searching (with both simple and boolean queries), pagination
+and documents indexing.
 
 ## Installation
 
@@ -22,7 +23,7 @@ Or install it yourself as:
 
 The example bellow uses the Amazon's example database called `imdb-movies`:
 
-# Use your AWS CloudSearch configuration
+### Use your AWS CloudSearch configuration
 ``` ruby
 CloudSearch.configure do |config|
   config.domain_id   = "pl6u4t3elu7dhsbwaqbsy3y6be"
@@ -30,23 +31,31 @@ CloudSearch.configure do |config|
 end
 ```
 
-# Search for 'star wars' on 'imdb-movies'
+### Search for 'star wars' on 'imdb-movies'
 ``` ruby
-search = CloudSearch::Search.new
-resp   = search.with_fields(:actor, :director, :title, :year, :text_relevance)
-      .with_query("star wars")
-      .search
+searcher = CloudSearch::Searcher.new
+resp     = searcher.with_fields(:actor, :director, :title, :year, :text_relevance)
+         .with_query("star wars")
+         .search
 ```
 
-# Or you can search using part of the name
+### Or you can search using part of the name
 ``` ruby
-search = CloudSearch::Search.new
-resp   = search.with_fields(:actor, :director, :title, :year, :text_relevance)
-      .with_query("matri*")
-      .search
+searcher = CloudSearch::Searcher.new
+resp     = searcher.with_fields(:actor, :director, :title, :year, :text_relevance)
+         .with_query("matri*")
+         .search
 ```
 
-# Results
+### You can also search using boolean queries
+``` ruby
+searcher = CloudSearch::Searcher.new
+resp     = searcher.with_fields(:actor, :director, :title, :year, :text_relevance)
+         .with_boolean_query("year:2000")
+         .search
+```
+
+## Results
 ``` ruby
 resp.results.each do |result|
   movie = result["data"]
@@ -66,14 +75,14 @@ end
 ## Pagination
 
 The results you get back are (currently) API-compatible with will\_paginate:
-  
+
 ``` ruby
-search = CloudSearch::Search.new
-resp   = search.with_fields(:actor, :director, :title, :year, :text_relevance)
-      .with_query("star wars")
-      .with_items_per_page(30)
-      .at_pate(10)
-      .search
+searcher = CloudSearch::Searcher.new
+resp     = searcher.with_fields(:actor, :director, :title, :year, :text_relevance)
+         .with_query("star wars")
+         .with_items_per_page(30)
+         .at_page(10)
+         .search
 
 resp.total_entries #=> 5000
 resp.total_pages   #=> 167
@@ -85,13 +94,14 @@ resp.page_size     #=> 30
 ## Indexing documents
 
 ``` ruby
-document = CloudSearch::Document.new :type => "add", # or "delete"
+document = CloudSearch::Document.new :type    => "add", # or "delete"
                                      :version => 123,
-                                     :id => 680, :lang => :en,
-                                     :fields => {:title => "Lord of the Rings"}
+                                     :id      => 680,
+                                     :lang    => :en,
+                                     :fields  => {:title => "Lord of the Rings"}
 
 indexer = CloudSearch::Indexer.new
-indexer << document # add as many documents as you want
+indexer << document # add as many documents as you want (CloudSearch currently sets a limit of 5MB per documents batch)
 indexer.index
 ```
 

data/lib/cloud_search/searcher.rb

@@ -25,16 +25,26 @@ module CloudSearch
       response.items_per_page = items_per_page
       response
     end
-    
+
     def with_query(query)
       @query = query
       self
     end
 
+    def with_boolean_query(query)
+      @boolean = true
+      with_query query
+      self
+    end
+
     def query
       @query or ''
     end
 
+    def boolean_query?
+      !!@boolean
+    end
+
     def with_fields(*fields)
       @fields = fields
       self
@@ -65,10 +75,16 @@ module CloudSearch
 
     def url
       "#{CloudSearch.config.search_url}/search".tap do |u|
-        u.concat("?q=#{CGI.escape(query)}&size=#{items_per_page}&start=#{start}")
+        u.concat("?#{query_parameter}=#{CGI.escape(query)}&size=#{items_per_page}&start=#{start}")
         u.concat("&return-fields=#{CGI.escape(@fields.join(","))}") unless @fields.nil? or @fields.empty?
       end
     end
+
+    private
+
+    def query_parameter
+      boolean_query? ? "bq" : "q"
+    end
   end
 end
 

data/lib/cloud_search/version.rb

@@ -1,3 +1,3 @@
 module CloudSearch
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/cloud_search/searcher_spec.rb

@@ -3,6 +3,10 @@ require "spec_helper"
 describe CloudSearch::Searcher do
   subject { described_class.new }
 
+  let(:url_prefix) do
+    "#{CloudSearch.config.search_url}/search?"
+  end
+
   describe "#query" do
     it "returns default query" do
       subject.query.should == ""
@@ -25,6 +29,27 @@ describe CloudSearch::Searcher do
     end
   end
 
+  describe "#with_boolean_query" do
+    it "sets the query mode to 'boolean'" do
+      subject.with_boolean_query("year:2000")
+      subject.should be_boolean_query
+    end
+
+    it "returns the searcher instance" do
+      subject.with_boolean_query("year:2000").should == subject
+    end
+
+    it "sets the query term" do
+      subject.with_boolean_query("year:2000")
+      subject.query.should == "year:2000"
+    end
+
+    it "uses 'bq' to specify the query in the URL" do
+      subject.with_boolean_query("year:2000")
+      subject.url.should == "#{url_prefix}bq=year%3A2000&size=10&start=0"
+    end
+  end
+
   describe "#with_fields" do
     it "returns #{described_class} instance" do
       subject.with_fields(:foo).should == subject
@@ -42,7 +67,7 @@ describe CloudSearch::Searcher do
 
     it "returns default items per page when it's tried to set nil value" do
       subject.with_items_per_page(nil)
-      subject.items_per_page.should == 10 
+      subject.items_per_page.should == 10
     end
   end
 
@@ -91,10 +116,6 @@ describe CloudSearch::Searcher do
   end
 
   describe "#url" do
-    let(:url_prefix) do
-      "#{CloudSearch.config.search_url}/search?"
-    end
-
     it "returns default cloud search url" do
       subject.url.should == "#{url_prefix}q=&size=10&start=0"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_search
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: