elasticsearch-persistence 6.0.0.pre → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3b68c6704df1a51940545080b631c127701074727d9879c5eaf9bf29513d63
-  data.tar.gz: 966be9deff09a99f149b8c7206b383737be278dd96f368fbda45d30b59fc0439
+  metadata.gz: 31bf48d65a26143768e093d3ef1a26f0d95adb5f4f009448b1b48cde4f1b643a
+  data.tar.gz: bf4f4581573e35a873cb8d1f2db6ec86ddf39420010fcaab6e00fced48f91376
 SHA512:
-  metadata.gz: 0ffc1d1c058660ee3060ffaac44449e4a19b0ee34b2f12f1818aa22753c4a670c7c3dfe9975f44bc41cff8913cb6604bcc6e8e61633e8263ef1888c4a024382b
-  data.tar.gz: 2e589e4a386389e4c41a95c92738d79def0ff49ec18ee2add9ba07e813ae4d2704156dbbe0a9dafeff3cc9767fda38fbfd570ad3c6a7d0be7973f92ab33e35b4
+  metadata.gz: 4e353c41e60cfa475821d87107aaceffaf399f0da68a28d8ecc529b5aadf3257bdc0df61f07a22055645ad143279cc1d30e895b505837bf540813e089622a95a
+  data.tar.gz: ec8f36fb64a038a5d0ec91bb51404b0c15d1d2b731175eba456098030c841c7e4d269c0e9f14c425b79a52b6531af1402c968a556560b29a8608df27c36b14a3

data/README.md

@@ -42,7 +42,7 @@ The library provides the Repository pattern for adding persistence to your Ruby
 
 The `Elasticsearch::Persistence::Repository` module provides an implementation of the
 [repository pattern](http://martinfowler.com/eaaCatalog/repository.html) and allows
-to save, delete, find and search objects stored in Elasticsearch, as well as configure
+you to save, delete, find and search objects stored in Elasticsearch, as well as configure
 mappings and settings for the index. It's an unobtrusive and decoupled way of adding
 persistence to your Ruby objects.
 
@@ -76,7 +76,7 @@ We can save a `Note` instance into the repository...
 note = Note.new id: 1, text: 'Test'
 
 repository.save(note)
-# PUT http://localhost:9200/repository/note/1 [status:201, request:0.210s, query:n/a]
+# PUT http://localhost:9200/repository/_doc/1 [status:201, request:0.210s, query:n/a]
 # > {"id":1,"text":"Test"}
 # < {"_index":"repository","_type":"note","_id":"1","_version":1,"created":true}
 ```
@@ -85,7 +85,7 @@ repository.save(note)
 
 ```ruby
 n = repository.find(1)
-# GET http://localhost:9200/repository/_all/1 [status:200, request:0.003s, query:n/a]
+# GET http://localhost:9200/repository/_doc/1 [status:200, request:0.003s, query:n/a]
 # < {"_index":"repository","_type":"note","_id":"1","_version":2,"found":true, "_source" : {"id":1,"text":"Test"}}
 => <Note:0x007fcbfc0c4980 @attributes={"id"=>1, "text"=>"Test"}>
 ```
@@ -104,7 +104,7 @@ repository.search(query: { match: { text: 'test' } }).first
 
 ```ruby
 repository.delete(note)
-# DELETE http://localhost:9200/repository/note/1 [status:200, request:0.014s, query:n/a]
+# DELETE http://localhost:9200/repository/_doc/1 [status:200, request:0.014s, query:n/a]
 # < {"found":true,"_index":"repository","_type":"note","_id":"1","_version":3}
 => {"found"=>true, "_index"=>"repository", "_type"=>"note", "_id"=>"1", "_version"=>2}
 ```
@@ -145,7 +145,7 @@ class MyRepository
 end
 
 client = Elasticsearch::Client.new(url: ENV['ELASTICSEARCH_URL'], log: true)
-repository = MyRepository.new(client: client, index_name: :my_notes, type: :my_note, klass: Note)
+repository = MyRepository.new(client: client, index_name: :my_notes, type: :note, klass: Note)
 repository.settings number_of_shards: 1 do
   mapping do
     indexes :text, analyzer: 'snowball'
@@ -168,7 +168,7 @@ Save the document with extra properties added by the `serialize` method:
 
 ```ruby
 repository.save(note)
-# PUT http://localhost:9200/my_notes/my_note/1
+# PUT http://localhost:9200/my_notes/note/1
 # > {"id":1,"text":"Test","my_special_key":"my_special_stuff"}
 {"_index"=>"my_notes", "_type"=>"my_note", "_id"=>"1", "_version"=>4, ... }
 ```
@@ -177,7 +177,7 @@ And `deserialize` it:
 
 ```ruby
 repository.find(1)
-# ***** CUSTOM DESERIALIZE LOGIC KICKING IN... *****
+# ***** CUSTOM DESERIALIZE LOGIC... *****
 <Note:0x007f9bd782b7a0 @attributes={... "my_special_key"=>"my_special_stuff"}>
 ```
 
@@ -245,10 +245,10 @@ repository.create_index!(force: true)
 note = Note.new('id' => 1, 'text' => 'Document with image', 'image' => '... BINARY DATA ...')
 
 repository.save(note)
-# PUT http://localhost:9200/notes_development/note/1
+# PUT http://localhost:9200/notes_development/_doc/1
 # > {"id":1,"text":"Document with image","image":"Li4uIEJJTkFSWSBEQVRBIC4uLg==\n"}
 puts repository.find(1).attributes['image']
-# GET http://localhost:9200/notes_development/note/1
+# GET http://localhost:9200/notes_development/_doc/1
 # < {... "_source" : { ... "image":"Li4uIEJJTkFSWSBEQVRBIC4uLg==\n"}}
 # => ... BINARY DATA ...
 ```
@@ -257,9 +257,9 @@ puts repository.find(1).attributes['image']
 
 Each of the following configurations can be set for a repository instance.
 If you have included the `Elasticsearch::Persistence::Repository::DSL` mixin, then you can use the class-level DSL
-methods to set each configuration. You can override the configuration for any instance by passing options to the
+methods to set each value. You can still override the configuration for any instance by passing options to the
 `#initialize` method.
-If you don't use the DSL mixin, you can set also the instance configuration with options passed the `#initialize` method.
+Even if you don't use the DSL mixin, you can set the instance configuration with options passed the `#initialize` method.
 
 ##### Client
 
@@ -269,6 +269,9 @@ The repository uses the standard Elasticsearch [client](https://github.com/elast
 client = Elasticsearch::Client.new(url: 'http://search.server.org')
 repository = NoteRepository.new(client: client)
 repository.client.transport.logger = Logger.new(STDERR)
+repository.client
+# => Elasticsearch::Client
+
 ```
 
 or with the DSL mixin:
@@ -282,6 +285,8 @@ class NoteRepository
 end
 
 repository = NoteRepository.new
+repository.client
+# => Elasticsearch::Client
 
 ```
 
@@ -292,6 +297,9 @@ is 'repository'.
 
 ```ruby
 repository = NoteRepository.new(index_name: 'notes_development')
+repository.index_name
+# => 'notes_development'
+
 ```
 
 or with the DSL mixin:
@@ -305,15 +313,20 @@ class NoteRepository
 end
 
 repository = NoteRepository.new
+repository.index_name
+# => 'notes_development'
 
 ```
 
-The `type` method specifies the Elasticsearch document type to use for storage, lookup and search. The default value is
+The `document_type` method specifies the Elasticsearch document type to use for storage, lookup and search. The default value is
 '_doc'. Keep in mind that future versions of Elasticsearch will not allow you to set this yourself and will use the type,
 '_doc'.
 
 ```ruby
 repository = NoteRepository.new(document_type: 'note')
+repository.document_type
+# => 'note'
+
 ```
 
 or with the DSL mixin:
@@ -327,6 +340,8 @@ class NoteRepository
 end
 
 repository = NoteRepository.new
+repository.document_type
+# => 'note'
 
 ```
 
@@ -336,6 +351,9 @@ returned instead.
 
 ```ruby
 repository = NoteRepository.new(klass: Note)
+repository.klass
+# => Note
+
 ```
 
 or with the DSL mixin:
@@ -349,6 +367,8 @@ class NoteRepository
 end
 
 repository = NoteRepository.new
+repository.klass
+# => Note
 
 ```
 
@@ -383,8 +403,10 @@ repository = NoteRepository.new
 
 ```
 
-You can also use the `#create` method defined on the repository class to create and set the mappings and settings 
-on an instance with a block in one call:
+##### Create a Repository and set its configuration with a block
+
+You can also use the `#create` method to instantiate and set the mappings and settings on an instance
+with a block in one call:
 
 ```ruby
 repository = NoteRepository.create(index_name: 'notes_development') do
@@ -399,13 +421,15 @@ repository = NoteRepository.create(index_name: 'notes_development') do
 end
 ```
 
+##### Index Management
+
 The convenience methods `create_index!`, `delete_index!` and `refresh_index!` allow you to manage the index lifecycle.
 These methods can only be called on repository instances and are not implemented at the class level.
 
 ##### Serialization
 
-The `serialize` and `deserialize` methods allow you to customize the serialization of the document when passing it
-to the storage, and the initialization procedure when loading it from the storage:
+The `serialize` and `deserialize` methods allow you to customize the serialization of the document when it
+is persisted to Elasticsearch, and define the initialization procedure when loading it from the storage:
 
 ```ruby
 class NoteRepository
@@ -428,7 +452,7 @@ The `save` method allows you to store a domain object in the repository:
 ```ruby
 note = Note.new id: 1, title: 'Quick Brown Fox'
 repository.save(note)
-# => {"_index"=>"notes_development", "_type"=>"my_note", "_id"=>"1", "_version"=>1, "created"=>true}
+# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>1, "created"=>true}
 ```
 
 The `update` method allows you to perform a partial update of a document in the repository.
@@ -436,18 +460,18 @@ Use either a partial document:
 
 ```ruby
 repository.update id: 1, title: 'UPDATED',  tags: []
-# => {"_index"=>"notes_development", "_type"=>"note", "_id"=>"1", "_version"=>2}
+# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>2}
 ```
 
 Or a script (optionally with parameters):
 
 ```ruby
 repository.update 1, script: 'if (!ctx._source.tags.contains(t)) { ctx._source.tags += t }', params: { t: 'foo' }
-# => {"_index"=>"notes_development", "_type"=>"note", "_id"=>"1", "_version"=>3}
+# => {"_index"=>"notes_development", "_type"=>"_doc", "_id"=>"1", "_version"=>3}
 ```
 
 
-The `delete` method allows to remove objects from the repository (pass either the object itself or its ID):
+The `delete` method allows you to remove objects from the repository (pass either the object itself or its ID):
 
 ```ruby
 repository.delete(note)
@@ -456,7 +480,7 @@ repository.delete(1)
 
 ##### Finding
 
-The `find` method allows to find one or many documents in the storage and returns them as deserialized Ruby objects:
+The `find` method allows you to find one or many documents in the storage and returns them as deserialized Ruby objects:
 
 ```ruby
 repository.save Note.new(id: 2, title: 'Fast White Dog')
@@ -479,15 +503,15 @@ Handle the missing objects in the application code, or call `compact` on the res
 
 ##### Search
 
-The `search` method to retrieve objects from the repository by a query string or definition in the Elasticsearch DSL:
+The `search` method is used to retrieve objects from the repository by a query string or definition in the Elasticsearch DSL:
 
 ```ruby
 repository.search('fox or dog').to_a
-# GET http://localhost:9200/notes_development/my_note/_search?q=fox
+# GET http://localhost:9200/notes_development/_doc/_search?q=fox
 # => [<MyNote ... FOX ...>, <MyNote ... DOG ...>]
 
 repository.search(query: { match: { title: 'fox dog' } }).to_a
-# GET http://localhost:9200/notes_development/my_note/_search
+# GET http://localhost:9200/notes_development/_doc/_search
 # > {"query":{"match":{"title":"fox dog"}}}
 # => [<MyNote ... FOX ...>, <MyNote ... DOG ...>]
 ```

data/examples/notes/application.rb

@@ -54,11 +54,12 @@ end
 
 class NoteRepository
   include Elasticsearch::Persistence::Repository
+  include Elasticsearch::Persistence::Repository::DSL
 
   client Elasticsearch::Client.new url: ENV['ELASTICSEARCH_URL'], log: true
 
-  index :notes
-  type  :note
+  index_name :notes
+  document_type  :note
 
   mapping do
     indexes :text,       analyzer: 'snowball'
@@ -66,8 +67,6 @@ class NoteRepository
     indexes :created_at, type:     'date'
   end
 
-  create_index!
-
   def deserialize(document)
     Note.new document['_source'].merge('id' => document['_id'])
   end

data/lib/elasticsearch/persistence/repository/response/results.rb

@@ -11,6 +11,7 @@ module Elasticsearch
           include Enumerable
 
           attr_reader :repository
+          attr_reader :raw_response
 
           # The key for accessing the results in an Elasticsearch query response.
           #
@@ -30,8 +31,8 @@ module Elasticsearch
           #
           def initialize(repository, response, options={})
             @repository = repository
-            @response   = Elasticsearch::Model::HashWrapper.new(response)
-            @options    = options
+            @raw_response = response
+            @options = options
           end
 
           def method_missing(method_name, *arguments, &block)
@@ -45,25 +46,25 @@ module Elasticsearch
           # The number of total hits for a query
           #
           def total
-            response[HITS][TOTAL]
+            raw_response[HITS][TOTAL]
           end
 
           # The maximum score for a query
           #
           def max_score
-            response[HITS][MAX_SCORE]
+            raw_response[HITS][MAX_SCORE]
           end
 
           # Yields [object, hit] pairs to the block
           #
           def each_with_hit(&block)
-            results.zip(response[HITS][HITS]).each(&block)
+            results.zip(raw_response[HITS][HITS]).each(&block)
           end
 
           # Yields [object, hit] pairs and returns the result
           #
           def map_with_hit(&block)
-            results.zip(response[HITS][HITS]).map(&block)
+            results.zip(raw_response[HITS][HITS]).map(&block)
           end
 
           # Return the collection of domain objects
@@ -76,7 +77,7 @@ module Elasticsearch
           # @return [Array]
           #
           def results
-            @results ||= response[HITS][HITS].map do |document|
+            @results ||= raw_response[HITS][HITS].map do |document|
               repository.deserialize(document.to_hash)
             end
           end
@@ -93,7 +94,7 @@ module Elasticsearch
           # @return [Elasticsearch::Model::HashWrapper]
           #
           def response
-            @response
+            @response ||= Elasticsearch::Model::HashWrapper.new(raw_response)
           end
         end
       end

data/lib/elasticsearch/persistence/repository/search.rb

@@ -43,18 +43,18 @@ module Elasticsearch
         # @return [Elasticsearch::Persistence::Repository::Response::Results]
         #
         def search(query_or_definition, options={})
-          type = document_type
-
-          case
-          when query_or_definition.respond_to?(:to_hash)
-            response = client.search( { index: index_name, type: type, body: query_or_definition.to_hash }.merge(options) )
-          when query_or_definition.is_a?(String)
-            response = client.search( { index: index_name, type: type, q: query_or_definition }.merge(options) )
+          request = { index: index_name,
+                      type: document_type }
+          if query_or_definition.respond_to?(:to_hash)
+            request[:body] = query_or_definition.to_hash
+          elsif query_or_definition.is_a?(String)
+            request[:q] = query_or_definition
           else
             raise ArgumentError, "[!] Pass the search definition as a Hash-like object or pass the query as a String" +
-                                 " -- #{query_or_definition.class} given."
+              " -- #{query_or_definition.class} given."
           end
-          Response::Results.new(self, response)
+
+          Response::Results.new(self, client.search(request.merge(options)))
         end
 
         # Return the number of domain object in the index
@@ -81,18 +81,19 @@ module Elasticsearch
         #
         def count(query_or_definition=nil, options={})
           query_or_definition ||= { query: { match_all: {} } }
-          type = document_type
+          request = { index: index_name,
+                      type: document_type }
 
-          case
-          when query_or_definition.respond_to?(:to_hash)
-            response = client.count( { index: index_name, type: type, body: query_or_definition.to_hash }.merge(options) )
-          when query_or_definition.is_a?(String)
-            response = client.count( { index: index_name, type: type, q: query_or_definition }.merge(options) )
+          if query_or_definition.respond_to?(:to_hash)
+            request[:body] = query_or_definition.to_hash
+          elsif query_or_definition.is_a?(String)
+            request[:q] = query_or_definition
           else
-            raise ArgumentError, "[!] Pass the search definition as a Hash-like object or pass the query as a String, not as [#{query_or_definition.class}]"
+            raise ArgumentError, "[!] Pass the search definition as a Hash-like object or pass the query as a String" +
+                " -- #{query_or_definition.class} given."
           end
 
-          response[COUNT]
+          client.count(request.merge(options))[COUNT]
         end
 
         private

data/lib/elasticsearch/persistence/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Persistence
-    VERSION = '6.0.0.pre'
+    VERSION = '6.0.0'
   end
 end

data/spec/repository/response/results_spec.rb

@@ -66,6 +66,22 @@ describe Elasticsearch::Persistence::Repository::Response::Results do
     it 'wraps the response in a HashWrapper' do
       expect(results.response._shards.total).to eq(5)
     end
+
+    context 'when the response method is not called' do
+
+      it 'does not create an instance of HashWrapper' do
+        expect(Elasticsearch::Model::HashWrapper).not_to receive(:new)
+        results
+      end
+    end
+
+    context 'when the response method is called' do
+
+      it 'does create an instance of HashWrapper' do
+        expect(Elasticsearch::Model::HashWrapper).to receive(:new)
+        results.response
+      end
+    end
   end
 
   describe '#total' do
@@ -102,4 +118,11 @@ describe Elasticsearch::Persistence::Repository::Response::Results do
       expect(results.map_with_hit { |pair| pair[0] }).to eq(['Object', 'Object'])
     end
   end
+
+  describe '#raw_response' do
+
+    it 'returns the raw response from Elasticsearch' do
+      expect(results.raw_response).to eq(response)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-persistence
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre
+  version: 6.0.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -307,28 +307,6 @@ files:
 - README.md
 - Rakefile
 - elasticsearch-persistence.gemspec
-- examples/music/album.rb
-- examples/music/artist.rb
-- examples/music/artists/_form.html.erb
-- examples/music/artists/artists_controller.rb
-- examples/music/artists/artists_controller_test.rb
-- examples/music/artists/index.html.erb
-- examples/music/artists/show.html.erb
-- examples/music/assets/application.css
-- examples/music/assets/autocomplete.css
-- examples/music/assets/blank_artist.png
-- examples/music/assets/blank_cover.png
-- examples/music/assets/form.css
-- examples/music/index_manager.rb
-- examples/music/search/index.html.erb
-- examples/music/search/search_controller.rb
-- examples/music/search/search_controller_test.rb
-- examples/music/search/search_helper.rb
-- examples/music/suggester.rb
-- examples/music/template.rb
-- examples/music/vendor/assets/jquery-ui-1.10.4.custom.min.css
-- examples/music/vendor/assets/jquery-ui-1.10.4.custom.min.js
-- examples/music/vendor/assets/stylesheets/ui-lightness/images/ui-bg_highlight-soft_100_eeeeee_1x100.png
 - examples/notes/.gitignore
 - examples/notes/Gemfile
 - examples/notes/README.markdown
@@ -367,9 +345,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.7