stretcher 1.0.0 → 1.1.0

data/README.md

@@ -43,10 +43,27 @@ res.results # => [#<Hashie::Mash _id="123" text="Hello">]
 res.raw     # => #<Hashie::Mash ...> Raw JSON from the search
 ```
 
+### Block Syntax
+
+```ruby
+# A nested block syntax is also supported.
+# with_server takes the same args as #new, but is amenable to blocks
+Stretcher::Server.with_server('http://localhost:9200') {|srv|
+  srv.index(:foo) {|idx|
+    idx.type(:bar) {|t| [t.exists?, t.get_mapping] }
+  } 
+}
+# => [true, #<Hashie::Mash bar=...>]
+```
+
 ### Multi Search
     
 ```ruby
-server.index('foo').msearch([{query: {match_all: {}}}])
+# Within a single index
+server.index(:foo).msearch([{query: {match_all: {}}}])
+# => Returns an array of Stretcher::SearchResults
+# Across multiple indexes
+server.msearch([{index: 'foo'}, {query: {match_all: {}}}])
 # => Returns an array of Stretcher::SearchResults
 ```
 

data/lib/stretcher/index.rb

@@ -11,8 +11,18 @@ module Stretcher
       @logger = options[:logger] || server.logger
     end
 
-    def type(name)
-      IndexType.new(self, name)
+    # Returns a Stretcher::IndexType object for the type +name+.
+    # 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
+    def type(name, &block)
+      t = IndexType.new(self, name)
+      block ? block.call(t) : t
     end
     
     # Given a hash of documents, will bulk index

data/lib/stretcher/server.rb

@@ -1,12 +1,21 @@
 module Stretcher
   class Server
     attr_reader :uri, :http, :logger
+
+    # Instantiate a new instance in a manner convenient for using the block syntax.
+    # Can be used interchangably with +Stretcher::Server.new+ but will return the value
+    # of the block if present. See the regular constructor for full options.
+    def self.with_server(*args)
+      s = self.new(*args)
+      yield s
+    end
     
     # Represents a Server context in elastic search.
+    # Use +connect+ 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').
-    def initialize(uri, options={})
+    def initialize(uri='http://localhost:9200', options={})
       @uri = uri
 
       @http = Faraday.new(:url => @uri) do |builder|        
@@ -33,8 +42,18 @@ module Stretcher
       end
     end
 
-    def index(name)
-      Index.new(self, name, logger: logger)
+    # Returns a Stretcher::Index object for the index +name+.
+    # 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
+    def index(name, &block)
+      idx = Index.new(self, name, logger: logger)
+      block ? block.call(idx) : idx
     end
 
     def bulk(data)

data/lib/stretcher/version.rb

@@ -1,3 +1,3 @@
 module Stretcher
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/lib/stretcher_index_spec.rb

@@ -28,6 +28,16 @@ describe Stretcher::Index do
     index.exists?.should be_true
   end
 
+  it "should support block syntax for types" do
+    exposed = nil
+    res = index.type(:foo) {|t|
+      exposed = t
+      :retval
+    }
+    res.should == :retval
+    exposed.class.should == Stretcher::IndexType
+  end
+
   it "should return stats without error" do
     index.stats['_all'].should_not be_nil
   end

data/spec/lib/stretcher_server_spec.rb

@@ -7,6 +7,16 @@ describe Stretcher::Server do
     server.class.should == Stretcher::Server
   end
 
+  it "should support the block friendly 'with_server'" do
+    exposed = nil
+    res = Stretcher::Server.with_server() {|s|
+      exposed = s
+      :retval
+    }
+    res.should == :retval
+    exposed.class.should == Stretcher::Server
+  end
+
   it "should properly return that our server is up" do
     server.up?.should be_true
   end
@@ -14,4 +24,14 @@ describe Stretcher::Server do
   it "should beget an index object cleanly" do
     server.index('foo').class.should == Stretcher::Index
   end
+
+  it "should support block syntax for indexes" do
+    exposed = nil
+    res = server.index(:foo) {|i|
+      exposed = i
+      :retval
+    }
+    res.should == :retval
+    exposed.class.should == Stretcher::Index
+  end
 end

metadata

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