elasticsearch-ruby 0.0.3 → 0.0.4

data/README.markdown

@@ -0,0 +1,49 @@
+# elasticsearch-client
+
+An elastic search ruby library with multiple transport support originall built
+for use with [SoundTracking](http://www.soundtracking.com/).
+
+> DISCLAIMER: Quite a bit more work to be done till production ready, use at your own
+> risk! :)
+
+Installation
+------------
+
+    $ gem install elasticsearch-ruby
+
+Usage
+-----
+
+```ruby
+
+transport = ElasticSearch::HTTPTransport.new(['http://localhost:9200'])
+client = ElasticSearch::Client.new(transport)
+
+index = client.create_index('twitter')
+index['tweet'].put(1, { foo: 'bar' })
+
+query = { query: { query_string: { query: 'bar' } } }
+results = index['tweet'].search
+
+results.total                         # 1
+
+results.each do |result|
+  result.score                        # 1.0
+  result['foo']                       # bar
+end
+
+client['twitter'].search(query).type  # 'tweet'
+
+```
+
+TODO:
+-----
+
+* Better configuration support
+* Failover and retry code
+* Better unicode suppoort with Thrift
+* Support for Memcache Transport
+* Query Builder and block support
+* Stats, Health lookup methods
+* Better error handling
+* Documentation

data/lib/elastic_search/client.rb

@@ -26,7 +26,7 @@ module ElasticSearch
       request = Request.new({ method: :head, index: index_name })
       begin
         execute(request).status.between?(200, 206)
-      rescue ElasticSearch::ResponseError
+      rescue ElasticSearch::NotFoundError
         return false
       end
     end

data/lib/elastic_search/request.rb

@@ -14,7 +14,7 @@ module ElasticSearch
 
     def parameters
       @stringified_parameters ||= @parameters.inject({}) do |options, (key, value)|
-        options[key.to_s] = value
+        options[key.to_s] = value.to_s
         options
       end if @parameters
     end
@@ -24,10 +24,9 @@ module ElasticSearch
     end
 
     def path
-      components = [@index, @type]
-      components << @id if @id
+      components = [@index, @type, @id]
       components << "_#{@action.to_s}" if @action
-      components.compact.join("/")
+      "/#{components.compact.join("/")}"
     end
   end
 end

data/lib/elastic_search/response.rb

@@ -14,7 +14,7 @@ module ElasticSearch
         elsif self.body['exists'].eql?(false)
           raise ElasticSearch::ItemMissingException, "_id: #{self.body['id']} NOT FOUND"
         else
-          raise ElasticSearch::ResponseError
+          raise ElasticSearch::NotFoundError
         end
       else
         raise ElasticSearch::ResponseError, "#{self.body['status']}: #{self.body['error']}"
@@ -33,6 +33,7 @@ module ElasticSearch
   end
 
   class ResponseError < StandardError; end
-  class IndexMissingException < StandardError; end
-  class ItemMissingException < StandardError; end
+  class NotFoundError < StandardError; end
+  class IndexMissingException < NotFoundError; end
+  class ItemMissingException < NotFoundError; end
 end

data/lib/elastic_search/search/results.rb

@@ -14,13 +14,14 @@ module ElasticSearch
     end
 
     class ResultItem < HashWithIndifferentAccess
-      attr_reader :index, :type, :id, :score
+      attr_reader :index, :type, :id, :score, :explanation
 
       def initialize(hit)
         @index = hit['_index']
         @type = hit['_type']
         @id = hit['_id']
         @score = hit['_score']
+        @explanation = hit ['_explanation']
         self.replace(hit['_source'])
       end
     end

data/lib/elastic_search/type.rb

@@ -47,6 +47,16 @@ module ElasticSearch
       request = build_request({ method: :get, id: id.to_s, action: :mlt, parameters: parameters, body: doc })
     end
 
+    def mapping
+      request = build_request(method: :get, action: :mapping)
+      execute(request).body
+    end
+
+    def mapping=(mapping)
+      request = build_request(method: :put, action: :mapping, body: mapping)
+      execute(request).status.eql?(200)
+    end
+
     def delete_mapping
       request = build_request({ method: :delete })
       execute(request).status.eql?(200)

data/lib/elastic_search/version.rb

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

data/spec/elasticsearch/client_spec.rb

@@ -43,10 +43,14 @@ describe ElasticSearch::Client do
       end
 
       describe :has_index? do
-        it "should know if an index exists" do
+        it "should return true if an index exists" do
           client.create_index(TEST_INDEX).refresh
           client.has_index?(TEST_INDEX).must_equal true
         end
+
+        it "should return false if an index does not exist" do
+          client.has_index?(TEST_INDEX).must_equal false
+        end
       end
 
       describe :bulk do

data/spec/elasticsearch/index_spec.rb

@@ -85,7 +85,8 @@ describe ElasticSearch::Index do
 
       describe :mapping do
         it "should return the mapping" do
-          index.mapping
+          index[:tweet].mapping = { tweet: { properties: { message: { type: 'string' } } } }
+          index.mapping[TEST_INDEX]['tweet']['properties']['message']['type'].must_equal 'string'
         end
       end
 

data/spec/elasticsearch/type_spec.rb

@@ -51,6 +51,13 @@ describe ElasticSearch::Type do
           results.total.must_equal 20
           results.count.must_equal 10
         end
+
+        it "should return an explanation if explain is passed as a parameter" do
+          type.put(1, { foo: 'bar' })
+          index.refresh
+          results = type.search(nil, q: 'bar', explain: true)
+          results.first.explanation.must_be_kind_of Hash
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thrift
-  requirement: &70153279330420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70153279330420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70153279329780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70153279329780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70153279329160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153279329160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70153279328580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153279328580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70153279328040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70153279328040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Driver for Elastic Search
 email:
 - edmund@edmundatwork.com
@@ -76,6 +101,7 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
+- README.markdown
 - Rakefile
 - elastic_search.gemspec
 - lib/elastic_search.rb
@@ -110,15 +136,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1939019870286825745
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1939019870286825745
 requirements: []
 rubyforge_project: elasticsearch
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby Driver for Elastic Search