elasticsearch_update 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8184b6ab6ae68ea0bee8b38f1cc54059ed3bbb7d
-  data.tar.gz: f8b5bca19aed12f5e68ef3aaea2c9ff4170f2042
+  metadata.gz: 3df537b4bd6bc80e4eb1120c60e39a8fa5f324df
+  data.tar.gz: 5959d7922c84ab8059edab8ef1f093957725541a
 SHA512:
-  metadata.gz: 8d17edc14813b94caa113d2d3ca5b790e7df47093b8330fc63c10b511390aceb9713c781badc00ec85fcea0b664da25322ede0003c6232542d901b713d64e670
-  data.tar.gz: f6fce5f86ddb2f53e19077cc24e00d5d1a31d74a18972597d0289a17d4f433ee97ec268865890c6c339c8db5fc9eb7eec1d8f9e68bc64bd6474fd4f724610d52
+  metadata.gz: 8a43c31b14e97b06724b2d0da9dc308b30d155bc4934067f7c22e5f43cbfa8e46b601fe631408a1b16f034c1991097feac29b9127d1a58db8d2dc2e3dba0538c
+  data.tar.gz: 1a2285449eef6fd531687878da4ab6944cfac4b4a244bdbe8001209cf5b09290fdc75bd3fb926b89d868ccf9601b7e88a68aee7a8d91163658c53452052c5bce

data/README.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.org/kkirsche/elasticsearch_update.svg?branch=master)](https://travis-ci.org/kkirsche/elasticsearch_update) [![Code Climate](https://codeclimate.com/github/kkirsche/elasticsearch_update/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/elasticsearch_update) [![Test Coverage](https://codeclimate.com/github/kkirsche/elasticsearch_update/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/elasticsearch_update) [![Dependency Status](https://gemnasium.com/kkirsche/elasticsearch_update.svg)](https://gemnasium.com/kkirsche/elasticsearch_update)
-# Elasticsearch Update v1.0.1
+[![Build Status](https://travis-ci.org/kkirsche/elasticsearch_update.svg?branch=master)](https://travis-ci.org/kkirsche/elasticsearch_update) [![Code Climate](https://codeclimate.com/github/kkirsche/elasticsearch_update/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/elasticsearch_update) [![Test Coverage](https://codeclimate.com/github/kkirsche/elasticsearch_update/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/elasticsearch_update) [![Dependency Status](https://gemnasium.com/kkirsche/elasticsearch_update.svg)](https://gemnasium.com/kkirsche/elasticsearch_update) [![Gem Version](https://badge.fury.io/rb/elasticsearch_update.svg)](http://badge.fury.io/rb/elasticsearch_update)
+# Elasticsearch Update
 
 This gem allows users to easily update their 1.0 and later Elasticsearch instance on the local machine from one of the following formats.
 

data/elasticsearch_update.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/kkirsche/elasticsearch_update"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   << 'elasticsearch_update'
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/elasticsearch_update/cli.rb

@@ -1,8 +1,20 @@
 require 'logger'
 
 module ElasticsearchUpdate
-  # This class is in charge of retrieving and downloading data.
+  # == CLI
+  # ElasticsearchUpdate::Cli class is used to begin application execution
+  # and walks the user through the update process
+  #
+  # == Parameters
+  #
+  # Start takes no parameters or options.
   class Cli
+    # Start the command line update process which calls all necessary
+    # methods and classes to complete an Elasticsearch update.
+    #
+    # ==== Example
+    #
+    #    ElasticsearchUpdate::Cli.start
     def self.start
       @log = Logger.new(STDOUT)
       @log.level = Logger::INFO

data/lib/elasticsearch_update/downloader.rb

@@ -4,10 +4,42 @@ require 'tempfile'
 require 'open-uri'
 
 module ElasticsearchUpdate
-  # This class is in charge of retrieving and downloading data.
+  # == Downloader
+  # ElasticsearchUpdate::Downloader class is used to download the
+  # Elasticsearch update file
+  #
+  # == Parameters
+  #
+  # Initilization requires a +hash+ and optional +test+ parameter.
+  #
+  # +hash+ is a ruby hash in the following format:
+  # { host: String, port: Integer }
+  #
+  # +test+ is a boolean identifying whether or not we are in a test
+  # if we are, we set the Logger to logging FATAL errors only.
+  #
+  # == Example
+  #
+  #    ElasticsearchUpdate::Downloader.new({ host: 'localhost', port: 9200 })
   class Downloader
     attr_reader :extension, :base, :version, :download_url, :verify_url
     attr_accessor :update_file
+    # == initialize
+    # Allows us to create an instance of the Downloader
+    #
+    # == Parameters
+    #
+    # initialize requires a +hash+ and optional +test+ parameter.
+    #
+    # +hash+ is a ruby hash in the following format:
+    # { host: String, port: Integer }
+    #
+    # +test+ is a boolean identifying whether or not we are in a test
+    # if we are, we set the Logger to logging FATAL errors only.
+    #
+    # == Example
+    #
+    #    ElasticsearchUpdate::Downloader.new({ host: 'localhost', port: 9200 })
     def initialize(hash, test = false)
       @log = Logger.new(STDOUT)
       if test
@@ -29,6 +61,21 @@ module ElasticsearchUpdate
                     @extension + '.sha1.txt'
     end
 
+    # == write_file_from_url
+    # Allows us to write data from a URL to a file.
+    #
+    # == Parameters
+    #
+    # write_file_from_url requires a +file+ to write to and a +url+ from which
+    # to download the file from.
+    #
+    # +file+ is a ruby File or Tempfile object
+    #
+    # +url+ is a string for the URL.
+    #
+    # == Example
+    #
+    #    write_file_from_url(Tempfile.new('example'), http://foo.bar/file.zip)
     def write_file_from_url(file, url)
       Net::HTTP.start(@base) do |http|
         begin
@@ -43,6 +90,22 @@ module ElasticsearchUpdate
       end
     end
 
+    # == download_file
+    # Begins the download process of the Elasticsearch update file.
+    #
+    # == Parameters
+    #
+    # download_file takes an optional boolean argument, named +test+.
+    #
+    # +test+ is an optional boolean which allows us to avoid actually writing to
+    # a file while running our tests.
+    #
+    # == Example
+    #
+    #    # Not a test
+    #    download_file
+    #    # Test
+    #    download_file(true)
     def download_file(test = false)
       @update_file = Tempfile.new(['elasticsearch_update_file', @extension])
 
@@ -53,6 +116,21 @@ module ElasticsearchUpdate
       @update_file
     end
 
+    # == verify_update_file
+    # Begins the verification process the Elasticsearch update file by
+    # using the instance variables of the file and the downloaded SHA1 value.
+    #
+    # == Parameters
+    #
+    # verify_update_file takes no parameters.
+    #
+    # == Requires
+    #
+    # verify_update_file requires @update_file to be set as a file.
+    #
+    # == Example
+    #
+    #    verify_update_file
     def verify_update_file
       @log.info('Beginning integrity check of downloaded file .')
       @file_sha1 = Digest::SHA1.file(@update_file.path).hexdigest
@@ -67,6 +145,22 @@ module ElasticsearchUpdate
       end
     end
 
+    # == download_remote_sha1
+    # Begins the download of the Elasticsearch update file SHA1 text file.
+    # It then separates the SHA1 value from the filename.
+    #
+    # == Parameters
+    #
+    # download_remote_sha1 takes no parameters.
+    #
+    # == Requires
+    #
+    # download_remote_sha1 requires @verify_url to be set as a string to a
+    # .txt file.
+    #
+    # == Example
+    #
+    #    download_remote_sha1
     def download_remote_sha1
       @log.info('Downloading Elasticsearch SHA1.')
 

data/lib/elasticsearch_update/elasticsearch.rb

@@ -3,9 +3,46 @@ require 'json'
 require 'net/http'
 
 module ElasticsearchUpdate
-  # This class is in charge of retrieving and downloading data.
+  # == Elasticsearch
+  # ElasticsearchUpdate::Elasticsearch class is used to interact with
+  # the local Elasticsearch instance.
+  #
+  # == Parameters
+  #
+  # Initilization takes an optional +hash+ and optional +test+ parameter.
+  #
+  # +hash+ is a ruby hash in the following format:
+  # { host: String, port: Integer }
+  #
+  # +test+ is a boolean identifying whether or not we are in a test
+  # if we are, we set the Logger to logging FATAL errors only.
+  #
+  # == Example
+  #
+  #    ElasticsearchUpdate::Elasticsearch.new({ host: 'localhost', port: 9200 })
   class Elasticsearch
     attr_reader :es_host, :es_port
+    # == initialize
+    # Allows us to create an instance of the Elasticsearch interaction client.
+    #
+    # == Parameters
+    #
+    # initialize takes an optional +hash+ and optional +test+ parameter.
+    #
+    # +hash+ is a ruby hash in the following format:
+    # { host: String, port: Integer }
+    #
+    # +test+ is a boolean identifying whether or not we are in a test
+    # if we are, we set the Logger to logging FATAL errors only.
+    #
+    # == Example
+    #
+    #    # Not a test, default host and port
+    #    ElasticsearchUpdate::Elasticsearch.new
+    #    # Not a test, manually set host and port
+    #    ElasticsearchUpdate::Elasticsearch.new({ host: 'localhost', port: 9200 })
+    #    # Test
+    #    ElasticsearchUpdate::Elasticsearch.new({ host: 'localhost', port: 9200 }, true)
     def initialize(hash = { host: 'localhost', port: 9200 }, test = false)
       @log = Logger.new(STDOUT)
       if test
@@ -20,6 +57,27 @@ module ElasticsearchUpdate
       @es_port = hash[:port]
     end
 
+    # == cluster_routing_allocation
+    # Allows us to enable or disable Elasticsearch's cluster routing allocation
+    # setting via the HTTP API. Learn more in Elasticsearch's documentation:
+    # http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-cluster.html
+    #
+    # == Parameters
+    #
+    # cluster_routing_allocation takes an optional +type+.
+    #
+    # +type+ is a String. Possible values include:
+    # 'all' -- (default) Allows shard allocation for all kinds of shards.
+    # 'primaries' -- Allows shard allocation only for primary shards.
+    # 'new_primaries' -- Allows shard allocation only for primary shards for new indices.
+    # 'none' -- No shard allocations of any kind are allowed for all indices.
+    #
+    # == Example
+    #
+    #    # Disabling shard allocation
+    #    cluster_routing_allocation('none')
+    #    # Allowing shard allocation
+    #    cluster_routing_allocation('all')
     def cluster_routing_allocation(type)
       @log.info('Disabling cluster routing allocation')
 
@@ -38,6 +96,19 @@ module ElasticsearchUpdate
       response
     end
 
+    # == shutdown_local_node
+    # Allows us to shutdown a the local Elasticsearch node via the HTTP API.
+    # Requires @es_host and @es_port which were set during initialization.
+    # Learn more in Elasticsearch's documentation:
+    # http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html
+    #
+    # == Parameters
+    #
+    # shutdown_local_node takes no parameters
+    #
+    # == Example
+    #
+    #    shutdown_local_node
     def shutdown_local_node
       @log.info('Shutting down local node')
       @shutdown_uri = URI('http://' + @es_host + ':' + @es_port.to_s + '/_cluster/nodes/_local/_shutdown')
@@ -46,16 +117,49 @@ module ElasticsearchUpdate
       response
     end
 
+    # == start_elasticsearch_service
+    # Allows us to begin the Linux Elasticsearch service
+    #
+    # == Parameters
+    #
+    # start_elasticsearch_service takes a sudo +password+ parameter as a String.
+    #
+    # == Example
+    #
+    #    start_elasticsearch_service('test_password')
     def start_elasticsearch_service(password)
       @log.info('Starting elasticsearch service')
       system('echo ' + password + ' | sudo -S service elasticsearch start')
     end
 
+    # == start_elasticsearch_binary
+    # Allows us to begin a Unix / Linux binary instance of Elasticsearch
+    # Windows users require a slightly different command.
+    #
+    # == Parameters
+    #
+    # start_elasticsearch_binary takes a +path+ parameter as a String.
+    #
+    # == Example
+    #
+    #    start_elasticsearch_binary('/path/to/elasticsearch')
     def start_elasticsearch_binary(path)
       @log.info('Starting elasticsearch binary')
       system(path + 'bin/elasticsearch')
     end
 
+    # == start_elasticsearch
+    # Allows us to use the proper command when starting Elasticsearch.
+    #
+    # == Parameters
+    #
+    # start_elasticsearch takes a +installer+ parameter which is an instance of
+    # ElasticsearchUpdate::Installer.
+    #
+    # == Example
+    #
+    #    installer = ElasticsearchUpdate::Installer.new('test_password', '.deb')
+    #    start_elasticsearch(installer)
     def start_elasticsearch(installer_obj)
       case installer_obj.extension
       when '.zip'

data/lib/elasticsearch_update/installer.rb

@@ -1,9 +1,43 @@
 require 'logger'
 
 module ElasticsearchUpdate
-  # This class is in charge of retrieving and downloading data.
+  # == Installer
+  # ElasticsearchUpdate::Installer class is used to install the downloaded
+  # Elasticsearch update file.
+  #
+  # == Parameters
+  #
+  # Initilization requires a sudo +password+, file +extension+, and optional +test+ parameter.
+  #
+  # +password+ is String. Ex. 'test_password'
+  #
+  # +extension+ is String. Ex. '.deb'
+  #
+  # +test+ is a boolean identifying whether or not we are in a test
+  # if we are, we set the Logger to logging FATAL errors only.
+  #
+  # == Example
+  #
+  #    ElasticsearchUpdate::Installer.new('test_password', '.deb')
   class Installer
     attr_accessor :sudo_password, :extension
+    # == initialize
+    # Allows us to create an instance of the Installer.
+    #
+    # == Parameters
+    #
+    # Initilization requires a sudo +password+, file +extension+, and optional +test+ parameter.
+    #
+    # +password+ is String. Ex. 'test_password'
+    #
+    # +extension+ is String. Ex. '.deb'
+    #
+    # +test+ is a boolean identifying whether or not we are in a test
+    # if we are, we set the Logger to logging FATAL errors only.
+    #
+    # == Example
+    #
+    #    ElasticsearchUpdate::Installer.new('test_password', '.deb')
     def initialize(password, extension, test = false)
       @log = Logger.new(STDOUT)
       if test
@@ -18,6 +52,19 @@ module ElasticsearchUpdate
       @extension = extension
     end
 
+    # == install_file
+    # Uses the extension found in the @extension variable set on initilization
+    # to determine what command should be used to install the update file.
+    #
+    # == Parameters
+    #
+    # install_file requires the update +file+ as a parameter.
+    #
+    # +file+ is File or Tempfile object. Ex. Tempfile.new('es_update_file')
+    #
+    # == Example
+    #
+    #    install_file(Tempfile.new('es_update_file'))
     def install_file(file)
       case @extension
       when '.zip'
@@ -31,6 +78,21 @@ module ElasticsearchUpdate
       end
     end
 
+    # == install_update_file
+    # Uses the given file and extension to install the service version of
+    # Elasticsearch from an RPM or DEB file.
+    #
+    # == Parameters
+    #
+    # install_update_file requires the update +file+ and +extension+ as a parameter.
+    #
+    # +file+ is File or Tempfile object. Ex. Tempfile.new('es_update_file')
+    #
+    # +extension+ is String. Ex. '.deb'
+    #
+    # == Example
+    #
+    #    install_update_file(Tempfile.new('es_update_file'), '.deb')
     def install_update_file(file, extension)
       @log.info('Installing' + extension + 'file.')
       command = 'echo ' + @sudo_password + ' | '
@@ -43,6 +105,8 @@ module ElasticsearchUpdate
       Kernel.system(command)
     end
 
+    # == unzip_file
+    # In development. Nothing occurs.
     def unzip_file(file)
     end
   end

data/lib/elasticsearch_update/version.rb

@@ -1,3 +1,3 @@
 module ElasticsearchUpdate
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/elasticsearch_update/wizard.rb

@@ -1,8 +1,36 @@
 require 'highline/import'
 
 module ElasticsearchUpdate
-  # This class is in charge of retrieving and downloading data.
+  # == Wizard
+  # ElasticsearchUpdate::Wizard class is used to ask questions
+  # to the user using the highline gem.
+  #
+  # == Parameters
+  #
+  # Initilization requires no parameters.
+  #
+  # == Example
+  #
+  #    ElasticsearchUpdate::Wizard.new
   class Wizard
+    # == extension
+    # extension is used to provide a menu to the user asking which file
+    # type they would like to use when updating Elasticsearch
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns +@choice+ which is a string containing either:
+    # 1. '.deb'
+    # 2. '.rpm'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    extension = wizard.extension
     def extension
       choose do |menu|
         menu.prompt = 'Which type of upgrade are we doing?  '
@@ -16,10 +44,42 @@ module ElasticsearchUpdate
       @choice
     end
 
+    # == version
+    # version is used to ask the user which version of Elasticsearch
+    # they would like to use.
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a string containing a version number. Ex: '1.4.3'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    version = wizard.version
     def version
       ask('What version of Elasticsearch should we update to? (major.minor.path) ', String) { |q| q.validate = /\d\.\d\.\d/ }
     end
 
+    # == host
+    # host is used to ask the user the hostname of Elasticsearch so we
+    # can interact with it over it's HTTP API.
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a string containing the hostname. Ex: 'localhost'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    host = wizard.host
     def host
       response = ask('What is your Elasticsearch hostname? (Default: localhost) ', String)
       response = 'localhost' if response == ''
@@ -27,6 +87,22 @@ module ElasticsearchUpdate
       response
     end
 
+    # == port
+    # port is used to ask the user the port of Elasticsearch so we
+    # can interact with it over it's HTTP API.
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a string containing the port. Ex: '9200'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    port = wizard.port
     def port
       response = ask('What is your Elasticsearch port? (Default: 9200) ', String)
 
@@ -35,6 +111,23 @@ module ElasticsearchUpdate
       response
     end
 
+    # == es_location_hash
+    # es_location_hash is used construct the location hash used by other
+    # gem classes.
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a hash containing the host and port.
+    # Ex: { host: 'localhost', port: 9200 }
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    location_hash = wizard.es_location_hash
     def es_location_hash
       {
         host: host,
@@ -42,14 +135,64 @@ module ElasticsearchUpdate
       }
     end
 
+    # == elasticsearch_fs_location
+    # elasticsearch_fs_location is used to find where the Elasticsearch
+    # binary file is so that we can update from .zip or .tar.gz and
+    # successfully start elasticsearch after the update
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a string containing path.
+    # Ex: '/path/to/elasticsearch/'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    fs_location = wizard.elasticsearch_fs_location
     def elasticsearch_fs_location
       ask('In what directory does Elasticsearch run? ', String)
     end
 
+    # == sudo_password
+    # sudo_password is used to get the sudo password for use while installing
+    # the updated Elasticsearch files. Echo's "x" for each keypress.
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a string containing the password.
+    # Ex: 'example_password'
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    password = wizard.sudo_password
     def sudo_password
       ask('What password should be used while updating Elasticsearch? ') { |q| q.echo = "x" }
     end
 
+    # == download_hash
+    # download_hash is used to construct the hash used by the Downloader
+    #
+    # == Parameters
+    #
+    # Requires no parameters.
+    #
+    # == Returns
+    #
+    # Returns a hash containing the base_url, version, and extension.
+    #
+    # == Example
+    #
+    #    wizard = ElasticsearchUpdate::Wizard.new
+    #    hash = wizard.download_hash
     def download_hash
       {
         base_url: 'download.elasticsearch.org',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_update
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kevin Kirsche
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="