capistrano-around_chatwork 0.1.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ce6249ea1665ecfcae2726bcd35733e958eb62f
-  data.tar.gz: aa389d3fe5c7de6ba5e0640c693d7148afcd38e0
+SHA256:
+  metadata.gz: af33eb9e410ee6bbb301b1066238060a96e6090202244424bae547a6698dc06d
+  data.tar.gz: a54735fc4dca586c91a3fe0c16d0b7305045132b32a5016418f5dc75323a8542
 SHA512:
-  metadata.gz: 112689a48316c89eff254c41abbec0f5888c03d20e68c7857d2b6ae0e1dd09fc8e1c04151e04553aaa8ee33c0d602c281d4ea011932dbf9b82ff083e8a844ee8
-  data.tar.gz: db8866438491e603143ed38c7e8821753844eb731a733ca2d0e749510a5c459c97d1fe0d8c10d213618f25da0126b06661d5077df3cb0ce84e6a5bd7ff78af99
+  metadata.gz: 802be193d45fbb36e362111f546786f3e6579569413ecb2693e579c38a77727de798ba98c9dc39d282256380e32f665c3b26012d6d88d63dbf221baf515ac6a9
+  data.tar.gz: 1f8a26a12aaf349a19a123b387b1317e1fa5d781ca913f924a9a45d68e7b36a7059d2b811ed8ac5745eb7aeb80c35a2aa0a1a57ea9cb2c5659537fc888878095

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Changelog
 ## Unreleased
-[full changelog](http://github.com/sue445/capistrano-around_chatwork/compare/v0.1.1...master)
+[full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v1.0.2...master)
+
+## 1.0.2
+[full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v1.0.1...v1.0.2)
+
+* Enable MFA requirement for gem releasing
+  * https://github.com/sue445/capistrano-around_chatwork/pull/5
+
+## 1.0.1
+[full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v1.0.0...v1.0.1)
+
+* Skip notify when message is empty
+  * https://github.com/sue445/capistrano-around_chatwork/pull/4
+
+## 1.0.0
+[full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v0.2.0...v1.0.0)
+
+* Drop support ruby older than 2.1 :bomb:
+* Notify failure message if task is failed
+  * https://github.com/sue445/capistrano-around_chatwork/pull/3
+
+## 0.2.0
+[full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v0.1.1...v0.2.0)
+
+* Use cha gem instead of chatwork gem
+  * https://github.com/sue445/capistrano-around_chatwork/pull/2
 
 ## 0.1.1
 [full changelog](https://github.com/sue445/capistrano-around_chatwork/compare/v0.1.0...v0.1.1)

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-around_chatwork.svg)](http://badge.fury.io/rb/capistrano-around_chatwork)
 [![Code Climate](https://codeclimate.com/github/sue445/capistrano-around_chatwork/badges/gpa.svg)](https://codeclimate.com/github/sue445/capistrano-around_chatwork)
-[![Dependency Status](https://gemnasium.com/sue445/capistrano-around_chatwork.svg)](https://gemnasium.com/sue445/capistrano-around_chatwork)
 
 post to [ChatWork](http://www.chatwork.com/) before and after the specified task
 
@@ -36,10 +35,9 @@ around_chatwork "deploy"
 ```
 
 ## Customize
-If you want to customize starting and ending mesasge, set `starting_message` and `ending_message`
-
-example
+If you want to customize messages, set `starting_message`, `ending_message` and `failure_message`
 
+### Example
 ```ruby
 set :starting_message, -> {
   "[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]started[/info]"
@@ -48,10 +46,31 @@ set :starting_message, -> {
 set :ending_message, -> {
   "[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]done (:elapsed_time: sec)[/info]"
 }
+
+set :failure_message, -> {
+  <<-MSG
+[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]failed (:elapsed_time: sec)
+:error_inspect:
+:error_backtrace:[/info]
+  MSG
+}
+```
+
+When these are falsy (e.g. `nil` or `false`) or empty string (e.g. `""`), notification is skipped.
+
+e.g.
+
+```ruby
+set :starting_message, nil
+set :ending_message, ""
 ```
 
+### Variables
 * `:task_name:` is replaced to current task name (e.g. `deploy`)
 * `:elapsed_time:` is replaced to elapsed time of task (e.g. `1.234`)
+* `:error_message:` is replaced to error message (i.e. `Exception#message`) if task is failed
+* `:error_inspect:` is replaced to error inspected message (i.e. `Exception#inspect`) if task is failed
+* `:error_backtrace:` is replaced to error backtrace (i.e. `Exception#backtrace`) if task is failed
 
 ## Development
 

data/capistrano-around_chatwork.gemspec

@@ -14,13 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sue445/capistrano-around_chatwork"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   %w(img/).each do |exclude_dir|
@@ -32,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "capistrano", ">= 3.0.0"
-  spec.add_dependency "chatwork", ">= 0.4.0"
+  spec.add_dependency "cha", ">= 1.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/capistrano/around_chatwork/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module AroundChatwork
-    VERSION = "0.1.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/capistrano/around_chatwork.rb

@@ -1,15 +1,30 @@
 require "capistrano/around_chatwork/version"
-require "chatwork"
+require "cha"
 
 module Capistrano
   module AroundChatwork
-    def self.format_message(message, task_name, elapsed_time = 0)
-      message.gsub(":task_name:", task_name).gsub(":elapsed_time:", sprintf("%5.3f", elapsed_time))
+    def self.format_message(message:, task_name:, elapsed_time: 0, error: nil)
+      return "" unless message
+
+      formatted_message = message.
+        gsub(":task_name:", task_name).
+        gsub(":elapsed_time:", sprintf("%5.3f", elapsed_time))
+
+      if error
+        formatted_message = formatted_message.
+          gsub(":error_message:", error.message).
+          gsub(":error_inspect:", error.inspect).
+          gsub(":error_backtrace:", error.backtrace.join("\n"))
+      end
+
+      formatted_message
     end
 
     def self.post_chatwork(message)
-      ChatWork.api_key = fetch(:chatwork_api_token)
-      ChatWork::Message.create(room_id: fetch(:chatwork_room_id), body: message)
+      return if message.empty?
+
+      client = Cha.new(api_token: fetch(:chatwork_api_token))
+      client.create_room_message(fetch(:chatwork_room_id), message)
     end
   end
 end
@@ -18,18 +33,47 @@ def around_chatwork(task_name)
   start_time = nil
 
   before_task = Rake::Task.define_task("#{task_name}:__before__") do
-    message = Capistrano::AroundChatwork.format_message(fetch(:starting_message), task_name)
+    message = Capistrano::AroundChatwork.format_message(
+      message:   fetch(:starting_message),
+      task_name: task_name,
+    )
     Capistrano::AroundChatwork.post_chatwork(message)
     start_time = Time.now
   end
 
   after_task = Rake::Task.define_task("#{task_name}:__after__") do
     elapsed_time = Time.now - start_time
-    message = Capistrano::AroundChatwork.format_message(fetch(:ending_message), task_name, elapsed_time)
+    message = Capistrano::AroundChatwork.format_message(
+      message:      fetch(:ending_message),
+      task_name:    task_name,
+      elapsed_time: elapsed_time,
+    )
     Capistrano::AroundChatwork.post_chatwork(message)
   end
 
-  Rake::Task[task_name].enhance([before_task]) do
+  target_task = Rake::Task[task_name]
+
+  target_task.instance_eval do
+    define_singleton_method :invoke_with_failure_message do |*args|
+      begin
+        invoke_without_failure_message(*args)
+      rescue Exception => error
+        elapsed_time = Time.now - start_time
+        message = Capistrano::AroundChatwork.format_message(
+          message:      fetch(:failure_message),
+          task_name:    task_name,
+          elapsed_time: elapsed_time,
+          error:        error,
+        )
+        Capistrano::AroundChatwork.post_chatwork(message)
+        raise
+      end
+    end
+    alias :invoke_without_failure_message :invoke
+    alias :invoke :invoke_with_failure_message
+  end
+
+  target_task.enhance([before_task]) do
     Rake::Task[after_task].invoke
   end
 end
@@ -42,4 +86,12 @@ set :ending_message, -> {
   "[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]done (:elapsed_time: sec)[/info]"
 }
 
+set :failure_message, -> {
+  <<-MSG
+[info][title][#{fetch(:stage)}] :task_name: @#{fetch(:user)}[/title]failed (:elapsed_time: sec)
+:error_inspect:
+:error_backtrace:[/info]
+  MSG
+}
+
 set :user, local_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-around_chatwork
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.2
 platform: ruby
 authors:
 - sue445
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -25,47 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: chatwork
+  name: cha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: post to ChatWork before and after the specified task
 email:
 - sue445@sue445.net
@@ -88,8 +88,11 @@ homepage: https://github.com/sue445/capistrano-around_chatwork
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message: 
+  homepage_uri: https://github.com/sue445/capistrano-around_chatwork
+  source_code_uri: https://github.com/sue445/capistrano-around_chatwork
+  changelog_uri: https://github.com/sue445/capistrano-around_chatwork/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,16 +100,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: post to ChatWork before and after the specified task
 test_files: []