furikake 0.0.1

data/README.md

@@ -0,0 +1,123 @@
+# Furikake [![Build Status](https://travis-ci.org/inokappa/furikake.svg?branch=master)](https://travis-ci.org/inokappa/furikake)
+![](https://raw.githubusercontent.com/inokappa/furikake/master/docs/images/furikake.png)
+
+## これなに
+
+* 利用している AWS リソースを Backlog の Wiki ページ (Markdown フォーマットのみ) に良しなに纏めてドキュメント化してくれるコマンドラインツールです
+* 簡単なコードを追加することで, 取得する AWS リソースを増やすことが出来るようにはしています
+* Backlog Wiki 以外にも登録出来るようにはしています
+
+## Install
+
+とりあえずは, `git clone` してきて `bundle install` する感じでお願い致します.
+
+```sh
+$ git clone git@github.com:inokappa/furikake.git
+$ bundle install --path vendor/bundle
+```
+
+## Usage
+
+### Create Wiki Page
+
+* Backlog の wiki を作成し, wiki ID を控えておく (後の .furikake.yml で利用する)
+
+### Write .envrc
+
+とりあえずは, direnv と組み合わせて利用することを想定しており, AWS のクレデンシャル情報は .envrc に記載して下さい.
+
+```sh
+export AWS_PROFILE=your-profile
+export AWS_REGION=ap-northeast-1
+```
+
+### Write .frikake.yml
+
+カレントディレクトリに, 以下のような内容で .furikake.yml を作成して下さい.
+
+```yaml
+backlog:
+  projects:
+    - space_id: 'your-backlog-space-id'
+      api_key: 'your-backlog-api-key'
+      top_level_domain: 'your-backlog-top-level-domain'
+      wiki_id: your-wiki-id
+      wiki_name: 'your-wiki-name'
+      header: >
+        # Test Header
+      footer: >
+        # Test Footer
+```
+
+### Run
+
+```sh
+# ドキュメント化する情報を標準出力に出力する
+bundle exec furikake show
+
+# ドキュメント化する情報を wiki に登録する
+bundle exec furikake publish
+```
+
+## Tips
+
+### リソース追加
+
+`lib/furikake/resources/` 以下に任意のファイル名でコードを追加することで, ドキュメント化する対象のリソースを追加することが出来ます.
+
+```ruby
+module Furikake
+  module Resources
+    module Ec2
+      def report(format = nil)
+        instance = get_resources
+        contents = {
+          title: 'EC2',
+          resources: [
+            {
+               subtitle: '',
+               header: ['Name', 'Instance ID', 'Instance Type',
+                        'Availability Zone', 'Private IP Address',
+                        'Public IP Address', 'State'],
+               resource: instance
+            }
+          ]
+        }
+        Furikake::Formatter.shaping(format, contents)
+      end
+
+      def get_resources
+        ec2 = Aws::EC2::Client.new
+        params = {}
+        instances = []
+        loop do
+          res = ec2.describe_instances(params)
+...
+```
+
+report メソッドには, 一覧化する際のヘッダを `header` に配列で指定します. get_resources メソッドにドキュメント化したいリソースの一覧を取得する為の処理を追加します. 戻り値は, 以下のようなフォーマットになるように実装して下さい.
+
+```
+[['ID', 'Name', 'Status'], ['ID', 'Name', 'Status'], ['ID', 'Name', 'Status']]
+```
+
+## Todo
+
+* エラー処理
+* デーモン化
+* Backlog Wiki 以外の Wiki (例えば, Github Wiki や Gist 等)
+* テスト追加
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/furikake.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "furikake"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/furikake

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'furikake'
+
+Furikake::CLI.start

data/furikake.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "furikake/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "furikake"
+  spec.version       = Furikake::VERSION
+  spec.authors       = ["inokappa"]
+  spec.email         = ["inokara@gmail.com"]
+
+  spec.summary       = %q{It is a command line tool to register your resources in Wiki page (Markdown format).}
+  spec.description   = %q{It is a command line tool to register your resources in Wiki page (Markdown format).}
+  spec.homepage      = "https://github.com/inokappa/furikake"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "rspec", "~> 3.0"
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'markdown-tables'
+  spec.add_dependency 'backlog_kit'
+end

data/lib/furikake/cli.rb

@@ -0,0 +1,22 @@
+require 'furikake'
+
+module Furikake
+  class CLI < Thor
+    desc 'version', 'version print.'
+    def version
+      puts Furikake::VERSION
+    end
+
+    desc 'show', 'resouces print.'
+    def show
+      report = Furikake::Report.new
+      report.show
+    end
+
+    desc 'publish', 'resouces publish to something.'
+    def publish
+      report = Furikake::Report.new
+      report.publish
+    end
+  end
+end

data/lib/furikake/config.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module Furikake
+  module Config
+    def read_furikake_yaml
+      open('.furikake.yml', 'r') { |f| YAML.load(f) }
+    end
+  end
+end

data/lib/furikake/formatter.rb

@@ -0,0 +1,9 @@
+require 'furikake/formatters/markdown'
+
+module Furikake
+  class Formatter
+    def self.shaping(format, contents)
+      Furikake::Formatters::Markdown.write(contents) if format.nil?
+    end
+  end
+end

data/lib/furikake/formatters/csv.rb

@@ -0,0 +1,9 @@
+module Furikake
+  module Formatters
+    class Csv
+      def self.wirte(c)
+        c
+      end
+    end
+  end
+end

data/lib/furikake/formatters/markdown.rb

@@ -0,0 +1,30 @@
+require 'erb'
+require 'markdown-tables'
+
+module Furikake
+  module Formatters
+    class Markdown
+      def self.write(c)
+        contents = <<EOS
+### <%= c[:title] %>
+
+<%- c[:resources].each do |r| -%>
+<%- if r[:subtitle] != '' -%>
+#### <%= r[:subtitle] %>
+
+<%- end -%>
+<%- if ! r[:resource].empty? -%>
+<%= MarkdownTables.make_table(r[:header], r[:resource], is_rows: true, align: 'l') %>
+
+<%- else -%>
+<%= 'N/A' %>
+
+<%- end -%>
+<%- end -%>
+EOS
+        erb = ERB.new(contents, nil, '-')
+        erb.result(binding).chomp
+      end
+    end
+  end
+end

data/lib/furikake/report.rb

@@ -0,0 +1,52 @@
+require 'furikake/reporters/backlog'
+
+module Furikake
+  class Report
+    include Furikake::Config
+
+    def initialize
+      @params = read_furikake_yaml
+      @resource = Furikake::Resource.generate
+    end
+
+    def show
+      @params['backlog']['projects'].each do |p|
+        header = insert_published_by(p['header'])
+        footer = p['footer']
+        puts generate(header, footer)
+      end
+    end
+
+    def publish
+      @params['backlog']['projects'].each do |p|
+        header = insert_published_by(p['header'])
+        footer = p['footer']
+        document = generate(header, footer)
+        p['wiki_contents'] = document
+        Furikake::Reporters::Backlog.new(p).publish
+      end
+    end
+
+    private
+
+    def generate(header, footer)
+      documents = <<"EOS"
+#{header}
+#{@resource}
+#{footer}
+EOS
+      documents
+    end
+
+    def insert_published_by(header)
+      headers = header.split("\n")
+      headers.insert(1, published_by)
+      headers.insert(2, "\n")
+      headers.join("\n")
+    end
+ 
+    def published_by
+      "*Published #{Time.now} by [furikake](https://github.com/inokappa/furikake)*"
+    end
+  end
+end

data/lib/furikake/reporters/backlog.rb

@@ -0,0 +1,25 @@
+require 'backlog_kit'
+
+module Furikake
+  module Reporters
+    class Backlog
+      def initialize(params)
+        @client ||= BacklogKit::Client.new(
+          space_id: params['space_id'],
+          api_key: params['api_key'],
+          top_level_domain: params['top_level_domain']
+        )
+        @wiki_id = params['wiki_id']
+        @wiki_name = params['wiki_name']
+        @wiki_contents = params['wiki_contents']
+      end
+
+      def publish
+        params = {}
+        params['name'] = @wiki_name
+        params['content'] = @wiki_contents
+        @client.update_wiki(@wiki_id, params)
+      end
+    end
+  end
+end

data/lib/furikake/resource.rb

@@ -0,0 +1,21 @@
+module Furikake
+  class Resource
+    def self.generate
+      documents = ''
+      load_type.each do |type|
+        require "furikake/resources/#{type}"
+        eval "documents.concat(Furikake::Resources::#{type.camelize}.report)"
+        documents.concat("\n")
+      end
+      documents
+    end
+
+    def self.load_type
+      type = []
+      Dir.glob(File.dirname(__FILE__) + '/resources/*').each do |r|
+        type << File.basename(r, '.rb') unless r.include?('stub')
+      end
+      type
+    end
+  end
+end

data/lib/furikake/resources/alb.rb

@@ -0,0 +1,71 @@
+module Furikake
+  module Resources
+    module Alb
+      def report
+        albs, target_groups = get_resources
+        headers = ['LB Name', 'DNS Name', 'Type', 'Target Group']
+        if albs.empty?
+          albs_info = 'N/A'
+        else
+          albs_info = MarkdownTables.make_table(headers,
+                                                albs,
+                                                is_rows: true,
+                                                align: 'l')
+        end
+        
+        headers = ['Target Group Name', 'Protocal', 'Port', 'Health Check Path', 'Health Chack Port', 'Health Check Protocol']
+        if target_groups.empty?
+          target_group_info = 'N/A'
+        else
+          target_group_info = MarkdownTables.make_table(headers,
+                                                        target_groups,
+                                                        is_rows: true,
+                                                        align: 'l')
+        end
+        
+        documents = <<"EOS"
+### ELB (ALB / NLB)
+
+#### ALB / NLB
+
+#{albs_info}
+
+#### Target Groups
+
+#{target_group_info}
+EOS
+        documents
+      end
+
+      def get_resources
+        alb = Aws::ElasticLoadBalancingV2::Client.new
+
+        albs = []
+        target_groups = []
+        alb.describe_load_balancers.load_balancers.each do |lb|
+          alb_info = []
+          t = alb.describe_target_groups({
+                                          load_balancer_arn: lb.load_balancer_arn
+                                         }).target_groups.map(&:to_h)
+          alb_info << lb.load_balancer_name
+          alb_info << lb.dns_name
+          alb_info << lb.type
+          alb_info << (t.map {|a| a[:target_group_name]}).join(", ")
+          albs << alb_info
+          target_group = []
+          target_group << (t.map {|a| a[:target_group_name]}).join(", ")
+          target_group << (t.map {|a| a[:protocol]}).join(", ")
+          target_group << (t.map {|a| a[:port]}).join(", ")
+          target_group << (t.map {|a| a[:health_check_path].nil? ? " " : a[:health_check_path]}).join(", ")
+          target_group << (t.map {|a| a[:health_check_port]}).join(", ")
+          target_group << (t.map {|a| a[:health_check_protocol]}).join(", ")
+          target_groups << target_group
+        end
+
+        return albs, target_groups
+      end
+
+      module_function :report, :get_resources
+    end
+  end
+end

data/lib/furikake/resources/clb.rb

@@ -0,0 +1,37 @@
+module Furikake
+  module Resources
+    module Clb
+      def report
+        resources = get_resources
+        headers = ['LB Name', 'DNS Name', 'Instances']
+        if resources.empty?
+          info = 'N/A'
+        else
+          info = MarkdownTables.make_table(headers, resources, is_rows: true, align: 'l')
+        end
+        documents = <<"EOS"
+### ELB (CLB)
+
+#{info}
+EOS
+        
+        documents
+      end
+
+      def get_resources
+        elb = Aws::ElasticLoadBalancing::Client.new
+        elbs = []
+        elb.describe_load_balancers.load_balancer_descriptions.each do |lb|
+          elb = []
+          elb << lb.load_balancer_name
+          elb << lb.dns_name
+          elb << (lb.instances.map(&:to_h).map {|a| a[:instance_id] }).join(',')
+          elbs << elb
+        end
+        elbs
+      end
+
+      module_function :report, :get_resources
+    end
+  end
+end

data/lib/furikake/resources/directory_service.rb

@@ -0,0 +1,50 @@
+module Furikake
+  module Resources
+    module DirectoryService
+      def report
+        resources = get_resources
+        headers = ['Directory ID', 'DNS Name', 'NetBIOS Name', 'Type', 'DNS Addresses', 'Size']
+        if resources.empty?
+          info = 'N/A'
+        else
+          info = MarkdownTables.make_table(headers, resources, is_rows: true, align: 'l')
+        end
+        documents = <<"EOS"
+### Directory Service (Simple AD)
+
+#{info}
+EOS
+        
+        documents
+      end
+
+      def get_resources
+        ds = Aws::DirectoryService::Client.new
+
+        req = {}
+        resouces = []
+        loop do
+          res = ds.describe_directories(req)
+          resouces.push(*res.directory_descriptions.map(&:to_h))
+          break if res.next_token.nil?
+          req[:next_token] = res.next_token
+        end
+      
+        directoryservice_infos = []
+        resouces.each do |r|
+          directory = []
+          directory << r[:directory_id]
+          directory << r[:name]
+          directory << r[:short_name]
+          directory << r[:type]
+          directory << r[:dns_ip_addrs].join(', ')
+          directory << r[:size]
+          directoryservice_infos << directory
+        end
+        directoryservice_infos
+      end
+
+      module_function :report, :get_resources
+    end
+  end
+end

data/lib/furikake/resources/ec2.rb

@@ -0,0 +1,56 @@
+module Furikake
+  module Resources
+    module Ec2
+      def report(format = nil)
+        instance = get_resources
+        contents = {
+          title: 'EC2',
+          resources: [
+            {
+               subtitle: '',
+               header: ['Name', 'Instance ID', 'Instance Type',
+                        'Availability Zone', 'Private IP Address',
+                        'Public IP Address', 'State'],
+               resource: instance
+            }
+          ]
+        }
+        Furikake::Formatter.shaping(format, contents)
+      end
+
+      def get_resources
+        ec2 = Aws::EC2::Client.new
+        params = {}
+        instances = []
+        loop do
+          res = ec2.describe_instances(params)
+          res.reservations.each do |r|
+            r.instances.each do |i|
+              instance = []
+              instance << 'N/A' if i.tags.map(&:to_h).all? { |h| h[:key] != 'Name' }
+              i.tags.each do |tag|
+                instance << tag.value if tag.key == 'Name'
+              end
+              instance << i.instance_id
+              instance << i.instance_type
+              instance << i.placement.availability_zone
+              instance << i.private_ip_address
+              if i.public_ip_address.nil?
+                instance << ' '
+              else
+                instance << i.public_ip_address
+              end
+              instance << i.state.name
+              instances << instance
+            end
+          end
+          break if res.next_token.nil?
+          params[:next_token] = res.next_token
+        end
+
+        instances
+      end
+      module_function :report, :get_resources
+    end
+  end
+end

data/lib/furikake/resources/elasticsearch_service.rb

@@ -0,0 +1,54 @@
+module Furikake
+  module Resources
+    module ElasticsearchService
+      def report
+        resources = get_resources
+        headers = ['Domain Name', 'Endpoint', 'Instance Type', "Instance Count", "Elasticsearch Version", 'EBS Type', 'EBS Size']
+        if resources.empty?
+          info = 'N/A'
+        else
+          info = MarkdownTables.make_table(headers, resources, is_rows: true, align: 'l')
+        end
+        documents = <<"EOS"
+### Elasticsearch Service
+
+#{info}
+EOS
+        
+        documents
+      end
+
+      def get_resources
+        ess = Aws::ElasticsearchService::Client.new
+
+        domains = []
+        loop do
+          res = ess.list_domain_names
+          domains.push(*res.domain_names.map(&:to_h))
+          break if res.domain_names.size == domains.size
+        end
+
+        domain_info = []
+        domains.each do |domain|
+          resource = []
+          res = ess.describe_elasticsearch_domains({
+                                                     domain_names: [domain[:domain_name]],
+                                                   })
+          res.domain_status_list.each do |r|
+            resource << r[:domain_name]
+            resource << r[:endpoints]['vpc']
+            resource << r[:elasticsearch_cluster_config][:instance_type]
+            resource << r[:elasticsearch_cluster_config][:instance_count]
+            resource << r[:elasticsearch_version]
+            resource << r[:ebs_options][:volume_type]
+            resource << r[:ebs_options][:volume_size]
+          end
+          domain_info << resource
+        end
+        domain_info
+      end
+
+      module_function :report, :get_resources
+    end
+  end
+end