capistrano3-notification 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21616767890c4e45b6ee17056648b909b7aa1739
-  data.tar.gz: 4072825cf9dd634c6b6f9221c2e750275e61decf
+  metadata.gz: 9aa2470a772b323322ee37f0f767bf9a1c65e760
+  data.tar.gz: ca08eeb030e87bad7fd2566e94e3854c9b59438d
 SHA512:
-  metadata.gz: 6021fccdb4ecf4dd2fe45455a30964d8dbd719dccd943bdff5d23297531c1017ec3bb6513c511fe6602d3aa6b1356a1442fe46f809dde7b7086a449596cd4335
-  data.tar.gz: e5894c79f74446570284dd1bb91fbe2b79d580377748fc194f1848a606ab0711f5f682b052cbc5b297d28aa3e84a8810347edb199b6990d525c9b05be048e618
+  metadata.gz: a32d2b423915160307d754bd174352b18a9b91ae7d9a06987f9642017a87286fb19cbcf33089b2dee20558c599f40fe11b11426ca9ba51f898aec1a299760541
+  data.tar.gz: 70772b0ba2d3a6a9018477a8885eca81e65108225ff23065ae2830b232fe29d0ea41fb4ff10a1080324bca1b8aed50c09f85dec217d1d5e021ea7040232287f4

data/README.md

@@ -1,13 +1,14 @@
 # Capistrano3::Notification
 
-Notification for capistrano3
+Notification for capistrano3.
+Sending notification to irc/slack/... after deployment completed.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'capistrano3-notification'
+gem 'capistrano3-notification', require: false
 ```
 
 ## Usage
@@ -18,6 +19,8 @@ in `Capfile`:
 require 'capistrano3/notification'
 ```
 
+## Configuration
+
 ### IRC notification
 
 in `deploy.rb` or staging files:
@@ -45,6 +48,18 @@ set :notification, -> { "#{fetch(:application)} was deployed to #{fetch(:stage)}
 
 **contribute me!**
 
+## Notify manually
+
+You can use `notify` method to send message.
+
+```ruby
+# lib/capistrano/tasks/foo.rake
+
+task :foo do
+  notify 'hello!'
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/masarakki/capistrano3-notification/fork )

data/lib/capistrano3/notification.rb

@@ -1,3 +1,10 @@
 require 'capistrano3/notification/version'
+require 'capistrano3/notification/adapter'
+%w(slack irc).each do |adapter|
+  require "capistrano3/notification/#{adapter}"
+end
+require 'capistrano3/notification/dsl'
+
+extend Capistrano3::Notification::DSL
 
 load File.expand_path('../notification/tasks/notification.rake', __FILE__)

data/lib/capistrano3/notification/adapter.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+
+module Capistrano3
+  module Notification
+    class Adapter
+      extend Forwardable
+      attr_reader :env
+      def_delegators :@env, :fetch
+
+      def initialize(env)
+        @env = env
+      end
+
+      def notify(_message)
+        raise 'this is abstract class'
+      end
+
+      private
+
+      def user
+        fetch(:notifier)
+      end
+    end
+  end
+end

data/lib/capistrano3/notification/dsl.rb

@@ -0,0 +1,13 @@
+module Capistrano3
+  module Notification
+    module DSL
+      def notify(message)
+        return if dry_run?
+        [Capistrano3::Notification::IRC,
+         Capistrano3::Notification::Slack].each do |klass|
+          klass.new(self).notify(message)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano3/notification/irc.rb

@@ -0,0 +1,33 @@
+require 'shout-bot'
+
+module Capistrano3
+  module Notification
+    class IRC < Adapter
+      def notify(message)
+        ShoutBot.shout(url) { |irc| irc.say message } if enabled?
+      end
+
+      private
+
+      def host
+        env.fetch(:irc_host)
+      end
+
+      def port
+        env.fetch(:irc_port)
+      end
+
+      def channel
+        env.fetch(:irc_channel)
+      end
+
+      def enabled?
+        user && host && port && channel && message
+      end
+
+      def url
+        "irc://#{user}@#{host}:#{port}/#{channel}"
+      end
+    end
+  end
+end

data/lib/capistrano3/notification/slack.rb

@@ -0,0 +1,42 @@
+require 'slack-notifier'
+
+module Capistrano3
+  module Notification
+    class Slack < Adapter
+      def notify(message)
+        notifier_options = { username: user, channel: channel }.reject { |_x, y| y.nil? }
+        ping_options = {}.tap do |h|
+          h[icon_type] = icon if icon_type
+        end
+        ::Slack::Notifier.new(webhook_url, notifier_options).ping message, ping_options
+      end
+
+      private
+
+      def webhook_url
+        fetch(:slack_webhook_url)
+      end
+
+      def channel
+        fetch(:slack_channel)
+      end
+
+      def icon
+        fetch(:slack_icon) || nil
+      end
+
+      def icon_type
+        case icon
+        when /^:.+:/
+          :icon_emoji
+        when /^http/
+          :icon_url
+        end
+      end
+
+      def enabled?
+        user && channel && webhook_url
+      end
+    end
+  end
+end

data/lib/capistrano3/notification/tasks/notification.rake

@@ -7,59 +7,9 @@ namespace :load do
 end
 
 namespace :notification do
-  task :notify_auto do
-    invoke 'notification:notify', fetch(:notification)
+  task :notify do
+    notify fetch(:notification)
   end
 
-  task :notify, [:message] do |t, args|
-    deprecated :irc_user, :notifier if fetch(:irc_user)
-    deprecated :slack_user, :notifier if fetch(:slack_user)
-
-    %w(irc slack).each do |adapter|
-      invoke "notification:#{adapter}", args[:message]
-    end
-    t.reenable
-  end
-
-  task :irc, [:message] do |t, args|
-    user = fetch(:irc_user) || fetch(:notifier)
-    host = fetch(:irc_host)
-    port = fetch(:irc_port)
-    channel = fetch(:irc_channel)
-    message = args[:message]
-    next unless user && host && port && channel && message
-    require 'shout-bot'
-    url = "irc://#{user}@#{host}:#{port}/#{channel}"
-    ShoutBot.shout(url) { |irc| irc.say message }
-    t.reenable
-  end
-
-  task :slack, [:message] do |t, args|
-    webhook_url = fetch(:slack_webhook_url)
-    user =  fetch(:slack_user) || fetch(:notifier)
-    channel = fetch(:slack_channel)
-    icon = fetch(:slack_icon) || nil
-    message = args[:message]
-    next unless user && channel && webhook_url && message
-    require 'slack-notifier'
-    notifier_options = { username: user, channel: channel }.reject { |_x, y| y.nil? }
-    icon_type = case icon
-                when /^:.+:/
-                  :icon_emoji
-                when /^http/
-                  :icon_url
-                end
-    ping_options = {}.tap do |h|
-      h[icon_type] = icon if icon_type
-    end
-    notifier = Slack::Notifier.new webhook_url, notifier_options
-    notifier.ping message, ping_options
-    t.reenable
-  end
-
-  def deprecated(old, new)
-    puts format('%6s %s', 'WARN'.red, ":#{old} is deplicated. use set :#{new}, '#{fetch(old)}'")
-  end
-
-  after 'deploy:finished', 'notification:notify_auto'
+  after 'deploy:finished', 'notification:notify'
 end

data/lib/capistrano3/notification/version.rb

@@ -1,5 +1,5 @@
 module Capistrano3
   module Notification
-    VERSION = '0.2.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-notification
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - masarakki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -112,6 +112,10 @@ files:
 - capistrano3-notification.gemspec
 - lib/capistrano3-notification.rb
 - lib/capistrano3/notification.rb
+- lib/capistrano3/notification/adapter.rb
+- lib/capistrano3/notification/dsl.rb
+- lib/capistrano3/notification/irc.rb
+- lib/capistrano3/notification/slack.rb
 - lib/capistrano3/notification/tasks/notification.rake
 - lib/capistrano3/notification/version.rb
 homepage: https://github.com/masarakki/capistrano3-notification