estool 0.0.6.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 734b762b75084c2f6aabe764e0366c823ab12c30
+  data.tar.gz: 9d0b92d3c3fcf0c001241240f4d76e0d21fc1692
+SHA512:
+  metadata.gz: 955f2a559a3ce1d249f16b702642ec228522ecfbab4c4bf279c60b17b80fe1e52817dd0fa667fb4b1ebb07e66671a4eff780c41c05108452e0c32d1162ead312
+  data.tar.gz: 9610236bc16ad7038df4dec8341efd458e3d7e5113a2a4811eaa5d15cc14b3b519a700cfe3722de11163e69162b4fa857c838ca89106e2aa1f4da7ff521685ac

data/LICENSE

@@ -0,0 +1,17 @@
+   ESTool - Elasticsearch CLI Tool
+
+   Copyright (C) 2016 David Hollinger
+
+   Contact at david.hollinger@moduletux.com
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,18 @@
+ESTool - Elasticsearch Commandline Tool
+=======================================
+
+EStool is a command-line tool for interacting with the Elasticsearch search and analytics engine. 
+
+Documentation
+-------------
+
+Tool is still in development. Only portions of Elasticsearch's [Cat API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html) have been implemented so far.
+
+License
+-------
+
+See [LICENSE](LICENSE) file.
+
+Maintainers
+-----------
+* David Hollinger, david.hollinger@moduletux.com, github:dhollinger

data/bin/estool

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'estool'
+
+# Placeholder
+Estool::Cli.start(ARGV)

data/lib/estool/actions/cat.rb

@@ -0,0 +1,20 @@
+require 'elasticsearch-api'
+require 'estool/connections'
+
+module Estool::Actions
+  class Cat
+    def self.run(action, data, options)
+      client = Estool::Connections.start_conn(options[:host], options[:port])
+      Estool::Connections.test_conn(client)
+      begin
+        puts client.cat.send(action, data)
+      rescue ArgumentError => args
+        puts "
+             #{args}
+        Usage: 'estool cat help #{action}' for more information
+        "
+        exit 1
+      end
+    end
+  end
+end

data/lib/estool/cat/aliases.rb

@@ -0,0 +1,27 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Aliases
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @timeout = options[:timeout]
+      @name = options[:name]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output,
+          master_timeout: @timeout,
+          name: @name
+      }
+      Estool::Actions::Cat.run(:aliases, data, @server)
+    end
+  end
+end

data/lib/estool/cat/allocation.rb

@@ -0,0 +1,27 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Allocation
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @node = options[:node]
+      @bytes = options[:bytes]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          node_id: @node,
+          bytes: @bytes,
+          format: @output
+      }
+      Estool::Actions::Cat.run(:allocation, data, @server)
+    end
+  end
+end

data/lib/estool/cat/count.rb

@@ -0,0 +1,27 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Count
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @timeout = options[:timeout]
+      @index = options[:index]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output,
+          master_timeout: @timeout,
+          index: @index
+      }
+      Estool::Actions::Cat.run(:count, data, @server)
+    end
+  end
+end

data/lib/estool/cat/fielddata.rb

@@ -0,0 +1,27 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Fielddata
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @timeout = options[:timeout]
+      @bytes = options[:bytes]
+      @fields = options[:fields]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          master_timeout: @timeout,
+          bytes: @bytes
+      }
+      data[:fields] = @fields unless @fields.nil?
+      Estool::Actions::Cat.run(:fielddata, data, @server)
+    end
+  end
+end

data/lib/estool/cat/health.rb

@@ -0,0 +1,25 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Health
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @timeout = options[:timeout]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output,
+          master_timeout: @timeout
+      }
+      Estool::Actions::Cat.run(:health, data, @server)
+    end
+  end
+end

data/lib/estool/cat/indices.rb

@@ -0,0 +1,29 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Indices
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @bytes = options[:bytes]
+      @primary = options[:primary]
+      @output = options[:output]
+      @index = options[:index]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          bytes: @bytes,
+          pri: @primary,
+          format: @output
+      }
+      data[:index] = @index unless @index.nil?
+      Estool::Actions::Cat.run(:indices, data, @server)
+    end
+  end
+end

data/lib/estool/cat/master.rb

@@ -0,0 +1,24 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Master
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output
+      }
+      Estool::Actions::Cat.run(:master, data, @server)
+    end
+
+  end
+end

data/lib/estool/cat/nodeattrs.rb

@@ -0,0 +1,24 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Nodeattrs
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output
+      }
+      Estool::Actions::Cat.run(:nodeattrs, data, @server)
+    end
+
+  end
+end

data/lib/estool/cat/nodes.rb

@@ -0,0 +1,23 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Nodes
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output
+      }
+      Estool::Actions::Cat.run(:nodes, data, @server)
+    end
+  end
+end

data/lib/estool/cat/plugin.rb

@@ -0,0 +1,21 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Plugin
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose
+      }
+      Estool::Actions::Cat.run(:plugins, data, @server)
+    end
+  end
+end

data/lib/estool/cat/ptasks.rb

@@ -0,0 +1,23 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Ptasks
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output,
+      }
+      Estool::Actions::Cat.run(:pending_tasks, data, @server)
+    end
+  end
+end

data/lib/estool/cat/recovery.rb

@@ -0,0 +1,27 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Recovery
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @bytes = options[:bytes]
+      @index = options[:index]
+      @output = options[:output]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose,
+          format: @output,
+      }
+      data[:index] = @index unless @index.nil?
+      data[:bytes] = @bytes unless @bytes.nil?
+      Estool::Actions::Cat.run(:recovery, data, @server)
+    end
+  end
+end

data/lib/estool/cat/repositories.rb

@@ -0,0 +1,21 @@
+require 'estool/actions/cat'
+
+module Estool
+  class Cat::Repositories
+
+    def initialize(options)
+      @verbose = options[:verbose]
+      @server = {
+          host: options[:host],
+          port: options[:port]
+      }
+    end
+
+    def run
+      data = {
+          v: @verbose
+      }
+      Estool::Actions::Cat.run(:repositories, data, @server)
+    end
+  end
+end

data/lib/estool/cat.rb

@@ -0,0 +1,146 @@
+require 'thor'
+
+module Estool
+  class Cat < Thor
+    class_option 'host', :type => :string,
+                  :banner => 'Elasticsearch host to connect to',
+                  :default => 'localhost',
+                  :aliases => '-H'
+    class_option 'port', :type => :string,
+                  :banner => 'Port to use when connecting to Elasticsearch',
+                  :default => '9200',
+                  :aliases => '-p'
+    class_option 'verbose', :type => :boolean,
+                  :banner => 'Verbose option. Not all subcommands support it',
+                  :default => false,
+                  :aliases => '-v'
+    class_option 'output', :type => :string,
+                  :banner => 'Display output as json or text',
+                  :default => 'text',
+                  :aliases => '-o'
+    class_option 'timeout', :type => :numeric,
+                  :banner => 'Set Master Timeout in seconds',
+                  :default => 30,
+                  :aliases => '-t'
+
+    desc 'aliases [OPTIONS]', 'Display information about aliases'
+    method_option 'name', :type => :string,
+                  :banner => 'Name of alias(es) to display information about',
+                  :aliases => '-n'
+    def aliases
+      require 'estool/cat/aliases'
+      Aliases.new(options).run
+    end
+
+    desc 'allocation [OPTIONS]', 'Display shard allocation information'
+    method_option 'node', :type => :array,
+                  :banner => 'Comma separated list of nodes',
+                  :aliases => '-n'
+    method_option 'bytes', :type => :string,
+                 :banner => 'Unit to display byte values in.',
+                 :default => 'b',
+                 :enum => %w{b k m g},
+                 :aliases => '-b'
+    def allocation
+      require 'estool/cat/allocation'
+      Allocation.new(options).run
+    end
+
+    desc 'count [OPTIONS]', 'Return Document count for cluster or indices'
+    method_option 'index', :type => :string,
+                  :banner => 'Index to count documents',
+                  :aliases => '-i'
+    def count
+      require 'estool/cat/count'
+      Count.new(options).run
+    end
+
+    desc 'fielddata [OPTIONS]', 'Return field data usage data'
+    method_option 'fields', :type => :string,
+                  :banner => 'Comma separated list of fields',
+                  :aliases => '-f'
+    method_option 'bytes', :type => :string,
+                  :banner => 'Unit to display byte values in.',
+                  :default => 'b',
+                  :enum => %w{b k m g},
+                  :aliases => '-b'
+    def fielddata
+      require 'estool/cat/fielddata'
+      Fielddata.new(options).run
+    end
+
+    desc 'health [OPTIONS]', 'Display Elasticsearch Cluster health'
+    def health
+      require 'estool/cat/health'
+      Health.new(options).run
+    end
+
+    desc 'indices [OPTIONS]', 'Display indices statistics across the cluster'
+    method_option 'index', :type => :string,
+                  :banner => 'Comma separated list of index names to display',
+                  :aliases => '-i'
+    method_option 'primary', :type => :boolean,
+                  :banner => 'Limit returned information to primary shards only',
+                  :aliases => '-P',
+                  :default => false
+    method_option 'bytes', :type => :string,
+                  :banner => 'Unit to display byte values in.',
+                  :default => 'b',
+                  :enum => %w{b k m g},
+                  :aliases => '-b'
+    def indices
+      require 'estool/cat/indices'
+      Indices.new(options).run
+    end
+
+    desc 'master [OPTIONS]', 'Display current master node'
+    def master
+      require 'estool/cat/master'
+      Master.new(options).run
+    end
+
+    desc 'nodeattrs [OPTIONS]', 'Display custom node attributes'
+    def nodeattrs
+      require 'estool/cat/nodeattrs'
+      Nodeattrs.new(options).run
+    end
+
+    desc 'nodes [OPTIONS]', 'Display Elasticsearch Nodes'
+    def nodes
+      require 'estool/cat/nodes'
+      Nodes.new(options).run
+    end
+
+    desc 'ptasks [OPTIONS]', 'Display Elasticsearch Pending Task in tabular format'
+    def ptasks
+      require 'estool/cat/ptasks'
+      Ptasks.new(options).run
+    end
+
+    desc 'plugins [OPTIONS]', 'Display Elasticsearch Plugins'
+    def plugins
+      require 'estool/cat/plugin'
+      Plugin.new(options).run
+    end
+
+    desc 'recovery [OPTIONS]', 'Display shard recovery status'
+    method_option 'index', :type => :string,
+                  :banner => 'List of indexes to return information about. Comma-separated',
+                  :aliases => '-i'
+    method_option 'bytes', :type => :string,
+                  :banner => 'Unit to display byte values in.',
+                  :default => 'b',
+                  :enum => %w{b k m g},
+                  :aliases => '-b'
+    def recovery
+      require 'estool/cat/recovery'
+      Recovery.new(options).run
+    end
+
+    desc 'repositories [OPTIONS]', 'Display registered repositories'
+    def repositories
+      require 'estool/cat/repositories'
+      Repositories.new(options).run
+    end
+  end
+end

data/lib/estool/connections.rb

@@ -0,0 +1,21 @@
+require 'elasticsearch'
+require 'net/http'
+
+module Estool
+  module Connections
+
+    def self.start_conn(host,port)
+      Elasticsearch::Client.new host: "#{host}:#{port}"
+    end
+
+    def self.test_conn(client)
+      begin
+        client.perform_request 'GET', '_cluster/health'
+      rescue Faraday::ConnectionFailed => connfail
+        # Connection Failure Message
+        puts connfail
+        exit 1
+      end
+    end
+  end
+end

data/lib/estool/version.rb

@@ -0,0 +1,4 @@
+module Estool
+  ESTOOL_ROOT = File.expand_path("../..", __FILE__)
+  VERSION = "0.0.6-alpha"
+end

data/lib/estool.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'elasticsearch'
+require 'net/http'
+require 'optparse'
+require 'estool/cat'
+require 'estool/connections'
+require 'thor'
+
+module Estool
+  class Cli < Thor
+    register(Estool::Cat, 'cat', 'cat [SUBCOMMAND] [OPTIONS]', 'Utilize Elasticsearch API', )
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: estool
+version: !ruby/object:Gem::Version
+  version: 0.0.6.pre.alpha
+platform: ruby
+authors:
+- David Hollinger III
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+description: 
+email:
+- david.hollinger@moduletux.com
+executables:
+- estool
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/estool
+- lib/estool.rb
+- lib/estool/actions/cat.rb
+- lib/estool/cat.rb
+- lib/estool/cat/aliases.rb
+- lib/estool/cat/allocation.rb
+- lib/estool/cat/count.rb
+- lib/estool/cat/fielddata.rb
+- lib/estool/cat/health.rb
+- lib/estool/cat/indices.rb
+- lib/estool/cat/master.rb
+- lib/estool/cat/nodeattrs.rb
+- lib/estool/cat/nodes.rb
+- lib/estool/cat/plugin.rb
+- lib/estool/cat/ptasks.rb
+- lib/estool/cat/recovery.rb
+- lib/estool/cat/repositories.rb
+- lib/estool/connections.rb
+- lib/estool/version.rb
+homepage: https://github.com/dhollinger/estool
+licenses:
+- Apache-2.0
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Command Line tool for interacting with Elasticsearch
+test_files: []
+has_rdoc: