asari 0.6.0 → 0.7.0

data/README.md

@@ -16,6 +16,20 @@ for easy integration with your Rails apps.
     asari = Asari.new("my-search-domain-asdfkljwe4") # CloudSearch search domain
     asari.add_item("1", { :name => "Tommy Morgan", :email => "tommy@wellbredgrapefruit.com"})
     asari.search("tommy") #=> ["1"] - a list of document IDs
+
+#### Sandbox Mode
+
+Because there is no "local" version of CloudSearch, and search instances can be
+kind of expensive, you shouldn't have to have a development version of your
+index set up in order to use Asari. Because of that, Asari has a "sandbox" mode
+where it does nothing with add/update/delete requests and just returns an empty
+collection for any searches. This sandbox mode is enabled by default - any time
+you want to actually connect to the search index, just do the following:
+
+    Asari.mode = :production
+
+You can turn the sandbox back on, if you like, by setting the mode to `:sandbox`
+again.
     
 #### Pagination
 
@@ -64,6 +78,25 @@ with your AR objects as follows:
     @user.asari_update_in_index
     @user.asari_remove_from_index
 
+You can also specify a :when option, like so:
+
+    asari_index("search-domain-for-users", [:name, :email, :twitter_handle,
+    :favorite_sweater], :when => :indexable)
+
+or
+    
+    asari_index("search-domain-for-users", [:name, :email, :twitter_handle,
+    :favorite_sweater], :when => Proc.new { |user| !user.admin && user.indexable })
+
+This provides a way to mark records that shouldn't be in the index. The :when
+option can be either a symbol - indicating a method on the object - or a Proc
+that accepts the object as its first parameter. If the method/Proc returns true
+when the object is created, the object is indexed - otherwise it is left out of
+the index. If the method/Proc returns true when the object is updated, the
+object is indexed - otherwise it is deleted from the index (if it has already
+been added). This lets you be sure that you never have inappropriate data in
+your search index.
+
 Because index updates are done as part of the AR lifecycle by default, you also
 might want to have control over how Asari handles index update errors - it's
 kind of problematic, if, say, users can't sign up on your site because

data/lib/asari/active_record.rb

@@ -40,29 +40,49 @@ class Asari
       #   search_domain - the CloudSearch domain to use for indexing this model.
       #   fields - an array of Symbols representing the list of fields that
       #     should be included in this index.
+      #   options - a hash of extra options to consider when indexing this
+      #     model. Right now, only one option is available:
+      #       when - a string or symbol representing a method name, or a Proc to
+      #         evaluate to determine if this model object should be indexed. On
+      #         creation, if the method or Proc specified returns false, the
+      #         model will not be indexed. On update, if the method or Proc
+      #         specified returns false, the model will be removed from the
+      #         index (if it exists there).
       #
       # Examples:
       #     class User < ActiveRecord::Base
       #       include Asari::ActiveRecord
       #
       #       asari_index("my-companies-users-asglkj4rsagkjlh34", [:name, :email])
+      #       # or
+      #       asari_index("my-companies-users-asglkj4rsagkjlh34", [:name, :email], :when => :should_be_indexed)
+      #       # or
+      #       asari_index("my-companies-users-asglkj4rsagkjlh34", [:name, :email], :when => Proc.new({ |user| user.published && !user.admin? }))
       #
-      def asari_index(search_domain, fields)
-        self.class_variable_set(:@@asari, Asari.new(search_domain))
-        self.class_variable_set(:@@fields, fields)
+      def asari_index(search_domain, fields, options = {})
+        self.class_variable_set(:@@asari_instance, Asari.new(search_domain))
+        self.class_variable_set(:@@asari_fields, fields)
+        self.class_variable_set(:@@asari_when, options.delete(:when))
       end
 
       def asari_instance
-        self.class_variable_get(:@@asari)
+        self.class_variable_get(:@@asari_instance)
       end
 
       def asari_fields
-        self.class_variable_get(:@@fields)
+        self.class_variable_get(:@@asari_fields)
+      end
+
+      def asari_when
+        self.class_variable_get(:@@asari_when)
       end
 
       # Internal: method for adding a newly created item to the CloudSearch
       # index. Should probably only be called from asari_add_to_index above.
       def asari_add_item(obj)
+        if self.asari_when
+          return unless asari_should_index?(obj)
+        end
         data = {}
         self.asari_fields.each do |field|
           data[field] = obj.send(field) || ""
@@ -75,6 +95,12 @@ class Asari
       # Internal: method for updating a freshly edited item to the CloudSearch
       # index. Should probably only be called from asari_update_in_index above.
       def asari_update_item(obj)
+        if self.asari_when
+          unless asari_should_index?(obj)
+            self.asari_remove_item(obj)
+            return
+          end
+        end
         data = {}
         self.asari_fields.each do |field|
           data[field] = obj.send(field)
@@ -92,6 +118,17 @@ class Asari
         self.asari_on_error(e)
       end
 
+      # Internal: method for looking at the when method/Proc (if defined) to
+      #   determine whether this model should be indexed.
+      def asari_should_index?(object)
+        when_test = self.asari_when
+        if when_test.is_a? Proc
+          return Proc.call(object)
+        else
+          return object.send(when_test)
+        end
+      end
+
       # Public: method for searching the index for the specified term and
       #   returning all model objects that match. 
       #

data/lib/asari/version.rb

@@ -1,3 +1,3 @@
 class Asari
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/active_record_spec.rb

@@ -5,7 +5,7 @@ describe Asari do
     describe "when CloudSearch is responding without error" do
       before :each do
         @asari = double()
-        ActiveRecordFake.class_variable_set(:@@asari, @asari)
+        ActiveRecordFake.class_variable_set(:@@asari_instance, @asari)
       end
 
       it "correctly sets up a before_destroy listener" do
@@ -60,7 +60,7 @@ describe Asari do
 
     describe "When CloudSearch is being a problem" do
       before :each do
-        ActiveRecordFake.class_variable_set(:@@asari, Asari.new("test-domain"))
+        ActiveRecordFake.class_variable_set(:@@asari_instance, Asari.new("test-domain"))
         stub_const("HTTParty", double())
         HTTParty.stub(:post).and_return(fake_error_response)
         HTTParty.stub(:get).and_return(fake_error_response)

data/spec/conditionals_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../spec_helper'
+
+describe Asari do
+  describe Asari::ActiveRecord do
+    describe "conditional indexing" do
+      describe "when a :when option is provided" do
+        before :each do
+          @arcs = ARConditionalsSpy.new
+          @arcs.be_indexable = false
+          @asari = double()
+          ARConditionalsSpy.class_variable_set(:@@asari_instance, @asari)
+        end
+
+        it "doesn't add to the index if the :when option returns false" do
+          expect(@arcs.was_asked).to eq(false)
+          @arcs.asari_add_to_index
+          expect(@arcs.was_asked).to eq(true)
+        end
+
+        it "doesn't add to the index if the :when option returns false" do
+          expect(@arcs.was_asked).to eq(false)
+          @arcs.asari_add_to_index
+          expect(@arcs.was_asked).to eq(true)
+        end
+
+        it "does add to the index if the :when option returns true" do
+          expect(@arcs.was_asked).to eq(false)
+          @arcs.be_indexable = true
+          @asari.should_receive(:add_item).with(1, { :name => "Tommy", :email => "some@email.com"})
+          @arcs.asari_add_to_index
+          expect(@arcs.was_asked).to eq(true)
+        end
+
+        it "deletes the item from the index if the :when option returns false when the item is updated" do
+          expect(@arcs.was_asked).to eq(false)
+          @asari.should_receive(:remove_item).with(1)
+          @arcs.asari_update_in_index
+          expect(@arcs.was_asked).to eq(true)
+        end
+
+        it "updates the item in the index if the :when option returns true when the item is updated" do
+          expect(@arcs.was_asked).to eq(false)
+          @arcs.be_indexable = true
+          @asari.should_receive(:update_item).with(1, { :name => "Tommy", :email => "some@email.com"})
+          @arcs.asari_update_in_index
+          expect(@arcs.was_asked).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec_helper.rb

@@ -34,6 +34,7 @@ module ActiveRecord
 end
 
 class ActiveRecordFake
+
   class << self
     def before_destroy(sym)
       @before_destroy = sym
@@ -78,3 +79,55 @@ class ActiveRecordFakeWithErrorOverride < ActiveRecordFake
     false
   end
 end
+
+class ARConditionalsSpy
+  attr_accessor :be_indexable
+  attr_accessor :was_asked
+
+  class << self
+    def before_destroy(sym)
+      @before_destroy = sym
+    end
+
+    def after_create(sym)
+      @after_create = sym
+    end
+
+    def after_update(sym)
+      @after_update = sym
+    end
+
+    def find(*args)
+      if args.size > 0
+        return [ARConditionalsSpy.new]
+      else
+        raise ActiveRecord::RecordNotFound
+      end
+    end
+  end
+
+  include Asari::ActiveRecord
+
+  asari_index("test-domain", [:name, :email], :when => :indexable)
+  
+  def initialize
+    @was_asked = false
+  end
+
+  def id
+    1
+  end
+
+  def name
+    "Tommy"
+  end
+
+  def email
+    "some@email.com"
+  end
+
+  def indexable
+    @was_asked = true
+    @be_indexable
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asari
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70109076129460 !ruby/object:Gem::Requirement
+  requirement: &70205905685040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109076129460
+  version_requirements: *70205905685040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70109076128860 !ruby/object:Gem::Requirement
+  requirement: &70205905684100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109076128860
+  version_requirements: *70205905684100
 description: Asari s a Ruby interface for AWS CloudSearch
 email:
 - tommy@wellbredgrapefruit.com
@@ -53,6 +53,7 @@ files:
 - spec/active_record_spec.rb
 - spec/asari_spec.rb
 - spec/collection_spec.rb
+- spec/conditionals_spec.rb
 - spec/documents_spec.rb
 - spec/search_spec.rb
 - spec_helper.rb
@@ -84,6 +85,7 @@ test_files:
 - spec/active_record_spec.rb
 - spec/asari_spec.rb
 - spec/collection_spec.rb
+- spec/conditionals_spec.rb
 - spec/documents_spec.rb
 - spec/search_spec.rb
 has_rdoc: