stretcher 1.15.0 → 1.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40ad9ca446b66da2b1558340d83accb106dd80bc
+  data.tar.gz: bc711b243bd448dbe5cb7079ad32353ef1244378
+SHA512:
+  metadata.gz: 41acaea45c9f4ec37fcd736c4ba7dab2929ffcb39b06a4134c7db3a84b843e923c529113b08f29d5b98142a1d9e013a8c23238498cd3d6d7e5074702a8c071ae
+  data.tar.gz: f00e4c5f5beaa2645680fdeff3182c4fd3b708981c15647ef2096ddad2a3ae84ea5ef959d0ccf3de8317e514806a756e5fc0dc5cc085098a09d3767f2d4e41a2

data/README.md

@@ -14,6 +14,7 @@ A concise, fast ElasticSearch client designed to reflect the actual elastic sear
 * Supports efficient bulk indexing operations
 * Returns most responses in convenient Hashie::Mash form
 * Configurable logging
+* Logs curl commandline statements in debug mode
 * Pure, threadsafe, ruby
 * Easily swap HTTP clients via Faraday
 * Tested against Ruby 2.0,1.9,1.8.7, Jruby, and Rubinius
@@ -86,6 +87,20 @@ server.index(:foo).bulk_index(docs)
 
 This README documents only part of stretcher's API. The full documentation for stretcher is available in its [full rdocs](http://rdoc.info/github/PoseBiz/stretcher/master/frames).
 
+### Logging
+
+Pass in the the `:log_level` parameter to set logging verbosity. cURL statements are surfaced at the `:debug` log level. For instance:
+
+```ruby
+Stretcher::Server.new('http://localhost:9200', :log_level => :debug)
+```
+
+You can also pass any Logger style object with the `:logger` option. For instance:
+
+```ruby
+Stretcher::Server.new('http://localhost:9200', :logger => Rails.logger)
+```
+
 ### Rails Integration
 
 Stretcher is a low level-client, but it was built as a part of a full suite of Rails integration tools.

data/lib/stretcher/index.rb

@@ -43,7 +43,7 @@ module Stretcher
       
       body = documents.reduce("") {|post_data, d_raw|
         d = Hashie::Mash.new(d_raw)
-        index_meta = { :_index => name, :_id => (d.delete(:id) || d.delete(:_id)) }
+        index_meta = { :_index => name, :_id => (d[:id] || d.delete(:_id)) }
 
         system_fields = %w{_type _parent _routing}
         d.keys.reduce(index_meta) do |memo, key|
@@ -67,6 +67,13 @@ module Stretcher
       request :delete
     end
 
+    # Takes a collection of hashes of the form {:_type => 'foo', :_id => 123}
+    # And issues an mget for them within the current index
+    def mget(meta_docs)
+      merge_data = {:_index => name}
+      @server.mget(meta_docs.map {|d| d.merge(merge_data) })
+    end
+
     # Retrieves stats for this index
     def stats
       request :get, "_stats"

data/lib/stretcher/index_type.rb

@@ -36,6 +36,10 @@ module Stretcher
       request(:get, '_mget', options, :ids => ids)
     end
 
+    def mget_existing(ids,options={})
+      mget(ids, options)
+    end
+
     # Explains a query for a specific document
     def explain(id, query, options={})
       request(:get, "#{id}/_explain", options, query)

data/lib/stretcher/server.rb

@@ -38,12 +38,16 @@ module Stretcher
     # Builds a logger when initializing an instance
     def self.build_logger(options)
       logger = options[:logger] || Logger.new(STDOUT)
-      log_level = options[:log_level] || :debug
-      logger.level = Logger.const_get(log_level.to_s.upcase)
 
-      logger.formatter = proc do |severity, datetime, progname, msg|
-        "[Stretcher][#{severity}]: #{msg}\n"
+      # We don't want to override the formatter if an external logger is used
+      if !options[:logger]
+        log_level = options[:log_level] || :warn
+        logger.level = Logger.const_get(log_level.to_s.upcase)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          "[Stretcher][#{severity}]: #{msg}\n"
+        end
       end
+      
       logger
     end
 
@@ -134,11 +138,28 @@ module Stretcher
     end
 
     # Retrieves multiple documents, possibly from multiple indexes
+    # Takes an array of docs, returns an array of docs
     # as per: http://www.elasticsearch.org/guide/reference/api/multi-get.html
-    def mget(body={})
-      request(:get, path_uri("/_mget")) {|req|
-        req.body = body
-      }
+    # If you pass :exists => true as the second argument it will not return stubs
+    # for missing documents. :exists => false works in reverse
+    def mget(docs=[], arg_opts={})
+      #Legacy API
+      return legacy_mget(docs) if docs.is_a?(Hash)
+      
+      opts = {:exists => true}.merge(arg_opts)
+      
+      res = request(:get, path_uri("/_mget"), {}, {:docs => docs})[:docs]
+      if opts.has_key?(:exists)
+        match = opts[:exists]
+        res.select {|d| d[:exists] == match}
+      else
+        res
+      end
+    end
+    
+    # legacy implementation of mget for backwards compat
+    def legacy_mget(body)
+      request(:get, path_uri("/_mget"), {}, body)
     end
 
     # Implements the Analyze API

data/lib/stretcher/version.rb

@@ -1,3 +1,3 @@
 module Stretcher
-  VERSION = "1.15.0"
+  VERSION = "1.16.0"
 end

data/spec/lib/stretcher_index_spec.rb

@@ -27,7 +27,10 @@ describe Stretcher::Index do
     [
      {:text => "Foo", :_text => '_Foo', "_type" => 'tweet', "_id" => 'fooid'},
      {:text => "Bar", :_text => '_Bar', "_type" => 'tweet', "_id" => 'barid'},
-     {:text => "Baz", :_text => '_Baz', "_type" => 'tweet', "id" => 'bazid'} # Note we support both _id and id
+     {:text => "Baz", :_text => '_Baz', "_type" => 'tweet', "id" => 'bazid'}, # Note we support both _id and id
+     {:username => "john", :age => 25, "_type" => 'user', "_id" => 'fooid'},
+     {:username => "jacob", :age => 32, "_type" => 'user', "_id" => 'barid'},
+     {:username => "jingleheimer", :age => 54, "_type" => 'user', "id" => 'bazid'} # Note we support both _id and id
     ]
   }
 
@@ -36,8 +39,15 @@ describe Stretcher::Index do
     index.type(:tweet).put_mapping(mdata)
   end
 
+  def create_user_mapping
+    mdata = {:user => {:properties => {:username => {:type => :string}, 
+                                       :age => {:type => :integer}}}}
+    index.type(:user).put_mapping(mdata)
+  end
+
   def seed_corpus
     create_tweet_mapping
+    create_user_mapping
     index.bulk_index(corpus)
     index.refresh
   end
@@ -48,7 +58,7 @@ describe Stretcher::Index do
     options = { :mappings => { :movie => { :properties => { :category => { :type => 'string' } } } } }
 
     server.logger.should_receive(:debug) do |&block|
-      block.call.should == %{curl -XPUT http://localhost:9200/foo -d '#{options.to_json}' '-H Accept: application/json' '-H Content-Type: application/json' '-H User-Agent: Stretcher Ruby Gem 1.14.0'}
+      block.call.should == %{curl -XPUT http://localhost:9200/foo -d '#{options.to_json}' '-H Accept: application/json' '-H Content-Type: application/json' '-H User-Agent: Stretcher Ruby Gem #{Stretcher::VERSION}'}
     end
 
     index.create(options)
@@ -71,6 +81,17 @@ describe Stretcher::Index do
     exposed.class.should == Stretcher::IndexType
   end
 
+  it "should return docs across types when issuing an mget" do
+    seed_corpus
+    tweet = corpus.select {|d| d['_type'] == 'tweet' }.first
+    user =  corpus.select {|d| d['_type'] == 'user' }.first
+    res = index.mget([{:_type => 'tweet', :_id => (tweet["_id"] || tweet['id'])},
+                      {:_type => 'user', :_id => (user["_id"] || user['id']) }])
+    res.length.should == 2
+    equalizer = lambda {|r| [r['_type'], r['_id']] }
+    res.map {|d| equalizer.call(d)}.sort.should == [tweet,user].map {|d| equalizer.call(d)}.sort
+  end
+
   it "should return stats without error" do
     index.stats['_all'].should_not be_nil
   end
@@ -102,13 +123,14 @@ describe Stretcher::Index do
 
     it "should bulk delete documents" do
       seed_corpus
-      index.bulk_delete([
-                         {"_type" => 'tweet', "_id" => 'fooid'},
-                         {"_type" => 'tweet', "_id" => 'barid'},
-                        ])
+      docs_meta = [
+                   {"_type" => 'tweet', "_id" => 'fooid'},
+                   {"_type" => 'tweet', "_id" => 'barid'},
+                  ]
+      index.mget(docs_meta).length.should == 2
+      index.bulk_delete(docs_meta)
       index.refresh
-      res = index.search({}, {:query => {:match_all => {}}})
-      expect(res.results.map(&:_id)).to match_array ['bazid']
+      res = index.mget(docs_meta).length.should == 0
     end
   end
 

data/stretcher.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency('faraday', '~> 0.8')
   gem.add_dependency('faraday_middleware', '~> 0.9.0')
   gem.add_dependency('excon', '>= 0.16')
-  gem.add_dependency('hashie', '~> 1.2.0')
+  gem.add_dependency('hashie', '>= 1.2.0')
 
   gem.add_development_dependency 'rspec', '>= 2.5.0'
   gem.add_development_dependency 'coveralls'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: stretcher
 version: !ruby/object:Gem::Version
-  version: 1.15.0
-  prerelease: 
+  version: 1.16.0
 platform: ruby
 authors:
 - Andrew Cholakian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,113 +41,99 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: The elegant ElasticSearch client
@@ -187,27 +168,26 @@ files:
 - stretcher.gemspec
 homepage: https://github.com/PoseBiz/stretcher
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The elegant ElasticSearch client, supporting persistent connections, and
   a clean DSL
 test_files: