slingshot-rb 0.0.1 → 0.0.2

data/README.markdown

@@ -1,6 +1,8 @@
 Slingshot
 =========
 
+![Slingshot](https://github.com/karmi/slingshot/raw/master/slingshot.png)
+
 _Slingshot_ aims to provide a rich Ruby API and DSL for the
 [ElasticSearch](http://www.elasticsearch.org/) search engine/database.
 
@@ -25,7 +27,7 @@ First, you need a running _ElasticSearch_ server. Thankfully, it's easy. Let's d
 
 OK, easy. Now, install the gem via Rubygems:
 
-    $ gem install slingshot
+    $ gem install slingshot-rb
 
 or from source:
 
@@ -86,7 +88,7 @@ from the database:
 Let's display the results:
 
     s.results.each do |document|
-      puts "* #{ document['_source']['title'] }"
+      puts "* #{ document.title }"
     end
 
     # * Two
@@ -135,7 +137,6 @@ Todo & Plans
 
 In order of importance:
 
-* Basic wrapper class for _hits_ in results, so we could write `results.first.document.title` instead of using the raw Hash
 * Getting document [by ID](http://www.elasticsearch.org/guide/reference/api/get.html)
 * Seamless _ActiveModel_ compatibility for easy usage in _Rails_ applications (this also means nearly full _ActiveRecord_ compatibility)
 * Allowing to set custom non-ActiveModel wrapper class (your own)

data/examples/dsl.rb

@@ -56,7 +56,7 @@ puts s.to_curl
 
 puts "", "Results:", "-"*80
 s.results.each_with_index do |document, i|
-  puts "#{i+1}. #{ document['_source']['title'].ljust(20) } [id] #{document['_id']}"
+  puts "#{i+1}. #{ document.title.ljust(20) } [id] #{document._id}"
 end
 
 puts "", "Facets: tags distribution across the whole database:", "-"*80

data/lib/slingshot/results/collection.rb

@@ -8,7 +8,11 @@ module Slingshot
       def initialize(response)
         @time    = response['took']
         @total   = response['hits']['total']
-        @results = response['hits']['hits']
+        @results = response['hits']['hits'].map do |h|
+                     document = h['_source'] ? h['_source'] : h['fields']
+                     h.update document if document
+                     Item.new h
+                   end
         @facets  = response['facets']
       end
 

data/lib/slingshot/results/item.rb

@@ -0,0 +1,36 @@
+module Slingshot
+  module Results
+
+    class Item < Hash
+
+      # Create new instance, recursively converting all Hashes to Item
+      # and leaving everything else alone.
+      #
+      def initialize(args={})
+        if args.is_a? Hash
+          args.each_pair do |key, value|
+            self[key.to_sym] = value.is_a?(Hash) ? self.class.new(value) : value
+          end
+          super.replace self
+        else
+          super()
+        end
+      end
+
+      # Delegate method to a key in underlying hash, if present,
+      # otherwise return +nil+.
+      #
+      def method_missing(method_name, *arguments)
+        self.has_key?(method_name.to_sym) ? self[method_name.to_sym] : nil
+      end
+
+      def inspect
+        s = []; self.each { |k,v| s << ":#{k} => #{v.inspect}" }
+        %Q|<Item #{s.join(', ')}>|
+      end
+
+      alias_method :to_indexed_json, :to_json
+    end
+
+  end
+end

data/lib/slingshot/rubyext/hash.rb

@@ -1,3 +1,3 @@
 class Hash
-  alias_method :to_indexed_json, :to_json if respond_to?(:to_json)
+  alias_method :to_indexed_json, :to_json
 end

data/lib/slingshot/version.rb

@@ -1,3 +1,3 @@
 module Slingshot
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/slingshot.rb

@@ -10,6 +10,7 @@ require 'slingshot/search/query'
 require 'slingshot/search/sort'
 require 'slingshot/search/facet'
 require 'slingshot/results/collection'
+require 'slingshot/results/item'
 require 'slingshot/index'
 require 'slingshot/dsl'
 

data/test/integration/results_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+module Slingshot
+
+  class ResultsIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Query results" do
+
+      should "allow easy access to returned documents" do
+        q = 'title:one'
+        s = Slingshot.search('articles-test') { query { string q } }
+        assert_equal 'One',  s.results.first.title
+        assert_equal 'ruby', s.results.first.tags[0]
+      end
+
+      should "allow easy access to returned documents with limited fields" do
+        q = 'title:one'
+        s = Slingshot.search('articles-test') { query { string q }.fields :title }
+        assert_equal 'One', s.results.first.title
+        assert_nil s.results.first.tags
+      end
+
+    end
+
+  end
+
+end

data/test/unit/results_collection_test.rb

@@ -6,24 +6,42 @@ module Slingshot
 
     context "Collection" do
       setup do
-        @default_response = { 'hits' => { 'hits' => [1, 2, 3] } }
+        @default_response = { 'hits' => { 'hits' => [{:_id => 1}, {:_id => 2}, {:_id => 3}] } }
       end
 
       should "be iterable" do
         assert_respond_to Results::Collection.new(@default_response), :each
         assert_nothing_raised do
-          Results::Collection.new(@default_response).each { |item| item + 1 }
-          Results::Collection.new(@default_response).map { |item| item + 1 }
+          Results::Collection.new(@default_response).each { |item| item[:_id] + 1 }
+          Results::Collection.new(@default_response).map  { |item| item[:_id] + 1 }
         end
       end
 
       should "be initialized with parsed json" do
         assert_nothing_raised do
           collection = Results::Collection.new( @default_response )
-          assert_equal [1,2,3], collection.results
+          assert_equal 3, collection.results.count
         end
       end
 
+      context "wrapping results" do
+
+        should "wrap hits in Item" do
+          response = { 'hits' => { 'hits' => [ { '_id' => 1, '_source' => { :title => 'Test', :body => 'Lorem' } } ] } }
+          document =  Results::Collection.new(response).first
+          assert_kind_of Results::Item, document
+          assert_equal 'Test', document.title
+        end
+
+        should "allow access to raw underlying Hash" do
+          response = { 'hits' => { 'hits' => [ { '_id' => 1, '_source' => { :title => 'Test', :body => 'Lorem' } } ] } }
+          document = Results::Collection.new(response).first
+          assert_not_nil document[:_source][:title]
+          assert_equal 'Test', document[:_source][:title]
+        end
+
+      end
+
     end
 
   end

data/test/unit/results_item_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+module Slingshot
+
+  class ResultsItemTest < Test::Unit::TestCase
+
+    context "Item" do
+
+      setup do
+        @document = Results::Item.new :title => 'Test', :author => { :name => 'Kafka' }
+      end
+
+      should "respond to :to_indexed_json" do
+        assert_respond_to Results::Item.new, :to_indexed_json
+      end
+
+      should "retrieve the values from underlying hash" do
+        assert_equal 'Test', @document[:title]
+      end
+
+      should "allow to retrieve the values by methods" do
+        assert_not_nil @document.title
+        assert_equal 'Test', @document.title
+      end
+
+      should "return nil for non-existing keys/methods" do
+        assert_nothing_raised { @document.whatever }
+        assert_nil @document.whatever
+      end
+
+      should "not care about symbols or strings in keys" do
+        @document = Results::Item.new 'title' => 'Test'
+        assert_not_nil @document.title
+        assert_equal 'Test', @document.title
+      end
+
+      should "allow to retrieve hashes" do
+        assert_equal 'Kafka', @document.author[:name]
+      end
+
+      should "allow to retrieve values from nested hashes" do
+        assert_not_nil   @document.author.name
+        assert_equal 'Kafka', @document.author.name
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slingshot-rb
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Karel Minarik
@@ -152,20 +152,22 @@ files:
 - README.markdown
 - Rakefile
 - examples/dsl.rb
+- lib/slingshot-rb.rb
 - lib/slingshot.rb
 - lib/slingshot/client.rb
 - lib/slingshot/configuration.rb
 - lib/slingshot/dsl.rb
 - lib/slingshot/index.rb
 - lib/slingshot/results/collection.rb
+- lib/slingshot/results/item.rb
 - lib/slingshot/rubyext/hash.rb
 - lib/slingshot/search.rb
 - lib/slingshot/search/facet.rb
 - lib/slingshot/search/query.rb
 - lib/slingshot/search/sort.rb
-- lib/slingshot/slingshot-rb.rb
 - lib/slingshot/version.rb
 - slingshot.gemspec
+- slingshot.png
 - test/fixtures/articles/1.json
 - test/fixtures/articles/2.json
 - test/fixtures/articles/3.json
@@ -173,12 +175,14 @@ files:
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
 - test/integration/query_string_test.rb
+- test/integration/results_test.rb
 - test/integration/sort_test.rb
 - test/test_helper.rb
 - test/unit/client_test.rb
 - test/unit/configuration_test.rb
 - test/unit/index_test.rb
 - test/unit/results_collection_test.rb
+- test/unit/results_item_test.rb
 - test/unit/search_facet_test.rb
 - test/unit/search_query_test.rb
 - test/unit/search_sort_test.rb
@@ -216,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: slingshot
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Ruby API for ElasticSearch
@@ -228,12 +232,14 @@ test_files:
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
 - test/integration/query_string_test.rb
+- test/integration/results_test.rb
 - test/integration/sort_test.rb
 - test/test_helper.rb
 - test/unit/client_test.rb
 - test/unit/configuration_test.rb
 - test/unit/index_test.rb
 - test/unit/results_collection_test.rb
+- test/unit/results_item_test.rb
 - test/unit/search_facet_test.rb
 - test/unit/search_query_test.rb
 - test/unit/search_sort_test.rb