instance_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd5d91e67f42c7c960085a25202475a656ddda67
+  data.tar.gz: 7dd8de44ef0d5d0d25c2e0f91544382a613d10d6
+SHA512:
+  metadata.gz: 5f955215f3b9f92d58e3a8c07ff4dc9451b71bb61e52cf242155095e5a92efe7323face2e47744d8a47241a906e2ef35b87389313a3ca5196afe7cb7ecf3d441
+  data.tar.gz: 5dc483f49d9506f6132c8688cda25d6a7f70bed088efc028783ff9d5ff177ffcb57ebb98a93e86b429e8e141f458927a6055d3b2fdcf1b79d3800290d6ad639e

data/.env.example

@@ -0,0 +1,2 @@
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.env

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in instance_finder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    instance-finder (0.1.0)
+      awesome_print (~> 1.8)
+      aws-sdk-ec2 (~> 1)
+      slop (~> 4.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    aws-partitions (1.52.0)
+    aws-sdk-core (3.13.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.24.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    coderay (1.1.2)
+    dotenv (2.2.1)
+    jmespath (1.3.1)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    slop (4.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv (~> 2.2)
+  instance-finder!
+  pry (~> 0.11)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Robert Coleman
+
+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,39 @@
+# Instance::Finder
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/instance/finder`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instance-finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instance-finder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/instance-finder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'instance_finder'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/instance_finder

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'instance_finder'
+require 'slop'
+require 'awesome_print'
+require 'csv'
+
+opts = Slop.parse do |o|
+  o.string '-t', '--tag-key', 'tag-key', required: true
+  o.string '-v', '--tag-value', 'tag-value', required: true
+  o.array '--states', 'a list of states', delimiter: ',', default: 'running'
+  o.string '-o', '--output-format', 'output format', default: 'csv'
+  o.array '--output-attributes', 'a list of attributes to output', delimiter: ',', default: 'private_ip_address'
+  o.separator ''
+  o.separator 'other options:'
+  o.on '--version' do
+    puts Instance::Finder::VERSION
+  end
+  o.on '--help' do
+    puts o
+    exit
+  end
+end
+
+results = Instance::Finder.instances({ opts[:tag_key] => opts[:tag_value] }, opts[:states])
+filtered_results = results.map do |hash|
+  hash.select do |key, value|
+    opts[:output_attributes].include? key.to_s
+  end
+end
+
+case opts[:output_format].downcase
+when 'csv'
+  csv_string = CSV.generate do |csv|
+    filtered_results.each do |hash|
+      csv << hash.values
+    end
+  end
+  puts csv_string
+when 'json'
+  puts JSON.pretty_generate filtered_results
+else
+  # output type not specified; PRs are welcome.
+  puts "Output format '#{opts[:output_format]}' doesn't exist. Valid options are CSV, JSON"
+end

data/instance_finder.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instance_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'instance_finder'
+  spec.version       = Instance::Finder::VERSION
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+
+  spec.summary       = %q{Find your EC2 instances based on tags}
+  spec.description   = %q{Find your EC2 instances based on tags - for CLI usage, Capistrano or as a library}
+  spec.homepage      = 'https://github.com/rjocoleman/instance-finder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'dotenv', '~> 2.2'
+
+  spec.add_dependency 'aws-sdk-ec2', '~> 1'
+  spec.add_dependency 'slop', '~> 4.6'
+  spec.add_dependency 'awesome_print', '~> 1.8'
+end

data/lib/instance_finder.rb

@@ -0,0 +1,63 @@
+require 'instance_finder/version'
+require 'aws-sdk-ec2'
+
+module Instance
+  class Finder
+    class << self
+      def instances(tags, states=['running'])
+        finder = Instance::Finder.new
+        finder.instances(tags, states)
+      end
+    end
+
+    def initialize
+      @ec2 = Aws::EC2::Client.new
+    end
+
+    def instances(tags, states=['running'])
+      output = []
+      results = @ec2.describe_instances filters: make_filters(tags, states)
+      results.reservations.each do |reservation|
+        reservation.instances.each do |instance|
+          output << {
+            instance_id: instance.instance_id,
+            private_ip_address: instance.private_ip_address,
+            private_dns_name: instance.private_dns_name,
+            public_ip_address: instance.public_ip_address,
+            public_dns_name: instance.public_dns_name,
+            subnet_id: instance.subnet_id,
+            vpc_id: instance.vpc_id,
+            availability_zone: instance.placement.availability_zone,
+            tags: coerce_tags(instance.tags),
+          }
+        end
+      end
+      output
+    end
+
+  private
+
+    def make_filters(tags, states)
+      filters = [
+        {
+          name: 'instance-state-name',
+          values: Array(states),
+        },
+      ]
+      tags.each do |key, value|
+        filters << {
+          name: "tag:#{key}",
+          values: Array(value),
+        }
+      end
+      filters
+    end
+
+    def coerce_tags(tags)
+      tags.map do |tag|
+        { tag.key => tag.value }
+      end
+    end
+
+  end
+end

data/lib/instance_finder/version.rb

@@ -0,0 +1,5 @@
+module Instance
+  class Finder
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: instance_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Find your EC2 instances based on tags - for CLI usage, Capistrano or
+  as a library
+email:
+- github@robert.net.nz
+executables:
+- instance_finder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/instance_finder
+- instance_finder.gemspec
+- lib/instance_finder.rb
+- lib/instance_finder/version.rb
+homepage: https://github.com/rjocoleman/instance-finder
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Find your EC2 instances based on tags
+test_files: []