tire 0.6.1 → 0.6.2

data/README.markdown

@@ -820,3 +820,5 @@ You can send feedback via [e-mail](mailto:karmi@karmi.cz) or via [Github Issues]
 -----
 
 [Karel Minarik](http://karmi.cz) and [contributors](http://github.com/karmi/tire/contributors)
+
+![](https://ga-beacon.appspot.com/UA-46901128-1/karmi/retire?pixel)

data/examples/tire-dsl.rb

@@ -816,6 +816,156 @@ s = Tire.search 'articles' do
   highlight :title, :body, :options => { :tag => '<strong class="highlight">' }
 end
 
+#### Suggest
+
+#
+# _Elasticsearch_
+# [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters.html)
+# feature suggests similar terms based on user input.
+# You can specify either the `term` or `phrase` suggester in the Tire DSL, or
+# use the `completion` suggester to get fast completions of user inputs, suitable
+# for auto-complete and instant search features.
+
+# Suggestion API is available either as standalone method or part of the search request.
+
+# To get search suggestions while doing a search, call the suggest API
+#
+s = Tire.search 'articles' do
+
+  # To define a suggest using the term suggester, first provide a custom name for the suggest.
+  #
+  suggest :suggest_title do
+    # Specify the input text.
+    #
+    text 'thrree blind mice'
+    # Then, define the field you want to use for suggestions and any options.
+    #
+    term :title, size: 3, sort: 'frequency'
+  end
+
+  # To define a suggest using the `phrase` suggest, use a different name.
+  suggest :phrase_suggest_title do
+    # Specify the text input text.
+    #
+    text 'thrree blind mice'
+    # Again, define the field you want to use for suggestions and any options.
+    #
+    phrase :title, size: 3 do
+      # Optinally, configure the `smoothing` option...
+      #
+      smoothing :stupid_backoff, discount: 0.5
+
+      # ...or the `generator` option.
+      generator :title, min_word_len: 1
+    end
+  end
+end
+
+# The results will be available in the `suggestions` property (which is iterable)
+#
+s.results.suggestions.each do |name, options|
+  puts "Suggestion returned for #{name}:\n"
+  options.each do |option|
+    puts "* Raw result: #{option}"
+  end
+end
+
+# You can also use helper methods available in suggestions results to get only
+# the suggested terms or phrases.
+#
+puts "Available corrections for suggest_title: #{s.results.suggestions.texts(:suggest_title).join(', ')}"
+
+# You can use the standalone API to achieve the same result:
+#
+s = Tire.suggest('articles') do
+
+  # Notice that for standalone API, the block method is `suggestion` rather than `suggest`:
+  #
+  suggestion :term_suggest do
+    text 'thrree'
+    term :title, size: 3, sort: 'frequency'
+  end
+
+end
+
+# You'll get the same object as above but as top level object
+#
+puts "Available corrections: #{s.results.texts.join(', ')}"
+
+#### Completion
+
+# In order to use _Elasticsearch_ completion you'll need to update your mappings to provide a field
+# with completion type. The example is adapted from this
+# [blog post](http://www.elasticsearch.org/blog/you-complete-me/).
+#
+index = Tire.index('hotels') do
+  delete
+
+  # Notice the type completion for the field _name_suggest_:
+  #
+  create :mappings => {
+      :hotel => {
+          :properties => {
+              :name => {:type => 'string'},
+              :city => {:type => 'string'},
+              :name_suggest => {:type => 'completion'}
+          }
+      }
+  }
+
+  # Let's add some documents into this index:
+  #
+  import([
+             {:id => '1', :type => 'hotel', :name => 'Mercure Hotel Munich', :city => 'Munich', :name_suggest => 'Mercure Hotel Munich'},
+             {:id => '2', :type => 'hotel', :name => 'Hotel Monaco', :city => 'Munich', :name_suggest => 'Hotel Monaco'},
+         ])
+  refresh
+
+end
+
+# We can ask for all hotels starting with a given prefix (such as "m") with this query:
+#
+s = Tire.suggest('hotels') do
+  suggestion 'complete' do
+    text 'm'
+    completion 'name_suggest'
+  end
+end
+
+# And retrieve results as above with the same object:
+#
+puts "There are #{s.results.texts.size} hotels starting with m:"
+s.results.texts.each do |hotel|
+  puts "* #{hotel}"
+end
+
+# You can use some advanced features of completion such as multiple inputs and unified output for
+# the same document.
+
+# If you add a document which has inputs and output values for the suggest field:
+#
+index.store({:id => '1', :type => 'hotel', :name => 'Mercure Hotel Munich', :city => 'Munich',
+             :name_suggest => {:input => ['Mercure Hotel Munich', 'Mercure Munich'], :output => 'Hotel Mercure'}})
+index.store({:id => '2', :type => 'hotel', :name => 'Hotel Monaco', :city => 'Munich',
+             :name_suggest => {:input => ['Monaco Munich', 'Hotel Monaco'], :output => 'Hotel Monaco'}})
+index.refresh
+
+# ... a completion request with the same input as above ...
+#
+s = Tire.suggest('hotels') do
+  suggestion 'complete' do
+    text 'm'
+    completion 'name_suggest'
+  end
+end
+
+# ... will match multiple inputs for the same document and return unified output in results:
+#
+puts "There are #{s.results.texts.size} hotels starting with m:"
+s.results.texts.each do |hotel|
+  puts "* #{hotel}"
+end
+
 #### Percolation
 
 # _Elasticsearch_ comes with one very interesting, and rather unique feature:

data/lib/tire.rb

@@ -30,12 +30,15 @@ require 'tire/search/filter'
 require 'tire/search/highlight'
 require 'tire/search/scan'
 require 'tire/search/script_field'
+require 'tire/suggest'
+require 'tire/suggest/suggestion'
 require 'tire/delete_by_query'
 require 'tire/multi_search'
 require 'tire/count'
 require 'tire/results/pagination'
 require 'tire/results/collection'
 require 'tire/results/item'
+require 'tire/results/suggestions'
 require 'tire/index'
 require 'tire/alias'
 require 'tire/dsl'
@@ -44,6 +47,7 @@ require 'tire/model/callbacks'
 require 'tire/model/percolate'
 require 'tire/model/indexing'
 require 'tire/model/import'
+require 'tire/model/suggest'
 require 'tire/model/search'
 require 'tire/model/persistence/finders'
 require 'tire/model/persistence/attributes'

data/lib/tire/dsl.rb

@@ -117,6 +117,10 @@ module Tire
       Search::Scan.new(names, options, &block)
     end
 
+    def suggest(indices=nil, options={}, &block)
+      Suggest::Suggest.new(indices, options, &block)
+    end
+
     def aliases
       Alias.all
     end

data/lib/tire/model/search.rb

@@ -145,8 +145,8 @@ module Tire
             if instance.destroyed?
               index.remove instance
             else
-              response = index.store( instance, {:percolate => percolator} )
-              instance.tire.matches = response['matches'] if instance.tire.respond_to?(:matches=)
+              @response = index.store( instance, {:percolate => percolator} )
+              instance.tire.matches = @response['matches'] if instance.tire.respond_to?(:matches=)
               self
             end
           end
@@ -225,6 +225,7 @@ module Tire
         include Tire::Model::Import::ClassMethods
         include Tire::Model::Indexing::ClassMethods
         include Tire::Model::Percolate::ClassMethods
+        include Tire::Model::Suggest::ClassMethods
         include ClassMethods
 
         INTERFACE = public_instance_methods.map(&:to_sym) - Object.public_instance_methods.map(&:to_sym)
@@ -245,9 +246,10 @@ module Tire
 
         INTERFACE = public_instance_methods.map(&:to_sym) - Object.public_instance_methods.map(&:to_sym)
 
-        attr_reader :instance
+        attr_reader :instance, :response
         def initialize(instance)
           @instance = instance
+          @response = {}
         end
       end
 

data/lib/tire/model/suggest.rb

@@ -0,0 +1,34 @@
+module Tire
+  module Model
+    module Suggest
+      module ClassMethods
+        def suggest(*args, &block)
+          default_options = {:type => document_type, :index => index.name}
+
+          if block_given?
+            options = args.shift || {}
+          else
+            query, options = args
+            options ||= {}
+          end
+
+          options = default_options.update(options)
+
+          s = Tire::Suggest::Suggest.new(options.delete(:index), options)
+
+          if block_given?
+            block.arity < 1 ? s.instance_eval(&block) : block.call(s)
+          else
+            s.suggestion 'default_suggestion' do
+              text query
+              completion 'suggest'
+            end
+          end
+
+          s.results
+
+        end
+      end
+    end
+  end
+end

data/lib/tire/results/collection.rb

@@ -5,16 +5,17 @@ module Tire
       include Enumerable
       include Pagination
 
-      attr_reader :time, :total, :options, :facets, :max_score
+      attr_reader :time, :total, :options, :facets, :max_score, :suggestions
 
       def initialize(response, options={})
-        @response  = response
-        @options   = options
-        @time      = response['took'].to_i
-        @total     = response['hits']['total'].to_i rescue nil
-        @facets    = response['facets']
-        @max_score = response['hits']['max_score'].to_f rescue nil
-        @wrapper   = options[:wrapper] || Configuration.wrapper
+        @response    = response
+        @options     = options
+        @time        = response['took'].to_i
+        @total       = response['hits']['total'].to_i rescue nil
+        @facets      = response['facets']
+        @suggestions = Suggestions.new(response['suggest']) if response['suggest']
+        @max_score   = response['hits']['max_score'].to_f rescue nil
+        @wrapper     = options[:wrapper] || Configuration.wrapper
       end
 
       def results

data/lib/tire/results/suggestions.rb

@@ -0,0 +1,68 @@
+module Tire
+  module Results
+
+  	class Suggestions
+      include Enumerable
+
+  		def initialize(response, options={})
+        @response = response
+        @options = options
+        @shards_info ||= @response.delete '_shards'
+        @keys ||= @response.keys
+      end
+
+      def results
+        return [] if failure?
+        @results ||= @response
+      end
+
+      def keys
+        @keys
+      end
+
+      def each(&block)
+        results.each(&block)
+      end
+
+      def size
+        results.size
+      end
+
+      def options(suggestion=:all)
+        if suggestion == :all
+          results.map {|k,v| v.map{|s| s['options']}}.flatten
+        else
+          results[suggestion.to_s].map{|s| s['options']}.flatten
+        end
+      end
+
+      def texts(suggestion=:all)
+        if suggestion == :all
+          results.map {|k,v| v.map{|s| s['options'].map {|o| o['text']}}}.flatten
+        else
+          results[suggestion.to_s].map{|s| s['options'].map {|o| o['text']}}.flatten
+        end
+      end
+
+      def payloads(suggestion=:all)
+        if suggestion == :all
+          results.map {|k,v| v.map{|s| s['options'].map {|o| o['payload']}}}.flatten
+        else
+          results[suggestion.to_s].map{|s| s['options'].map {|o| o['payload']}}.flatten
+        end
+      end
+
+      def error
+        @response['error']
+      end
+
+      def success?
+        error.to_s.empty?
+      end
+
+      def failure?
+        ! success?
+      end
+  	end
+	end
+end

data/lib/tire/search.rb

@@ -81,6 +81,12 @@ module Tire
         self
       end
 
+      def suggest(name, &block)
+        @suggest ||= {}
+        @suggest.update Tire::Suggest::Suggestion.new(name, &block).to_hash
+        self
+      end
+
       def highlight(*args)
         unless args.empty?
           @highlight = Highlight.new(*args)
@@ -160,6 +166,7 @@ module Tire
           request.update( { :filter => @filters.first.to_hash } ) if @filters && @filters.size == 1
           request.update( { :filter => { :and => @filters.map {|filter| filter.to_hash} } } ) if  @filters && @filters.size > 1
           request.update( { :highlight => @highlight.to_hash } ) if @highlight
+          request.update( { :suggest => @suggest.to_hash } ) if @suggest
           request.update( { :size => @size } )               if @size
           request.update( { :from => @from } )               if @from
           request.update( { :fields => @fields } )           if @fields

data/lib/tire/suggest.rb

@@ -0,0 +1,108 @@
+module Tire
+  module Suggest
+    class SuggestRequestFailed < StandardError; end
+
+    class Suggest
+
+      attr_reader :indices, :suggestion, :options
+
+      def initialize(indices=nil, options={}, &block)
+        if indices.is_a?(Hash)
+          @indices = indices.keys
+        else
+          @indices = Array(indices)
+        end
+
+        #TODO no options for now
+        @options = options
+
+        @path    = ['/', @indices.join(','), '_suggest'].compact.join('/').squeeze('/')
+
+        block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
+      end
+
+      def suggestion(name, &block)
+        @suggestion = Suggestion.new(name, &block)
+        self
+      end
+
+      def multi(&block)
+        @suggestion = MultiSuggestion.new(&block)
+        self
+      end
+
+      def results
+        @results  || (perform; @results)
+      end
+
+      def response
+        @response || (perform; @response)
+      end
+
+      def json
+        @json || (perform; @json)
+      end
+
+      def url
+        Configuration.url + @path
+      end
+
+      def params
+        options = @options.except(:wrapper, :payload, :load)
+        options.empty? ? '' : '?' + options.to_param
+      end
+
+      def perform
+        @response = Configuration.client.get(self.url + self.params, self.to_json)
+        if @response.failure?
+          STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"
+          raise Tire::Search::SearchRequestFailed, @response.to_s
+        end
+        @json = MultiJson.decode(@response.body)
+        @results = Results::Suggestions.new(@json, @options)
+        return self
+      ensure
+        logged
+      end
+
+      def to_curl
+        to_json_escaped = to_json.gsub("'",'\u0027')
+        %Q|curl -X GET '#{url}#{params.empty? ? '?' : params.to_s + '&'}pretty' -d '#{to_json_escaped}'|
+      end
+
+      def to_hash
+        request = {}
+        request.update( @suggestion.to_hash )
+        request
+      end
+
+      def to_json(options={})
+        payload = to_hash
+        MultiJson.encode(payload, :pretty => Configuration.pretty)
+      end
+
+      def logged(endpoint='_search')
+        if Configuration.logger
+
+          Configuration.logger.log_request endpoint, indices, to_curl
+
+          took = @json['took']  rescue nil
+          code = @response.code rescue nil
+
+          if Configuration.logger.level.to_s == 'debug'
+            body = if @json
+              MultiJson.encode( @json, :pretty => Configuration.pretty)
+            else
+              MultiJson.encode( MultiJson.load(@response.body), :pretty => Configuration.pretty) rescue ''
+            end
+          else
+            body = ''
+          end
+
+          Configuration.logger.log_response code || 'N/A', took || 'N/A', body || 'N/A'
+        end
+      end
+    end
+  end
+end
+

data/lib/tire/suggest/suggestion.rb

@@ -0,0 +1,105 @@
+module Tire
+  module Suggest
+
+    class Suggestion
+      attr_accessor :value, :name
+
+      def initialize(name, &block)
+        @name = name
+        @value = {}
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
+      end
+
+      def text(value)
+        @value[:text] = value
+        self
+      end
+
+      def completion(value, options={})
+        @value[:completion] = {:field => value}.update(options)
+        self
+      end
+
+      def term(value, options={})
+        @value[:term] = { :field => value }.update(options)
+        self
+      end
+
+      def phrase(field, options={}, &block)
+        @value[:phrase] = PhraseSuggester.new(field, options, &block).to_hash
+        self
+      end
+
+      def to_hash
+        {@name.to_sym => @value}
+      end
+
+      def to_json(options={})
+        to_hash.to_json
+      end
+
+    end
+
+    # Used to generate phrase suggestions
+    class PhraseSuggester
+
+      def initialize(field, options={}, &block)
+        @options = options
+        @value   = { :field => field }
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
+      end
+
+      def generator(field, options={})
+        @generators ||= []
+        @generators << { :field => field }.update(options).to_hash
+        self
+      end
+
+      def smoothing(type, options={})
+        @value[:smoothing] = { type => options }
+      end
+
+      def to_json(options={})
+        to_hash.to_json
+      end
+
+      def to_hash
+        @value.update(@options)
+        @value.update( { :direct_generator => @generators } ) if @generators && @generators.size > 0
+
+        @value
+      end
+
+    end
+
+    class MultiSuggestion
+      attr_accessor :suggestions
+
+      def initialize(&block)
+        @value = {}
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
+      end
+
+      def text(value)
+        @global_text = value
+        self
+      end
+
+      def suggestion(name, &block)
+        @suggestions ||= {}
+        @suggestions.update Suggestion.new(name, &block).to_hash
+        self
+      end
+
+      def to_hash
+        @value.update @suggestions
+        @value[:text] = @global_text if @global_text
+        @value
+      end
+
+      def to_json(options={})
+        to_hash.to_json
+      end
+    end
+	end
+end

data/lib/tire/version.rb

@@ -1,15 +1,11 @@
 module Tire
-  VERSION   = "0.6.1"
+  VERSION   = "0.6.2"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    * Added support for bulk update
-    * Improved Kaminari support
-    * Improved the behaviour of `default` properties in Tire::Persistence
-    * Added the information about the gem "retirement" and other documentation improvements
-    * Fixed errors due to NewRelic's patching of Curl
-    * [ACTIVEMODEL] Use Object#id#to_s in `get_id_from_document`
-    * Added support for "Delete By Query" API
+    19e524c [ACTIVEMODEL] Exposed the response from `MyModel#.update_index` as the `response` method on return value
+    bfcde21 [#916] Added support for the Suggest API (@marc-villanueva)
+    710451d [#857] Added support for the Suggest API (@fbatista)
   END
 end

data/test/integration/bulk_test.rb

@@ -61,7 +61,7 @@ module Tire
         end
         @index.bulk_update documents, refresh: true
 
-        documents = Tire.search('bulk-test') { query {all} }.results.to_a
+        documents = Tire.search('bulk-test') { query {all} }.results.to_a.sort { |a,b| a.id <=> b.id }
         assert_equal 'one-updated', documents[0][:title]
         assert_equal 'two-updated', documents[1][:title]
         assert_equal 'three-updated', documents[2][:title]

data/test/integration/search_response_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+#require File.expand_path('../../models/supermodel_article', __FILE__)
+
+module Tire
+
+  class SearchResponseIntegrationTest < Test::Unit::TestCase
+        include Test::Integration
+
+    class ::ActiveModelArticleWithTitle < ActiveModelArticleWithCallbacks
+      mapping do
+        indexes :title, type: :string
+      end
+    end
+
+    class ::ActiveModelArticleWithMalformedTitle < ActiveModelArticleWithCallbacks
+      mapping do
+        indexes :title, type: :string
+      end
+
+      def to_indexed_json
+        json = JSON.parse(super)
+        json["title"] = { key: "value" }
+        json.to_json
+      end
+    end
+
+    def setup
+      super
+      ActiveModelArticleWithTitle.index.delete
+      ActiveModelArticleWithMalformedTitle.index.delete
+    end
+
+    def teardown
+      super
+      ActiveModelArticleWithTitle.index.delete
+      ActiveModelArticleWithMalformedTitle.index.delete
+    end
+
+    context "Successful index update" do
+
+      setup do
+        @model = ActiveModelArticleWithTitle.new \
+                   :id      => 1,
+                   :title   => 'Test article',
+                   :content => 'Lorem Ipsum. Dolor Sit Amet.'
+        @response = @model.update_index
+      end
+
+      should "expose the index response on successful update" do
+        assert_equal @response.response["ok"], true
+      end
+
+    end
+
+    context "Unsuccessful index update" do
+      setup do
+        ActiveModelArticleWithMalformedTitle.create_elasticsearch_index
+        @model = ActiveModelArticleWithMalformedTitle.new \
+                   :id      => 1,
+                   :title   => 'Test article',
+                   :content => 'Lorem Ipsum. Dolor Sit Amet.'
+        @response = @model.update_index
+      end
+
+      should "expose the index response on update error" do
+        assert_equal @response.response["status"], 400
+      end
+    end
+  end
+end

data/test/integration/suggest_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+module Tire
+
+  class SuggestIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context 'Search Suggest' do
+
+      should 'add suggestions field to the results using the term suggester' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.search('articles-test') do
+          suggest :term_suggest1 do
+            text 'thrree'
+            term :title
+          end
+        end
+
+        assert_equal 1, s.results.suggestions.size
+        assert_equal 'three', s.results.suggestions.texts.first
+      end
+
+      should 'add suggestions field to the results using the phrase suggester' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.search('articles-test') do
+          suggest :phrase_suggest1 do
+            text 'thrree'
+            phrase :title
+          end
+        end
+
+        assert_equal 1, s.results.suggestions.size
+        assert_equal 'three', s.results.suggestions.texts.first
+      end
+
+    end
+
+    context 'Standalone term and phrase suggest' do
+
+      should 'return term suggestions when used with standalone api' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.suggest('articles-test') do
+          suggestion :term_suggest do
+            text 'thrree'
+            term :title
+          end
+        end
+
+        assert_equal 1, s.results.texts.size
+        assert_equal 'three', s.results.texts.first
+      end
+
+      should 'return phrase suggestions when used with standalone api' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.suggest('articles-test') do
+          suggestion :prhase_suggest do
+            text 'thrree'
+            phrase :title
+          end
+        end
+
+        assert_equal 1, s.results.texts.size
+        assert_equal 'three', s.results.texts.first
+      end
+
+    end
+
+    context 'Standalone suggest' do
+      setup do
+        Tire.index('suggest-test') do
+          delete
+          create :mappings => {
+              :article => {
+                  :properties => {
+                      :title => {:type => 'string', :analyzer => 'simple'},
+                      :title_suggest => {:type => 'completion', :analyzer => 'simple'},
+                  }
+              }
+          }
+          import([
+                     {:id => '1', :type => 'article', :title => 'one', :title_suggest => 'one'},
+                     # this document has multiple inputs for completion field and a specified output
+                     {:id => '2', :type => 'article', :title => 'two', :title_suggest => {:input => %w(two dos due), :output => 'Two[2]'}},
+                     {:id => '3', :type => 'article', :title => 'three', :title_suggest => 'three'}
+                 ])
+          refresh
+        end
+      end
+
+      teardown do
+        Tire.index('suggest-test') { delete }
+      end
+
+      should 'return completion suggestions when used with standalone api' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.suggest('suggest-test') do
+          suggestion 'complete' do
+            text 't'
+            completion 'title_suggest'
+          end
+        end
+
+        assert_equal 2, s.results.texts.size
+        assert_equal %w(Two[2] three), s.results.texts
+      end
+
+      should 'allow multiple completion requests in the same request' do
+        # Tire::Configuration.logger STDERR, :level => 'debug'
+        s = Tire.suggest('suggest-test') do
+          multi do
+            suggestion 'foo' do
+              text 'o'
+              completion 'title_suggest'
+            end
+            suggestion 'bar' do
+              text 'd'
+              completion 'title_suggest'
+            end
+          end
+        end
+
+        assert_equal 2, s.results.size
+        assert_equal %w(one), s.results.texts(:foo)
+        assert_equal %w(Two[2]), s.results.texts(:bar)
+      end
+
+    end
+  end
+end

data/test/models/active_record_models.rb

@@ -11,7 +11,10 @@ class ActiveRecordArticle < ActiveRecord::Base
     mapping do
       indexes :title,      :type => 'string', :boost => 10, :analyzer => 'snowball'
       indexes :created_at, :type => 'date'
-
+      indexes :suggest, :type => :completion,
+                        :index_analyzer => :simple,
+                        :search_analyzer => :simple,
+                        :payloads => true
       indexes :comments do
         indexes :author
         indexes :body
@@ -23,6 +26,7 @@ class ActiveRecordArticle < ActiveRecord::Base
     {
       :title        => title,
       :length       => length,
+      :suggest      => suggest,
 
       :comments     => comments.map { |c| { :_type  => 'active_record_comment',
                                             :_id    => c.id,
@@ -32,6 +36,14 @@ class ActiveRecordArticle < ActiveRecord::Base
     }.to_json
   end
 
+  def suggest
+    { 
+      input: self.title.split(/\W/).reject(&:empty?),
+      output: self.title,
+      payload: { length: length, comment_authors: comment_authors}
+    }
+  end
+
   def length
     title.length
   end

data/test/unit/search_test.rb

@@ -339,6 +339,33 @@ module Tire
 
       end
 
+      context "suggest" do
+        should "allow to specify term suggest" do
+          s = Search::Search.new('index') do
+            suggest :suggest_name do
+              text 'text'
+              term :candidate_field
+            end
+          end
+
+          hash = MultiJson.decode( s.to_json )
+          assert_not_nil hash['suggest']
+        end
+
+        should "allow to specify phrase suggest" do
+          s = Search::Search.new('index') do
+            suggest :suggest_name do
+              text 'text'
+              phrase :candidate_field
+            end
+          end
+
+          hash = MultiJson.decode( s.to_json )
+          assert_not_nil hash['suggest']
+        end
+
+      end
+
       context "with version" do
 
         should "set the version" do

data/test/unit/suggest_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+module Tire
+
+  class SuggestTest < Test::Unit::TestCase
+
+    context "Suggest" do
+      setup { Configuration.reset }
+
+      should "be initialized with single index" do
+        s = Suggest::Suggest.new('index') do 
+          suggestion 'default-suggestion' do 
+            text 'foo'
+            completion 'bar'
+          end
+        end
+        assert_match %r|/index/_suggest|, s.url
+      end
+
+      should "allow to suggest all indices by leaving index empty" do
+        s = Suggest::Suggest.new do 
+          suggestion 'default-suggestion' do 
+            text 'foo'
+            completion 'bar'
+          end
+        end
+        assert_match %r|localhost:9200/_suggest|, s.url
+      end
+
+      should "return curl snippet for debugging" do
+        s = Suggest::Suggest.new('index') do 
+          suggestion 'default-suggestion' do 
+            text 'foo'
+            completion 'bar'
+          end
+        end
+        assert_match %r|curl \-X GET 'http://localhost:9200/index/_suggest\?pretty' -d |, s.to_curl
+        assert_match %r|\s*{\s*"default-suggestion"\s*:\s*{\s*"text"\s*:\s*"foo"\s*,\s*"completion"\s*:\s*{\s*"field"\s*:\s*"bar"\s*}\s*}\s*}\s*|, s.to_curl
+      end
+
+      should "return itself as a Hash" do
+        s = Suggest::Suggest.new('index') do 
+          suggestion 'default_suggestion' do 
+            text 'foo'
+            completion 'bar'
+          end
+        end
+        assert_nothing_raised do
+          assert_instance_of Hash,  s.to_hash
+          assert_equal "foo", s.to_hash[:default_suggestion][:text]
+        end
+      end
+
+      should "allow to pass options for completion queries" do
+        s = Suggest::Suggest.new do
+          suggestion 'default_suggestion' do
+            text 'foo'
+            completion 'bar', :fuzzy => true
+          end
+        end
+        assert_equal true, s.to_hash[:default_suggestion][:completion][:fuzzy]
+      end
+
+      should "perform the suggest lazily" do
+        response = mock_response '{"_shards": {"total": 5, "successful": 5, "failed": 0}, "default-suggestion": [{"text": "ssd", "offset": 0, "length": 10, "options": [] } ] }', 200
+        Configuration.client.expects(:get).returns(response)
+        Results::Suggestions.expects(:new).returns([])
+
+        s = Suggest::Suggest.new('index') do 
+          suggestion 'default-suggestion' do 
+            text 'foo'
+            completion 'bar'
+          end
+        end
+        assert_not_nil s.results
+        assert_not_nil s.response
+        assert_not_nil s.json
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tire
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -409,10 +409,12 @@ files:
 - lib/tire/model/persistence/finders.rb
 - lib/tire/model/persistence/storage.rb
 - lib/tire/model/search.rb
+- lib/tire/model/suggest.rb
 - lib/tire/multi_search.rb
 - lib/tire/results/collection.rb
 - lib/tire/results/item.rb
 - lib/tire/results/pagination.rb
+- lib/tire/results/suggestions.rb
 - lib/tire/rubyext/hash.rb
 - lib/tire/rubyext/ruby_1_8.rb
 - lib/tire/rubyext/symbol.rb
@@ -427,6 +429,8 @@ files:
 - lib/tire/search/scan.rb
 - lib/tire/search/script_field.rb
 - lib/tire/search/sort.rb
+- lib/tire/suggest.rb
+- lib/tire/suggest/suggestion.rb
 - lib/tire/tasks.rb
 - lib/tire/utils.rb
 - lib/tire/version.rb
@@ -472,7 +476,9 @@ files:
 - test/integration/results_test.rb
 - test/integration/scan_test.rb
 - test/integration/script_fields_test.rb
+- test/integration/search_response_test.rb
 - test/integration/sort_test.rb
+- test/integration/suggest_test.rb
 - test/models/active_model_article.rb
 - test/models/active_model_article_with_callbacks.rb
 - test/models/active_model_article_with_custom_document_type.rb
@@ -516,18 +522,17 @@ files:
 - test/unit/search_script_field_test.rb
 - test/unit/search_sort_test.rb
 - test/unit/search_test.rb
+- test/unit/suggest_test.rb
 - test/unit/tire_test.rb
 - tire.gemspec
 homepage: http://github.com/karmi/tire
 licenses: []
 post_install_message: ! "================================================================================\n\n
   \ Please check the documentation at <http://karmi.github.com/retire/>.\n\n--------------------------------------------------------------------------------\n\n
-  \ IMPORTANT CHANGES LATELY:\n\n  * Added support for bulk update\n  * Improved Kaminari
-  support\n  * Improved the behaviour of `default` properties in Tire::Persistence\n
-  \ * Added the information about the gem \"retirement\" and other documentation improvements\n
-  \ * Fixed errors due to NewRelic's patching of Curl\n  * [ACTIVEMODEL] Use Object#id#to_s
-  in `get_id_from_document`\n  * Added support for \"Delete By Query\" API\n\n  See
-  the full changelog at <http://github.com/karmi/tire/commits/v0.6.1>.\n\n--------------------------------------------------------------------------------\n"
+  \ IMPORTANT CHANGES LATELY:\n\n  19e524c [ACTIVEMODEL] Exposed the response from
+  `MyModel#.update_index` as the `response` method on return value\n  bfcde21 [#916]
+  Added support for the Suggest API (@marc-villanueva)\n  710451d [#857] Added support
+  for the Suggest API (@fbatista)\n\n  See the full changelog at <http://github.com/karmi/tire/commits/v0.6.2>.\n\n--------------------------------------------------------------------------------\n"
 rdoc_options:
 - --charset=UTF-8
 require_paths:
@@ -593,7 +598,9 @@ test_files:
 - test/integration/results_test.rb
 - test/integration/scan_test.rb
 - test/integration/script_fields_test.rb
+- test/integration/search_response_test.rb
 - test/integration/sort_test.rb
+- test/integration/suggest_test.rb
 - test/models/active_model_article.rb
 - test/models/active_model_article_with_callbacks.rb
 - test/models/active_model_article_with_custom_document_type.rb
@@ -637,5 +644,6 @@ test_files:
 - test/unit/search_script_field_test.rb
 - test/unit/search_sort_test.rb
 - test/unit/search_test.rb
+- test/unit/suggest_test.rb
 - test/unit/tire_test.rb
 has_rdoc: