[MODEL] Refactored the suggestions output wrapper

Refactored the accessor for the `suggest` part of the response introduced in elastic#483
to allow a richer interface.

Added a `terms` helper method which just returns a flat array of

    response.suggestions.terms
    # => [ 'Foo', 'Bar' ]

Related: rubygems/rubygems.org#1135

Author: karmi

elasticsearch-model/lib/elasticsearch/model.rb

@@ -31,6 +31,7 @@
 require 'elasticsearch/model/response/results'
 require 'elasticsearch/model/response/records'
 require 'elasticsearch/model/response/pagination'
+require 'elasticsearch/model/response/suggestions'
 
 require 'elasticsearch/model/ext/active_record'
 

elasticsearch-model/lib/elasticsearch/model/response.rb

@@ -72,10 +72,10 @@ def aggregations
           response['aggregations'] ? Hashie::Mash.new(response['aggregations']) : nil
         end
 
-        # Returns a Hashie::Mash of the suggest
+        # Returns a Hashie::Mash of the suggestions
         #
-        def suggest
-          response['suggest'] ? Hashie::Mash.new(response['suggest']) : nil
+        def suggestions
+          Suggestions.new(response['suggest'])
         end
       end
     end

elasticsearch-model/lib/elasticsearch/model/response/suggestions.rb

@@ -0,0 +1,13 @@
+module Elasticsearch
+  module Model
+    module Response
+
+      class Suggestions < Hashie::Mash
+        def terms
+          self.to_a.map { |k,v| v.first['options'] }.flatten.map {|v| v['text']}.uniq
+        end
+      end
+
+    end
+  end
+end

elasticsearch-model/test/integration/active_record_basic_test.rb

@@ -23,7 +23,6 @@ class ::Article < ActiveRecord::Base
             settings index: { number_of_shards: 1, number_of_replicas: 0 } do
               mapping do
                 indexes :title,         type: 'string', analyzer: 'snowball'
-                indexes :suggest_title, type: 'completion'
                 indexes :body,          type: 'string'
                 indexes :created_at,    type: 'date'
               end
@@ -219,13 +218,14 @@ def as_indexed_json(options = {})
         should "allow dot access to response" do
           response = Article.search query: { match: { title: { query: 'test' } } },
                                     aggregations: { dates: { date_histogram: { field: 'created_at', interval: 'hour' } } },
-                                    suggest: { title_suggest: { text: 'test', completion: { field: 'suggest_title' } } }
+                                    suggest: { text: 'tezt', title: { term: { field: 'title', suggest_mode: 'always' } } }
 
           response.response.respond_to?(:aggregations)
-          assert_equal 2, response.response.aggregations.dates.buckets.first.doc_count
+          assert_equal 2, response.aggregations.dates.buckets.first.doc_count
 
           response.response.respond_to?(:suggest)
-          assert_equal 2, response.response.suggest.title_suggest.first.options.size
+          assert_equal 1, response.suggestions.title.first.options.size
+          assert_equal ['test'], response.suggestions.terms
         end
       end
 

elasticsearch-model/test/unit/response_test.rb

@@ -9,7 +9,7 @@ def self.document_type; 'bar'; end
 
     RESPONSE = { 'took' => '5', 'timed_out' => false, '_shards' => {'one' => 'OK'}, 'hits' => { 'hits' => [] },
                  'aggregations' => {'foo' => {'bar' => 10}},
-                 'suggest' => {'my_suggest' => []}}
+                 'suggest' => {'my_suggest' => [ { 'text' => 'foo', 'options' => [ { 'text' => 'Foo', 'score' => 2.0 }, { 'text' => 'Bar', 'score' => 1.0 } ] } ]}}
 
     setup do
       @search  = Elasticsearch::Model::Searching::SearchRequest.new OriginClass, '*'
@@ -79,9 +79,26 @@ def self.document_type; 'bar'; end
       @search.expects(:execute!).returns(RESPONSE)
 
       response = Elasticsearch::Model::Response::Response.new OriginClass, @search
-      assert_respond_to response, :suggest
-      assert_kind_of Hashie::Mash, response.suggest
-      assert_equal [], response.suggest.my_suggest
+
+      assert_respond_to response, :suggestions
+      assert_kind_of Hashie::Mash, response.suggestions
+      assert_equal 'Foo', response.suggestions.my_suggest.first.options.first.text
+    end
+
+    should "return array of terms from the suggestions" do
+      @search.expects(:execute!).returns(RESPONSE)
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_not_empty response.suggestions
+      assert_equal [ 'Foo', 'Bar' ], response.suggestions.terms
+    end
+
+    should "return empty array as suggest terms when there are no suggestions" do
+      @search.expects(:execute!).returns({})
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_empty response.suggestions
+      assert_equal [], response.suggestions.terms
     end
   end
 end