stretcher 1.3.0 → 1.3.1

data/lib/stretcher/index.rb

@@ -75,7 +75,7 @@ module Stretcher
     
     # Issues a search with the given query opts and body, both should be hashes
     #
-    #    res = server.index('foo').search({size: 12}, {query: {match_all: {}}})
+    #    res = server.index('foo').search(size: 12, {query: {match_all: {}}})
     #    es.class   # Stretcher::SearchResults
     #    res.total   # => 1
     #    res.facets  # => nil
@@ -115,6 +115,16 @@ module Stretcher
       @server.msearch req_body
     end
 
+    # Implements the Analyze API
+    # EX: 
+    #    index.analyze("Candles", analyzer: :snowball)
+    #    # => #<Hashie::Mash tokens=[#<Hashie::Mash end_offset=7 position=1 start_offset=0 token="candl" type="<ALPHANUM>">]>
+    def analyze(text, analysis_params)
+      @server.request(:get, path_uri("/_analyze"), analysis_params) do |req|
+        req.body = text
+      end
+    end
+
     # Full path to this index
     def path_uri(path="/")
       @server.path_uri("/#{name}") + path.to_s

data/lib/stretcher/index_type.rb

@@ -71,6 +71,7 @@ module Stretcher
     end
 
     # Issues an Index#search scoped to this type
+    # See Index#search for more details
     def search(generic_opts={}, body=nil)
       @index.search(generic_opts.merge(type: name), body)
     end

data/lib/stretcher/server.rb

@@ -108,12 +108,23 @@ module Stretcher
         req.body = body
       }
     end
+    
+    # Implements the Analyze API
+    # EX: 
+    #    server.analyze("Candles", analyzer: :snowball)
+    #    # => #<Hashie::Mash tokens=[#<Hashie::Mash end_offset=7 position=1 start_offset=0 token="candl" type="<ALPHANUM>">]>
+    # as per: http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze.html
+    def analyze(text, analysis_params)
+      request(:get, path_uri("/_analyze"), analysis_params) do |req|
+        req.body = text
+      end
+    end
 
     # Full path to the server root dir
     def path_uri(path="/")
       @uri.to_s + path.to_s
     end
-    
+
     # Handy way to query the server, returning *only* the body
     # Will raise an exception when the status is not in the 2xx range
     def request(method, *args, &block)

data/lib/stretcher/version.rb

@@ -1,3 +1,3 @@
 module Stretcher
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/spec/lib/stretcher_index_spec.rb

@@ -77,6 +77,11 @@ describe Stretcher::Index do
     res[0].class.should == Stretcher::SearchResults
   end
 
+  it "execute the analysis API and return an expected result" do
+    analyzed = index.analyze("Candles", analyzer: :snowball)
+    analyzed.tokens.first.token.should == 'candl'
+  end
+
   it "should raise an exception when msearching a non-existant index" do
     lambda {
       res = server.index(:does_not_exist).msearch([{query: {match_all: {}}}])

data/spec/lib/stretcher_server_spec.rb

@@ -42,4 +42,9 @@ describe Stretcher::Server do
     res.should == :retval
     exposed.class.should == Stretcher::Index
   end
+
+  it "execute the analysis API and return an expected result" do
+    analyzed = server.analyze("Candles", analyzer: :snowball)
+    analyzed.tokens.first.token.should == 'candl'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stretcher
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday