stretcher 1.1.1 → 1.1.2

data/README.md

@@ -63,7 +63,7 @@ Stretcher::Server.with_server('http://localhost:9200') {|srv|
 server.index(:foo).msearch([{query: {match_all: {}}}])
 # => Returns an array of Stretcher::SearchResults
 # Across multiple indexes
-server.msearch([{index: 'foo'}, {query: {match_all: {}}}])
+server.msearch([{index: :foo}, {query: {match_all: {}}}])
 # => Returns an array of Stretcher::SearchResults
 ```
 

data/lib/stretcher/index.rb

@@ -15,21 +15,21 @@ module Stretcher
     # Optionally takes a block, which will be passed a single arg with the Index obj
     # The block syntax returns the evaluated value of the block
     # 
-    # Examples:
-    #
-    # my_index.index(:foo) # => #<Stretcher::Index ...>
-    #
-    # my_index.index(:foo) {|idx| 1+1} # => 2
+    #    my_index.index(:foo) # => #<Stretcher::Index ...>
+    #    my_index.index(:foo) {|idx| 1+1} # => 2
     def type(name, &block)
       t = IndexType.new(self, name)
       block ? block.call(t) : t
     end
     
     # Given a hash of documents, will bulk index
+    #
+    #    docs = [{"_type" => "tweet", "_id" => 91011, "text" => "Bulked"}]
+    #    server.index(:foo).bulk_index(docs)
     def bulk_index(documents)
       @server.bulk documents.reduce("") {|post_data, d_raw|
         d = Hashie::Mash.new(d_raw)
-        action_meta = {"index" => {"_index" => name, "_type" => d["_type"], "_id" => d["id"]}}
+        action_meta = {"index" => {"_index" => name, "_type" => d["_type"], "_id" => d["_id"] || d["id"]}}
         action_meta["index"]["_parent"] = d["_parent"] if d["_parent"]
         post_data << (action_meta.to_json + "\n")
         post_data << (d.to_json + "\n")
@@ -69,12 +69,13 @@ module Stretcher
     end
     
     # Issues a search with the given query opts and body, both should be hashes
-    # Ex: res = server.index('foo').search({size: 12}, {query: {match_all: {}}})
-    # * es.class   # Stretcher::SearchResults
-    # * res.total   # => 1
-    # * res.facets  # => nil
-    # * res.results # => [#<Hashie::Mash _id="123" text="Hello">]
-    # * res.raw     # => #<Hashie::Mash ...> Raw JSON from the search
+    #
+    #    res = server.index('foo').search({size: 12}, {query: {match_all: {}}})
+    #    es.class   # Stretcher::SearchResults
+    #    res.total   # => 1
+    #    res.facets  # => nil
+    #    res.results # => [#<Hashie::Mash _id="123" text="Hello">]
+    #    res.raw     # => #<Hashie::Mash ...> Raw JSON from the search
     def search(query_opts={}, body=nil)
       uri = path_uri('/_search?' + Util.querify(query_opts))
       logger.info { "Stretcher Search: curl -XGET #{uri} -d '#{body.to_json}'" }
@@ -88,6 +89,9 @@ module Stretcher
     # This deviates slightly from the official API in that *ONLY*
     # queries are requried, the empty {} preceding them are not
     # See: http://www.elasticsearch.org/guide/reference/api/multi-search.html
+    #
+    #    server.index(:foo).msearch([{query: {match_all: {}}}])
+    #    # => Returns an array of Stretcher::SearchResults
     def msearch(queries=[])
       raise ArgumentError, "msearch takes an array!" unless queries.is_a?(Array)
       req_body = queries.reduce([]) {|acc,q|
@@ -98,6 +102,7 @@ module Stretcher
       @server.msearch req_body
     end
 
+    # Full path to this index
     def path_uri(path="/")
       @server.path_uri("/#{name}") + path.to_s
     end

data/lib/stretcher/index_type.rb

@@ -70,6 +70,7 @@ module Stretcher
       server.http.head(path_uri("/#{id}")).status != 404
     end
 
+    # Full path to this index type
     def path_uri(path="/")
       index.path_uri("/#{name}") + path.to_s
     end

data/lib/stretcher/server.rb

@@ -11,10 +11,10 @@ module Stretcher
     end
     
     # Represents a Server context in elastic search.
-    # Use +connect+ when you want to use the block syntax.
+    # Use +with_server+ when you want to use the block syntax.
     # The options hash takes an optional instance of Logger under :logger.
     #
-    # Ex: server = Stretcher::Server.new('http://localhost:9200').
+    #    server = Stretcher::Server.new('http://localhost:9200')
     def initialize(uri='http://localhost:9200', options={})
       @uri = uri
 
@@ -46,11 +46,8 @@ module Stretcher
     # Optionally takes a block, which will be passed a single arg with the Index obj
     # The block syntax returns the evaluated value of the block
     # 
-    # Examples:
-    #
-    # my_server.index(:foo) # => #<Stretcher::Index ...>
-    #
-    # my_server.index(:foo) {|idx| 1+1} # => 2
+    #    my_server.index(:foo) # => #<Stretcher::Index ...>
+    #    my_server.index(:foo) {|idx| 1+1} # => 2
     def index(name, &block)
       idx = Index.new(self, name, logger: logger)
       block ? block.call(idx) : idx
@@ -71,10 +68,13 @@ module Stretcher
     # Takes an array of msearch data as per
     # http://www.elasticsearch.org/guide/reference/api/multi-search.html
     # Should look something like:
-    # {"index" : "test"}
-    # {"query" : {"match_all" : {}}, "from" : 0, "size" : 10}
-    # {"index" : "test", "search_type" : "count"}
-    # {"query" : {"match_all" : {}}}
+    #    data = [
+    #      {"index" : "test"}
+    #      {"query" : {"match_all" : {}}, "from" : 0, "size" : 10}
+    #      {"index" : "test", "search_type" : "count"}
+    #      {"query" : {"match_all" : {}}}
+    #    ]
+    #    server.msearch(data)
     def msearch(body=[])
       raise ArgumentError, "msearch takes an array!" unless body.is_a?(Array)
       fmt_body = body.map(&:to_json).join("\n") + "\n"
@@ -97,6 +97,7 @@ module Stretcher
       }
     end
 
+    # Full path to the server root dir
     def path_uri(path="/")
       @uri.to_s + path.to_s
     end
@@ -110,7 +111,7 @@ module Stretcher
                 # Elastic search does mostly deal with JSON
                 req.headers["Content-Type"] = 'application/json'
                 block.call(req)
-               end
+              end
             else
               http.send(method, *args)
             end

data/lib/stretcher/version.rb

@@ -1,3 +1,3 @@
 module Stretcher
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/spec/lib/stretcher_index_spec.rb

@@ -5,9 +5,9 @@ describe Stretcher::Index do
   let(:index) { server.index('foo') }
   let(:corpus) {
     [
-     {text: "Foo", "_type" => 'tweet'},
-     {text: "Bar", "_type" => 'tweet'},
-     {text: "Baz", "_type" => 'tweet'}
+     {text: "Foo", "_type" => 'tweet', "_id" => 'fooid'},
+     {text: "Bar", "_type" => 'tweet', "_id" => 'barid'},
+     {text: "Baz", "_type" => 'tweet', "id" => 'bazid'} # Note we support both _id and id
     ]
   }
 
@@ -52,6 +52,9 @@ describe Stretcher::Index do
 
   it "should bulk index documents properly" do
     seed_corpus
+    corpus.each {|doc|
+      index.type(doc["_type"]).get(doc["_id"] || doc["id"]).text.should == doc[:text]
+    }
   end
 
   # TODO: Actually use two indexes

metadata

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