slingshot-rb 0.0.8 → 0.0.9

data/test/integration/highlight_test.rb

@@ -21,7 +21,7 @@ module Slingshot
         assert doc.highlight.title.to_s.include?('<em>'), "Highlight does not include default highlight tag"
       end
 
-      should "return entire content with highlighted fragments in ElasticSearch >= 0.16.0" do
+      should "return entire content with highlighted fragments" do
         # Slingshot::Configuration.logger STDERR, :level => 'debug'
 
         content = "A Fox one day fell into a deep well and could find no means of escape. A Goat, overcome with thirst, came to the same well, and seeing the Fox, inquired if the water was good. Concealing his sad plight under a merry guise, the Fox indulged in a lavish praise of the water, saying it was excellent beyond measure, and encouraging him to descend. The Goat, mindful only of his thirst, thoughtlessly jumped down, but just as he drank, the Fox informed him of the difficulty they were both in and suggested a scheme for their common escape. \"If,\" said he, \"you will place your forefeet upon the wall and bend your head, I will run up your back and escape, and will help you out afterwards.\" The Goat readily assented and the Fox leaped upon his back. Steadying himself with the Goat horns, he safely reached the mouth of the well and made off as fast as he could. When the Goat upbraided him for breaking his promise, he turned around and cried out, \"You foolish old fellow! If you had as many brains in your head as you have hairs in your beard, you would never have gone down before you had inspected the way up, nor have exposed yourself to dangers from which you had no means of escape.\" Look before you leap."

data/test/integration/index_mapping_test.rb

@@ -15,7 +15,7 @@ module Slingshot
           store :article, :title => 'One'
           refresh
         end
-        sleep 1
+        sleep 1.5
 
         assert_equal 'string', index.mapping['article']['properties']['title']['type'],  index.mapping.inspect
         assert_nil             index.mapping['article']['properties']['title']['boost'], index.mapping.inspect

data/test/integration/index_store_test.rb

@@ -36,6 +36,33 @@ module Slingshot
 
     end
 
+    context "Removing documents from the index" do
+
+      teardown { Slingshot.index('articles-test-remove').delete }
+
+      setup do
+        Slingshot.index 'articles-test-remove' do
+          delete
+          create
+          store :id => 1, :title => 'One'
+          store :id => 2, :title => 'Two'
+          refresh
+        end
+      end
+
+      should "remove document from the index" do
+
+        assert_equal 2, Slingshot.search('articles-test-remove') { query { string '*' } }.results.count
+
+        assert_nothing_raised do
+          assert Slingshot.index('articles-test-remove').remove 1
+          assert ! Slingshot.index('articles-test-remove').remove(1)
+        end
+
+      end
+
+    end
+
   end
 
 end

data/test/integration/persistent_model_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+module Slingshot
+
+  class PersistentModelIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    def setup
+      super
+      PersistentArticle.index.delete
+    end
+
+    def teardown
+      super
+      PersistentArticle.index.delete
+    end
+
+    context "PersistentModel" do
+
+      should "save documents into index and find them by IDs" do
+        one = PersistentArticle.create :id => 1, :title => 'One'
+        two = PersistentArticle.create :id => 2, :title => 'Two'
+
+        PersistentArticle.index.refresh
+        sleep(1.5)
+
+        results = PersistentArticle.find [1, 2]
+
+        assert_equal 2, results.size
+        
+      end
+    end
+
+  end
+end

data/test/integration/query_string_test.rb

@@ -10,19 +10,19 @@ module Slingshot
       should "find article by title" do
         q = 'title:one'
         assert_equal 1, search(q).results.count
-        assert_equal 'One', search(q).results.first['_source']['title']
+        assert_equal 'One', search(q).results.first[:title]
       end
 
       should "find articles by title with boosting" do
         q = 'title:one^100 OR title:two'
         assert_equal 2, search(q).results.count
-        assert_equal 'One', search(q).results.first['_source']['title']
+        assert_equal 'One', search(q).results.first[:title]
       end
 
       should "find articles by tags" do
         q = 'tags:ruby AND tags:python'
         assert_equal 1, search(q).results.count
-        assert_equal 'Two', search(q).results.first['_source']['title']
+        assert_equal 'Two', search(q).results.first[:title]
       end
 
       should "find any article with tags" do

data/test/integration/sort_test.rb

@@ -15,7 +15,7 @@ module Slingshot
         end
 
         assert_equal 5, s.results.count
-        assert_equal 'Five', s.results.first['_source']['title']
+        assert_equal 'Five', s.results.first[:title]
       end
 
       should "sort by title, descending" do
@@ -26,7 +26,7 @@ module Slingshot
         end
 
         assert_equal 5, s.results.count
-        assert_equal 'Two', s.results.first['_source']['title']
+        assert_equal 'Two', s.results.first[:title]
       end
 
     end

data/test/models/active_model_article.rb

@@ -0,0 +1,31 @@
+# Example ActiveModel class
+
+require 'rubygems'
+require 'active_model'
+
+class ActiveModelArticle
+
+  extend  ActiveModel::Naming
+  include ActiveModel::AttributeMethods
+  include ActiveModel::Serialization
+  include ActiveModel::Serializers::JSON
+
+  include Slingshot::Model::Search
+
+  attr_reader :attributes
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def id;         attributes['id'] || attributes['_id']; end
+  def id=(value); attributes['id'] = value;              end
+
+  def method_missing(name, *args, &block)
+    attributes[name.to_sym] || attributes[name.to_s] || super
+  end
+
+  def persisted?; true; end
+  def save;       true; end
+
+end

data/test/models/active_model_article_with_callbacks.rb

@@ -0,0 +1,49 @@
+# Example ActiveModel class with callbacks
+
+require 'rubygems'
+require 'active_model'
+
+class ActiveModelArticleWithCallbacks
+
+  include ActiveModel::AttributeMethods
+  include ActiveModel::Validations
+  include ActiveModel::Serialization
+  include ActiveModel::Serializers::JSON
+  include ActiveModel::Naming
+
+  extend  ActiveModel::Callbacks
+  define_model_callbacks :save, :destroy
+
+  include Slingshot::Model::Search
+  include Slingshot::Model::Callbacks
+
+  attr_reader :attributes
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def method_missing(id, *args, &block)
+    attributes[id.to_sym] || attributes[id.to_s] || super
+  end
+
+  def persisted?
+    true
+  end
+
+  def save
+    _run_save_callbacks do
+      STDERR.puts "[Saving ...]"
+    end
+  end
+
+  def destroy
+    _run_destroy_callbacks do
+      STDERR.puts "[Destroying ...]"
+      @destroyed = true
+    end
+  end
+
+  def destroyed?; !!@destroyed; end
+
+end

data/test/models/active_model_article_with_custom_index_name.rb

@@ -0,0 +1,5 @@
+# Example ActiveModel class with custom index name
+
+class ActiveModelArticleWithCustomIndexName < ActiveModelArticle
+  index_name 'custom-index-name'
+end

data/test/models/active_record_article.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'active_record'
+
+class ActiveRecordArticle < ActiveRecord::Base
+  include Slingshot::Model::Search
+  include Slingshot::Model::Callbacks
+
+  mapping do
+    indexes :title,      :type => 'string', :boost => 10, :analyzer => 'snowball'
+    indexes :created_at, :type => 'date'
+  end
+end

data/test/models/persistent_article.rb

@@ -0,0 +1,11 @@
+# Example class with ElasticSearch persistence
+
+class PersistentArticle
+
+  include Slingshot::Model::Persistence
+
+  property :title
+  property :published_on
+  property :tags
+
+end

data/test/models/persistent_articles_with_custom_index_name.rb

@@ -0,0 +1,10 @@
+# Example class with ElasticSearch persistence and custom index name
+
+class PersistentArticleWithCustomIndexName
+
+  include Slingshot::Model::Persistence
+
+  property :title
+
+  index_name 'custom-index-name'
+end

data/test/models/supermodel_article.rb

@@ -0,0 +1,22 @@
+# Example ActiveModel class for testing :searchable mode
+
+require 'rubygems'
+require 'supermodel'
+
+class SupermodelArticle < SuperModel::Base
+  include SuperModel::RandomID
+
+  include Slingshot::Model::Search
+  include Slingshot::Model::Callbacks
+
+  mapping do
+    indexes :title,      :type => 'string', :boost => 15, :analyzer => 'czech'
+  end
+
+  alias :persisted? :exists?
+
+  def destroyed?
+    !self.class.find(self.id) rescue true
+  end
+
+end

data/test/models/validated_model.rb

@@ -0,0 +1,11 @@
+# Example ActiveModel with validations
+
+class ValidatedModel
+
+  include Slingshot::Model::Persistence
+
+  property :name
+
+  validates_presence_of :name
+
+end

data/test/test_helper.rb

@@ -11,6 +11,10 @@ Dir[File.dirname(__FILE__) + '/models/**/*.rb'].each { |m| require m }
 
 class Test::Unit::TestCase
 
+  def mock_response(body, code=200)
+    stub(:body => body, :code => code)
+  end
+
   def fixtures_path
     Pathname( File.expand_path( 'fixtures', File.dirname(__FILE__) ) )
   end

data/test/unit/active_model_lint_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+module Slingshot
+  module Model
+
+    class ActiveModelLintTest < Test::Unit::TestCase
+
+      include ActiveModel::Lint::Tests
+
+      def setup
+        @model = PersistentArticle.new :title => 'Test'
+      end
+
+    end
+
+  end
+end

data/test/unit/client_test.rb

@@ -15,6 +15,9 @@ module Slingshot
         assert_raise(ArgumentError) { @http.post 'URL'         }
         assert_raise(NoMethodError) { @http.post 'URL', 'DATA' }
 
+        assert_raise(ArgumentError) { @http.put               }
+        assert_raise(ArgumentError) { @http.put 'URL'         }
+
         assert_raise(ArgumentError) { @http.delete       }
         assert_raise(NoMethodError) { @http.delete 'URL' }
       end
@@ -29,6 +32,7 @@ module Slingshot
       should "respond to HTTP methods" do
         assert_respond_to Client::RestClient, :get
         assert_respond_to Client::RestClient, :post
+        assert_respond_to Client::RestClient, :put
         assert_respond_to Client::RestClient, :delete
       end
       

data/test/unit/configuration_test.rb

@@ -4,6 +4,10 @@ module Slingshot
 
   class ConfigurationTest < Test::Unit::TestCase
 
+    def teardown
+      Slingshot::Configuration.reset
+    end
+
     context "Configuration" do
       setup do
         Configuration.instance_variable_set(:@url,    nil)

data/test/unit/index_test.rb

@@ -10,8 +10,22 @@ module Slingshot
         @index = Slingshot::Index.new 'dummy'
       end
 
+      should "have a name" do
+        assert_equal 'dummy', @index.name
+      end
+
+      should "return true when exists" do
+        Configuration.client.expects(:get).returns(mock_response('{"dummy":{"document":{"properties":{}}}}'))
+        assert @index.exists?
+      end
+
+      should "return false when does not exist" do
+        Configuration.client.expects(:get).raises(RestClient::ResourceNotFound)
+        assert ! @index.exists?
+      end
+
       should "create new index" do
-        Configuration.client.expects(:post).returns('{"ok":true,"acknowledged":true}')
+        Configuration.client.expects(:post).returns(mock_response('{"ok":true,"acknowledged":true}'))
         assert @index.create
       end
 
@@ -21,26 +35,26 @@ module Slingshot
       end
 
       should "delete index" do
-        Configuration.client.expects(:delete).returns('{"ok":true,"acknowledged":true}')
+        Configuration.client.expects(:delete).returns(mock_response('{"ok":true,"acknowledged":true}'))
         assert @index.delete
       end
 
       should "not raise exception and just return false when deleting non-existing index" do
-        Configuration.client.expects(:delete).returns('{"error":"[articles] missing"}')
+        Configuration.client.expects(:delete).returns(mock_response('{"error":"[articles] missing"}'))
         assert_nothing_raised { assert ! @index.delete }
         Configuration.client.expects(:delete).raises(RestClient::BadRequest)
         assert_nothing_raised { assert ! @index.delete }
       end
 
       should "refresh the index" do
-        Configuration.client.expects(:post).returns('{"ok":true,"_shards":{}}')
+        Configuration.client.expects(:post).returns(mock_response('{"ok":true,"_shards":{}}'))
         assert_nothing_raised { assert @index.refresh }
       end
 
       context "mapping" do
 
         should "create index with mapping" do
-          Configuration.client.expects(:post).returns('{"ok":true,"acknowledged":true}')
+          Configuration.client.expects(:post).returns(mock_response('{"ok":true,"acknowledged":true}'))
 
           assert @index.create :settings => { :number_of_shards => 1 },
                                :mappings => { :article => {
@@ -67,7 +81,7 @@ module Slingshot
             }
           }
           JSON
-          Configuration.client.stubs(:get).returns(json)
+          Configuration.client.stubs(:get).returns(mock_response(json))
 
           assert_equal 'string', @index.mapping['article']['properties']['title']['type']
           assert_equal 2.0,      @index.mapping['article']['properties']['title']['boost']
@@ -78,19 +92,19 @@ module Slingshot
       context "when storing" do
 
         should "properly set type from args" do
-          Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').returns('{"ok":true,"_id":"test"}').twice
+          Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').returns(mock_response('{"ok":true,"_id":"test"}')).twice
           @index.store 'article', :title => 'Test'
           @index.store :article,  :title => 'Test'
         end
 
         should "set default type" do
-          Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/", '{"title":"Test"}').returns('{"ok":true,"_id":"test"}')
+          Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/", '{"title":"Test"}').returns(mock_response('{"ok":true,"_id":"test"}'))
           @index.store :title => 'Test'
         end
 
         should "call #to_indexed_json on non-String documents" do
           document = { :title => 'Test' }
-          Configuration.client.expects(:post).returns('{"ok":true,"_id":"test"}')
+          Configuration.client.expects(:post).returns(mock_response('{"ok":true,"_id":"test"}'))
           document.expects(:to_indexed_json)
           @index.store document
         end
@@ -104,15 +118,15 @@ module Slingshot
 
           should "store Hash it under its ID property" do
             Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/123",
-                                                     {:id => 123, :title => 'Test'}.to_json).
-                                                returns('{"ok":true,"_id":"123"}')
+                                                     Yajl::Encoder.encode({:id => 123, :title => 'Test'})).
+                                                returns(mock_response('{"ok":true,"_id":"123"}'))
             @index.store :id => 123, :title => 'Test'
           end
 
           should "store a custom class under its ID property" do
             Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/123",
                                                      {:id => 123, :title => 'Test', :body => 'Lorem'}.to_json).
-                                                returns('{"ok":true,"_id":"123"}')
+                                                returns(mock_response('{"ok":true,"_id":"123"}'))
             @index.store Article.new(:id => 123, :title => 'Test', :body => 'Lorem')
           end
 
@@ -126,24 +140,24 @@ module Slingshot
           Configuration.reset :wrapper
 
           Configuration.client.stubs(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').
-                                            returns('{"ok":true,"_id":"id-1"}')
+                                            returns(mock_response('{"ok":true,"_id":"id-1"}'))
           @index.store :article, :title => 'Test'
         end
 
         should "return document in default wrapper" do
           Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
-                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+                                             returns(mock_response('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}'))
           article = @index.retrieve :article, 'id-1'
           assert_instance_of Results::Item, article
-          assert_equal 'Test', article['_source']['title']
           assert_equal 'Test', article.title
+          assert_equal 'Test', article[:title]
         end
 
         should "return document as a hash" do
           Configuration.wrapper Hash
 
           Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
-                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+                                             returns(mock_response('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}'))
           article = @index.retrieve :article, 'id-1'
           assert_instance_of Hash, article
         end
@@ -152,7 +166,7 @@ module Slingshot
           Configuration.wrapper Article
 
           Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
-                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+                                             returns(mock_response('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}'))
           article = @index.retrieve :article, 'id-1'
           assert_instance_of Article, article
           assert_equal 'Test', article.title
@@ -160,6 +174,215 @@ module Slingshot
 
       end
 
+      context "when removing" do
+
+        should "properly set type from args" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/").
+                                                returns('{"ok":true,"_id":"test"}').twice
+          @index.remove 'article', :title => 'Test'
+          @index.remove :article,  :title => 'Test'
+        end
+
+        should "set default type" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/").
+                                                returns('{"ok":true,"_id":"test"}')
+          @index.remove :title => 'Test'
+        end
+
+        should "get ID from hash" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
+                                                returns('{"ok":true,"_id":"1"}')
+          @index.remove :id => 1
+        end
+
+        should "get ID from method" do
+          document = stub('document', :id => 1)
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
+                                                returns('{"ok":true,"_id":"1"}')
+          @index.remove document
+        end
+
+        should "get ID from arguments" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
+                                                returns('{"ok":true,"_id":"1"}')
+          @index.remove :document, 1
+        end
+
+      end
+
+      context "when storing in bulk" do
+        # The expected JSON looks like this:
+        #
+        # {"index":{"_index":"dummy","_type":"document","_id":"1"}}
+        # {"id":"1","title":"One"}
+        # {"index":{"_index":"dummy","_type":"document","_id":"2"}}
+        # {"id":"2","title":"Two"}
+        #
+        # See http://www.elasticsearch.org/guide/reference/api/bulk.html
+
+        should "serialize Hashes" do
+          Configuration.client.expects(:post).with do |url, json|
+            url  == "#{Configuration.url}/_bulk"
+            json =~ /"_index":"dummy"/
+            json =~ /"_type":"document"/
+            json =~ /"_id":"1"/
+            json =~ /"_id":"2"/
+            json =~ /"id":"1"/
+            json =~ /"id":"2"/
+            json =~ /"title":"One"/
+            json =~ /"title":"Two"/
+          end.returns('{}')
+
+          @index.bulk_store [ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ]
+
+        end
+
+        should "serialize ActiveModel instances" do
+          Configuration.client.expects(:post).with do |url, json|
+            url  == "#{Configuration.url}/_bulk"
+            json =~ /"_index":"active_model_articles"/
+            json =~ /"_type":"article"/
+            json =~ /"_id":"1"/
+            json =~ /"_id":"2"/
+            json =~ /"id":"1"/
+            json =~ /"id":"2"/
+            json =~ /"title":"One"/
+            json =~ /"title":"Two"/
+          end.returns('{}')
+
+          one = ActiveModelArticle.new 'title' => 'One'; one.id = '1'
+          two = ActiveModelArticle.new 'title' => 'Two'; two.id = '2'
+
+          ActiveModelArticle.index.bulk_store [ one, two ]
+
+        end
+
+        should "try again when an exception occurs" do
+          Configuration.client.expects(:post).raises(RestClient::RequestFailed).at_least(2)
+
+          assert_raise(RestClient::RequestFailed) do
+            @index.bulk_store [ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ]
+          end
+        end
+
+        should_eventually "raise exception when collection item does not have ID" do
+          # TODO: raise exception when collection item does not have ID
+        end
+
+      end
+
+      context "when importing" do
+        setup do
+          @index = Slingshot::Index.new 'import'
+        end
+
+        class ::ImportData
+          DATA = (1..4).to_a
+
+          def self.paginate(options={})
+            options = {:page => 1, :per_page => 1000}.update options
+            DATA.slice( (options[:page]-1)*options[:per_page]...options[:page]*options[:per_page] )
+          end
+
+          def self.each(&block);   DATA.each █ end
+          def self.map(&block);    DATA.map █  end
+          def self.count;          DATA.size;        end
+        end
+
+        should "be initialized with a collection" do
+          @index.expects(:bulk_store).returns(:true)
+
+          assert_nothing_raised { @index.import [{ :id => 1, :title => 'Article' }] }
+        end
+
+        should "be initialized with a class and params" do
+          @index.expects(:bulk_store).returns(:true)
+
+          assert_nothing_raised { @index.import ImportData }
+        end
+
+        context "plain collection" do
+
+          should "just store it in bulk" do
+            collection = [{ :id => 1, :title => 'Article' }]
+            @index.expects(:bulk_store).with( collection ).returns(true)
+
+            @index.import collection
+          end
+
+        end
+
+        context "class" do
+
+          should "call the passed method and bulk store the results" do
+            @index.expects(:bulk_store).with([1, 2, 3, 4]).returns(true)
+
+            @index.import ImportData, :paginate
+          end
+
+          should "pass the params to the passed method and bulk store the results" do
+            @index.expects(:bulk_store).with([1, 2]).returns(true)
+            @index.expects(:bulk_store).with([3, 4]).returns(true)
+
+            @index.import ImportData, :paginate, :page => 1, :per_page => 2
+          end
+
+          should "pass the class when method not passed" do
+            @index.expects(:bulk_store).with(ImportData).returns(true)
+
+            @index.import ImportData
+          end
+
+        end
+
+        context "with passed block" do
+
+          context "and plain collection" do
+
+            should "allow to manipulate the collection in the block" do
+              Slingshot::Index.any_instance.expects(:bulk_store).with([{ :id => 1, :title => 'ARTICLE' }])
+
+
+              @index.import [{ :id => 1, :title => 'Article' }] do |articles|
+                articles.map { |article| article.update :title => article[:title].upcase }
+              end
+            end
+
+          end
+
+          context "and object" do
+
+            should "call the passed block on every batch" do
+              Slingshot::Index.any_instance.expects(:bulk_store).with([1, 2])
+              Slingshot::Index.any_instance.expects(:bulk_store).with([3, 4])
+
+              runs = 0
+              @index.import ImportData, :paginate, :per_page => 2 do |documents|
+                runs += 1
+                # Don't forget to return the documents at the end of the block
+                documents
+              end
+
+              assert_equal 2, runs
+            end
+
+            should "allow to manipulate the documents in passed block" do
+              Slingshot::Index.any_instance.expects(:bulk_store).with([2, 3])
+              Slingshot::Index.any_instance.expects(:bulk_store).with([4, 5])
+
+
+              @index.import ImportData, :paginate, :per_page => 2 do |documents|
+                # Add 1 to every "document" and return them
+                documents.map { |d| d + 1 }
+              end
+            end
+
+          end
+
+        end
+
+      end
+
     end
 
   end