vscripts 0.1.3 → 0.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjM5YzJkNTdlYjQ5MmRmYTkzNGNkYTk4YzM0MTgwMTM2YmVjOWNiZg==
+    ZTNmYzIzYjVhMTVmMjhmMjI0MGRiYTRlMDRiNzFjYmYxNzMwMzEyYw==
   data.tar.gz: !binary |-
-    ZDYzNzVkMjVmZWE0Njc4MzIxMmE4Nzk4OTY1MWQ4OWY5YzI4YWNjNA==
+    MzQ2YmZmOWQ2ZTk1YzkzMmE1OTcyNDVjZGJjYTk4ZGZmNWViZjYyMw==
 SHA512:
   metadata.gz: !binary |-
-    MzkzNDZmZTFmYjljZDg0NmRmODE3YTNkYTQ5Y2JkYWM2NmRlY2NkYzM1YjU2
-    M2RiYzExMjg3YWQ3MjIzMWY0ZGY4ZjdlNDZmMThmZDNjZDdmYmYwNmEzNzc2
-    YTU5OGFmZWFlZTE4NDI3YTMwMzk2NjAzZTA2NDhhNjRmOTVkM2Y=
+    ZjBlMzBkYWJjYzMyZjM0Y2I1ZTE4NTYwMDZkY2MzNzBlMzYwNjIwNGUzZTdk
+    MWU5ZDRhZWJjMTFiZDhlZTdmMWE4MzI3ZTUzNzUyMjQ2ZGM2NTU0NTVkMzgy
+    OTczMTEzNzU2OTZhMmI3NmM5ZTRiZjYwMTI0MTNjMDcxYzZhMjA=
   data.tar.gz: !binary |-
-    ZGM0MTNhMmQxOTYwZTc1ZTgxNWJkYzZjNGI0NmExN2RkNzc0OGIyMGY2OTU0
-    YzI0MTRmNmVlN2ZiYTJlM2U1NjhmYzhhZTJjZTliZmMxY2I0ZjIyNjQ4NmJk
-    MGViMThkOGUyZTgyMTlhNjEwNDJmNmYxMjFjZDI2MGYxMWZjMWY=
+    MmYwMDhkODRlMjQyMDhhMjMxMDUxMzBhZTU3ZmI1YWE5YWZiOTFmMjdhMTMz
+    ZjQxZmMwYjIxMGM3MzJmODZiYTMzMzgyOTYzNmQ0ZDJkYzNiOTYxNzYyOTEw
+    NmRlYTU3NGQxZTRkODBkMzk1M2M1NzMxODk3MmZiM2QwYTYyMmI=

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
   - 2.1.2
 deploy:
   provider: rubygems

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+Version 0.1.5
+---
+  * Add configuration file ([Vlad - f928415](https://github.com/vghn/vscripts/commit/f928415a19c4f300566721fcffd14877497de6f1))
+  * Add testing for Ruby 2.0.0 ([Vlad - ba19d81](https://github.com/vghn/vscripts/commit/ba19d817194fe1395ce5d2b3884552004e5e07ef))
+  * Fix command line options ([Vlad - cc6e8ad](https://github.com/vghn/vscripts/commit/cc6e8ad6ee77218cfe4cb8ae80af57a291d36ddb))
+  * Fix test for Ruby 2.0 ([Vlad - 2d32474](https://github.com/vghn/vscripts/commit/2d32474afcd2f1122d0d9deebc4e5c0bae700ff5))
+  * Fix smells ([Vlad - 23283a9](https://github.com/vghn/vscripts/commit/23283a941d356e185364d83832d88b15919c2bf7))
+  * Minor code improvements ([Vlad - b9091e5](https://github.com/vghn/vscripts/commit/b9091e5fbd6a50679c214d4d7db9539965d727e6))
+
+Version 0.1.4
+---
+  * Switch back to previous branch on deployment ([Vlad - 244ac9a](https://github.com/vghn/vscripts/commit/244ac9a6d810abd63a625c88bc0a2efac19a9993))
+  * Respect RSpec convention for class methods ([Vlad - 35130ef](https://github.com/vghn/vscripts/commit/35130efd5b21cc18335efb1d620e3412e1d57963))
+  * Add LICENSE and CHANGELOG to the README ([Vlad - 4616bf9](https://github.com/vghn/vscripts/commit/4616bf984d4b77718505595651fa62532ecf8a67))
+  * Improve versioning ([Vlad - 0f52286](https://github.com/vghn/vscripts/commit/0f52286d344fa2d46e41e96f693c989b4367f822))
+  * Minor changes ([Vlad - a32dbcc](https://github.com/vghn/vscripts/commit/a32dbcc70be3043e12624a83d5e25aa1a0ffd405))
+  * Minor code changes ([Vlad - 8821acd](https://github.com/vghn/vscripts/commit/8821acd570fb9058feefe8eacf9212ef9d5c4a39))
+  * Add integration testing ([Vlad - a875320](https://github.com/vghn/vscripts/commit/a875320b65c94cb84304136a0b2967e744098207))
+  * Metadata only since rubygems 2.0 ([Vlad - ab5264b](https://github.com/vghn/vscripts/commit/ab5264b8a3bd93c325f99eae6473a89ebdfa71e9))
+
 Version 0.1.3
 ---
   * Upgrade documentation ([Vlad - fd6fb30](https://github.com/vghn/vscripts/commit/fd6fb30af09d4f4050f0b35d41cc3bfb7e534e4a))

data/README.md

@@ -16,6 +16,12 @@ Automation daemon.
 ### Gem installation
 `gem install vscripts`
 
+## Configuration
+
+VScripts looks for a configuration file in the following locations(in order):
+  - a file specified in the `--config` command line option
+  - `.vscripts.yml` in the $HOME directory
+  - `/etc/vscripts/config.yml`
 
 ## Usage
 
@@ -26,8 +32,9 @@ vscripts GLOBAL-OPTIONS COMMAND OPTIONS
 
 ### Global Options
 ```
--h|--help: Displays VScripts help.
--v|--version: Displays the version number.
+--config,  -c <s>: Specify configuration file
+--help,    -h    : Displays VScripts help
+--version, -v    : Displays the version number
 ```
 
 
@@ -106,3 +113,11 @@ associated with the current instance.
 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
+
+
+## License
+See [LICENSE](LICENSE)
+
+
+## Changelog
+See [CHANGELOG](CHANGELOG.md)

data/bin/vscripts

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'vscripts'
-VScripts.run(ARGV)
+VScripts.run

data/lib/vscripts.rb

@@ -1,12 +1,21 @@
 require 'vscripts/commands'
 require 'vscripts/command_line'
+require 'vscripts/config'
 
 # Main VScripts module
 module VScripts
+  # Reads the command line arguments
+  def self.cli
+    @cli ||= CommandLine.new # Parses command line
+  end
+
+  # Reads the configuration files
+  def self.config
+    @config ||= VScripts::Config.new(cli.global.config) # Parses configuration
+  end
+
   # Reads the arguments and runs the given command
-  def self.run(argv)
-    cli = CommandLine.new(argv)
-    command = VScripts::Commands.const_get(cli.command).new(cli.arguments)
-    command.execute
+  def self.run
+    VScripts::Commands.const_get(cli.command).new(cli.command_options).execute
   end
 end # module VScripts

data/lib/vscripts/aws/ec2.rb

@@ -38,15 +38,24 @@ module VScripts
         ec2.tags.create(resource, key, value)
       end
 
+      # @return [Hash] a correct Hash object with all tags and keys
+      def all_tags_hash
+        hash = {}
+        all_tags.each do |key, value|
+          hash = hash.merge(Hash[key, value])
+        end
+        hash
+      end
+
       # Exclude tags
       # @param list [Array] the list of tag keys to be excluded
       # @return [Hash] the filtered tags
       def tags_without(list = [])
-        all_tags.each_with_object({}) do |tag, hash|
-          key, value = tag[0], tag[1]
-          hash[key] = value unless list.include? key
-          hash
+        hash = all_tags_hash
+        list.each do |key|
+          hash.delete(key)
         end
+        hash
       end
 
       # Looks for the value of the 'Name' tag for the given instance
@@ -72,7 +81,7 @@ module VScripts
       #   a Name tag
       def similar_instances
         check_instance
-        functional_instances.map do |functional_instance|
+        functional_instances.compact.map do |functional_instance|
           next if functional_instance.id == instance_id
           functional_instance.tags['Name']
         end

data/lib/vscripts/command_line.rb

@@ -1,21 +1,21 @@
 require 'trollop'
+require 'vscripts/version'
 require 'vscripts/commands'
 
 module VScripts
   # Parses the command line arguments
   class CommandLine
-    # @return [Array] all command line arguments
-    attr_accessor :arguments
     # @return [Hash] the global command line arguments.
     attr_reader :global
     # @return [String] the command name
     attr_reader :command
+    # @return [Array] the command specific arguments.
+    attr_reader :command_options
 
-    # Builds command line arguments
-    def initialize(argv = [])
-      @arguments ||= argv
-      @global    ||= parse_cli_options
-      @command   ||= verify_command
+    # @param args [Array] the command line arguments
+    # @return [Hash] the command line options
+    def initialize(args = ARGV)
+      parse_global(args)
     end
 
     # Specifies command line options
@@ -23,44 +23,49 @@ module VScripts
     # This method smells of :reek:TooManyStatements but ignores them
     def parser # rubocop:disable MethodLength
       available = Commands.list.map { |cmd| cmd.to_s.downcase }
-      @parser ||= Trollop::Parser.new do
-        version VScripts::VERSION_C
+      Trollop::Parser.new do
+        version VScripts::VERSION::COPYRIGHT
         banner <<-EOS
 VScripts automation daemon.
 
 Available commands:
         #{available}
 
-Usage:
+USAGE:
   vscripts GLOBAL-OPTIONS COMMAND OPTIONS
 
 For help on an individual command:
   vscripts COMMAND --help
 
-Global Options:
+GLOBAL OPTIONS:
 EOS
+        opt :config, 'Specify configuration file',
+            type: :string, short: '-c'
         stop_on available
+        stop_on_unknown
       end
     end
 
-    # @return [Hash] the command line arguments
-    def parse_cli_options
+    # @param args [Array] the command line arguments
+    # @return [Hash] the command line options
+    def parse_global(args)
       Trollop.with_standard_exception_handling parser do
-        fail Trollop::HelpNeeded if arguments.empty?
-        parser.parse arguments
+        @global = parser.parse args
+        fail Trollop::HelpNeeded if args.empty? || !parse_command(args)
       end
+      @global
     end
 
     # Ensures command is available
     # @return [String] the command name
-    def verify_command
-      command_cli = arguments.shift
-      command_cls = command_cli.capitalize.to_sym
-      if Commands.list.include?(command_cls)
-        return command_cls
-      else
-        abort "Error: Unknown subcommand '#{command_cli}'\nTry --help."
-      end
+    # @return [Array] the command specific arguments
+    def parse_command(args)
+      command = args.shift
+      return unless command
+      command_class = command.capitalize.to_sym
+      abort "Error: unknown subcommand '#{command}'\nTry --help." \
+        unless Commands.list.include?(command_class)
+      @command, @command_options = [command_class, args]
     end
   end # class CommandLine
 end # module VScripts

data/lib/vscripts/commands/identify.rb

@@ -11,6 +11,7 @@ module VScripts
 
       # Shows help
       USAGE = <<-EOS
+
 This command creates a themed host name and fully qualified domain name for
 the server, using AWS EC2 tags. The default theme is `Group-Role-#` which means
 that the command collects the value of the `Group` and the `Role` AWS EC2 tags
@@ -24,20 +25,20 @@ Once a new host name is composed, both `/etc/hostname` and `/etc/hosts` are
 modified on the local instance and a new `Name` EC2 tag is created and
 associated with the current instance.
 
-    If a ***--host*** argument is provided it will override the default theme.
-    *DOMAIN* is still looked up.
-    If a ***--domain*** argument is provided it will override the default
-    domain.
+If a ***--host*** argument is provided it will override the default theme.
+*DOMAIN* is still looked up.
+If a ***--domain*** argument is provided it will override the default
+domain.
 
-    EXAMPLES:
-    $ vscripts identify
-    MyGroup-MyRole-1.Example.tld
-    $ vscripts identify --ec2-tag-theme NAME-#
-    MyName-1.Example.tld`
-    $ vscripts identify --host myhost --domain example.com
-    myhost.example.com`
+  USAGE:
+  $ vscripts identify
+  MyGroup-MyRole-1.Example.tld
+  $ vscripts identify --ec2-tag-theme NAME-#
+  MyName-1.Example.tld`
+  $ vscripts identify --host myhost --domain example.com
+  myhost.example.com`
 
-    Options:
+  OPTIONS:
       EOS
 
       # @return [String] the theme
@@ -137,6 +138,7 @@ associated with the current instance.
 
       # Modifies the host name
       def set_hostname
+        return unless File.exist?(hostname_path)
         return if File.read(hostname_path).strip == new_hostname
         puts "Setting local hostname (#{new_hostname})..."
         write_file(hostname_path, new_hostname)
@@ -145,10 +147,11 @@ associated with the current instance.
 
       # Modifies the hosts file
       def update_hosts
+        return unless File.exist?(hosts_path)
         return if File.readlines(hosts_path)
           .grep(/#{new_fqdn} #{new_hostname}/)
           .any?
-        hosts_body = hosts_file.gsub(
+        hosts_body = File.read(hosts_path).gsub(
           /^127\.0\.0\.1.*/,
           "127\.0\.0\.1 #{new_fqdn} #{new_hostname} localhost"
         )
@@ -158,9 +161,9 @@ associated with the current instance.
 
       # Executes the command
       def execute
-        set_name_tag
-        set_hostname
-        update_hosts
+        puts 'EC2 tag not changed!' unless set_name_tag
+        puts 'Hostname not changed!' unless set_hostname
+        puts 'Hosts file not changed!' unless update_hosts
         puts 'Done.'
       end
     end # class Identify

data/lib/vscripts/commands/tags2facts.rb

@@ -12,19 +12,19 @@ module VScripts
       # Shows help
       USAGE = <<-EOS
 
-  This command can only be run on an AWS EC2 instance. It looks for all tags
-  associated with it and dumps them in a JSON file. By default this file is
-  `/etc/facter/facts.d/ec2_tags.json`. It can be overridden with the
-  ***`--file`*** argument.
+This command can only be run on an AWS EC2 instance. It looks for all tags
+associated with it and dumps them in a JSON file. By default this file is
+`/etc/facter/facts.d/ec2_tags.json`. It can be overridden with the
+***`--file`*** argument.
 
-  The `Name` and `Domain` tags are excluded by default because this command is
-  intended to add Facter facts and these 2 already exist in Facter. This
-  behaviour can be overridden by adding `[-a|--all]` command line option.
+The `Name` and `Domain` tags are excluded by default because this command is
+intended to add Facter facts and these 2 already exist in Facter. This
+behaviour can be overridden by adding `[-a|--all]` command line option.
 
-  Usage:
-       $ vscripts tags2facts [options]
+  USAGE:
+    vscripts tags2facts [options]
 
-  Options:
+  OPTIONS:
       EOS
 
       # @return [Array] the command specific arguments

data/lib/vscripts/config.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+
+module VScripts
+  # VScripts Configuration
+  class Config
+    # User's configuration file
+    DOT_FILE   = "#{File.expand_path('~')}/.vscripts.yml"
+    # Global configuration file
+    SYSTEM_CONFIG_FILE = '/etc/vscripts/config.yml'
+    # Global defaults
+    GLOBAL_DEFAULTS = {}
+
+    # @return [Hash] all configuration options
+    attr_reader :get
+
+    # Loads class
+    # @param cfg_file [String] the path to the configuration file
+    # @return [Hash] the configuration options
+    def initialize(config_file = nil)
+      @file = config_file
+      @get  = GLOBAL_DEFAULTS.merge(options)
+    end
+
+    # Parses the configuration files in order
+    # @return [Hash] the first configuration hash found
+    def options
+      parse(@file) ||
+        parse(DOT_FILE) ||
+        parse(SYSTEM_CONFIG_FILE) ||
+        {}
+    end
+
+    # Parses the configuration
+    # @param file [String] the path to the configuration file
+    # @return [Hash] the configuration hash
+    def parse(file)
+      YAML.load(read(file)) if check_config(file)
+    end
+
+    # @param (see #parse)
+    # @return [String] the contents of the file
+    def read(file)
+      File.read(file)
+    end
+
+    # @param (see #parse)
+    # @return [Boolean] true if the file exists
+    def check_config(file)
+      file && File.exist?(file)
+    end
+  end # class Config
+end # module VScripts

data/lib/vscripts/util/local_system.rb

@@ -7,11 +7,6 @@ module VScripts
         '/etc/hosts'
       end
 
-      # @return [String] the contents of the hosts file
-      def hosts_file
-        File.read(hosts_path)
-      end
-
       # @return [String] the hostname file path
       def hostname_path
         '/etc/hostname'

data/lib/vscripts/version.rb

@@ -1,8 +1,13 @@
 module VScripts
-  # @return [String] the version number
-  VERSION = File.read(File.expand_path('../../../VERSION', __FILE__)).strip
-  # @return [String] the semantic version number
-  VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH = VERSION.split('.')
-  # @return [String] the copyrighted version number
-  VERSION_C = "VScripts #{VERSION} (c) #{Time.new.year} Vlad Ghinea"
+  # This module holds the version information.
+  module VERSION
+    # @return [String] the version number
+    STRING = '0.1.5'
+
+    # @return [String] the semantic version number
+    MAJOR, MINOR, PATCH = STRING.split('.').map(&:to_i)
+
+    # @return [String] the copyrighted version number
+    COPYRIGHT = "VScripts #{STRING} (c) #{Time.new.year} Vlad Ghinea"
+  end
 end