ec2-host 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94ae5ab54d79d7e269102382f12b40c31f16c349
+  data.tar.gz: 14ccb9795b4629b607899c7192ad1567e50c4132
+SHA512:
+  metadata.gz: 82e4d30e8df2b2311146a37db0e13e6adac9f70383fb892f4342908401ef37582b4c4ff30defc1f56265f559ba7d7954540b2fc21b0646088b89a94b22aad952
+  data.tar.gz: 43d10651c6b326ff1ab898e0807c366926288b3b7fefed673ce04a006eeb7a1b4f1e0523158e4e09cb01f83708b8a844706945c69617c61e9ebfe39966e4adc6

data/.gitignore

@@ -0,0 +1,17 @@
+*~
+.bundle
+.pryrc
+.rvmrc
+.rbenv-version
+.ruby-version
+.yardoc
+.DS_Store
+Gemfile.lock
+coverage
+doc
+log
+tmp
+vendor
+*.swp
+pkg/
+.env

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (2015/08/10)
+
+first version

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naotoshi Seo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# ec2-host
+
+Search hosts on AWS EC2
+
+## Installation
+
+```
+gem install ec2-host
+```
+
+## Configuration
+
+You can write a configuration file located at `/etc/sysconfig/ec2-host` (You can configure this path by `EC2_HOST_CONFIG_FILE` environment variable), or as environment variables:
+
+AWS SDK (CLI) parameters:
+
+* **AWS_REGION**; AWS SDK (CLI) region such as `ap-northeast-1`, `us-east-1`. 
+* **AWS_ACCESS_KEY_ID**: AWS SDK (CLI) crendentials. Default loads a credentials file
+* **AWS_SECRET_ACCESS_KEY**: AWS SDK (CLI) credentials. Default load a credentials file
+* **AWS_PROFILE**: The profile key of the AWS SDK (CLI) credentails file. Default is `default`
+* **AWS_CREDENTIALS_FILE**: Path of the AWS SDK (CLI) credentails file. Default is `$HOME/.aws/credentials`. See [Configuring the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) for details. 
+
+ec2-host parameters:
+
+* **HOSTNAME_TAG**: EC2 tag key used to express a hostname. The default is `Name`.
+* **ROLES_TAG**: EC2 tag keys used to express roles. The default is `Roles`
+  * You can assign multiple roles seperated by `,` comma
+  * Also, you can express levels of roles delimited by `:`.
+  * Example: admin:ami, then `EC2::Host.new(role: 'admin:ami')` and also `EC2::Host.new(role1: 'admin')` returns this host
+* **OPTIONAL_STRING_TAGS**: You may add optional non-array tags. You can specify multiple tags like `Service,Status`. 
+* **OPTIONAL_ARRAY_TAGS**: You may add optional array tags. Array tags allows multiple values delimited by `,` (comma) as `Roles` tag.
+* **LOG_LEVEL**: Log level such as `info`, `debug`, `error`. The default is `info`. 
+
+See [sampel.conf](./sample.conf)
+
+## Tag Example
+
+* **Name**: hostname
+* **Roles**: app:web,app:db
+* **Service**: sugoi
+* **Status**: setup
+
+## CLI Usage
+
+```
+$ ec2-host --role1 admin
+host1
+ip-XXX-XXX-XXX-XXX # if Name tag is not assigned
+```
+
+See `ec2-host help get-hosts` for details:
+
+```
+Usage:
+  ec2-host get-hosts
+
+Options:
+  -h, [--hostname=one two three]                 # name or private_dns_name
+  --usage, [--role=one two three]                # role
+  --r1, --usage1, --u1, [--role1=one two three]  # role1, the 1st part of role delimited by :
+  --r2, --usage2, --u2, [--role2=one two three]  # role2, the 2nd part of role delimited by :
+  --r3, --usage3, --u3, [--role3=one two three]  # role3, the 3rd part of role delimited by :
+  -i, [--info], [--no-info]                      # show host info, not only hostname
+              [--debug], [--no-debug]            # debug mode
+
+Search EC2 hosts
+```
+
+## Library Usage
+
+See http://sonots.github.io/ec2-host/doc/frames.html.
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## For Developers
+
+### ToDo
+
+* Support assume-roles
+* Use mock/stub to run test (currently, directly accessing to EC2)
+* Should cache a result of describe-instances in like 30 seconds?
+
+### How to Run test
+
+See [spec/README.md](spec/README.md)
+
+### How to Release Gem
+
+1. Update gem.version in the gemspec
+2. Update CHANGELOG.md
+3. git commit && git push
+4. Run `bundle exec rake release`
+
+### How to Update doc
+
+1. Run `./doc.sh`
+2. git commit && git push (to gh-pages branch)
+
+### Licenses
+
+See [LICENSE](LICENSE)
+

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- coding: utf-8; -*-
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new :spec do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+  task default: :spec
+rescue LoadError, NameError
+  # OK, they can be absent on non-development mode.
+end
+
+desc "irb console"
+task :console do
+  require_relative "lib/ec2-host"
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+task :c => :console
+
+desc "pry console"
+task :pry do
+  require_relative "lib/ec2-host"
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/bin/ec2-host

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/ec2/host/cli'
+EC2::Host::CLI.start(ARGV)

data/doc.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+bundle exec yardoc
+rsync -au --delete doc/ /tmp/doc
+git checkout gh-pages
+rsync -au --delete /tmp/doc/ doc

data/ec2-host.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |gem|
+  gem.name          = "ec2-host"
+  gem.version       = '0.0.1'
+  gem.author        = ['Naotoshi Seo']
+  gem.email         = ['sonots@gmail.com']
+  gem.homepage      = 'https://github.com/sonots/ec2-host'
+  gem.summary       = "Search hosts on AWS EC2"
+  gem.description   = "Search hosts on AWS EC2"
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'aws-sdk'
+  gem.add_runtime_dependency 'hashie'
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'dotenv'
+
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
+end

data/example/aws-sdk.rb

@@ -0,0 +1,15 @@
+require 'pp'
+require 'aws-sdk'
+require 'dotenv'
+Dotenv.load
+
+# Aws.config.update({
+#     region: 'us-west-2',
+#       credentials: Aws::Credentials.new('akid', 'secret'),
+# })
+
+ec2 = Aws::EC2::Client.new
+pp instances = ec2.describe_instances.reservations.map(&:instances)
+
+require 'pry'
+binding.pry

data/example/example.rb

@@ -0,0 +1,6 @@
+require 'ec2-host'
+require 'pp'
+
+EC2::Host.new(role1: 'admin').each do |host|
+  pp host
+end

data/lib/ec2-host.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+
+require_relative 'ec2/host/string_util'
+require_relative 'ec2/host/hash_util'
+require_relative 'ec2/host/config'
+require_relative 'ec2/host/host_data'
+require_relative 'ec2/host/role_data'
+require_relative 'ec2/host/client_util'
+require_relative 'ec2/host'

data/lib/ec2/host.rb

@@ -0,0 +1,113 @@
+class EC2
+  # Search EC2 hosts from tags
+  #
+  #     require 'ec2-host'
+  #     # Search by `Name` tag
+  #     EC2::Host.new(hostname: 'test').first # => test
+  #
+  #     # Search by `Roles` tag
+  #     EC2::Host.new(
+  #       role: 'admin:haikanko',
+  #     ).each do |host|
+  #       # ...
+  #     end
+  #
+  #     or
+  #
+  #     EC2::Host.new(
+  #       role1: 'admin',
+  #       role2: 'haikanko',
+  #     ).each do |host|
+  #       # ...
+  #     end
+  #
+  #     # Or search
+  #     EC2::Host.new(
+  #       {
+  #           role1: 'db',
+  #           role2: 'master',
+  #       },
+  #       {
+  #           role1: 'web',
+  #       }
+  #     ).each do |host|
+  #         # ...
+  #     end
+  #
+  #     EC2::Host.me.hostname # => 'test'
+  class Host
+    include Enumerable
+
+    # @return [Host::Data] representing myself
+    def self.me
+      new(instance_id: ClientUtil.get_instance_id).each do |d|
+        return d
+      end
+      raise 'Not Found'
+    end
+
+    # Configure EC2::Host
+    #
+    # @params [Hash] params see EC2::Host::Config for configurable parameters
+    def self.configure(params = {})
+      Config.configure(params)
+    end
+
+    ARRAY_TAG_DELIMITER = ','
+    ROLE_TAG_DELIMITER = ':'
+
+    attr_reader :conditions, :options
+
+    # @param [Array of Hash, or Hash] conditions (and options)
+    #
+    #     EC2::Host.new(
+    #       hostname: 'test',
+    #       options: {a: 'b'}
+    #     )
+    #
+    #     EC2::Host.new(
+    #       {
+    #         hostname: 'foo',
+    #       },
+    #       {
+    #         hostname: 'bar',
+    #       },
+    #       options: {a: 'b'}
+    #     )
+    def initialize(*conditions)
+      conditions = [{}] if conditions.empty?
+      conditions = [conditions] if conditions.kind_of?(Hash)
+      @options = {}
+      if conditions.size == 1
+        @options = conditions.first.delete(:options) || {}
+      else
+        index = conditions.find_index {|condition| condition.has_key?(:options) }
+        @options = conditions.delete_at(index)[:options] if index
+      end
+      raise ArgumentError, "Hash expected (options)" unless @options.is_a?(Hash)
+      @conditions = []
+      conditions.each do |condition|
+        @conditions << Hash[condition.map {|k, v| [k, Array(v).map(&:to_s)]}]
+      end
+      raise ArgumentError, "Array of Hash, or Hash expected (conditions)" unless @conditions.all? {|h| h.kind_of?(Hash)}
+    end
+
+    # @yieldparam [Host::Data] data entry
+    def each(&block)
+      @conditions.each do |condition|
+        search(ClientUtil.get_instances, condition, &block)
+      end
+      return self
+    end
+
+    private
+
+    def search(instances, condition)
+      instances.each do |i|
+        d = EC2::Host::HostData.initialize(i)
+        next unless d.match?(condition)
+        yield d
+      end
+    end
+  end
+end

data/lib/ec2/host/cli.rb

@@ -0,0 +1,74 @@
+require 'thor'
+require 'ec2-host'
+
+class EC2
+  class Host
+    class CLI < Thor
+      default_command :get_hosts
+
+      desc 'get-hosts', 'Search EC2 hosts (default)'
+      option :hostname,
+        :aliases => '-h',
+        :type => :array,
+        :desc => "name or private_dns_name"
+      option :role,
+        :aliases => %w[--usage],
+        :type => :array,
+        :desc => "role"
+      option :role1,
+        :aliases => %w[--r1 --usage1 --u1], # hmm, -r1 is not suppored by thor
+        :type => :array,
+        :desc => "role1, the 1st part of role delimited by #{ROLE_TAG_DELIMITER}"
+      option :role2,
+        :aliases => %w[--r2 --usage2 --u2],
+        :type => :array,
+        :desc => "role2, the 2nd part of role delimited by #{ROLE_TAG_DELIMITER}"
+      option :role3,
+        :aliases => %w[--r3 --usage3 --u3],
+        :type => :array,
+        :desc => "role3, the 3rd part of role delimited by #{ROLE_TAG_DELIMITER}"
+      Config.optional_options.each do |opt, tag|
+        option opt, :type => :array, :desc => opt
+      end
+      option :info,
+        :aliases => %w[-i],
+        :type => :boolean,
+        :desc => "show host info, not only hostname"
+      option :debug,
+        :type => :boolean,
+        :desc => "debug mode"
+      def get_hosts
+        if options[:info]
+          EC2::Host.new(condition).each do |host|
+            $stdout.puts host.info
+          end
+        else
+          EC2::Host.new(condition).each do |host|
+            $stdout.puts host.hostname
+          end
+        end
+      end
+
+      private
+
+      def condition
+        return @condition if @condition
+        _condition = HashUtil.except(options, :info, :debug)
+        @condition = {}
+        _condition.each do |key, val|
+          if tag = Config.optional_options[key.to_s]
+            field = StringUtil.underscore(tag)
+            @condition[field.to_sym] = val
+          else
+            @condition[key.to_sym] = val
+          end
+        end
+        if options[:debug]
+          $stderr.puts(options: options)
+          $stderr.puts(condition: @condition)
+        end
+        @condition
+      end
+    end
+  end
+end

data/lib/ec2/host/client_util.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'aws-sdk'
+
+class EC2
+  class Host
+    class ClientUtil
+      def self.get_instances
+        # I do not use describe_instances(filter:) because it does not support array tag ..
+        return @instances if @instances
+        Aws.config.update(region: Config.aws_region, credentials: Config.aws_credentials)
+        ec2 = Aws::EC2::Client.new
+        @instances = ec2.describe_instances.reservations.map(&:instances).flatten
+      end
+
+      def self.get_instance_id
+        return @instance_id if @instance_id
+        begin
+          http_conn = Net::HTTP.new('169.254.169.254')
+          http_conn.open_timeout = 5
+          @instance_id = http_conn.start {|http| http.get('/latest/meta-data/instance-id').body }
+        rescue Net::OpenTimeout
+          raise "HTTP connection to 169.254.169.254 is timeout. Probably, not an EC2 instance?"
+        end
+      end
+    end
+  end
+end

data/lib/ec2/host/config.rb

@@ -0,0 +1,111 @@
+require 'dotenv'
+Dotenv.load
+
+class EC2
+  class Host
+    class Config
+      class << self
+        attr_writer :config_file,
+          :aws_region,
+          :aws_profile,
+          :aws_access_key_id,
+          :aws_secret_access_key,
+          :aws_credentials_file,
+          :log_level,
+          :hostname_tag,
+          :roles_tag,
+          :optional_array_tags,
+          :optional_string_tags
+      end
+
+      def self.configure(params)
+        params.each do |key, val|
+          send("#{key}=", val)
+        end
+      end
+
+      def self.config_file
+        @config_file ||= ENV.fetch('EC2_HOST_CONFIG_FILE', '/etc/sysconfig/ec2-host')
+      end
+
+      def self.aws_region
+        @aws_region ||= ENV['AWS_REGION'] || config.fetch('AWS_REGION')
+      end
+
+      def self.aws_profile
+        @aws_profile ||= ENV['AWS_PROFILE'] || config.fetch('AWS_PROFILE', 'default')
+      end
+
+      def self.aws_access_key_id
+        @aws_access_key_id ||= ENV['AWS_ACCESS_KEY_ID'] || config.fetch('AWS_ACCESS_KEY_ID', nil)
+      end
+
+      def self.aws_secret_access_key
+        @aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY'] || config.fetch('AWS_SECRET_ACCESS_KEY', nil)
+      end
+
+      # this is not an official aws sdk environment variable
+      def self.aws_credentials_file
+        @aws_credentials_file ||= ENV['AWS_CREDENTIALS_FILE'] || config.fetch('AWS_CREDENTIALS_FILE', nil)
+      end
+
+      def self.log_level
+        @log_level ||= ENV['LOG_LEVEL'] || config.fetch('LOG_LEVEL', 'info')
+      end
+
+      def self.hostname_tag
+        @hostname_tag ||= ENV['HOSTNAME_TAG'] || config.fetch('HOSTNAME_TAG', 'Name')
+      end
+
+      def self.roles_tag
+        @roles_tag ||= ENV['ROLES_TAG'] || config.fetch('ROLES_TAG', 'Roles')
+      end
+
+      def self.optional_array_tags
+        @optional_array_tags ||= (ENV['OPTIONAL_ARRAY_TAGS'] || config.fetch('OPTIONAL_ARRAY_TAGS', '')).split(',')
+      end
+
+      def self.optional_string_tags
+        @optional_string_tags ||= (ENV['OPTIONAL_STRING_TAGS'] || config.fetch('OPTIONAL_STRING_TAGS', '')).split(',')
+      end
+
+      # private
+
+      def self.aws_credentials
+        @aws_credentials ||=
+          if aws_access_key_id and aws_secret_access_key
+            Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
+          else
+            Aws::SharedCredentials.new(profile_name: aws_profile, path: aws_credentials_file)
+          end
+      end
+
+      def self.optional_array_options
+        @optional_array_options ||= Hash[optional_array_tags.map {|tag|
+          [StringUtil.singularize(StringUtil.underscore(tag)), tag]
+        }]
+      end
+
+      def self.optional_string_options
+        @optional_string_options ||= Hash[optional_string_tags.map {|tag|
+          [StringUtil.underscore(tag), tag]
+        }]
+      end
+
+      def self.optional_options
+        @optional_options ||= optional_array_options.merge(optional_string_options)
+      end
+
+      def self.config
+        return @config if @config
+        @config = {}
+        File.readlines(config_file).each do |line|
+          next if line.start_with?('#')
+          key, val = line.chomp.split('=', 2)
+          @config[key] = val
+        end
+        @config
+      end
+    end
+  end
+end

data/lib/ec2/host/hash_util.rb

@@ -0,0 +1,11 @@
+class EC2
+  class Host
+    module HashUtil
+      def self.except(hash, *keys)
+        hash = hash.dup
+        keys.each {|key| hash.delete(key) }
+        hash
+      end
+    end
+  end
+end

data/lib/ec2/host/host_data.rb

@@ -0,0 +1,128 @@
+require 'forwardable'
+require 'hashie/mash'
+
+class EC2
+  class Host
+    # Represents each host
+    class HostData < Hashie::Mash
+      # :hostname, # tag:Name or hostname part of private_dns_name
+      # :roles,    # tag:Roles.split(',') such as web:app1,db:app1
+      # :region,   # ENV['AWS_REGION'],
+      # :instance, # Aws::EC2::Types::Instance itself
+      #
+      # and OPTIONAL_ARRAY_TAGS, OPTIONAL_STRING_TAGS
+
+      extend Forwardable
+      def_delegators :instance,
+        :instance_id,
+        :private_ip_address,
+        :public_ip_address,
+        :launch_time,
+        :state,
+        :monitoring
+
+      alias_method :ip, :private_ip_address
+      alias_method :start_date, :launch_time
+      def usages; roles; end
+
+      def self.initialize(instance)
+        d = self.new
+        d.instance = instance
+        d.set_hostname
+        d.set_roles
+        d.set_region
+        d.set_string_tags
+        d.set_array_tags
+        d
+      end
+
+      # match with condition or not
+      #
+      # @param [Hash] condition search parameters
+      def match?(condition)
+        return false unless role_match?(condition)
+        condition = HashUtil.except(condition,
+          :role, :role1, :role2, :role3,
+          :usage, :usage1, :usage2, :usage3
+        )
+        condition.each do |key, values|
+          if self.send(key).is_a?(Array)
+            return false unless self.send(key).find {|v| values.include?(v) }
+          else
+            return false unless values.include?(self.send(key))
+          end
+        end
+        true
+      end
+
+      def inspect
+        sprintf "#<Aws::Host::HostData %s>", info
+      end
+
+      def info
+        if hostname and status and roles and tags and service
+          # special treatment for DeNA ;)
+          sprintf "%s:%s(%s)[%s]{%s}", \
+            hostname, status, roles.join(' '), tags.join(' '), service
+        else
+          HashUtil.except(self, :instance).to_s
+        end
+      end
+
+      # private
+
+      def role_match?(condition)
+        # usage is an alias of role
+        if role = (condition[:role] || condition[:usage])
+          role1, role2, role3 = role.first.split(':')
+        else
+          role1 = (condition[:role1] || condition[:usage1] || []).first
+          role2 = (condition[:role2] || condition[:usage2] || []).first
+          role3 = (condition[:role3] || condition[:usage3] || []).first
+        end
+        if role1
+          return false unless self.roles.find {|role| role.match?(role1, role2, role3) }
+        end
+        true
+      end
+
+      def set_hostname
+        self.hostname = find_string_tag(Config.hostname_tag)
+        self.hostname = instance.private_dns_name.split('.').first if self.hostname.empty?
+      end
+
+      def set_roles
+        roles  = find_array_tag(Config.roles_tag)
+        self.roles = roles.map {|role| EC2::Host::RoleData.initialize(role) }
+      end
+
+      def set_region
+        self.region = Config.aws_region
+      end
+
+      def set_string_tags
+        Config.optional_string_tags.each do |tag|
+          field = StringUtil.underscore(tag)
+          self[field] = find_string_tag(tag)
+        end
+      end
+
+      def set_array_tags
+        Config.optional_array_tags.each do |tag|
+          field = StringUtil.underscore(tag)
+          self[field] = find_array_tag(tag)
+        end
+      end
+
+      def find_string_tag(key)
+        v = instance.tags.find {|tag| tag.key == key }
+        v ? v.value : ''
+      end
+
+      def find_array_tag(key)
+        v = instance.tags.find {|tag| tag.key == key }
+        v ? v.value.split(ARRAY_TAG_DELIMITER) : []
+      end
+    end
+  end
+end

data/lib/ec2/host/role_data.rb

@@ -0,0 +1,60 @@
+class EC2
+  class Host
+    RoleData = Struct.new(
+      :role1, :role2, :role3
+    )
+
+    # Represents each role
+    class RoleData
+      def self.initialize(role)
+        role1, role2, role3 = role.split(ROLE_TAG_DELIMITER)
+        self.new(role1, role2, role3)
+      end
+
+      # @return [String] something like "admin:jenkins:slave"
+      def role
+        @role ||= [role1, role2, role3].compact.reject(&:empty?).join(ROLE_TAG_DELIMITER)
+      end
+      alias :to_s :role
+
+      # @return [Array] something like ["admin", "admin:jenkins", "admin:jenkins:slave"]
+      def uppers
+        uppers = [RoleData.new(role1)]
+        uppers << RoleData.new(role1, role2) if role2 and !role2.empty?
+        uppers << RoleData.new(role1, role2, role3) if role3 and !role3.empty?
+        uppers
+      end
+
+      def match?(role1, role2 = nil, role3 = nil)
+        if role3
+          role1 == self.role1 and role2 == self.role2 and role3 == self.role3
+        elsif role2
+          role1 == self.role1 and role2 == self.role2
+        else
+          role1 == self.role1
+        end
+      end
+
+      # Equality
+      #
+      #     Role::Data.new('admin') == Role::Data.new('admin') #=> true
+      #     Role::Data.new('admin', 'jenkin') == "admin:jenkins" #=> true
+      #
+      # @param [Object] other
+      def ==(other)
+        case other
+        when String
+          self.role == other
+        when EC2::Host::RoleData
+          super(other)
+        else
+          false
+        end
+      end
+
+      def inspect
+        "\"#{to_s}\""
+      end
+    end
+  end
+end

data/lib/ec2/host/string_util.rb

@@ -0,0 +1,31 @@
+class EC2
+  class Host
+    # If want sophisticated utility, better to use ActiveSupport
+    module StringUtil
+      def self.camelize(string)
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { $2.capitalize }
+        string.gsub!(/\//, '::')
+        string
+      end
+
+      def self.underscore(camel_cased_word)
+        return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+        word = camel_cased_word.to_s.gsub(/::/, '/')
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+      def self.pluralize(string)
+        "#{string.chomp('s')}s"
+      end
+
+      def self.singularize(string)
+        string.chomp('s')
+      end
+    end
+  end
+end

data/sample.conf

@@ -0,0 +1,8 @@
+AWS_ACCESS_KEY_ID=xxxxxxx
+AWS_SECRET_ACCESS_KEY=xxxxxx
+AWS_REGION=ap-northeast-1
+HOSTNAME_TAG=Name
+ROLES_TAG=Roles
+OPTIONAL_ARRAY_TAGS=Tags
+OPTIONAL_STRING_TAGS=Service,Status
+LOG_LEVEL=info

data/spec/README.md

@@ -0,0 +1,35 @@
+# How to run test
+
+NOTE: Currently, mock is not supported yet. So, you have to create your own AWS account, and instances.
+
+Configure .env file as
+
+```
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
+EC2_HOST_CONFIG_FILE=.env
+OPTIONAL_ARRAY_TAGS=Tags
+OPTIONAL_STRING_TAGS=Service,Status
+```
+
+EC2 instance tags must be configured as followings:
+
+```
+[
+  {
+    Name: test
+    Roles: admin:admin,test
+    Service: test
+    Status: reserve
+    Tags: standby
+  }
+  {
+    Name: isucon4
+    Roles: isucon4:qual
+    Service: isucon4
+    Status: active
+    Tags: master
+  }
+]
+```

data/spec/host_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+shared_examples_for 'host' do
+  it 'should have parameters' do
+    [ :hostname,
+      :roles,
+      :status,
+      :tags,
+      :service,
+      :region,
+      :instance,
+      :instance_id,
+      :private_ip_address,
+      :public_ip_address,
+      :launch_time,
+      :state,
+      :monitoring,
+      :ip,
+      :start_date,
+      :usages,
+    ].each do |k|
+      expect{ subject.__send__(k) }.not_to raise_error
+    end
+  end
+end
+
+describe EC2::Host do
+  describe 'options' do
+    context do
+      let(:subject) { EC2::Host.new(hostname: 'test', options: {foo:'bar'}) }
+      it { expect(subject.options).to eq({foo:'bar'}) }
+      it { expect(subject.conditions).to eq([{hostname: ['test']}]) }
+    end
+
+    context do
+      let(:subject) { EC2::Host.new({hostname: 'foo'}, {hostname: 'bar'}, options: {foo:'bar'}) }
+      it { expect(subject.options).to eq({foo:'bar'}) }
+      it { expect(subject.conditions).to eq([{hostname: ['foo']}, {hostname: ['bar']}]) }
+    end
+  end
+
+  context 'by hostname' do
+    let(:hosts) { EC2::Host.new(hostname: 'test').to_a }
+    let(:subject)  { hosts.first }
+    it_should_behave_like 'host'
+    it { expect(hosts.size).to eq(1) }
+    it { expect(subject.hostname).to eq('test') }
+  end
+
+  context 'by role' do
+    context 'by a role' do
+      let(:subject) { EC2::Host.new(role1: 'admin').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple roles (or)' do
+      let(:hosts) {
+        EC2::Host.new(
+          {
+            role1: 'admin',
+            role2: 'ami',
+          },
+          {
+            role1: 'isucon4',
+          }
+        ).to_a
+      }
+      let(:subject) { hosts.first }
+      it { expect(hosts.size).to be >= 2 }
+      it_should_behave_like 'host'
+    end
+  end
+
+  # This is for DeNA use
+  context 'by usage (an alias of usage)' do
+    context 'by a usage' do
+      let(:subject) { EC2::Host.new(usage1: 'admin').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple usages (or)' do
+      let(:hosts) {
+        EC2::Host.new(
+          {
+            usage1: 'admin',
+            usage2: 'ami',
+          },
+          {
+            usage1: 'isucon4',
+          }
+        ).to_a
+      }
+      let(:subject) { hosts.first }
+      it { expect(hosts.size).to be >= 2 }
+      it_should_behave_like 'host'
+    end
+  end
+
+  context 'by status' do
+    context 'by a status' do
+      let(:subject) { EC2::Host.new(status: :active).first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple status (or)' do
+      let(:hosts) { EC2::Host.new(status: [:reserve, :active]).to_a }
+      let(:subject) { hosts.first }
+      it_should_behave_like 'host'
+      it { expect(hosts.size).to be >= 2 }
+    end
+
+    context 'by a string status' do
+      let(:subject) { EC2::Host.new(status: 'active').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple string status (or)' do
+      let(:hosts) { EC2::Host.new(status: ['reserve', 'active']).to_a }
+      let(:subject) { hosts.first }
+      it_should_behave_like 'host'
+      it { expect(hosts.size).to be >= 2 }
+    end
+  end
+
+  context 'by service' do
+    context 'by a service' do
+      let(:subject) { EC2::Host.new(service: 'isucon4').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple services (or)' do
+      let(:hosts) { EC2::Host.new(service: ['test', 'isucon4']) }
+      let(:subject) { hosts.first }
+      it_should_behave_like 'host'
+    end
+  end
+
+  context 'by region' do
+    context 'by a region' do
+      let(:subject) { EC2::Host.new(region: 'ap-northeast-1').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple regions (or)' do
+      let(:hosts) { EC2::Host.new(region: ['ap-northeast-1']) }
+      let(:subject) { hosts.first }
+      it_should_behave_like 'host'
+    end
+  end
+
+  context 'by tags' do
+    context 'by a tag' do
+      let(:subject) { EC2::Host.new(tags: 'master').first }
+      it_should_behave_like 'host'
+    end
+
+    context 'by multiple tags (or)' do
+      let(:hosts) { EC2::Host.new(tags: ['standby', 'master']) }
+      let(:subject) { hosts.first }
+      it_should_behave_like 'host'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV['RACK_ENV'] = 'test'
+Bundler.require :test
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'vendor/'
+  add_filter 'spec/'
+  add_group 'libs', 'lib'
+end
+
+Bundler.require :default # <- need this *after* simplecov
+require 'pry'
+require 'ec2-host'
+require 'dotenv'
+Dotenv.load
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: ec2-host
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search hosts on AWS EC2
+email:
+- sonots@gmail.com
+executables:
+- ec2-host
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ec2-host
+- doc.sh
+- ec2-host.gemspec
+- example/aws-sdk.rb
+- example/example.rb
+- lib/ec2-host.rb
+- lib/ec2/host.rb
+- lib/ec2/host/cli.rb
+- lib/ec2/host/client_util.rb
+- lib/ec2/host/config.rb
+- lib/ec2/host/hash_util.rb
+- lib/ec2/host/host_data.rb
+- lib/ec2/host/role_data.rb
+- lib/ec2/host/string_util.rb
+- sample.conf
+- spec/README.md
+- spec/host_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/ec2-host
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Search hosts on AWS EC2
+test_files:
+- spec/README.md
+- spec/host_spec.rb
+- spec/spec_helper.rb
+has_rdoc: