capistrano-telegram 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51f372428b82746973575fb18d09242b0e68554538236c40e5a43442c0fb2d89
+  data.tar.gz: 8c07d69b7ac0e0313e069922b2018115e538066fe4430c1f120f86c5dff6dfeb
+SHA512:
+  metadata.gz: 183ea268064a60f241a9fa2fe409f24b2cd0a266c4d388fc551f3ebf4aad11ed43e5222969f692ae2ddb1de3430e0147a5fa2be160a3df4769dc22c8ac19623c
+  data.tar.gz: a819d96f3ffa3c274d1baadc3f7aeafd56ef8c4efe0e2f99d4ab50cb01fddc2b03a5e2508e4833d45772c2151d32944d21a37dd3ec3c59f02aed7561646300a0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-telegram.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Mattia Malonni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Capistrano - Telegram Notification
+
+Send notifications to Telegram about Capistrano deployments.
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'capistrano-telegram'
+   ```
+
+2. Execute:
+
+   ```
+   $ bundle
+   ```
+
+3. Require the library in your application's Capfile:
+
+   ```ruby
+   require 'capistrano/telegram'
+   ```
+
+### config/deploy.rb
+
+```ruby
+set :telegram_bot_key, 'YOUR_BOT_ID'
+set :telegram_chat_id, 'YOUR_BOT_CHAT_ID'
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-telegram.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name = "capistrano-telegram"
+  spec.version = '1.0.0'
+  spec.authors = ["Mattia Malonni"]
+  spec.email = ["mattia.malonni@gmail.com"]
+  spec.summary = %q{Notify Capistrano deployment to Telegram.}
+  spec.description = %q{Notify Capistrano deployment to Telegram.}
+  spec.homepage = "https://github.com/MattiaMalonni/capistrano-telegram"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '>= 3.8.1'
+  spec.add_dependency 'telegram-bot-ruby', "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/messaging/helpers.rb

@@ -0,0 +1,36 @@
+module Capistrano
+  module Messaging
+    module Helpers
+      
+      def icon_emoji
+        options.fetch(:icon_emoji, nil)
+      end
+
+      def deployer
+        Etc.getpwnam(ENV['USER']).gecos
+      end
+
+      def branch
+        fetch(:branch)
+      end
+
+      def application
+        fetch(:application)
+      end
+
+      def stage(default = 'an unknown stage')
+        fetch(:stage, default)
+      end
+
+      #
+      # Return the elapsed running time as a string.
+      #
+      # Examples: 21-18:26:30, 15:28:37, 01:14
+      #
+      def elapsed_time
+        `ps -p #{$$} -o etime=`.strip
+      end
+
+    end        
+  end
+end

data/lib/capistrano/messaging/telegram.rb

@@ -0,0 +1,38 @@
+require_relative 'helpers'
+
+module Capistrano
+  module Messaging
+    class Telegram
+      include Helpers
+
+      extend Forwardable
+      def_delegators :env, :fetch
+
+      def payload_for_updating
+        "#{deployer} has started deploying branch #{branch} of #{application} to #{stage}"
+      end
+
+      def payload_for_reverting
+        "#{deployer} has started rolling back branch `#{branch}` of #{application} to #{stage}"
+      end
+
+      def payload_for_updated
+        "#{deployer} has finished deploying branch #{branch} of #{application} to #{stage}"
+      end
+
+      def payload_for_reverted
+        "#{deployer} has finished rolling back branch of #{application} to #{stage}"
+      end
+
+      def payload_for_failed
+        "#{deployer} has failed to #{deploying? ? 'deploy' : 'rollback'} branch #{branch} of #{application} to #{stage}"
+      end
+
+      def payload_for(action)
+        method = "payload_for_#{action}"
+        respond_to?(method) && send(method)
+      end
+
+    end
+  end
+end

data/lib/capistrano/tasks/telegram.rake

@@ -0,0 +1,41 @@
+namespace :telegram do
+  namespace :deploy do
+
+    desc 'Notify about updating deploy'
+    task :updating do
+      Capistrano::Telegram.new(self).send(:updating)
+    end
+
+    desc 'Notify about reverting deploy'
+    task :reverting do
+      Capistrano::Telegram.new(self).send(:reverting)
+    end
+
+    desc 'Notify about updated deploy'
+    task :updated do
+      Capistrano::Telegram.new(self).send(:updated)
+    end
+
+    desc 'Notify about reverted deploy'
+    task :reverted do
+      Capistrano::Telegram.new(self).send(:reverted)
+    end
+
+    desc 'Notify about failed deploy'
+    task :failed do
+      Capistrano::Telegram.new(self).send(:failed)
+    end
+
+    desc 'Test Slack integration'
+    task :test => %i[updating updated reverting reverted failed] do
+      # all tasks run as dependencies
+    end
+
+  end
+end
+
+before 'deploy:updating',           'telegram:deploy:updating'
+before 'deploy:reverting',          'telegram:deploy:reverting'
+after  'deploy:finishing',          'telegram:deploy:updated'
+after  'deploy:finishing_rollback', 'telegram:deploy:reverted'
+after  'deploy:failed',             'telegram:deploy:failed'

data/lib/capistrano/telegram.rb

@@ -0,0 +1,32 @@
+require_relative 'messaging/telegram'
+
+require 'telegram/bot'
+
+load File.expand_path('../tasks/telegram.rake', __FILE__)
+
+module Capistrano
+  class Telegram
+    
+    extend Forwardable
+    def_delegators :env, :fetch
+
+    def initialize(env)
+      @telegram_bot_key = fetch(:telegram_bot_key, nil)
+      @telegram_chat_id = fetch(:telegram_chat_id, nil)
+      @message = Capistrano::Messaging::Telegram.new
+    end
+
+    def send(action)
+      payload = @message.payload_for(action)
+      send_to_telegram(payload)
+    end
+
+    private 
+    def send_to_telegram(message)
+      ::Telegram::Bot::Client.run(@telegram_bot_key) do |bot|
+        bot.api.send_message(chat_id: @telegram_chat_id, text: message)
+      end
+    end
+  
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-telegram
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mattia Malonni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+- !ruby/object:Gem::Dependency
+  name: telegram-bot-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Notify Capistrano deployment to Telegram.
+email:
+- mattia.malonni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-telegram.gemspec
+- lib/capistrano-telegram.rb
+- lib/capistrano/messaging/helpers.rb
+- lib/capistrano/messaging/telegram.rb
+- lib/capistrano/tasks/telegram.rake
+- lib/capistrano/telegram.rb
+homepage: https://github.com/MattiaMalonni/capistrano-telegram
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Notify Capistrano deployment to Telegram.
+test_files: []