cloud_search 0.0.2 → 0.0.3

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cloud_search.gemspec
 gemspec
+
+group :test do
+  gem "growl"
+  gem "guard"
+  gem "guard-rspec"
+  gem "rb-fsevent"
+  gem "debugger"
+end
+

data/README.md

@@ -22,30 +22,33 @@ Or install it yourself as:
 
 The example bellow uses the Amazon's example database called `imdb-movies`:
 
-```ruby
 # Use your AWS CloudSearch configuration
+``` ruby
 CloudSearch.configure do |config|
   config.domain_id   = "pl6u4t3elu7dhsbwaqbsy3y6be"
   config.domain_name = "imdb-movies"
 end
+```
 
 # Search for 'star wars' on 'imdb-movies'
+``` ruby
 search = CloudSearch::Search.new
 resp   = search.with_fields(:actor, :director, :title, :year, :text_relevance)
-      .query("star wars")
-      .request
+      .with_query("star wars")
+      .search
+```
 
 # Or you can search using part of the name
+``` ruby
 search = CloudSearch::Search.new
 resp   = search.with_fields(:actor, :director, :title, :year, :text_relevance)
-      .query("matri*")
-      .request
-
-# Number of results
-resp.hits
+      .with_query("matri*")
+      .search
+```
 
 # Results
-res.results.each do |result|
+``` ruby
+resp.results.each do |result|
   movie = result["data"]
 
   # List of actors on the movie
@@ -60,6 +63,25 @@ res.results.each do |result|
 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
+
+resp.total_entries #=> 5000
+resp.total_pages   #=> 167
+resp.current_page  #=> 10
+resp.offset        #=> 300
+resp.page_size     #=> 30
+```
+
 ## Indexing documents
 
 ``` ruby
@@ -73,7 +95,6 @@ indexer << document # add as many documents as you want
 indexer.index
 ```
 
-
 ## Contributing
 
 1. Fork it

data/cloud_search.gemspec

@@ -24,9 +24,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "simplecov" , "~> 0.6"
   gem.add_development_dependency "vcr"       , "~> 2.2"
   gem.add_development_dependency "webmock"
-  gem.add_development_dependency "guard"
-  gem.add_development_dependency "guard-rspec"
-  gem.add_development_dependency "rb-fsevent"
 
   gem.add_dependency "em-http-request"       , "~> 1.0"
 end

data/lib/cloud_search/search_response.rb

@@ -1,6 +1,6 @@
 module CloudSearch
   class SearchResponse
-    attr_accessor :body
+    attr_reader   :body
     attr_accessor :http_code
 
     def results
@@ -15,7 +15,39 @@ module CloudSearch
       hits >= 1
     end
 
+    def body=(body)
+      @body = body
+      calculate_pages
+      @body
+    end
+
+    def items_per_page
+      @items_per_page or 10
+    end
+
+    alias :page_size :items_per_page
+    alias :total_entries :hits
+
+    attr_writer :items_per_page
+    attr_reader :current_page
+    attr_reader :total_pages
+
+    def offset
+      return 0 unless found?
+      (@current_page - 1) * items_per_page
+    end
+
     private
+    def calculate_pages
+      num_full_pages = hits / items_per_page
+      @total_pages   = hits % items_per_page > 0 ? num_full_pages + 1 : num_full_pages
+      @total_pages   = 1 if @total_pages == 0
+
+      start = (_hits and _hits["start"]) || 0
+      @current_page = (start / items_per_page) + 1
+      @current_page = @total_pages if @current_page > @total_pages
+    end
+
     def _hits
       body and body['hits']
     end

data/lib/cloud_search/searcher.rb

@@ -22,26 +22,52 @@ module CloudSearch
         end
       end
 
+      response.items_per_page = items_per_page
       response
     end
-
-    def query(q)
-      @query = q
+    
+    def with_query(query)
+      @query = query
       self
     end
 
+    def query
+      @query or ''
+    end
+
     def with_fields(*fields)
       @fields = fields
       self
     end
 
-    private
+    def with_items_per_page(items_per_page)
+      @items_per_page = items_per_page
+      self
+    end
+
+    def items_per_page
+      @items_per_page or 10
+    end
+
+    def at_page(page)
+      @page_number = (page && page < 1) ? 1 : page
+      self
+    end
+
+    def page_number
+      @page_number or 1
+    end
+
+    def start
+      return 0 if page_number <= 1
+      (items_per_page * page_number) - 1
+    end
 
     def url
-      url = CloudSearch.config.search_url
-      url+= "/search"
-      url+= "?q=#{CGI.escape(@query)}"
-      url+= "&return-fields=#{CGI.escape(@fields.join(","))}" if @fields.any?
+      "#{CloudSearch.config.search_url}/search".tap do |u|
+        u.concat("?q=#{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
   end
 end

data/lib/cloud_search/version.rb

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

data/spec/cloud_search/search_response_spec.rb

@@ -27,11 +27,35 @@ describe CloudSearch::SearchResponse do
       end
     end
 
+    describe "#total_entries" do
+      it "returns same value from hits" do
+        subject.hits.should == subject.total_entries
+      end
+    end
+
     describe "#found?" do
       it "returns true when found documents" do
         subject.should be_found
       end
     end
+
+    describe "#items_per_page" do
+      it "returns items per page" do
+        subject.items_per_page.should == 10
+      end
+    end
+
+    describe "#page_size" do
+      it "returns number of items per page" do
+        subject.items_per_page.should == subject.items_per_page
+      end
+    end
+
+    describe "#offset" do
+      it "returns offset" do
+        subject.offset.should == 0
+      end
+    end
   end
 
   context "when there aren't results" do
@@ -56,5 +80,23 @@ describe CloudSearch::SearchResponse do
         subject.should_not be_found
       end
     end
+
+    describe "#items_per_page" do
+      it "returns items per page" do
+        subject.items_per_page.should == 10
+      end
+    end
+
+    describe "#page_size" do
+      it "returns number of items per page" do
+        subject.items_per_page.should == subject.items_per_page
+      end
+    end
+
+    describe "#offset" do
+      it "returns offset" do
+        subject.offset.should == 0
+      end
+    end   
   end
 end

data/spec/cloud_search/searcher_spec.rb

@@ -3,11 +3,124 @@ require "spec_helper"
 describe CloudSearch::Searcher do
   subject { described_class.new }
 
+  describe "#query" do
+    it "returns default query" do
+      subject.query.should == ""
+    end
+
+    it "returns default query when it's tried to set nil value" do
+      subject.with_query(nil)
+      subject.query.should == ""
+    end
+  end
+
+  describe "#with_query" do
+    it "returns #{described_class} instance" do
+      subject.with_query("foo").should == subject
+    end
+
+    it "setup query" do
+      subject.with_query("foo")
+      subject.query.should == "foo"
+    end
+  end
+
+  describe "#with_fields" do
+    it "returns #{described_class} instance" do
+      subject.with_fields(:foo).should == subject
+    end
+
+    it "setup more thane one value" do
+      subject.with_fields(:foo, :bar, :foobar)
+    end
+  end
+
+  describe "#items_per_page" do
+    it "returns default items_per_page" do
+      subject.items_per_page.should == 10
+    end
+
+    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 
+    end
+  end
+
+  describe "#with_items_per_page" do
+    it "returns #{described_class} instance" do
+      subject.with_items_per_page(nil).should == subject
+    end
+
+    it "setup items per page" do
+      subject.with_items_per_page(100)
+      subject.items_per_page.should == 100
+    end
+  end
+
+  describe "#page_number" do
+    it "returns default page number" do
+      subject.page_number.should == 1
+    end
+
+    it "returns default page number when it's tried to set nil value" do
+      subject.at_page(nil)
+      subject.page_number.should == 1
+    end
+  end
+
+  describe "#at_page" do
+    it "returns #{described_class} instance" do
+      subject.at_page(1).should == subject
+    end
+
+    it "setup page number" do
+      subject.at_page(2)
+      subject.page_number.should == 2
+    end
+  end
+
+  describe "#start" do
+    it "returns default start index number to search" do
+      subject.start.should == 0
+    end
+
+    it "returns start index 19 for page 2" do
+      subject.at_page(2)
+      subject.start.should == 19
+    end
+  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
+
+    it "returns cloud search url with foo query" do
+      subject.with_query("foo").url.should == "#{url_prefix}q=foo&size=10&start=0"
+    end
+
+    it "returns cloud search url with size equals 20" do
+      subject.with_items_per_page(20).url.should == "#{url_prefix}q=&size=20&start=0"
+    end
+
+    it "returns cloud search url with start at 19" do
+      subject.at_page(2).url.should == "#{url_prefix}q=&size=10&start=19"
+    end
+
+    it "returns cloud search url with foo and bar fields" do
+      subject.with_fields(:foo, :bar).url.should == "#{url_prefix}q=&size=10&start=0&return-fields=foo%2Cbar"
+    end
+  end
+
   describe "#search" do
     before do
       subject
         .with_fields(:actor, :director, :title, :year, :text_relevance)
-        .query("star wars")
+        .with_query("star wars")
     end
 
     around { |example| VCR.use_cassette "search/request/full", &example }

data/spec/fixtures/vcr_cassettes/search/request/full.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://search-imdb-movies-pl6u4t3elu7dhsbwaqbsy3y6be.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=star%20wars&return-fields=actor,director,title,year,text_relevance
+    uri: http://search-imdb-movies-pl6u4t3elu7dhsbwaqbsy3y6be.us-east-1.cloudsearch.amazonaws.com/2011-02-01/search?q=star%20wars&return-fields=actor,director,title,year,text_relevance&size=10&start=0
     body:
       encoding: US-ASCII
       string: ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_search
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -107,54 +107,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A wraper to Amazon CloudSearch's API
@@ -246,3 +198,4 @@ test_files:
 - spec/fixtures/vcr_cassettes/search/request/full.yml
 - spec/spec_helper.rb
 - spec/support/vcr.rb
+has_rdoc: