furikake 0.1.6 → 0.2.1

data/README.md

@@ -43,6 +43,12 @@ export AWS_PROFILE=your-profile
 export AWS_REGION=ap-northeast-1
 ```
 
+BACKLOG_API キーについても環境変数に指定することも可能です.
+
+```sh
+export BACKLOG_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
 ### Step 3: Generate && Modify .frikake.yml
 
 If you're starting on a fresh furikake project, you can use furikake to generate your .furikake.yml:
@@ -98,6 +104,18 @@ bundle exec furikake show
 bundle exec furikake publish
 ```
 
+### Step x: Monitor
+
+`monitor` コマンドを利用することで, `publish` コマンドを常駐化することが可能です.
+
+```sh
+# 1 時間毎に対象をチェックして wiki に登録する
+bundle exec furikake monitor
+
+# 10 分毎に対象をチェックして wiki に登録する
+bundle exec furikake monitor --interval=600
+```
+
 ## Tips
 
 ### 検索対象リソース追加 (addons ディレクトリ)

data/furikake.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "octorelease"
 

data/lib/furikake/cli.rb

@@ -9,13 +9,13 @@ module Furikake
 
     desc 'show', 'resouces print.'
     def show
-      report = Furikake::Report.new
+      report = Furikake::Report.new(true)
       report.show
     end
 
     desc 'publish', 'resouces publish to something. (Default: Backlog)'
     def publish
-      report = Furikake::Report.new
+      report = Furikake::Report.new(true)
       report.publish
     end
 

data/lib/furikake/monitor.rb

@@ -3,6 +3,7 @@
 module Furikake
   class Monitor < Report
     def initialize(options)
+      super(true)
       $stdout.sync = true
       @logger = Logger.new($stdout)
       @flag_int = false

data/lib/furikake/report.rb

@@ -4,14 +4,16 @@ module Furikake
   class Report
     include Furikake::Config
 
-    def initialize
+    def initialize(cli, params = nil)
       $stdout.sync = true
       @logger = Logger.new($stdout)
+      @cli = cli
+      @params = @cli ? read_furikake_yaml : params
+      raise ArgumentError, 'パラメータが設定されていません.' if @params.nil?
     end
 
     def show
-      params = read_furikake_yaml
-      params['backlog']['projects'].each do |p|
+      @params['backlog']['projects'].each do |p|
         header = insert_published_by(p['header'])
         footer = p['footer']
         puts generate(header, footer)
@@ -19,8 +21,7 @@ module Furikake
     end
 
     def publish
-      params = read_furikake_yaml
-      params['backlog']['projects'].each do |p|
+      @params['backlog']['projects'].each do |p|
         header = insert_published_by(p['header'])
         footer = p['footer']
         document = generate(header, footer)
@@ -31,14 +32,10 @@ module Furikake
       end
     end
 
-    # def monitor_test
-    #   show
-    # end
-
     private
 
     def generate(header, footer)
-      resource = Furikake::Resource.generate
+      resource = Furikake::Resource.generate(@cli, @params['resources'])
       documents = <<"EOS"
 #{header}
 #{resource}

data/lib/furikake/resource.rb

@@ -1,8 +1,8 @@
 module Furikake
   class Resource
-    def self.generate
+    def self.generate(cli, resources)
       documents = ''
-      load_resource_type.each do |type|
+      load_resource_type(cli, resources).each do |type|
         if type.include?('addon')
           $LOAD_PATH.push(Dir.pwd + '/addons')
           require "#{type}"
@@ -26,9 +26,9 @@ module Furikake
       documents
     end
 
-    def self.load_resource_type
+    def self.load_resource_type(cli, resources)
       type = []
-      config_defined_resources = load_config_resource_type
+      config_defined_resources = cli ? load_config_resource_type : resources['aws'].sort
       default_resources = load_default_resource_type
       if default_resources == config_defined_resources
         type.push(default_resources)

data/lib/furikake/resources/rds.rb

@@ -29,7 +29,7 @@ module Furikake
         rds_infos = []
         rds.describe_db_instances.db_instances.map(&:to_h).each do |i|
           instance = []
-          instance << i[:db_cluster_identifier]
+          instance << (!i[:db_cluster_identifier].nil? ? i[:db_cluster_identifier] : 'N/A')
           instance << i[:db_instance_identifier]
           instance << i[:db_instance_class]
           instance << i[:engine]

data/lib/furikake/resources/stub/rds.rb

@@ -0,0 +1,52 @@
+Aws.config[:rds] = {
+  stub_responses: {
+    describe_db_instances: {
+      db_instances: [
+        {
+          db_instance_identifier: 'my-rds',
+          db_instance_arn: 'arn:aws:rds:ap-northeast-1a:123456789012:db:my-rds',
+          db_instance_status: 'available',
+          db_instance_class: 'db.t2.medium',
+          availability_zone: 'ap-northeast-1a',
+          multi_az: false,
+          endpoint: {
+            address: 'my-rds-instance-endpoint'
+          },
+          engine: 'mysql'
+        },
+        {
+          db_cluster_identifier: 'my-cluster',
+          db_instance_identifier: 'my-cluster-instnace',
+          db_instance_arn: 'arn:aws:rds:ap-northeast-1a:123456789012:db:my-cluster-instance',
+          db_instance_status: 'available',
+          db_instance_class: 'db.t2.medium',
+          availability_zone: 'ap-northeast-1a',
+          multi_az: false,
+          endpoint: {
+            address: 'my-cluster-endpoint'
+          },
+          engine: 'aurora'
+        }
+      ]
+    },
+    describe_db_clusters: {
+      db_clusters: [
+        {
+          db_cluster_identifier: 'my-cluster',
+          endpoint: 'my-cluster-endpoint',
+          reader_endpoint: 'my-cluster-reader-endpoint',
+          db_cluster_members: [
+            {
+              db_instance_identifier: 'my-cluster-writer-instance',
+              is_cluster_writer: true
+            },
+            {
+              db_instance_identifier: 'my-cluster-reader-instance',
+              is_cluster_writer: false
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

data/lib/furikake/version.rb

@@ -1,3 +1,3 @@
 module Furikake
-  VERSION = '0.1.6'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furikake
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - inokappa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-25 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - lib/furikake/resources/security_group.rb
 - lib/furikake/resources/stub.rb
 - lib/furikake/resources/stub/ec2.rb
+- lib/furikake/resources/stub/rds.rb
 - lib/furikake/resources/vpc.rb
 - lib/furikake/resources/vpc_endpoint.rb
 - lib/furikake/setup.rb
@@ -174,7 +175,7 @@ homepage: https://github.com/inokappa/furikake
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,9 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: It is a command line tool to register your resources in Wiki page (Markdown
   format).