tire 0.3.2 → 0.3.3

data/lib/tire/version.rb

@@ -1,5 +1,5 @@
 module Tire
-  VERSION   = "0.3.2"
+  VERSION   = "0.3.3"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
@@ -24,5 +24,11 @@ module Tire
     
       When there's no conflict with existing methods, Tire methods are added
       to the class namespace, as well, so the change is 100% backwards-compatible.
+
+    0.3.3
+    ---------------------------------------------------------
+    # Added proper will_paginate compatibility
+    # Added support for plugging in another HTTP library (see lib/http/clients/curb for an example)
+
   END
 end

data/test/integration/active_record_searchable_test.rb

@@ -35,10 +35,15 @@ module Tire
     context "ActiveRecord integration" do
 
       setup    do
+        ActiveRecordArticle.destroy_all
         Tire.index('active_record_articles').delete
+
         load File.expand_path('../../models/active_record_models.rb', __FILE__)
       end
-      teardown { Tire.index('active_record_articles').delete }
+      teardown do
+        ActiveRecordArticle.destroy_all
+        Tire.index('active_record_articles').delete
+      end
 
       should "configure mapping" do
         assert_equal 'snowball', ActiveRecordArticle.mapping[:title][:analyzer]
@@ -90,8 +95,9 @@ module Tire
         end
 
         should "load records with options on query search" do
-          assert_equal ActiveRecordArticle.find(['1', '2'], :include => 'comments'),
-                       ActiveRecordArticle.search('"Test 1" OR "Test 2"', :load => { :include => 'comments' }).results
+          assert_equal ActiveRecordArticle.find(['1'], :include => 'comments').first,
+                       ActiveRecordArticle.search('"Test 1"',
+                                                  :load => { :include => 'comments' }).results.first
         end
 
         should "return empty collection for nonmatching query" do

data/test/integration/index_store_test.rb

@@ -7,10 +7,7 @@ module Tire
 
     context "Storing the documents in index" do
 
-      teardown { Tire.index('articles-test-ids').delete }
-
-      should "store hashes under their IDs" do
-
+      setup do
         Tire.index 'articles-test-ids' do
           delete
           create
@@ -23,7 +20,16 @@ module Tire
 
           refresh
         end
+      end
 
+      teardown { Tire.index('articles-test-ids').delete }
+
+      should "happen in existing index" do
+        assert   Tire.index("articles-test-ids").exists?
+        assert ! Tire.index("four-oh-four-index").exists?
+      end
+
+      should "store hashes under their IDs" do
         s = Tire.search('articles-test-ids') { query { string '*' } }
 
         assert_equal 4, s.results.count

data/test/integration/percolator_test.rb

@@ -43,9 +43,7 @@ module Tire
           assert @index.unregister_percolator_query('alert')
           Tire.index('_percolator').refresh
 
-          assert_raise(RestClient::ResourceNotFound) do
-            Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert")
-          end
+          assert Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert").failure?
         end
 
       end

data/test/models/active_model_article_with_custom_document_type.rb

@@ -0,0 +1,7 @@
+# Example ActiveModel class with custom document type
+
+require File.expand_path('../active_model_article', __FILE__)
+
+class ActiveModelArticleWithCustomDocumentType < ActiveModelArticle
+  document_type 'my_custom_type'
+end

data/test/test_helper.rb

@@ -16,8 +16,8 @@ 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)
+  def mock_response(body, code=200, headers={})
+    Tire::HTTP::Response.new(body, code, headers)
   end
 
   def fixtures_path

data/test/unit/configuration_test.rb

@@ -33,7 +33,7 @@ module Tire
       end
 
       should "return default client" do
-        assert_equal Client::RestClient, Configuration.client
+        assert_equal HTTP::Client::RestClient, Configuration.client
       end
 
       should "return nil as logger by default" do
@@ -59,7 +59,7 @@ module Tire
         assert_equal          'http://example.com', Configuration.url
         Configuration.reset
         assert_equal          'http://localhost:9200', Configuration.url
-        assert_equal          Client::RestClient, Configuration.client
+        assert_equal          HTTP::Client::RestClient, Configuration.client
       end
     end
 

data/test/unit/http_client_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module Tire
+  module HTTP
+
+    class ClientTest < Test::Unit::TestCase
+
+      context "RestClient" do
+
+        should "be default" do
+          assert_equal Client::RestClient, Configuration.client
+        end
+
+        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
+          assert_respond_to Client::RestClient, :head
+        end
+
+      end
+
+    end
+  end
+
+end

data/test/unit/http_response_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module Tire
+  module HTTP
+
+    class ResponseTest < Test::Unit::TestCase
+
+      context "Response" do
+
+        should "take response body, code and headers on initialization" do
+          response = Response.new "http response body",
+                                  200,
+                                  :content_length => 20,
+                                  :content_encoding => 'gzip'
+
+          assert_equal "http response body", response.body
+          assert_equal 200, response.code
+        end
+
+        should "not require headers" do
+          assert_nothing_raised do
+            Response.new "Forbidden", 403
+          end
+        end
+
+        should "return success" do
+          responses = []
+          responses << Response.new('OK', 200)
+          responses << Response.new('Redirect', 302)
+
+          responses.each { |response| assert response.success? }
+
+          assert ! Response.new('NotFound', 404).success?
+        end
+
+        should "return failure" do
+          assert Response.new('NotFound', 404).failure?
+        end
+
+      end
+
+    end
+
+  end
+end

data/test/unit/index_test.rb

@@ -20,7 +20,7 @@ module Tire
       end
 
       should "return false when does not exist" do
-        Configuration.client.expects(:head).raises(RestClient::ResourceNotFound)
+        Configuration.client.expects(:head).returns(mock_response('', 404))
         assert ! @index.exists?
       end
 
@@ -30,7 +30,7 @@ module Tire
       end
 
       should "not raise exception and just return false when trying to create existing index" do
-        Configuration.client.expects(:post).raises(RestClient::BadRequest)
+        Configuration.client.expects(:post).returns(mock_response('{"error":"IndexAlreadyExistsException[\'dummy\']"}', 400))
         assert_nothing_raised { assert ! @index.create }
       end
 
@@ -40,9 +40,7 @@ module Tire
       end
 
       should "not raise exception and just return false when deleting non-existing index" do
-        Configuration.client.expects(:delete).returns(mock_response('{"error":"[articles] missing"}'))
-        assert_nothing_raised { assert ! @index.delete }
-        Configuration.client.expects(:delete).raises(RestClient::BadRequest)
+        Configuration.client.expects(:delete).returns(mock_response('{"error":"[articles] missing"}', 404))
         assert_nothing_raised { assert ! @index.delete }
       end
 
@@ -229,33 +227,33 @@ module Tire
 
         should "get type from document" do
           Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/1").
-                                                returns('{"ok":true,"_id":"1"}').twice
+                                                returns(mock_response('{"ok":true,"_id":"1"}')).twice
           @index.remove :id => 1, :type => 'article', :title => 'Test'
           @index.remove :id => 1, :type => 'article', :title => 'Test'
         end
 
         should "set default type" do
           Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
-                                                returns('{"ok":true,"_id":"1"}')
+                                                returns(mock_response('{"ok":true,"_id":"1"}'))
           @index.remove :id => 1, :title => 'Test'
         end
 
         should "get ID from hash" do
           Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
-                                                returns('{"ok":true,"_id":"1"}')
+                                                returns(mock_response('{"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"}')
+                                                returns(mock_response('{"ok":true,"_id":"1"}'))
           @index.remove document
         end
 
         should "get type and ID from arguments" do
           Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/1").
-                                                returns('{"ok":true,"_id":"1"}')
+                                                returns(mock_response('{"ok":true,"_id":"1"}'))
           @index.remove :article, 1
         end
 
@@ -288,7 +286,7 @@ module Tire
             json =~ /"id":"2"/ &&
             json =~ /"title":"One"/ &&
             json =~ /"title":"Two"/
-          end.returns('{}')
+          end.returns(mock_response('{}'), 200)
 
           @index.bulk_store [ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ]
 
@@ -305,7 +303,7 @@ module Tire
             json =~ /"id":"2"/ &&
             json =~ /"title":"One"/ &&
             json =~ /"title":"Two"/
-          end.returns('{}')
+          end.returns(mock_response('{}', 200))
 
           one = ActiveModelArticle.new 'title' => 'One'; one.id = '1'
           two = ActiveModelArticle.new 'title' => 'Two'; two.id = '2'
@@ -315,15 +313,13 @@ module Tire
         end
 
         should "try again when an exception occurs" do
-          Configuration.client.expects(:post).raises(RestClient::RequestFailed).at_least(2)
+          Configuration.client.expects(:post).returns(mock_response('Server error', 503)).at_least(2)
 
-          assert_raise(RestClient::RequestFailed) do
-            @index.bulk_store [ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ]
-          end
+          assert !@index.bulk_store([ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ])
         end
 
         should "display error message when collection item does not have ID" do
-          Configuration.client.expects(:post).with { |url, json| url  == "#{Configuration.url}/_bulk" }
+          Configuration.client.expects(:post).with{ |url, json| url  == "#{Configuration.url}/_bulk" }.returns(mock_response('success', 200))
           STDERR.expects(:puts).once
 
           documents = [ { :title => 'Bogus' }, { :title => 'Real', :id => 1 } ]

data/test/unit/model_persistence_test.rb

@@ -20,6 +20,22 @@ module Tire
           assert_equal 'another-index-name', PersistentArticleWithCustomIndexName.index.name
         end
 
+        context "with index prefix" do
+          setup do
+            Model::Search.index_prefix 'prefix'
+          end
+          
+          teardown do
+            Model::Search.index_prefix nil
+          end
+          
+          should "have configured prefix in index_name" do
+            assert_equal 'prefix_persistent_articles', PersistentArticle.index_name
+            assert_equal 'prefix_persistent_articles', PersistentArticle.new(:title => 'Test').index_name
+          end
+          
+        end
+
         should "have document_type" do
           assert_equal 'persistent_article', PersistentArticle.document_type
           assert_equal 'persistent_article', PersistentArticle.new(:title => 'Test').document_type
@@ -395,7 +411,8 @@ module Tire
                                  end.returns(mock_response('{"ok":true,"_id":"123"}'))
 
             Configuration.client.expects(:delete).
-                                 with("#{Configuration.url}/persistent_articles/persistent_article/123")
+                                 with("#{Configuration.url}/persistent_articles/persistent_article/123").
+                                 returns(mock_response('{"ok":true,"acknowledged":true}', 200))
 
             article = PersistentArticle.new :id => '123', :title => 'Test'
             article.save
@@ -435,6 +452,7 @@ module Tire
             }}
           }
 
+          Tire::Index.any_instance.stubs(:exists?).returns(false)
           Tire::Index.any_instance.expects(:create).with(expected)
 
           class ::PersistentArticleWithMapping

data/test/unit/model_search_test.rb

@@ -68,6 +68,14 @@ module Tire
           ActiveModelArticleWithCustomIndexName.search { query { string 'foo' } }
         end
 
+        should "search in custom type" do
+          name = ActiveModelArticleWithCustomDocumentType.index_name
+          Tire::Search::Search.expects(:new).with(name, { :type => 'my_custom_type' }).returns(@stub).twice
+
+          ActiveModelArticleWithCustomDocumentType.search 'foo'
+          ActiveModelArticleWithCustomDocumentType.search { query { string 'foo' } }
+        end
+
         should "allow to pass custom document type" do
           Tire::Search::Search.
             expects(:new).
@@ -618,6 +626,7 @@ module Tire
 
           should "NOT overload existing top-level instance methods" do
             ActiveRecordClassWithTireMethods.stubs(:columns).returns([])
+            ActiveRecordClassWithTireMethods.stubs(:column_defaults).returns({})
             assert_equal "THIS IS MY INDEX!", ActiveRecordClassWithTireMethods.new.index
             assert_equal 'active_record_class_with_tire_methods',
                          ActiveRecordClassWithTireMethods.new.tire.index.name
@@ -625,6 +634,67 @@ module Tire
 
         end
 
+        context "with index prefix" do
+          class ::ModelWithoutPrefix
+            extend ActiveModel::Naming
+            extend ActiveModel::Callbacks
+
+            include Tire::Model::Search
+            include Tire::Model::Callbacks
+          end
+          class ::ModelWithPrefix
+            extend ActiveModel::Naming
+            extend ActiveModel::Callbacks
+
+            include Tire::Model::Search
+            include Tire::Model::Callbacks
+
+            tire.index_prefix 'custom_prefix'
+          end
+
+          class ::OtherModelWithPrefix
+            extend ActiveModel::Naming
+            extend ActiveModel::Callbacks
+
+            include Tire::Model::Search
+            include Tire::Model::Callbacks
+
+            index_prefix 'other_custom_prefix'
+          end
+
+          teardown do
+            # FIXME: Depends on the interface itself
+            Model::Search.index_prefix nil
+          end
+
+          should "return nil by default" do
+            assert_nil Model::Search.index_prefix
+          end
+
+          should "allow to set and retrieve the value" do
+            assert_nothing_raised { Model::Search.index_prefix 'app_environment' }
+            assert_equal 'app_environment', Model::Search.index_prefix
+          end
+
+          should "allow to reset the value" do
+            Model::Search.index_prefix 'prefix'
+            Model::Search.index_prefix nil
+            assert_nil Model::Search.index_prefix
+          end
+
+          should "not add any prefix by default" do
+            assert_equal 'model_without_prefixes', ModelWithoutPrefix.index_name
+          end
+
+          should "add general and custom prefixes to model index names" do
+            Model::Search.index_prefix 'general_prefix'
+            assert_equal 'general_prefix_model_without_prefixes',         ModelWithoutPrefix.index_name
+            assert_equal 'custom_prefix_model_with_prefixes',             ModelWithPrefix.index_name
+            assert_equal 'other_custom_prefix_other_model_with_prefixes', OtherModelWithPrefix.index_name
+          end
+
+        end
+
       end
 
       context "Results::Item" do

data/test/unit/results_collection_test.rb

@@ -50,6 +50,13 @@ module Tire
         assert_equal 2,  collection.options[:page]
       end
 
+      should "be will_paginate compatible" do
+        collection = Results::Collection.new(@default_response)
+        %w(total_pages offset current_page per_page total_entries).each do |method|
+          assert_respond_to collection, method
+        end
+      end
+
       context "wrapping results" do
 
         setup do