vscripts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d38d36783f6824793b72877c41ed04da154c492
+  data.tar.gz: e16339dde0ebe97ccba08c2698713a04b9f73431
+SHA512:
+  metadata.gz: ffb1d84f8a7c17162fa951b115579ac862503fda12662380db96d06af0afae7ed494d13ec6657cbf454efced85aa04eba5c6e5afe710547fd0033896e4a50668
+  data.tar.gz: 96f561e9331fbcf87a3738c46fea0729a642a8bcf6c2d55b5fcbc70dedab1aa3759a031a7ddcb353c6e23afa873e0f8eaa045ded9579ea4ca911218431533857

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+Version 0.0.1
+---
+  * Create gem structure ([Vlad - 635a06d](https://github.com/vghn/vscripts/commit/635a06d33fab5e8dbee39991ffc1e7bbf4ef4e6f))
+  * Copyright year ([Vlad - 5f11c06](https://github.com/vghn/vscripts/commit/5f11c0616e806af127a187740f845e0a23939211))
+  * Add clean tasks ([Vlad - 6675f56](https://github.com/vghn/vscripts/commit/6675f5649a797df8a74ffd2e3bbe7d1ec232321f))
+  * Simplify executable ([Vlad - 7ba96a8](https://github.com/vghn/vscripts/commit/7ba96a8a4e99b2c3f83bdc15cccfa5e66e825c44))
+  * Command line ([Vlad - ebb5dfb](https://github.com/vghn/vscripts/commit/ebb5dfb0c08e412d9e041ea80e1d05b957baaca0))
+  * Misc ([Vlad - ae012ec](https://github.com/vghn/vscripts/commit/ae012ec3d741bc8cc4cec19e4973b5f1ff1abff0))
+  * Update README ([Vlad - ded7d20](https://github.com/vghn/vscripts/commit/ded7d2081d643009c38e8fe51b860c8d9eb0880a))
+  * Tags2Facts command ([Vlad - 314e71b](https://github.com/vghn/vscripts/commit/314e71b242f4cb4fc0f27e440395cd2d04a55515))
+  * Travis ([Vlad - 3cc8938](https://github.com/vghn/vscripts/commit/3cc89389306b17faddf8cf51e02679138ef4c352))
+  * Travis Ruby 2.1.2 ([Vlad - b7c97ec](https://github.com/vghn/vscripts/commit/b7c97ecd9698065bf332ce9b9e5089aa2655fc5b))
+  * Update README ([Vlad - 81b5732](https://github.com/vghn/vscripts/commit/81b5732399ac8cccb295b77f43e0138f3909a46a))
+  * Travis spec ([Vlad - 5d45334](https://github.com/vghn/vscripts/commit/5d453348b2629208815109632d550d349e153daf))
+  * Fix tags hash ([Vlad - ca87f5f](https://github.com/vghn/vscripts/commit/ca87f5f329f27e18fa1b8bb64c013d417e99cb15))
+  * Add badges in README ([Vlad - df19aa8](https://github.com/vghn/vscripts/commit/df19aa86db8e589a89387828cb9da53e075c7438))
+  * Fix command case ([Vlad - abee006](https://github.com/vghn/vscripts/commit/abee006560a3983a8021d28ed95593e02e78e10a))
+  * Capitalize tags ([Vlad - 13fc4f2](https://github.com/vghn/vscripts/commit/13fc4f2d0f8982a74fd38b13deb593c4740d56bd))
+  * Minor fixes ([Vlad - 1ce2b34](https://github.com/vghn/vscripts/commit/1ce2b34d32dc8d24108b00c0ce8c04f2cc14495e))
+  * Fix code smells ([Vlad - 4da7c79](https://github.com/vghn/vscripts/commit/4da7c7938ee5250fe002fc2c23e66ec081f77ca5))
+  * Add rake dependency ([Vlad - e4a7b77](https://github.com/vghn/vscripts/commit/e4a7b77df57660372619084a903b13b26ff84258))
+  * Fix tags hash ([Vlad - cc9e175](https://github.com/vghn/vscripts/commit/cc9e175fbb48ba293ca278356fb755c15f31d3f7))
+  * Add automated deployment task ([Vlad - a113a4d](https://github.com/vghn/vscripts/commit/a113a4d9cacc51740daa5cde0294dad8ff297757))
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (C) 2014 Vlad Ghinea <vlad@ghn.me>
+
+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
+
+   http://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,65 @@
+# VScripts
+  [![Build Status](https://travis-ci.org/vghn/vscripts.svg?branch=master)](https://travis-ci.org/vghn/vscripts)
+  [![Code Climate](https://codeclimate.com/github/vghn/vscripts.png)](https://codeclimate.com/github/vghn/vscripts)
+
+Automation daemon.
+
+## Dependencies
+- Ruby >= 1.9.3
+- An AWS account (you'll need to create):
+  - A SNS Queue (optional, will attempt to create if can't be found)
+  - A Route53 zone.
+
+## Installing
+
+### Gem installation
+`gem install vscripts`
+
+
+## Usage
+
+```
+vscripts GLOBAL-OPTIONS COMMAND OPTIONS
+```
+
+
+### Global Options:
+```
+  -h|--help: Displays VScripts help.
+  -v|--version: Displays the version number.
+```
+
+
+### Commands:
+
+1. **Tags2Facts**
+  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.
+
+    > **Options**:
+    ```
+--file, -f <s>: The file that will store the tags (default:
+                /etc/facter/facts.d/ec2_tags.json)
+--all,  -a: Collect all tags
+--help, -h: Shows help
+    ```
+
+    > **EXAMPLES**:
+    ```
+$ vscripts tags2facts
+$ vscripts tags2facts --file /tmp/my_tags.json --all
+    ```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/vghn/vscripts/fork )
+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,19 @@
+RAKE_ROOT = File.dirname(__FILE__)
+$LOAD_PATH << File.join(RAKE_ROOT, 'tasks')
+
+# Load all tasks
+Dir['tasks/**/*.rake'].each { |task| load task }
+
+# Rake
+require 'rake/clean'
+# Bundler
+require "bundler/gem_tasks"
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+# Default task
+task :default do
+  puts `rake -T`
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/vscripts

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

data/lib/vscripts.rb

@@ -0,0 +1,12 @@
+require 'vscripts/command'
+require 'vscripts/command_line'
+
+# Main VScripts module
+module VScripts
+  # Gets the command name from command line and calls the right class.
+  def self.run(*args)
+    cli     = CommandLine.new(*args)
+    command = VScripts::Commands.const_get(cli.command).new(*cli.extra)
+    command.execute
+  end
+end # module VScripts

data/lib/vscripts/aws.rb

@@ -0,0 +1,10 @@
+require 'aws-sdk'
+require 'logger'
+require 'yaml'
+
+module VScripts
+  # Amazon Web Services Module
+  module AWS
+    ::AWS.config
+  end # module AWS
+end # module VScripts

data/lib/vscripts/aws/ec2.rb

@@ -0,0 +1,69 @@
+require 'vscripts/aws'
+require 'vscripts/aws/metadata'
+
+module VScripts
+  module AWS
+    # EC2 Class smells of :reek:UncommunicativeModuleName
+    # @ec2 smells of :reek:UncommunicativeVariableName
+
+    # AWS Elastic Compute Cloud
+    class EC2
+      include VScripts::AWS::Metadata
+
+      # Load AWS SDK for EC2
+      def initialize
+        @ec2 ||= ::AWS::EC2.new
+      end
+
+      # @return [AWS::EC2]
+      attr_reader :ec2
+
+      # Get instance object
+      def instance
+        check_instance
+        ec2.instances[instance_id]
+      end
+
+      # @return [AWS::EC2::ResourceTagCollection] Tags collection
+      def all_tags
+        instance.tags
+      end
+
+      # Get a list of tags
+      def tags_without(list = [])
+        all = all_tags
+        list.each { |excluded| all.delete(excluded) }
+        all
+      end
+
+      # Looks for the value of the 'Name' tag for the given instance
+      def name
+        all_tags_hash['Name']
+      end
+
+      # @return[AWS::EC2::InstanceCollection] Lists instances that have a
+      # 'Name' tag
+      def named_instances
+        ec2.instances.tagged('Name')
+      end
+
+      # @return[Array] Lists instances that are not terminated
+      def functional_instances
+        named_instances.map do |named_instance|
+          named_instance if [:running, :shutting_down, :stopping, :stopped]
+            .include?(named_instance.status)
+        end
+      end
+
+      # @return[Array] The 'Name' tag value except the local instance
+      def similar_instances
+        check_instance
+        functional_instances.map do |functional_instance|
+          if functional_instance.id != instance_id
+            functional_instance.tags['Name']
+          end
+        end
+      end
+    end # class EC2
+  end # module Amazon
+end # module VScripts

data/lib/vscripts/aws/metadata.rb

@@ -0,0 +1,50 @@
+require 'open-uri'
+require 'net/http'
+
+module VScripts
+  module AWS
+    # This module contacts the AWS Metadata service to collect information
+    # about the EC2 instance.
+    module Metadata
+      # @return [String] Metadata URL
+      def metadata_url
+        'http://instance-data/latest/meta-data'
+      end
+
+      # @return [String] Get availability zone from metadata
+      def zone
+        open("#{metadata_url}/placement/availability-zone")
+          .read
+      end
+
+      # @return [String] Get the region from the zone
+      def region
+        zone[/^(.*[\d])[a-z]$/, 1]
+      end
+
+      # @return [String] Get instance's ID from metadata
+      def instance_id
+        open("#{metadata_url}/instance-id").read
+      end
+
+      # @return [String] Get instance's public hostname from metadata
+      def public_hostname
+        open("#{metadata_url}/public-hostname").read
+      end
+
+      # @return [Boolean] Check connection to service
+      def ec2_instance?
+        Net::HTTP.get_response(URI.parse(metadata_url)) && true
+      rescue
+        false
+      end
+
+      # Fail if the current instance is not an EC2 instance
+      def check_instance
+        unless ec2_instance?
+          abort 'FATAL: NOT an EC2 instance or could not connect to Metadata'
+        end
+      end
+    end # module Metadata
+  end # module AWS
+end # module VScripts

data/lib/vscripts/command.rb

@@ -0,0 +1,14 @@
+require 'vscripts/commands/tags2facts'
+
+module VScripts
+  # Main Command class
+  class Command
+    # Lists the available commands
+    # @return [Array]
+    def self.list
+      VScripts::Commands.constants.select do |cls|
+        VScripts::Commands.const_get(cls).is_a? Class
+      end
+    end
+  end # class Command
+end # module VScripts

data/lib/vscripts/command_line.rb

@@ -0,0 +1,72 @@
+require 'trollop'
+require 'vscripts/command'
+
+module VScripts
+  # Global Command Line
+  class CommandLine
+    # @return [Hash] Global command line arguments
+    attr_reader :global
+    # @return [String] Command name
+    attr_reader :command
+    # @return [Array] Extra arguments passed to the command
+    attr_reader :extra
+
+    # Build command line arguments
+    def initialize(*args)
+      @global ||= parse(*args)
+      @command ||= check_command(*args)
+      @extra ||= rest(*args)
+    end
+
+    # Specifies command line options
+    # This method smells of :reek:NestedIterators but ignores them
+    # This method smells of :reek:TooManyStatements but ignores them
+    def parser # rubocop:disable MethodLength
+      available = Command.list
+      Trollop::Parser.new do
+        version VScripts::VERSION_C
+        banner <<-EOS
+VScripts automation daemon.
+
+Available commands:
+        #{available.map { |cmd| cmd.to_s.downcase }}
+
+Usage:
+  vscripts GLOBAL-OPTIONS COMMAND OPTIONS
+
+For help on an individual command:
+  vscripts COMMAND --help
+
+Global Options:
+EOS
+        stop_on available
+      end
+    end
+
+    # Parses command line arguments
+    def parse(*args)
+      Trollop.with_standard_exception_handling parser do
+        fail Trollop::HelpNeeded if args.empty?
+        parser.parse args
+      end
+    end
+
+    # Ensure command is available
+    # @return [String] Command name
+    def check_command(args)
+      command_cli = args.shift
+      command_cls = command_cli.capitalize.to_sym
+      if command_cli && Command.list.include?(command_cls)
+        return command_cls
+      else
+        puts "Error: Unknown subcommand '#{command_cli}'\nTry --help for help."
+        exit 1
+      end
+    end
+
+    # @return [Array] The rest of the arguments
+    def rest(args)
+      args
+    end
+  end # class CommandLine
+end # module VScripts

data/lib/vscripts/commands/tags2facts.rb

@@ -0,0 +1,84 @@
+require 'trollop'
+require 'vscripts/aws/ec2'
+require 'vscripts/util/local_system'
+
+module VScripts
+  # Commands module
+  module Commands
+    # @ec2 smells of :reek:UncommunicativeVariableName
+
+    # Tags2Facts Class
+    class Tags2facts
+      include VScripts::Util::LocalSystem
+
+      # 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.
+
+  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]
+
+  Options:
+      EOS
+
+      # @return [Hash] Command specific arguments
+      attr_reader :cli
+      # @return [AWS::EC2] EC2 SDK
+      attr_reader :ec2
+
+      def initialize(*args)
+        @cli ||= parse(*args)
+        @ec2 ||= VScripts::AWS::EC2.new
+      end
+
+      # Specifies command line options
+      def parser
+        Trollop::Parser.new do
+          banner USAGE
+          opt :file, 'The file that will store the tags',
+              type: :string, default: '/etc/facter/facts.d/ec2_tags.json'
+          opt :all, 'Collect all tags'
+          stop_on_unknown
+        end
+      end
+
+      # Parses command line arguments
+      def parse(*args)
+        Trollop.with_standard_exception_handling parser do
+          parser.parse args
+        end
+      end
+
+      # @return [Array] A list of tags to be excluded
+      def exclude_list
+        cli.all ? [] : %w(Name Domain)
+      end
+
+      # @return [Hash] Tags table
+      def tags_hash
+        ec2.tags_without(exclude_list).to_h
+      end
+
+      # @return [JSON] Formatted JSON
+      def tags_json
+        JSON.pretty_generate(tags_hash.to_h)
+      end
+
+      # Writes the formatted JSON to a file
+      def execute
+        file = cli.file
+        puts "Writing tags to \"#{file}\""
+        ensure_file_content(file, tags_json)
+        puts 'Done.'
+      end
+    end # class Tags2facts
+  end # module Commands
+end # module VScripts