tire 0.5.5 → 0.5.6

data/lib/tire/version.rb

@@ -1,14 +1,11 @@
 module Tire
-  VERSION   = "0.5.5"
+  VERSION   = "0.5.6"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    * Improved documentation
-    * Improved isolation of Tire methods in model integrations
-    * Improved handling of times/dates in `Model::Persistence`
-    * Added support for "Put Mapping" and "Delete mapping" APIs
-    * Added escaping document IDs in URLs
-    * Allowed passing URL options when passing search definition as a Hash
+    * Added support for the `constant_score` query
+    * Prevent `Curl::Err::MultiBadEasyHandle` errors in the Curb client
+    * Refactored the model importing integration and Rake tasks
   END
 end

data/test/integration/active_record_searchable_test.rb

@@ -600,6 +600,7 @@ module Tire
         setup do
           ActiveRecordModelWithPercolation.index.register_percolator_query('alert') { string 'warning' }
           Tire.index('_percolator').refresh
+          sleep 0.2
         end
 
         should "return matching queries when percolating" do

data/test/integration/boosting_queries_test.rb

@@ -10,19 +10,56 @@ module Tire
       should "allow to set multiple queries per condition" do
         s = Tire.search('articles-test') do
           query do
-            boosting(:negative_boost => 0.2) do
-              positive do
-                string "Two One"
-              end
-              negative do
-                term :tags, 'python'
-              end
+            boosting negative_boost: 0.2 do
+              positive { string "title:Two title:One tags:ruby tags:python"     }
+              negative { term :tags, 'python' }
             end
           end
         end
 
         assert_equal 'One', s.results[0].title
-        assert_equal 'Two', s.results[1].title
+        assert_equal 'Two', s.results[1].title  # Matches 'python', so is demoted
+      end
+
+      context "in the featured results scenario" do
+        setup do
+          # Tire.configure { logger STDERR }
+          @index = Tire.index('featured-results-test') do
+            delete; create
+            store title: 'Kitchen special tool',   featured: true
+            store title: 'Kitchen tool tool tool', featured: false
+            store title: 'Garage tool',            featured: false
+            refresh
+          end
+        end
+
+        teardown do
+          @index.delete
+        end
+
+        should "return featured results first" do
+          s = Tire.search('featured-results-test') do
+            query do
+              boosting negative_boost: 0.1 do
+                positive do
+                  match :title, 'tool'
+                end
+                # The `negative` query runs _within_ the results of the `positive` query,
+                # and "rescores" the documents which match it, lowering their score.
+                negative do
+                  filtered do
+                    query  { match :title, 'kitchen' }
+                    filter :term, featured: false
+                  end
+                end
+              end
+            end
+          end
+
+          assert_equal 'Garage tool', s.results[0].title              # Non-kitchen first
+          assert_equal 'Kitchen special tool', s.results[1].title     # Featured first
+          assert_equal 'Kitchen tool tool tool', s.results[2].title   # Rest
+        end
       end
 
     end

data/test/integration/constant_score_queries_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+module Tire
+
+  class ConstantScoreQueriesIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+    context "Constant score queries" do
+
+      should "return the same score for all results" do
+        s = Tire.search('articles-test') do
+          query do
+            constant_score do
+              query do
+                terms :tags, ['ruby', 'python']
+              end
+            end
+          end
+        end
+
+        assert_equal 2, s.results.size
+        assert s.results[0]._score == s.results[1]._score
+      end
+
+      context "in the featured results scenario" do
+        # Adapted from: http://www.fullscale.co/blog/2013/01/24/Implementing_Featured_Results_With_ElasticSearch.html
+        setup do
+          @index = Tire.index('featured-results-test') do
+            delete; create
+            store title: 'Kitchen special tool',   featured: true
+            store title: 'Kitchen tool tool tool', featured: false
+            store title: 'Garage tool',            featured: false
+            refresh
+          end
+        end
+
+        teardown do
+          @index.delete
+        end
+
+
+        should "return featured results first" do
+          s = Tire.search('featured-results-test') do
+            query do
+              boolean do
+                should do
+                  constant_score do
+                    query  { match :title, 'tool' }
+                    filter :term, featured: true
+                    boost 100
+                  end
+                end
+                should do
+                  match :title, 'tool'
+                end
+              end
+            end
+          end
+
+          assert_equal 'Kitchen special tool', s.results[0].title
+          assert_equal 'Kitchen tool tool tool', s.results[1].title
+        end
+      end
+
+    end
+  end
+end

data/test/integration/dsl_search_test.rb

@@ -13,7 +13,7 @@ module Tire
 
         assert_equal 2, s.results.count
         assert_equal 2, s.results.facets['tags']['count']
-        assert_match /_search\?pretty' -d '{/, s.to_curl, 'Make sure to ignore payload in URL params'
+        assert_match %r|articles-test/_search\?pretty' -d '{|, s.to_curl, 'Make sure to ignore payload in URL params'
       end
 
       should "allow passing URL parameters" do
@@ -21,7 +21,14 @@ module Tire
 
         assert_equal 0, s.results.count
         assert_equal 2, s.results.total
-        assert_match /_search.*search_type=count.*' -d '{/, s.to_curl
+        assert_match %r|articles-test/_search.*search_type=count.*' -d '{|, s.to_curl
+      end
+
+      should "allow to pass document type in index name" do
+        s = Tire.search 'articles-test/article', query: { match: { tags: 'ruby' } }
+
+        assert_equal 2, s.results.total
+        assert_match %r|articles-test/article/_search|, s.to_curl
       end
 
       should "allow building search query iteratively" do

data/test/integration/percolator_test.rb

@@ -106,6 +106,6 @@ module Tire
       Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/weather") rescue nil
     end
 
-  end
+  end unless ENV['TRAVIS']
 
 end

data/test/integration/persistent_model_test.rb

@@ -186,6 +186,7 @@ module Tire
         setup do
           PersistentArticleWithPercolation.index.register_percolator_query('alert') { string 'warning' }
           Tire.index('_percolator').refresh
+          sleep 0.2
         end
 
         should "return matching queries when percolating" do

data/test/unit/http_client_test.rb

@@ -69,6 +69,18 @@ module Tire
             response = Configuration.client.get "http://localhost:9200/articles/article/1"
           end
 
+          should "be threadsafe" do
+            threads = []
+
+            %w| foo bar |.each do |q|
+              threads << Thread.new do
+                Tire.search { query { match :_all, q } }.results.to_a
+              end
+            end
+
+            threads.each { |t| t.join() }
+          end
+
         end
 
       end

data/test/unit/index_test.rb

@@ -193,12 +193,12 @@ module Tire
 
         should "update the mapping" do
           Configuration.client.expects(:put).returns(mock_response('{"ok":true,"acknowledged":true}', 200))
-          assert @index.mapping( 'document', { properties: { body: {type: 'string', analyzer: 'english'} } } )
+          assert @index.mapping( 'document', { :properties => { :body => { :type => 'string', :analyzer => 'english'} } } )
         end
 
         should "fail to update the mapping when conflicts occur" do
           Configuration.client.expects(:put).returns(mock_response('{"error":"MergeMappingException","status":400}', 400))
-          assert ! @index.mapping( 'document', { properties: { body: {type: 'string', analyzer: 'english'} } } )
+          assert ! @index.mapping( 'document', { :properties => { :body => { :type => 'string', :analyzer => 'english'} } } )
         end
 
         should "raise an exception for the bang method" do
@@ -337,10 +337,12 @@ module Tire
 
         context "document with ID" do
 
-          should "store Hash it under its ID property" do
-            Configuration.client.expects(:post).with("#{@index.url}/document/123",
-                                                     MultiJson.encode({:id => 123, :title => 'Test'})).
-                                                returns(mock_response('{"ok":true,"_id":"123"}'))
+          should "store a Hash under its ID property" do
+            Configuration.client.expects(:post).with do |path, json|
+              assert_equal "#{@index.url}/document/123", path
+              assert_equal 123, MultiJson.load(json)['id']
+            end.returns(mock_response('{"ok":true,"_id":"123"}'))
+
             @index.store :id => 123, :title => 'Test'
           end
 

data/test/unit/search_query_test.rb

@@ -415,5 +415,27 @@ module Tire::Search
 
     end
 
+    context 'ConstantScoreQuery' do
+      should "not raise an error when no block is given" do
+        assert_nothing_raised { Query.new.constant_score }
+      end
+
+      should "wrap query" do
+        assert_equal( { :constant_score => {:query => { :term => { :attr => { :term => 'foo' } } } } },
+                      Query.new.constant_score { query { term :attr, 'foo' } } )
+      end
+
+      should "wrap filter" do
+        assert_equal( { :constant_score => {:filter => { :term => { :attr => 'foo' } } } },
+                      Query.new.constant_score { filter :term, :attr => 'foo' } )
+      end
+
+      should "wrap the boost" do
+        assert_equal( { :constant_score => {:boost => 3 } },
+                      Query.new.constant_score { boost 3 } )
+      end
+
+    end
+
   end
 end

data/test/unit/tire_test.rb

@@ -15,18 +15,24 @@ module Tire
       context "DSL" do
 
         should "allow searching with a block" do
-          Search::Search.expects(:new).returns( stub(:perform => true) )
+          Search::Search.expects(:new).with do |index, options, block|
+            assert_equal 'dummy', index
+          end.returns( stub(:perform => true) )
 
           Tire.search 'dummy' do
-            query 'foo'
+            query { string 'foo' }
           end
         end
 
         should "allow searching with a Ruby Hash" do
           payload = { :query => { :query_string => { :query => 'foo' } } }
-          Search::Search.expects(:new).with('dummy', :payload => payload).returns( stub(:perform => true) )
 
-          Tire.search 'dummy', payload
+          Search::Search.expects(:new).with do |index, options|
+            assert_equal index, 'dummy'
+            assert_equal payload, options[:payload]
+          end.returns( stub(:perform => true) )
+
+          s = Tire.search 'dummy', payload
         end
 
         should "raise an error when passed incorrect payload" do
@@ -38,7 +44,7 @@ module Tire
         should "extract URL parameters from options" do
           payload = { :query => { :match => { :foo => 'bar' } } }
 
-          Search::Search.expects(:new).with do |index,options|
+          Search::Search.expects(:new).with do |index, options|
             assert_equal 'bar',   options[:payload][:query][:match][:foo]
             assert_equal 'count', options[:search_type]
           end.returns( stub(:perform => true) )
@@ -46,6 +52,14 @@ module Tire
           Tire.search 'dummy', :query => { :match => { :foo => 'bar' } }, :search_type => 'count'
         end
 
+        should "allow to pass document type" do
+          Search::Search.expects(:new).with do |index, options|
+            assert_equal 'dummy/foo', index
+          end
+
+          Tire.search 'dummy/foo', {}
+        end
+
         should "raise SearchRequestFailed when receiving bad response from backend" do
           assert_raise(Search::SearchRequestFailed) do
             Tire::Configuration.client.expects(:get).returns( mock_response('INDEX DOES NOT EXIST', 404) )

data/tire.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "activemodel", ">= 3.0"
   s.add_dependency "hashr",       "~> 0.0.19"
   s.add_dependency "activesupport"
+  s.add_dependency "ansi"
 
   # = Development dependencies
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tire
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70310347391340 !ruby/object:Gem::Requirement
+  requirement: &70314615618020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70310347391340
+  version_requirements: *70314615618020
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70310347390800 !ruby/object:Gem::Requirement
+  requirement: &70314615617280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70310347390800
+  version_requirements: *70314615617280
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70310347390300 !ruby/object:Gem::Requirement
+  requirement: &70314615643440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70310347390300
+  version_requirements: *70314615643440
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70310347389840 !ruby/object:Gem::Requirement
+  requirement: &70314615642080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70310347389840
+  version_requirements: *70314615642080
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70310347405760 !ruby/object:Gem::Requirement
+  requirement: &70314615641260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.0.19
   type: :runtime
   prerelease: false
-  version_requirements: *70310347405760
+  version_requirements: *70314615641260
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70310347405380 !ruby/object:Gem::Requirement
+  requirement: &70314615640780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70310347405380
+  version_requirements: *70314615640780
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: &70314615639740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70314615639740
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70310347404840 !ruby/object:Gem::Requirement
+  requirement: &70314615638440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70310347404840
+  version_requirements: *70314615638440
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70310347404420 !ruby/object:Gem::Requirement
+  requirement: &70314615636800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347404420
+  version_requirements: *70314615636800
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70310347403880 !ruby/object:Gem::Requirement
+  requirement: &70314615636040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +120,10 @@ dependencies:
         version: '0.13'
   type: :development
   prerelease: false
-  version_requirements: *70310347403880
+  version_requirements: *70314615636040
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70310347403380 !ruby/object:Gem::Requirement
+  requirement: &70314615657700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +131,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70310347403380
+  version_requirements: *70314615657700
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70310347402920 !ruby/object:Gem::Requirement
+  requirement: &70314615656860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +142,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70310347402920
+  version_requirements: *70314615656860
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70310347402460 !ruby/object:Gem::Requirement
+  requirement: &70314615656060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,10 +153,10 @@ dependencies:
         version: '2.2'
   type: :development
   prerelease: false
-  version_requirements: *70310347402460
+  version_requirements: *70314615656060
 - !ruby/object:Gem::Dependency
   name: redis-persistence
-  requirement: &70310347402080 !ruby/object:Gem::Requirement
+  requirement: &70314615655240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347402080
+  version_requirements: *70314615655240
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70310347401620 !ruby/object:Gem::Requirement
+  requirement: &70314615654020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347401620
+  version_requirements: *70314615654020
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70310347401120 !ruby/object:Gem::Requirement
+  requirement: &70314615653500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -175,10 +186,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70310347401120
+  version_requirements: *70314615653500
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70310347400700 !ruby/object:Gem::Requirement
+  requirement: &70314615652940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +197,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347400700
+  version_requirements: *70314615652940
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70310347400240 !ruby/object:Gem::Requirement
+  requirement: &70314615652100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,10 +208,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347400240
+  version_requirements: *70314615652100
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &70310347399820 !ruby/object:Gem::Requirement
+  requirement: &70314615651240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -208,10 +219,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347399820
+  version_requirements: *70314615651240
 - !ruby/object:Gem::Dependency
   name: oj
-  requirement: &70310347399340 !ruby/object:Gem::Requirement
+  requirement: &70314615666200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -219,10 +230,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70310347399340
+  version_requirements: *70314615666200
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70310347398820 !ruby/object:Gem::Requirement
+  requirement: &70314615665640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -230,7 +241,7 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70310347398820
+  version_requirements: *70314615665640
 description: ! "   Tire is a Ruby client for the Elasticsearch search engine/database.\n\n
   \  It provides Ruby-like API for fluent communication with the Elasticsearch server\n
   \  and blends with ActiveModel class for convenient usage in Rails applications.\n\n
@@ -307,6 +318,7 @@ files:
 - test/integration/boolean_queries_test.rb
 - test/integration/boosting_queries_test.rb
 - test/integration/bulk_test.rb
+- test/integration/constant_score_queries_test.rb
 - test/integration/count_test.rb
 - test/integration/custom_score_queries_test.rb
 - test/integration/dis_max_queries_test.rb
@@ -385,11 +397,9 @@ homepage: http://github.com/karmi/tire
 licenses: []
 post_install_message: ! "================================================================================\n\n
   \ Please check the documentation at <http://karmi.github.com/tire/>.\n\n--------------------------------------------------------------------------------\n\n
-  \ IMPORTANT CHANGES LATELY:\n\n  * Improved documentation\n  * Improved isolation
-  of Tire methods in model integrations\n  * Improved handling of times/dates in `Model::Persistence`\n
-  \ * Added support for \"Put Mapping\" and \"Delete mapping\" APIs\n  * Added escaping
-  document IDs in URLs\n  * Allowed passing URL options when passing search definition
-  as a Hash\n\n  See the full changelog at <http://github.com/karmi/tire/commits/v0.5.5>.\n\n--------------------------------------------------------------------------------\n"
+  \ IMPORTANT CHANGES LATELY:\n\n  * Added support for the `constant_score` query\n
+  \ * Prevent `Curl::Err::MultiBadEasyHandle` errors in the Curb client\n  * Refactored
+  the model importing integration and Rake tasks\n\n  See the full changelog at <http://github.com/karmi/tire/commits/v0.5.6>.\n\n--------------------------------------------------------------------------------\n"
 rdoc_options:
 - --charset=UTF-8
 require_paths:
@@ -424,6 +434,7 @@ test_files:
 - test/integration/boolean_queries_test.rb
 - test/integration/boosting_queries_test.rb
 - test/integration/bulk_test.rb
+- test/integration/constant_score_queries_test.rb
 - test/integration/count_test.rb
 - test/integration/custom_score_queries_test.rb
 - test/integration/dis_max_queries_test.rb