elasticsearch-utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10216ce0da878da2324802434785d0c85a38574e
+  data.tar.gz: bb623a5c05cf2c77d760ef63e0ea6c5fa63980b4
+SHA512:
+  metadata.gz: bac93d302849099b9f62d4f5287c87299f09e36efa4269385ad8f0e13afdc6140ebd522539d77d43aa9b888d9db1d1789128b85a695d11ccf6594286e82848da
+  data.tar.gz: b165e2e5ed7868e418684e9cfa47e154234748b75bc980612acdb695a455c491f79aaaf9911ada175e15e4184d57f7a827f824b5c9e584c9327cef499c7f60d6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticsearch-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bob Breznak
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Elasticsearch::Utils
+
+Adds more cool methods to [`Elasticsearch::Client`](https://github.com/elasticsearch/elasticsearch-ruby) clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elasticsearch-utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elasticsearch-utils
+
+## Usage
+
+### Streaming
+
+For those times when you want to map over all results of a search, perhaps in a background job, that may be very large and not worry about paging. This method leverages the [`scroll`](http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html) feature of ElasticSearch to maximize server-side efficiency.
+
+In this example, we run a search for all Bobs in the index and output their last name. There are a ton of bobs in Bobland so the deep paging would normally tax the server, so we opt to stream.
+
+```
+client = Elasticsearch::Client.new my_elasticsearch_config
+
+search_body = {
+  query: {
+    match: {
+      name_first: 'bob'
+    }
+  }
+}
+
+search_params = index: :bobland, type: :person, body: search_body
+
+client.stream search_params do |doc|
+  puts doc['name_last']
+end
+```
+
+You can pass a `memo` variable to the block to track state in subsequent results. Stream will return the resulting memo.
+
+```
+bob_families = SortedSet.new
+bob_families = client.stream search_params do |doc, bob_families|
+  bob_families << doc['name_last']
+end
+
+puts "There are #{bob_families.count} families of bobs!"
+```
+
+To stop streaming, throw `:stop_stream` like so:
+
+```
+memo = client.stream search_params do |doc, memo|
+  # If you are not using `memo`, you could also use `break`
+  throw :stop_stream if memo > 10000
+
+  # Use memo to count total results processed
+  memo += 1
+end
+
+puts "Streamed #{memo} bobs!"
+```
+
+If sorting is not important for your query, even greater efficiency can be achieved by setting the `search_type` to `scan` like so:
+
+```
+search_params[:search_type] = :scan
+
+client.stream search_params do |doc|
+  # handle each bob out of order
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/elasticsearch-utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/elasticsearch-utils.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'elasticsearch-utils'
+  spec.version       = Elasticsearch::Utils::VERSION
+  spec.authors       = ['Andrew Hammond', 'Bob Breznak']
+  spec.email         = ['andrew@evertrue.com', 'bob@evertrue.com']
+  spec.summary       = 'Simple utilities built ontop of Elasticsearch'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/evertrue/elasticsearch-utils'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/elasticsearch/api/actions/stream.rb

@@ -0,0 +1,38 @@
+module Elasticsearch
+  module API
+    module Actions
+      # search.stream index: 'scrollindex', scroll: '5m', body: { query: { title: 'test' } }
+      #
+      # counter = 0
+      # search.stream counter, index: 'scrollindex', scroll: '5m', body: { query: { title: 'test' } }
+
+      def stream(*args, &block)
+        raise ArgumentError.new "wrong number of arguments (#{args.count} for 1..2)" if args.count > 2
+        raise ArgumentError.new 'no block given' unless block_given?
+        
+        opts, memo = *args.reverse
+        opts[:scroll] = opts[:scroll] || opts['scroll'] || '5m'
+        
+        scroll_opts = { :scroll => opts[:scroll] }
+
+        catch :stop_stream do
+          results = search opts
+          scroll_opts[:scroll_id] = results['_scroll_id']
+          
+          results = scroll scroll_opts if opts[:search_type] =~ /scan/
+          
+          until results['hits']['hits'].empty? do
+            scroll_opts[:scroll_id] = results['_scroll_id']
+            results['hits']['hits'].each do |doc|
+              doc_source = doc['_source']
+              memo = yield doc_source, memo
+            end
+            results = scroll scroll_opts
+          end
+        end
+        
+        memo
+      end
+    end
+  end
+end

data/lib/elasticsearch/utils/version.rb

@@ -0,0 +1,5 @@
+module Elasticsearch
+  module Utils
+    VERSION = "0.0.1"
+  end
+end

data/lib/elasticsearch/utils.rb

@@ -0,0 +1,7 @@
+require 'elasticsearch/utils/version'
+require 'elasticsearch/api/actions/stream'
+
+module Elasticsearch
+  module Utils
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch-utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hammond
+- Bob Breznak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple utilities built ontop of Elasticsearch
+email:
+- andrew@evertrue.com
+- bob@evertrue.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- elasticsearch-utils.gemspec
+- lib/elasticsearch/api/actions/stream.rb
+- lib/elasticsearch/utils.rb
+- lib/elasticsearch/utils/version.rb
+homepage: https://github.com/evertrue/elasticsearch-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple utilities built ontop of Elasticsearch
+test_files: []
+has_rdoc: