es_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f915708d508475ae6a6e1554cde67e5b3d56628c
+  data.tar.gz: 5866f75f14bbfc929a99b6c634d674929f87e9b7
+SHA512:
+  metadata.gz: 9aac32dc765a3ad98e8b995f721aa6b447e3f928472f40a01817731c2238279b46142f93f51146ee1c720db483dfb2a7f870dbe91da823da07103679be37a4aa
+  data.tar.gz: 485c20eaecb405d70625968f61aa1c79d611a4974582a2ac4f56750830185e08e3c25fd23a8cc2ec4185d38b7a33e062803e417ce996db6d58713c8ad337ccb7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sent-hil
+
+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,68 @@
+# es_utils
+
+This library contains a bunch of improvements to `elasticsearch` ruby gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'es_utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install es_utils
+
+## Api
+    # this requires `elasticsearch`, so you don't have to again
+    require "es_utils"
+
+### kibana
+
+    # I find this time format `%FT%T%:z` or `2014-06-29T18:26:54-07:00`
+    # to be best for kibana. This library monkepatches `Time` to add
+    # `kibana` method.
+    Time.now.kibana
+
+### scroll_each
+
+    # `A scrolled search allows us to do an initial search and to keep
+    # pulling batches of results from Elasticsearch until there are no
+    # more results left. It’s a bit like a cursor in a traditional database.`
+    #
+    # http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html
+    #
+    # `scroll_each` abstracts away the bookkeeping logic. It takes `options` Hash
+    # and a block which is called on the results of each scroll.
+    client =  Elasticsearch::Client.new
+    options = {
+      :index       => <index_name>,    # required
+      :scroll      => "5m",            # optional
+      :size        => 10,              # optional
+      :body        => {:sort => "_id"} # optional
+    }
+
+    client.scroll_each options do |results|
+      results.each do |result|
+        # add your logic here
+        # example: puts result["_source"]
+      end
+    end
+
+### bulk_index
+
+    # `bulk_index` removes away need to pass index name and type as part
+    # of each document when doing a bulk indexing operation.
+    documents = [ {a: 1}, {a: 2}, {a: 3} ]
+    client.bulk_index(:index => "es_utils", :type => "doc", :refresh => true, :body => documents)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/es_utils.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'es_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "es_utils"
+  spec.version       = EsUtils::VERSION
+  spec.authors       = ["sent-hil"]
+  spec.email         = ["me@sent-hil.com"]
+  spec.description   = %q{Utils library for elasticsearch gem}
+  spec.summary       = %q{This library contains a bunch of improvements and additions to elasticsearch ruby gem.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "elasticsearch"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/es_utils/core_ext/time.rb

@@ -0,0 +1,12 @@
+require "time"
+
+class Time
+  # Returns time in format `2014-06-29T18:26:54-07:00`
+  def kibana
+    self.strftime("%FT%T%:z")
+  end
+
+  def logstash
+    self.strftime("%Y.%m.%d")
+  end
+end

data/lib/es_utils/ext/elasticsearch/bulk_index.rb

@@ -0,0 +1,19 @@
+module Elasticsearch
+  module API
+    module Actions
+      [:index, :update, :delete].each do |action|
+        define_method "bulk_#{action}" do |params={}|
+          body = params[:body].map do |raw|
+            {action => {
+                :_index => params[:index],
+                :_type  => params[:type],
+                :data   => raw
+            }}
+          end
+
+          bulk(params.merge(:body => body))
+        end
+      end
+    end
+  end
+end

data/lib/es_utils/ext/elasticsearch/scroll.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module API
+    module Actions
+      def scroll_each(arguments={}, &blk)
+        valid_params = [
+          :index, :scroll, :size, :body
+        ]
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
+
+        params[:body]   ||= {}
+        params[:scroll] ||= "5m"
+        params[:size]   ||= 100
+
+        s = search({
+          index:       params[:index],
+          scroll:      params[:scroll],
+          size:        params[:size],
+          body:        {sort: '_id'}.merge(params[:body]),
+          search_type: "scan",
+        })
+
+        loop do
+          s = scroll(:scroll_id => s["_scroll_id"], :scroll => params[:scroll])
+          results = s["hits"]["hits"]
+
+          break  if results.empty?
+
+          blk.call(results)
+        end
+      end
+    end
+  end
+end

data/lib/es_utils/version.rb

@@ -0,0 +1,3 @@
+module EsUtils
+  VERSION = "0.0.1"
+end

data/lib/es_utils.rb

@@ -0,0 +1,9 @@
+require "elasticsearch"
+
+require_relative "./es_utils/version"
+require_relative "./es_utils/core_ext/time"
+require_relative "./es_utils/ext/elasticsearch/scroll"
+require_relative "./es_utils/ext/elasticsearch/bulk_index"
+
+module EsUtils
+end

data/spec/es_utils/core_ext/time_spec.rb

@@ -0,0 +1,7 @@
+require_relative "../../spec_helper"
+
+describe "Time#kibana" do
+  it "monkey patches `Time` to add `kibana` method" do
+    expect(Time.parse("2014.06.29").kibana).to eq("2014-06-29T00:00:00-07:00")
+  end
+end

data/spec/es_utils/ext/elasticsearch/bulk_index_spec.rb

@@ -0,0 +1,22 @@
+require_relative "../../../spec_helper"
+
+describe "Elasticsearach#bulk_index" do
+  after { client.indices.delete(:index => index_name) }
+
+  it "monkey patches `Elasticsearach` to add `bulk_index`" do
+    documents = [
+      {a: 1}, {a: 2}, {a: 3}
+    ]
+    client.bulk_index(:index => index_name, :type => "doc", :refresh => true, :body => documents)
+
+    raw = client.search(:index => index_name, :type => "doc")
+    result = raw["hits"]["hits"]
+
+    index  = result.map {|x| x["_index"]}.uniq[0]
+    type   = result.map {|x| x["_type"]}.uniq[0]
+
+    expect(index).to eq(index_name)
+    expect(type).to eq("doc")
+    expect(result.count).to eq(3)
+  end
+end

data/spec/es_utils/ext/elasticsearch/scroll_spec.rb

@@ -0,0 +1,36 @@
+require_relative "../../../spec_helper"
+
+describe "Elasticsearach#scroll" do
+  after { client.indices.delete(:index => index_name) }
+
+  it "monkey patches `Elasticsearach` to add `scroll` method" do
+    events = []
+    (1..100).to_a.each do |i|
+      events << {:index => {
+        :_index => "es_utils",
+        :_type  => "document",
+        :data   => {
+          :number => i
+        }
+      }}
+    end
+
+    client.bulk(:body => events, :refresh => true)
+
+    options = {
+      :index       => index_name,
+      :scroll      => "5m",
+      :size        => 10,
+      :body        => {:sort => "_id"}
+    }
+
+    output = []
+    client.scroll_each options do |results|
+      results.each do |result|
+        output << result["_source"]["number"]
+      end
+    end
+
+    expect((1..100).to_a).to eq(output.sort)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require_relative "../lib/es_utils"
+
+def client
+  @client ||= Elasticsearch::Client.new
+end
+
+def index_name
+  "es_utils"
+end
+
+require "pry"

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: es_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sent-hil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utils library for elasticsearch gem
+email:
+- me@sent-hil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- es_utils.gemspec
+- lib/es_utils.rb
+- lib/es_utils/core_ext/time.rb
+- lib/es_utils/ext/elasticsearch/bulk_index.rb
+- lib/es_utils/ext/elasticsearch/scroll.rb
+- lib/es_utils/version.rb
+- spec/es_utils/core_ext/time_spec.rb
+- spec/es_utils/ext/elasticsearch/bulk_index_spec.rb
+- spec/es_utils/ext/elasticsearch/scroll_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: This library contains a bunch of improvements and additions to elasticsearch
+  ruby gem.
+test_files:
+- spec/es_utils/core_ext/time_spec.rb
+- spec/es_utils/ext/elasticsearch/bulk_index_spec.rb
+- spec/es_utils/ext/elasticsearch/scroll_spec.rb
+- spec/spec_helper.rb