sgdoc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a488f37d0d4b8921d508b17f273dbf423d527bf
-  data.tar.gz: 2a01b6e054105d90ebc8291fe1a6d018d2252598
+  metadata.gz: dfe3f1db6cd5e5afe70362d29b25df3685ca6a87
+  data.tar.gz: 1a8c5c041de3ab4da7a378c3604425f93610b0f2
 SHA512:
-  metadata.gz: 48b43aba768af54d2259d23174d2a1d2fe230202bb607077cdf60f0d7218f5321daa9ea6f4ce2013dadae841e57ca38a8e661f791870daa0f1ccc4f4f6313744
-  data.tar.gz: f8a314a60fc2a564ea08059faa525d0a513fd064883df7ea45591d49be22d5244fde22df06998e27ea51b5117d469565d92b0c5be949e86a346593421cd0504e
+  metadata.gz: c3a5a02940643289850d5fc2cffd02cc0941382f0755ed1f1c02db7726804c8ea129c27f67ad19efe36dddd69127b674ae611111aa1c5aa9bd39c6e47d25fa56
+  data.tar.gz: 1762e52af27785541335ec2f3f580157dd0d89e19401f801da25f7196ec0a1f583561479aa0aea0075d244c4671c6d02384aa4fd0c7bd909b3acd09746847871

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:latest
+MAINTAINER Yuji Takaesu <taka.esu.user@gmail.com>
+
+RUN gem install sgdoc
+
+ENTRYPOINT ["sgdoc"]
+CMD [""]

data/README.ja.md

@@ -11,19 +11,32 @@ SGを参照しているサービスはEC2,RDS,ELBを対象とする(その他は
 
 ## やりたいこと
 
-- [ ] aws-sdkで必要な情報を取得してハッシュ化
-- [ ] Erubisに渡してerbテンプレートで展開する
+- Erubisに渡してerbテンプレートで展開する
     - ドキュメントにはSecurityGroupの内容
     - 関連付けの情報(EC2, ELB, EC2)
-- [ ] SecurityGroupのIn,Outのポリシーにコメントを入れれるようにしたい(別ファイルでポートのコメント管理。定型文はYamlで管理(0.0.0.0/0など))
-
+- SecurityGroupのIn,Outのポリシーにコメントを入れれるようにしたい(別ファイルでポートのコメント管理。定型文はYamlで管理(0.0.0.0/0など))
 
 ### Credentialは次の順番で有効になる
-- (これは設定しないのでいらないかな) `:access_key_id` , `:secret_access_key` , and `:session_token` options
-- `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`
+- (未) `:access_key_id` , `:secret_access_key` , and `:session_token` options
+- `ENV['AWS_REGION']`, `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`
 - HOME/.aws/credentials shared credentials file
 - EC2 instance profile credentials See Plugins::RequestSigner for more details.
 
+
+### 実行方法
+
+```
+shared credentials file(HOME/.aws/credentials) に設定がある場合
+$ sgdoc > sgdoc.md
+
+環境変数を設定して実行
+$ AWS_REGION=ap-northeast-1 AWS_ACCESS_KEY_ID=[ACCESS_KEY] AWS_SECRET_ACCESS_KEY=[SECRET_ACCESS_KEY] sgdoc > sgdoc.md
+
+Dockerで実行する
+$ docker build . -f Dockerfile -t yusabana/sgdoc
+$ docker run --rm -e AWS_REGION=ap-northeast-1 -e AWS_ACCESS_KEY_ID=[ACCESS_KEY] -e AWS_SECRET_ACCESS_KEY=[SECRET_ACCESS_KEY] yusabana/sgdoc sgdoc
+```
+
 ## Requirements
 
 Ruby 2.1 or higher

data/README.md

@@ -1,8 +1,8 @@
 # Sgdoc
 
-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/sgdoc`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/yusabana/sgdoc.svg?branch=master)](https://travis-ci.org/yusabana/sgdoc)
 
-TODO: Delete this and the text above, and describe your gem
+For Japanese [README.ja.md](README.ja.md)
 
 ## Installation
 

data/lib/sgdoc/client.rb

@@ -10,7 +10,7 @@ module Sgdoc
 
     def security_groups_by_vpc_id
       describe_security_groups = @ec2_client.describe_security_groups.security_groups
-      security_groups ||= describe_security_groups.map { |sg| Sgdoc::EC2::SecurityGroup.new(sg) }
+      security_groups = describe_security_groups.map { |sg| Sgdoc::EC2::SecurityGroup.new(sg) }
 
       # vpcIDのキーをvpcのオブジェクトにしても良い
       security_groups.group_by { |sg| sg.vpc_id }

data/lib/sgdoc/ec2/ip_permission.rb

@@ -4,7 +4,7 @@ module Sgdoc
       ALL_STRING = 'all'
 
       def initialize(ip_permission:, ip_range: nil, user_id_group_pair: nil)
-        raise StandardError 'Unknown pattern of IpPermission, at least must need ip_range or user_id_group_pair' if ip_range.nil? && user_id_group_pair.nil?
+        raise StandardError, 'Unknown pattern of IpPermission, at least must need ip_range or user_id_group_pair' if ip_range.nil? && user_id_group_pair.nil?
 
         @ip_range = ip_range
         @user_id_group_pair = user_id_group_pair
@@ -38,7 +38,7 @@ module Sgdoc
 
       def doc_description
         # TODO desriptionを出力する使用を考える(IPベースの設定ファイルでいいかも)
-        '-'
+        ' '
       end
     end
   end

data/lib/sgdoc/ec2/security_group.rb

@@ -14,7 +14,7 @@ module Sgdoc
       end
 
       def tags_to_json
-        return '-' if tags.empty?
+        return ' ' if tags.empty?
 
         tags.each_with_object({}) do |tag, memo|
           memo[tag.key] = tag.value

data/lib/sgdoc/templates/security_groups.md.erb

@@ -10,7 +10,7 @@
 
 ### Inbound
 
-| Protocol | Port | Source | _Description |
+| Protocol | Port | Source | %Description |
 | ---- | ---- | ---- | ---- |
 <% if sg.inbound_permissions.each do |iperm| %>
 | <%= iperm.protocol %> | <%= iperm.port %> | <%= iperm.target %> | <%= iperm.doc_description %> |
@@ -20,7 +20,7 @@
 
 ### Outbound
 
-| Protocol | Port | Destination | _Description |
+| Protocol | Port | Destination | %Description |
 | ---- | ---- | ---- | ---- |
 <% if sg.outbound_permissions.each do |operm| %>
 | <%= operm.protocol %> | <%= operm.port %> | <%= operm.target %> | <%= operm.doc_description %> |

data/lib/sgdoc/version.rb

@@ -1,3 +1,3 @@
 module Sgdoc
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sgdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuji Takaesu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-08 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.ja.md