stretcher 1.3.3 → 1.4.0

data/README.md

@@ -91,6 +91,13 @@ The test suite is not to be trusted, don't count on your indexes staying around!
 
 Specs may be run with `rake spec`
 
+## Contributors
+
+* @andrewvc
+* @psynix
+* @fmardini
+* @chatgris
+
 ## Contributing
 
 1. Fork it

data/lib/stretcher/es_component.rb

@@ -2,23 +2,36 @@ module Stretcher
   # Elasticsearch has symmetry across API endpoints for Server, Index, and Type, lets try and provide some common ground
   class EsComponent
 
+    # Many of the methods marked protected are called by one line shims in subclasses. This is mostly to facilitate
+    # better looking rdocs
+    
     private
     
     def do_search(generic_opts={}, explicit_body=nil)
-      uri_str = '/_search'
+      query_opts = {}
       body = nil
       if explicit_body
-        uri_str << '?' + Util.querify(generic_opts)
+        query_opts = generic_opts
         body = explicit_body
       else
         body = generic_opts
       end
 
-      logger.info { "Stretcher Search: curl -XGET '#{uri_str}' -d '#{body.to_json}'" }
-      response = @server.request(:get, path_uri(uri_str)) do |req|
+      logger.info { "Stretcher Search: curl -XGET '#{Util.qurl(path_uri('_search'), query_opts)}' -d '#{body.to_json}'" }
+      response = request(:get, "_search", query_opts) do |req|
         req.body = body
       end
       SearchResults.new(:raw => response)      
     end
+
+    def do_refresh
+      request(:post, "_refresh")
+    end
+
+    def request(method, path=nil, query_opts=nil, *args, &block)
+      prefixed_path = path_uri(path)
+      raise "Cannot issue request, no server specified!" unless @server
+      @server.request(method, prefixed_path, query_opts, *args, &block)
+    end
   end
 end

data/lib/stretcher/index.rb

@@ -38,39 +38,44 @@ module Stretcher
 
     # Creates the index, with the supplied hash as the optinos body (usually mappings: and settings:))
     def create(options={})
-      @server.request(:put, path_uri) do |req|
+      request(:put) do |req|
         req.body = options
       end
     end
 
     # Deletes the index
     def delete
-      @server.request :delete, path_uri
+      request :delete
     end
 
     # Retrieves stats for this index
     def stats
-      @server.request :get, path_uri("/_stats")
+      request :get, "_stats"
     end
 
     # Retrieves status for this index
     def status
-      @server.request :get, path_uri("/_status")
+      request :get, "_status"
     end
 
     # Retrieve the mapping for this index
     def get_mapping
-      @server.request :get, path_uri("/_mapping")
+      request :get, "_mapping"
     end
 
     # Retrieve settings for this index
     def get_settings
-      @server.request :get, path_uri("/_settings")
+      request :get, "_settings"
     end
 
     # Check if the index has been created on the remote server
     def exists?
-      @server.http.head(path_uri).status != 404
+      # Unless the exception is hit we know its a 2xx response
+      request(:head)
+      true
+    rescue Stretcher::RequestError => e
+      raise e if e.http_response.status != 404
+      false
     end
 
     # Issues a search with the given query opts and body, both should be hashes
@@ -108,14 +113,20 @@ module Stretcher
     #    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|
+      request(:get, "_analyze", analysis_params) do |req|
         req.body = text
       end
     end
+    
+    # Perform a refresh making all items in this index available instantly
+    def refresh
+      do_refresh
+    end
 
     # Full path to this index
     def path_uri(path="/")
-      @server.path_uri("/#{name}") + path.to_s
+      p = @server.path_uri("/#{name}")
+      path ? p << "/#{path}" : p
     end
   end
 end

data/lib/stretcher/index_type.rb

@@ -14,13 +14,13 @@ module Stretcher
     # Retrieves the document by ID
     # Normally this returns the contents of _source, however, the 'raw' flag is passed in, it will return the full response hash
     def get(id, raw=false)
-      res = server.request(:get, path_uri("/#{id}"))
+      res = request(:get, id)
       raw ? res : res["_source"]
     end
 
     # Index an item with a specific ID
     def put(id, source)
-      server.request(:put, path_uri("/#{id}"), source)
+      request(:put, id, source)
     end
 
     # Uses the update api to modify a document with a script
@@ -28,38 +28,32 @@ module Stretcher
     # type.update(987, script: "ctx._source.message = 'Updated!'")
     # See http://www.elasticsearch.org/guide/reference/api/update.html
     def update(id, body)
-      server.request(:post, path_uri("/#{id}/_update"), body)
+      request(:post, "#{id}/_update", body)
     end
 
     # Deletes the document with the given ID
     def delete(id)
-      res = server.http.delete path_uri("/#{id}")
-
-      # Since 404s are just not a problem here, let's simply return false
-      if res.status == 404
-        false
-      elsif res.status >= 200 && res.status <= 299
-        res.body
-      else
-        raise RequestError.new(res), "Error processing delete request! Status: #{res.status}\n Body: #{res.body}"
-      end
+      request :delete, id
+    rescue Stretcher::RequestError => e
+      raise e if e.http_response.status != 404
+      false
     end
 
     # Retrieve the mapping for this type
     def get_mapping
-      @server.request :get, path_uri("/_mapping")
+      request :get, "_mapping"
     end
 
     # Delete the mapping for this type. Note this will delete
     # All documents of this type as well
     # http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping.html
     def delete_mapping
-      @server.request :delete, path_uri("/_mapping")
+      request :delete, "_mapping"
     end
 
     # Alter the mapping for this type
     def put_mapping(body)
-      @server.request(:put, path_uri("/_mapping")) {|req|
+      request(:put, "_mapping") {|req|
         req.body = body
       }
     end
@@ -67,7 +61,11 @@ module Stretcher
     # Check if this index type is defined, if passed an id
     # this will check if the given document exists
     def exists?(id=nil)
-      server.http.head(path_uri("/#{id}")).status != 404
+      request :head, id
+      true
+    rescue Stretcher::RequestError => e
+      raise e if e.http_response.status != 404
+      false
     end
 
     # Issues an Index#search scoped to this type
@@ -78,8 +76,9 @@ module Stretcher
     end
 
     # Full path to this index type
-    def path_uri(path="/")
-      index.path_uri("/#{name}") + path.to_s
+    def path_uri(path=nil)
+      p = index.path_uri(name)
+      path ? p << "/#{path}" : p
     end
   end
 end

data/lib/stretcher/server.rb

@@ -119,24 +119,29 @@ module Stretcher
         req.body = text
       end
     end
+    
+    # Perform a refresh, making all indexed documents available
+    def refresh
+      do_refresh
+    end
 
     # Full path to the server root dir
-    def path_uri(path="/")
+    def path_uri(path=nil)
       @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)
-      logger.info { "Stretcher: Issuing Request #{method.to_s.upcase}, #{args}" }
+    def request(method, url=nil, query_opts=nil, *args, &block)
+      logger.info { "Stretcher: Issuing Request #{method.to_s.upcase}, #{Util.qurl(url,query_opts)}" }
       res = if block
-              http.send(method, *args) do |req|
+              http.send(method, url, query_opts, *args) do |req|
                 # Elastic search does mostly deal with JSON
                 req.headers["Content-Type"] = 'application/json'
                 block.call(req)
               end
             else
-              http.send(method, *args)
+              http.send(method, url, query_opts, *args)
             end
 
       if res.status >= 200 && res.status <= 299

data/lib/stretcher/util.rb

@@ -1,5 +1,9 @@
 module Stretcher
   module Util
+    def self.qurl(url, query_opts=nil)
+      query_opts && !query_opts.empty? ? "#{url}?#{querify(query_opts)}" : url
+    end
+    
     def self.querify(hash)
       hash.map {|k,v| "#{k}=#{v}"}.join('&')
     end

data/lib/stretcher/version.rb

@@ -1,3 +1,3 @@
 module Stretcher
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end

data/spec/lib/stretcher_index_spec.rb

@@ -15,7 +15,7 @@ describe Stretcher::Index do
 
   def create_tweet_mapping
     mdata = {:tweet => {:properties => {:text => {:type => :string}}}}
-    index.type('tweet').put_mapping(mdata)
+    index.type(:tweet).put_mapping(mdata)
   end
 
   def seed_corpus
@@ -66,7 +66,7 @@ describe Stretcher::Index do
   it "should search without error" do
     seed_corpus
     match_text = corpus.first[:text]
-    sleep 1 # ES needs time to update!
+    index.refresh
     res = index.search({}, {:query => {:match => {:text => match_text}}})
     res.results.first.text.should == match_text
   end

data/spec/lib/stretcher_index_type_spec.rb

@@ -22,7 +22,7 @@ describe Stretcher::Index do
     it "should search and find the right doc" do
       match_text = 'hello'
       type.put(123123, @doc)
-      sleep 1
+      index.refresh
       res = type.search({}, {:query => {:match => {:message => match_text}}})
       res.results.first.message.should == @doc[:message]
     end

data/spec/lib/stretcher_server_spec.rb

@@ -29,6 +29,10 @@ describe Stretcher::Server do
     server.status.ok.should be_true
   end
 
+  it "should refresh w/o error" do
+    server.refresh.ok.should be_true
+  end
+
   it "should beget an index object cleanly" do
     server.index('foo').class.should == Stretcher::Index
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stretcher
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday