elastic_mapper 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTA5MjVlNTE4OTVmYjg4ZmY5MDc5YzA1NTExZWJhYzY3YmYwZWMzYw==
-  data.tar.gz: !binary |-
-    YWE3YTVkZjZiNjRhMGNmNTY2ZjdmNDg1OWY4MWZlODI5Y2M4ZjhmNA==
+SHA1:
+  metadata.gz: 44bac02c15e1ea5ac170e5ead716ed32d2a2e0c9
+  data.tar.gz: 1b1263a1980b20109be0a125776b56c597014066
 SHA512:
-  metadata.gz: !binary |-
-    NTc2ODlhZmYzYTBhOTIwMGEwZjU2NTU0MGUwMTA0YzU0MTNiNmMyMTI4ZTFk
-    OGRjYzBkM2IxYjdiNDBkZDk0ZDNkNzM4NWI0YWY1MmVkMGY1NTU1YTNkMjg5
-    ZWY2NjBjMDVjZWI3OGExNmFhNDRiNmM0YWQ3ZGYxNTc1ODRmOGY=
-  data.tar.gz: !binary |-
-    NzhlNWU0OWM5NDIyNTRhNmQ2YjliZmY2N2FjYjliOTA1ZDI5YmIwMThmYTM3
-    MmNmZWUyMzQ4OGM0OTNmOTdkOGRmOGVmMzY4MzgzYjE3ZWZkMzRmZDFlNGJh
-    N2YxODVkZGQ2NWZhMjc0MDVhZDJlY2Y0YzMxN2VkOTc2MWY3ZTQ=
+  metadata.gz: 7d034a538c4f0f657cddff452dbfe87e88db7e911dd5b52f9226f4706ec71b067ecb7cd035884fa1f4d7f72befa28193a8af30475a39fb2dac702ab665a7d5b5
+  data.tar.gz: 5dd79e2a9978c2ad677e4d85da8e05c6e3cca2add42df49cc8755d316e4a317fb755349f296d036a8ffb3b2ff9199be8805b4f5c3e57d9017d1c9034e2cc6f0f

data/README.md

@@ -1,15 +1,25 @@
 ElasticMapper
 =============
 
-A dead simple DSL for integrating ActiveRecord with ElasticSearch.
+A damn simple mixin for integrating ActiveModel with ElasticSearch.
 
-ElasticMapper is built on top of the [Stretcher](https://github.com/PoseBiz/stretcher) library.
+ElasticMapper is built on top of the [Stretcher](https://github.com/PoseBiz/stretcher) client.
 
 Background
 ----------
 
-Describing Mappings
-----------------
+I'm a big fan of the [Stretcher](https://github.com/PoseBiz/stretcher) ElasticSearch client. It exposes an API that's: straightforward, elegant, and well documented. I tend to choose stretcher when pulling search into Rails projects.
+
+A few projects in, I noticed that I was rewriting a lot of the same code for:
+
+* describing the mappings on documents.
+* indexing documents.
+* and searching for documents.
+
+From this grew ElasticMapper; Simply include the ElasticMapper mixin in your ActiveModels, it provides helpers for: generating mappings, indexing documents, and performing search.
+
+Creating Mappings
+-----------------
 
 Mappings indicate to ElasticSearch how the fields of a document should be indexed:
 
@@ -18,32 +28,92 @@ http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping.ht
 ElasticMapper provides a `mapping` method, for describing these mappings.
 
 ```ruby
-def Article
+def Article < ActiveHash::Base
 	include ElasticMapper
 
+	# Note we might sometimes want to index the same field in a few
+	# different ways, ElasticMapper creates a unique name automatically
+	# if fields collide :title, :title_1, ...
 	mapping :title, :doi, { type => :string, index => :not_analyzed }
 	mapping :title, :abstract, type => :string
 	mapping :publication_date, type => :date
 end
 ```
 
-When you first create or modify mappings on an ElasticMapper model, you should run:
+When you create or modify mappings on an ElasticMapper model, you should run:
 
 ```ruby
 Article.put_mapping
 ```
 
-ToDo
-----
+Indexing a Document
+-------------------
+
+When you create or update a document using the ElasticMapper mixin, simply call `index`.
+
+```ruby
+article = Article.create(title: "Hello World", doi: "doi://12354.com")
+article.index
+```
+
+Or, even easier, use the ActiveRecord `:after_save` hook:
+
+```ruby
+class Article < ActiveRecord::Base
+
+  include ElasticMapper
+
+  validates_uniqueness_of :doi
+  validates_presence_of :doi, :title
+
+  after_save :index
+
+  mapping :title, :doi, :index => :not_analyzed
+  mapping :title, :abstract
+  mapping :publication_date, :type => :date
+end
+```
+
+Searching
+---------
+
+ElasticMapper adds the `search` method to your ActiveModel classes. Results will be returned as instances of your ActiveModel class.
 
-* Put more tests around search.
-* Test the library out.
+*String Queries*
+
+You can provide a string query to your model, and it will be parsed using the ElasticSearch query DSL:
+
+```ruby
+articles = Article.search('hello AND world')
+```
+
+*Hash Queries*
+
+You can also provide a hash object, for advanced searches.
+
+```ruby
+articles = Article.search({ "query_string" => { "query" => 'alpha' } })
+```
+
+*Pagination*
+
+* `:size` how many search results should be returned?
+* `:from` what offset should we start returning results from?
+
+```ruby
+results = SearchModel.search('* OR alpha', size: 10, from: 10)
+```
+
+That's It
+---------
+
+Let me know what you think!
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'elasticmapper'
+    gem 'elastic_mapper'
 
 And then execute:
 
@@ -51,15 +121,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install elasticmapper
-
-## Usage
-
-TODO: Write usage instructions here
+    $ gem install elastic_mapper
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/elasticmapper/fork )
+1. Fork it ( http://github.com/bcoe/elasticmapper/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/elastic_mapper/search.rb

@@ -55,7 +55,11 @@ module ElasticMapper::Search
         end
       end
 
-      ordered_results(res.results.map(&:id))
+      Hashie::Mash.new({
+        documents: ordered_results(res.results.map(&:id)),
+        from: opts[:from],
+        total: res.total
+      })
     end
 
     # Create a query hash from a query string.

data/lib/elastic_mapper/version.rb

@@ -1,3 +1,3 @@
 module ElasticMapper
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/elastic_mapper/search_spec.rb

@@ -30,55 +30,57 @@ describe ElasticMapper::Search do
 
       it "returns documents matching a query string" do
         results = SearchModel.search('alpha')
-        results.count.should == 1
-        results.first.foo.should == 'alpha century'
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'
       end
 
       it "supports elasticsearch query DSL" do
         results = SearchModel.search('*')
-        results.count.should == 3
+        results.documents.count.should == 3
       end
 
       it "handles escaping invalid search string" do
         results = SearchModel.search('AND AND mars')
-        results.count.should == 1
-        results.first.foo.should == 'alpha century'
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'
       end
     end
 
     context "search by hash" do
       it "returns documents matching the hash query" do
         results = SearchModel.search({ "query_string" => { "query" => 'alpha' } })
-        results.count.should == 1
-        results.first.foo.should == 'alpha century'        
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'        
       end
     end
 
     context "sort" do
       it "can sort in descending order" do
         results = SearchModel.search('*', sort: { :foo => :desc })
-        results.first.foo.should == 'hello world'
-        results.second.foo.should == 'cat lover'
+        results.documents.first.foo.should == 'hello world'
+        results.documents.second.foo.should == 'cat lover'
       end
 
       it "can sort in ascending order" do
         results = SearchModel.search('*', sort: { :foo => :asc })
-        results.first.foo.should == 'alpha century'
-        results.second.foo.should == 'cat lover'
+        results.documents.first.foo.should == 'alpha century'
+        results.documents.second.foo.should == 'cat lover'
       end
     end
 
     context "pagination" do
       it "allows result size to be set with size" do
         results = SearchModel.search('* OR alpha', size: 1)
-        results.count.should == 1
-        results.first.foo.should == 'alpha century'
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'
       end
 
       it "allows documents to be skipped with from" do
-        results = SearchModel.search('* OR alpha', size: 1, from: 1)
-        results.count.should == 1
-        results.first.foo.should == 'hello world'
+        results = SearchModel.search({ "query_string" => { "query" => '* OR alpha' } }, size: 1, from: 1)
+        results.total.should == 3
+        results.from.should == 1
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'hello world'
       end
     end
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: elastic_mapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Benjamin Coe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stretcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -42,70 +42,70 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: active_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -141,12 +141,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []