Persistence implementation: ActiveRecord pattern

README.md

@@ -1,9 +1,9 @@
 # Elasticsearch
 
-This repository contains ActiveModel, ActiveRecord and Ruby on Rails integrations for
-[Elasticsearch](http://elasticsearch.org):
+This repository contains various Ruby and Rails integrations for [Elasticsearch](http://elasticsearch.org):
 
 * ActiveModel integration with adapters for ActiveRecord and Mongoid
+* _Repository Pattern_ based persistence layer for Ruby objects
 * Enumerable-based wrapper for search results
 * ActiveRecord::Relation-based wrapper for returning search results as records
 * Convenience model methods such as `search`, `mapping`, `import`, etc
@@ -41,13 +41,16 @@ or install it from a source code checkout:
 
 ## Usage
 
-This project is split into two separate gems:
+This project is split into three separate gems:
 
 * [**`elasticsearch-model`**](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-model),
-  which contains model-related features such as setting up indices, `search` method, pagination, etc
+  which contains search integration for Ruby/Rails models such as ActiveRecord::Base and Mongoid,
+
+* [**`elasticsearch-persistence`**](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-persistence),
+  which provides standalone persistence layer for Ruby/Rails objects and models
 
 * [**`elasticsearch-rails`**](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-rails),
-  which contains features for Ruby on Rails applications
+  which contains various features for Ruby on Rails applications
 
 Example of a basic integration into an ActiveRecord-based model:
 
@@ -64,20 +67,43 @@ Article.import
 @articles = Article.search('foobar').records
 ```
 
+Example of using Elasticsearch as a repository for a Ruby model:
+
+```ruby
+require 'virtus'
+class Article
+  include Virtus.model
+  attribute :title, String
+end
+
+require 'elasticsearch/persistence'
+repository = Elasticsearch::Persistence::Repository.new
+
+repository.save Article.new(title: 'Test')
+# POST http://localhost:9200/repository/article [status:201, request:0.760s, query:n/a]
+# => {"_index"=>"repository", "_type"=>"article", "_id"=>"Ak75E0U9Q96T5Y999_39NA", ...}
+```
+
 You can generate a fully working Ruby on Rails application with a single command:
 
 ```bash
 rails new searchapp --skip --skip-bundle --template https://raw.github.com/elasticsearch/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/01-basic.rb
 ```
 
-Please refer to each library documentation for detailed information and examples.
+**Please refer to each library documentation for detailed information and examples.**
 
 ### Model
 
 * [[README]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-model/README.md)
 * [[Documentation]](http://rubydoc.info/gems/elasticsearch-model/)
 * [[Test Suite]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-model/test)
 
+### Persistence
+
+* [[README]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-persistence/README.md)
+* [[Documentation]](http://rubydoc.info/gems/elasticsearch-persistence/)
+* [[Test Suite]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-persistence/test)
+
 ### Rails
 
 * [[README]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-rails/README.md)

Rakefile

@@ -1,6 +1,6 @@
 require 'pathname'
 
-subprojects = %w| elasticsearch-model elasticsearch-rails |
+subprojects = %w| elasticsearch-model elasticsearch-rails elasticsearch-persistence |
 
 __current__ = Pathname( File.expand_path('..', __FILE__) )
 

elasticsearch-model/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 0.1.3
+
 ## 0.1.2
 
 * Properly delegate existence methods like `result.foo?` to `result._source.foo`

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

@@ -27,7 +27,9 @@ def initialize(klass, search, options={})
         # @return [Hash]
         #
         def response
-          @response ||= search.execute!
+          @response ||= begin
+            Hashie::Mash.new(search.execute!)
+          end
         end
 
         # Returns the collection of "hits" from Elasticsearch

elasticsearch-model/lib/elasticsearch/model/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Model
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

elasticsearch-model/test/integration/active_record_basic_test.rb

@@ -164,6 +164,14 @@ class ::Article < ActiveRecord::Base
             assert_equal 'Testing Coding', response.records.order('title DESC').first.title
           end
         end
+
+        should "allow dot access to response" do
+          response = Article.search query: { match: { title: { query: 'test' } } },
+                                    aggregations: { dates: { date_histogram: { field: 'created_at', interval: 'hour' } } }
+
+          response.response.respond_to?(:aggregations)
+          assert_equal 2, response.response.aggregations.dates.buckets.first.doc_count
+        end
       end
 
     end

elasticsearch-model/test/unit/response_test.rb

@@ -25,6 +25,16 @@ def self.document_type; 'bar'; end
       assert_equal 'OK',        response.shards.one
     end
 
+    should "wrap the raw Hash response in Hashie::Mash" do
+      @search  = Elasticsearch::Model::Searching::SearchRequest.new OriginClass, '*'
+      @search.stubs(:execute!).returns({'hits' => { 'hits' => [] }, 'aggregations' => { 'dates' => 'FOO' }})
+
+      response = Elasticsearch::Model::Response::Response.new OriginClass, @search
+
+      assert_respond_to response.response, :aggregations
+      assert_equal 'FOO', response.response.aggregations.dates
+    end
+
     should "load and access the results" do
       @search.expects(:execute!).returns(RESPONSE)
 

elasticsearch-persistence/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.3
+
+* Released the "elasticsearch-persistence" Rubygem
+
+## 0.0.1
+
+* Initial infrastructure for the gem