cloud_search_rails 0.0.1 → 0.0.2

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', :version => 2, :opts => "--format nested" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/cloud_search_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cloud_search_rails"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Langevin"]
-  s.date = "2012-04-28"
+  s.date = "2012-05-01"
   s.description = "Rails integration for CloudSearch"
   s.email = "dan.langevin@lifebooker.com"
   s.extra_rdoc_files = [

data/lib/cloud_search_rails.rb

@@ -4,6 +4,10 @@ require 'cloud_search_rails/exceptions'
 require 'cloud_search_rails/index'
 require 'cloud_search_rails/search'
 
+if defined?(Rails)
+  require 'cloud_search_rails/railtie'
+end
+
 module CloudSearchRails
 
   def self.connection(domain = "default")
@@ -35,7 +39,7 @@ module CloudSearchRails
 
       # ensure config is all set
       unless self.cloud_search_domain.present?
-        raise CloudSearchRails::MissingSearchDomain.new
+        raise CloudSearchRails::MissingSearchDomain.new(self)
       end
     end
 

data/lib/cloud_search_rails/exceptions.rb

@@ -1,3 +1,8 @@
 module CloudSearchRails
-  class MissingSearchDomain < Exception; end;
+  class MissingSearchDomain < Exception
+    # constructor
+    def initialize(klass)
+      super("You must define a cloud_search_domain for #{klass}")
+    end
+  end
 end

data/lib/cloud_search_rails/index.rb

@@ -35,6 +35,8 @@ module CloudSearchRails
           d.id = self.id
           d.lang = "en"
           d.version = self.updated_at.to_i
+          # class name
+          d.add_field("type", self.class.base_class.name)
           self.cloud_search_data.each_pair do |k,v|
             d.add_field(k.to_s, v.to_s)
           end

data/lib/cloud_search_rails/search.rb

@@ -1,31 +1,83 @@
 module CloudSearchRails
 
   module Search
+
     def self.included(klass)
       klass.send(:extend, ClassMethods)
       klass.class_eval do 
-        named_scope :cloud_search_rails_scope, lambda{|*ids|
+        # lambda block for the scope
+        scope_def = lambda{|*ids|
           {
             :conditions => [
               "#{self.table_name}.#{self.primary_key} IN (?)", ids.flatten
             ]
           }
         }
+        named_scope :cloud_search_rails_scope, scope_def do 
+          include WillPaginateMethods
+        end
+      end
+    end
+
+    # methods of WillPaginate compatibility
+    module WillPaginateMethods
+      
+      attr_accessor :current_page, :per_page, :total_entries
+
+      # calculated offset given the current page and the number
+      # of entries per page
+      def offset
+        (self.current_page - 1) * self.per_page
+      end
+      
+      # total number of pages  
+      def total_pages
+        (self.total_entries.to_f / self.per_page.to_f).ceil
       end
+
     end
 
     module ClassMethods
       
       # return a scope with the subset of ids
-      def cloud_search(query = nil, &block)
-        search_request = AWSCloudSearch::SearchRequest.new.tap do |req|
-          req.q = query if query.present?
-          yield(req) if block_given?
-        end
+      def cloud_search(*args)
+        opts = {
+          :page => 1,
+          :per_page => 20
+        }
+        opts = opts.merge(args.extract_options!)
+        query = args.first
+        
+        response = self.cloud_search_response(args.first, opts)
+        ids = response.hits.collect{|h| h["id"]}
+
+        proxy = self.cloud_search_rails_scope(ids)
+        proxy.per_page = opts[:per_page]    
+        proxy.current_page = opts[:page] 
+        proxy.total_entries = response.found  
+        proxy
+      end
 
-        res =  self.cloud_search_connection.search(search_request)
-        ids = res.hits.collect{|h| h["id"]}
-        self.cloud_search_rails_scope(ids)
+      protected
+
+      # perform a query to CloudSearch and get a response
+      def cloud_search_response(query, opts)
+        self.cloud_search_connection.search(
+          self.cloud_search_request(query, opts)
+        )
+      end
+
+      # generate a request to CloudSearch
+      def cloud_search_request(query, opts)
+        AWSCloudSearch::SearchRequest.new.tap do |req|
+          if query.nil?
+            req.bq = "type:'#{self.base_class.name}'"
+          else
+            req.bq = "(and '#{query}' type:'#{self.base_class.name}')" 
+          end
+          req.size = opts[:per_page]
+          req.start = (opts[:page] - 1) * opts[:per_page]
+        end
       end
 
     end

data/spec/cloud_search_rails/index_spec.rb

@@ -8,10 +8,13 @@ describe CloudSearchRails::Index do
 
     conn.create_table(:mock_index_classes, :force => true) do |t|
       t.string(:name)
+      t.timestamps
     end
 
     conn.create_table(:mock_index_with_datas, :force => true) do |t|
       t.string(:name)
+      t.string(:type)
+      t.timestamps
     end
 
     MockIndexClass = Class.new(ActiveRecord::Base) do
@@ -22,7 +25,7 @@ describe CloudSearchRails::Index do
 
     MockIndexWithData = Class.new(ActiveRecord::Base) do
       indexed_with_cloud_search do |config|
-        config.cloud_search_domain = "connection-mock"
+        config.cloud_search_domain = "mock-index-with-data"
       end
     end
 
@@ -71,7 +74,7 @@ describe CloudSearchRails::Index do
     end
   end
 
-  context ".cloud_search_delete_document" do
+  context ".cloud_search_add_document" do
 
     let(:batch_method) do
       :cloud_search_add_document
@@ -97,6 +100,18 @@ describe CloudSearchRails::Index do
     it_should_behave_like("batching")
   end
 
+  context ".cloud_search_domain" do
+
+    it "should be an inheritable attribute" do
+      NewKlass = Class.new(MockIndexWithData)
+      NewKlass.cloud_search_domain.should eql(
+        MockIndexWithData.cloud_search_domain
+      )
+    end
+
+  end
+
+
   context ".cloud_search_reindex" do
 
     it "should reindex the entire collection" do
@@ -148,6 +163,7 @@ describe CloudSearchRails::Index do
       doc.expects(:lang=).with("en")
       doc.expects(:version=).with(t.to_i)
       doc.expects(:add_field).with("key", "val")
+      doc.expects(:add_field).with("type", "MockIndexWithData")
       AWSCloudSearch::Document.stubs(:new => doc)
 
       mock_index_with_data = MockIndexWithData.new

data/spec/cloud_search_rails/search_spec.rb

@@ -4,22 +4,28 @@ describe CloudSearchRails::Search do
 
   before(:all) do
 
+    conn = ActiveRecord::Base.connection
+    conn.create_table(:mock_classes, :force => true) do |t|
+      t.string("name")
+      t.timestamps
+    end
+
     MockClass = Class.new(ActiveRecord::Base) do
       indexed_with_cloud_search do |config|
         config.cloud_search_domain = "mock-class"
       end
+
+      named_scope :name_like, lambda{|n|
+        {:conditions => ["name LIKE ?", n]}
+      }
+
     end
 
   end
 
   context "#cloud_search" do
 
-    it "should proxy its search request to cloud_search and return
-      an Arel-like object" do
-
-      search_request = AWSCloudSearch::SearchRequest.new
-      search_request.expects(:q=).with("my query")
-
+    before(:each) do
       AWSCloudSearch::SearchRequest.stubs(:new => search_request)
 
       MockClass.cloud_search_connection
@@ -28,15 +34,91 @@ describe CloudSearchRails::Search do
         .returns(stub({
           :hits => [
             {"id" => 1},
-            {"id" => 2}]
+            {"id" => 2}
+          ],
+          :found => 300,
+          :start => 0
         }))
+    end
+
+    let(:search_request) do
+      search_request = AWSCloudSearch::SearchRequest.new
+      search_request.expects(:bq=).with("(and 'my query' type:'MockClass')")
+      search_request
+    end
+
+    it "should proxy its search request to cloud_search and return
+      an Arel-like object" do
+
       proxy = MockClass.cloud_search("my query")
       proxy.proxy_options[:conditions].should eql(
         ["mock_classes.id IN (?)", [1, 2]]
       )
+    end
+
+    it "should be chainable, maintaining its meta_data" do
+      proxy = MockClass.cloud_search("my query").name_like("name")
+      proxy.current_page.should eql(1)
+      proxy.offset.should eql(0)
+    end
+
+    context "#current_page" do
+
+      it "should default to 1" do
+        proxy = MockClass.cloud_search("my query")
+        proxy.current_page.should eql(1)
+      end
+
+      it "should be able to be set" do
+        search_request.expects(:start=).with(80)
+        proxy = MockClass.cloud_search("my query", :page => 5)
+        proxy.current_page.should eql(5)
+      end
+
+    end
+
+    context "#offset" do
+
+      it "should be able to compute its offset" do
+        proxy = MockClass.cloud_search("my query", :page => 5)
+        proxy.offset.should eql(80)
+      end
+
+    end
+
+    context "#per_page" do
+
+      it "should default to 20" do
+        proxy = MockClass.cloud_search("my query")
+        proxy.per_page.should eql(20)
+      end
+
+      it "should be able to be set" do
+        search_request.expects(:size=).with(50)
+        proxy = MockClass.cloud_search("my query", :per_page => 50)
+        proxy.per_page.should eql(50)
+      end
 
     end
 
+    context "#total_entries" do
+      
+      it "should get it from its search_response" do
+        proxy = MockClass.cloud_search("my query")
+        proxy.total_entries.should eql(300)
+      end
+
+    end
+
+    context "#total_pages" do
+      
+      it "should be the ceiling of its total_entries divided 
+        by per_page" do
+        proxy = MockClass.cloud_search("my query", :per_page => 7)
+        proxy.total_pages.should eql(43)
+      end
+
+    end
   end
   
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'cloud_search_rails'
 require 'active_record'
+require 'mocha'
 
 require 'ruby-debug'
 Debugger.start
@@ -18,6 +19,8 @@ ActiveRecord::Base.establish_connection({
 
 CloudSearchRails.activate_active_record!
 
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
 RSpec.configure do |config|
   config.mock_with :mocha
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_search_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cloud_search
-  requirement: &2165846820 !ruby/object:Gem::Requirement
+  requirement: &2177103240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165846820
+  version_requirements: *2177103240
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2165845900 !ruby/object:Gem::Requirement
+  requirement: &2177102720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2165845900
+  version_requirements: *2177102720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2165844560 !ruby/object:Gem::Requirement
+  requirement: &2177101980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2165844560
+  version_requirements: *2177101980
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2165843160 !ruby/object:Gem::Requirement
+  requirement: &2177101120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165843160
+  version_requirements: *2177101120
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2165842040 !ruby/object:Gem::Requirement
+  requirement: &2177100480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2165842040
+  version_requirements: *2177100480
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2165840700 !ruby/object:Gem::Requirement
+  requirement: &2177099660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165840700
+  version_requirements: *2177099660
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2165839680 !ruby/object:Gem::Requirement
+  requirement: &2177098540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2165839680
+  version_requirements: *2177098540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165838940 !ruby/object:Gem::Requirement
+  requirement: &2177097920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2165838940
+  version_requirements: *2177097920
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2165838320 !ruby/object:Gem::Requirement
+  requirement: &2177097340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165838320
+  version_requirements: *2177097340
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2165837580 !ruby/object:Gem::Requirement
+  requirement: &2177096780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165837580
+  version_requirements: *2177096780
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2165836960 !ruby/object:Gem::Requirement
+  requirement: &2177096280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165836960
+  version_requirements: *2177096280
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2165836320 !ruby/object:Gem::Requirement
+  requirement: &2177095740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,7 +142,7 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2165836320
+  version_requirements: *2177095740
 description: Rails integration for CloudSearch
 email: dan.langevin@lifebooker.com
 executables: []
@@ -188,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3038165031770199580
+      hash: -2698562838851711787
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: