slingshot-rb 0.0.3 → 0.0.4

data/README.markdown

@@ -145,7 +145,6 @@ Todo & Plans
 
 In order of importance:
 
-* 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)
 * Seamless [will_paginate](https://github.com/mislav/will_paginate) compatibility for easy pagination
 * [Histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html) facets

data/lib/slingshot/client.rb

@@ -3,6 +3,9 @@ module Slingshot
   module Client
 
     class Base
+      def get(url)
+        raise NoMethodError, "Implement this method in your client class"
+      end
       def post(url, data)
         raise NoMethodError, "Implement this method in your client class"
       end
@@ -12,6 +15,9 @@ module Slingshot
     end
 
     class RestClient < Base
+      def self.get(url)
+        ::RestClient.get url
+      end
       def self.post(url, data)
         ::RestClient.post url, data
       end

data/lib/slingshot/index.rb

@@ -20,20 +20,46 @@ module Slingshot
     end
 
     def store(*args)
+      # TODO: Infer type from the document (hash property, method)
+
       if args.size > 1
         (type, document = args)
       else
         (document = args.pop; type = :document)
       end
+
+      old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
+      id = case true
+        when document.is_a?(Hash)                                           then document[:id] || document['id']
+        when document.respond_to?(:id) && document.id != document.object_id then document.id
+      end
+      $VERBOSE = old_verbose
+
       document = case true
         when document.is_a?(String) then document
         when document.respond_to?(:to_indexed_json) then document.to_indexed_json
         else raise ArgumentError, "Please pass a JSON string or object with a 'to_indexed_json' method"
       end
-      result = Configuration.client.post "#{Configuration.url}/#{@name}/#{type}/", document
+
+      if id
+        result = Configuration.client.post "#{Configuration.url}/#{@name}/#{type}/#{id}", document
+      else
+        result = Configuration.client.post "#{Configuration.url}/#{@name}/#{type}/", document
+      end
       JSON.parse(result)
     end
 
+    def retrieve(type, id)
+      result = Configuration.client.get "#{Configuration.url}/#{@name}/#{type}/#{id}"
+      h = JSON.parse(result)
+      if Configuration.wrapper == Hash then h
+      else
+        document = h['_source'] ? h['_source'] : h['fields']
+        h.update document if document
+        Configuration.wrapper.new(h)
+      end
+    end
+
     def refresh
       Configuration.client.post "#{Configuration.url}/#{@name}/_refresh", ''
     end

data/lib/slingshot/version.rb

@@ -1,3 +1,3 @@
 module Slingshot
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/integration/index_store_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module Slingshot
+
+  class IndexStoreTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Storing the documents in index" do
+
+      teardown { Slingshot.index('articles-test-ids').delete }
+
+      should "store hashes under their IDs" do
+
+        Slingshot.index 'articles-test-ids' do
+          delete
+          create
+
+          store :id => 1, :title => 'One'
+          store :id => 2, :title => 'Two'
+          store :id => 3, :title => 'Three'
+          store :id => 4, :title => 'Four'
+          store :id => 4, :title => 'Four'
+
+          refresh
+        end
+
+        s = Slingshot.search('articles-test-ids') { query { string '*' } }
+
+        assert_equal 4, s.results.count
+
+        document = Slingshot.index('articles-test-ids').retrieve :document, 4
+        assert_equal 'Four', document.title
+        assert_equal 2,      document._version.to_i
+
+      end
+
+    end
+
+  end
+
+end

data/test/models/article.rb

@@ -0,0 +1,15 @@
+# Example non-ActiveModel custom wrapper for result item
+
+class Article
+  attr_reader :id, :title, :body
+
+  def initialize(attributes={})
+    attributes.each { |k,v| instance_variable_set(:"@#{k}", v) }
+  end
+
+  def to_json
+    { :id => @id, :title => @title, :body => @body }.to_json
+  end
+
+  alias :to_indexed_json :to_json
+end

data/test/test_helper.rb

@@ -7,6 +7,8 @@ require 'pathname'
 
 require 'slingshot'
 
+Dir[File.dirname(__FILE__) + '/models/**/*.rb'].each { |m| require m }
+
 class Test::Unit::TestCase
 
   def fixtures_path

data/test/unit/client_test.rb

@@ -8,6 +8,9 @@ module Slingshot
       setup { @http ||= Client::Base.new }
 
       should "have abstract methods" do
+        assert_raise(ArgumentError) { @http.get                }
+        assert_raise(NoMethodError) { @http.get 'URL'          }
+
         assert_raise(ArgumentError) { @http.post               }
         assert_raise(ArgumentError) { @http.post 'URL'         }
         assert_raise(NoMethodError) { @http.post 'URL', 'DATA' }
@@ -23,7 +26,8 @@ module Slingshot
         assert_equal Client::RestClient, Configuration.client
       end
 
-      should "respond to post and delete" do
+      should "respond to HTTP methods" do
+        assert_respond_to Client::RestClient, :get
         assert_respond_to Client::RestClient, :post
         assert_respond_to Client::RestClient, :delete
       end

data/test/unit/index_test.rb

@@ -62,6 +62,64 @@ module Slingshot
           assert_raise(ArgumentError) { @index.store document }
         end
 
+        context "document with ID" do
+
+          should "store Hash it under its ID property" do
+            Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/123",
+                                                     {:id => 123, :title => 'Test'}.to_json).
+                                                returns('{"ok":true,"_id":"123"}')
+            @index.store :id => 123, :title => 'Test'
+          end
+
+          should "store a custom class under its ID property" do
+            Configuration.client.expects(:post).with("#{Configuration.url}/dummy/document/123",
+                                                     {:id => 123, :title => 'Test', :body => 'Lorem'}.to_json).
+                                                returns('{"ok":true,"_id":"123"}')
+            @index.store Article.new(:id => 123, :title => 'Test', :body => 'Lorem')
+          end
+
+        end
+
+      end
+
+      context "when retrieving" do
+
+        setup do
+          Configuration.reset :wrapper
+
+          Configuration.client.stubs(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').
+                                            returns('{"ok":true,"_id":"id-1"}')
+          @index.store :article, :title => 'Test'
+        end
+
+        should "return document in default wrapper" do
+          Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
+                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+          article = @index.retrieve :article, 'id-1'
+          assert_instance_of Results::Item, article
+          assert_equal 'Test', article['_source']['title']
+          assert_equal 'Test', article.title
+        end
+
+        should "return document as a hash" do
+          Configuration.wrapper Hash
+
+          Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
+                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+          article = @index.retrieve :article, 'id-1'
+          assert_instance_of Hash, article
+        end
+
+        should "return document in custom wrapper" do
+          Configuration.wrapper Article
+
+          Configuration.client.expects(:get).with("#{Configuration.url}/dummy/article/id-1").
+                                             returns('{"_id":"id-1","_version":1, "_source" : {"title":"Test"}}')
+          article = @index.retrieve :article, 'id-1'
+          assert_instance_of Article, article
+          assert_equal 'Test', article.title
+        end
+
       end
 
     end

data/test/unit/results_collection_test.rb

@@ -1,17 +1,5 @@
 require 'test_helper'
 
-class Article
-  attr_reader :title, :body
-  def initialize(attributes={})
-    @title = attributes[:title]
-    @body  = attributes[:body]
-  end
-  def to_json
-    { :title => @title, :body => @body }.to_json
-  end
-  alias :to_indexed_json :to_json
-end
-
 module Slingshot
 
   class ResultsCollectionTest < Test::Unit::TestCase

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slingshot-rb
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Karel Minarik
@@ -174,9 +174,11 @@ files:
 - test/fixtures/articles/4.json
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
+- test/integration/index_store_test.rb
 - test/integration/query_string_test.rb
 - test/integration/results_test.rb
 - test/integration/sort_test.rb
+- test/models/article.rb
 - test/test_helper.rb
 - test/unit/client_test.rb
 - test/unit/configuration_test.rb
@@ -231,9 +233,11 @@ test_files:
 - test/fixtures/articles/4.json
 - test/fixtures/articles/5.json
 - test/integration/facets_test.rb
+- test/integration/index_store_test.rb
 - test/integration/query_string_test.rb
 - test/integration/results_test.rb
 - test/integration/sort_test.rb
+- test/models/article.rb
 - test/test_helper.rb
 - test/unit/client_test.rb
 - test/unit/configuration_test.rb