estool 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7e7ce0b66d13b4530fd66b8c13a9a52fc57e881
-  data.tar.gz: 4198e9fa1717bb703f61d09852600e8c0bd29194
+  metadata.gz: 9b796b14201ba030ce8cc0754cec0c57c92be380
+  data.tar.gz: deebecfb4219e665f3b7142eb6a5988c77053cc3
 SHA512:
-  metadata.gz: 89fe4326849d0b68ce3699fd44bdc34493c31dd364aa4bae8710502f2a86318f6d90ccf2bc845a6c5949e8ea2be4c9be19d079d8f669ba7cc4fc31b495ef1dd4
-  data.tar.gz: 6dd633ffdc0171c0bc723137a6320ab62480223f2191603f9e9923fdcb265b94beb061da38452a982f6affcf58e8e1d3ec07877a19452d9f4bc32786975fb54f
+  metadata.gz: b3ec563efba29dba758f1d5a91efcc20a192d66028428371ab2490b4751b5c61a92ddb2cf53bcc133aa2cf0d87c31ad531946869751d3b4fdeeef811d5e1a9cc
+  data.tar.gz: f520c9c03b9c594a8279858373ad126c5a750554b0146f9d4882db3fd7270d7cb1dcc66ad2e56f28897b560349f998c260b702fc63c5e89b136bbc8fbf77ebae

data/README.md

@@ -3,10 +3,93 @@ ESTool - Elasticsearch Commandline Tool
 
 EStool is a command-line tool for interacting with the Elasticsearch search and analytics engine. 
 
-Documentation
--------------
+## Installation
+
+Install the gem
+
+        gem install estool
+        
+## Requirements
+
+* Requires Elasticsearch cluster accessible over HTTP.
+* Tested on Elasticsearch 1.7.x, 2.3.x, 5.x
+* Ruby 2.2.6
+
+## Using estool
+
+Getting help:
+
+        estool -h
+        
+Global options:
+
+* `-h, --host=HOST` - Elasticsearch node to connect to. Default: `localhost`
+* `-p, --port=PORT` - HTTP port to connect to. Default: `9200`
+* `-v, --verbose` - Show verbose output. In most commands this is represented by column headings. Not supported by all commands.
+        
+#### Cluster Health
+        
+This subcommand will print the cluster health out to the screen.
+
+        $ estool health
+        
+More options can be listed with `$ estool health -h`
+
+#### Indices
+
+This subcommand is used to interact with the Cluster Indices.
+
+Currently supports following actions:
+* list indices
+* create/delete/close indices
+
+##### Examples
+Create a new index:
+
+        $ estool index create --name=index1
+
+Delete an index:
+
+        $ estool index delete --name=index1
+
+Close an index:
+
+        $ estool index close --name=index1
+        
+Show indices:
+
+the `index` subcommand defaults to the show command, so you can get a list of indices simply by running:
+
+        $ estool index
+
+#### Aliases
+
+This subcommand is used to interact with Index aliases within the cluster.
+
+Currently supported actions:
+* list aliases
+* create/delete aliases
+
+##### Examples
+
+Create a new alias:
+
+        $ estool aliases create -i index1 -n test_index
+
+Delete an alias:
+
+        $ estool aliases delete -i index1 -n test_index
+ 
+List aliases:
+
+        $ estool aliases
+        
+Like the `estool index` command, `estool aliases` defaults to listing the aliases for all indices.
+
+List aliases for an index:
+
+        $ estool aliases list -i index1
 
-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
 -------

data/lib/estool/actions/cat.rb

@@ -16,17 +16,17 @@ module Estool::Actions
       data.each do |k, v|
         case k
         when :verbose
-            params.merge!(v: v)
-          when :output
-            params.merge!(format: v)
-          when :name
-            params.merge!(name: v)
-          when :node
-            params.merge!(node_id: v)
-          when :primary
-            params.merge!(pri: v)
-          else
-            params.merge!("#{k}": v)
+          params.merge!(v: v)
+        when :output
+          params.merge!(format: v)
+        when :name
+          params.merge!(name: v)
+        when :node
+          params.merge!(node_id: v)
+        when :primary
+          params.merge!(pri: v)
+        else
+          params.merge!("#{k}": v)
         end
       end
       return params

data/lib/estool/actions/index.rb

@@ -15,14 +15,12 @@ module Estool::Actions
       params = {}
       data.each do |k, v|
         case k
-        when :name
-            params.merge!(index: v)
-          when :update
-            params.merge!(update_all_types: v)
-          when :wait
-            params.merge!(wait_for_active_shards: v)
-          else
-            params.merge!("#{k}": v)
+        when :update
+          params.merge!(update_all_types: v)
+        when :wait
+          params.merge!(wait_for_active_shards: v)
+        else
+          params.merge!("#{k}": v)
         end
       end
       return params

data/lib/estool/cli/aliases.rb

@@ -6,14 +6,8 @@ module Estool
     command :aliases do |c|
 
       c.desc 'Get a list of aliases'
-      c.long_desc %{
-        Get a list of all aliases or a list of aliases for a specific index.
-      }
       c.command [:list, :ls] do |ls|
 
-        ls.flag 'name', :arg_name => 'alias name(s)',
-                        :desc => 'Comma separated list of aliases to get information about'
-
         ls.flag [:index, :i], :arg_name => 'index name(s)',
                               :desc => 'Comma separated list of index names'
 
@@ -28,6 +22,52 @@ module Estool
           ls_alias.run
         end
       end
+
+      c.desc 'create an alias for an index.'
+      c.command [:create, :c] do |create|
+        create.flag [:name, :n], :arg_name => 'alias name',
+                                 :required => true,
+                                 :desc     => 'What to name the alias.'
+
+        create.flag [:index, :i], :arg_name => 'index name',
+                                  :required => true,
+                                  :desc     => 'Index to apply alias to.'
+
+        create.action do |global_options,options,args|
+          options = {
+            host: global_options[:host],
+            port: global_options[:port],
+            name: options[:name],
+            index: options[:index]
+          }
+          cr_alias = Estool::Actions::Index.new('put_alias', options)
+          cr_alias.run
+        end
+      end
+
+      c.desc 'delete an alias for an index.'
+      c.command [:delete, :d] do |delete|
+        delete.flag [:name, :n], :arg_name => 'alias name',
+                                 :required => true,
+                                 :desc     => 'Which alias to delete.'
+
+        delete.flag [:index, :i], :arg_name => 'index name',
+                                  :required => true,
+                                  :desc     => 'Index to apply alias to.'
+
+        delete.action do |global_options,options,args|
+          options = {
+            host: global_options[:host],
+            port: global_options[:port],
+            name: options[:name],
+            index: options[:index]
+          }
+          dl_alias = Estool::Actions::Index.new('delete_alias', options)
+          dl_alias.run
+        end
+      end
+
+      c.default_command :list
     end
   end
 end

data/lib/estool/cli/index.rb

@@ -24,7 +24,7 @@ module Estool
           options = {
             host: global_options[:host],
             port: global_options[:port],
-            name: options[:name],
+            index: options[:name],
             update: options[:update],
             wait: options[:wait]
           }

data/lib/estool/connections.rb

@@ -9,13 +9,11 @@ module Estool
     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
+      client.perform_request 'GET', '_cluster/health'
+    rescue Faraday::ConnectionFailed => connfail
+      # Connection Failure Message
+      puts connfail
+      exit 1
     end
   end
 end

data/lib/estool/version.rb

@@ -1,4 +1,4 @@
 module Estool
   ESTOOL_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = "0.2.1"
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: estool
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - David Hollinger III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -70,7 +70,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: 
+description: |-
+  Command Line tool for interacting with Elasticsearch.
+                            Still in Development, expect bugs and fast releases
+                            until 1.0.0.
 email:
 - david.hollinger@moduletux.com
 executables:
@@ -113,8 +116,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
-summary: 'Command Line tool for interacting with Elasticsearch. Still in Development,
-  expect bugs and fast releases until 1.0.0. NOTE: version 0.2.0 involves a complete
-  CLI rewrite. Some options have not been reimplemented, others have changed, and
-  a new command implemented'
+summary: Command Line tool for Elasticsearch
 test_files: []