deployment_notifications 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 013e2cecba81f4ff7924bd0db65c34c424f5c1f50fc04fc48c704545e8b074a9
+  data.tar.gz: cc6912e19c46650a2af53daee5080555b7b5d291f4e226a8e2e67c9ea289aed5
+SHA512:
+  metadata.gz: 9f2010f36cf93f274c067df44a033074ea873f9c1ef8fcd0104fe3987757c3b429626aae3a397ce10883fd4ff64759843915ee17db1081776739ce93090568da
+  data.tar.gz: c75147606b336cc27b6bb694af7688d229f173d02fddef75649f35ef91dcf40ec73339b12982ca35492fb6dc8cfea48d57d0d643f0d49cab6f1c416f8a3f817c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ashish Garg
+
+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,59 @@
+# DeploymentNotifications
+
+`DeploymentNotifications` is a gem that integrates with Capistrano and Slackistrano to provide custom deployment messages to your Slack channel. This gem simplifies the setup process by automatically configuring the necessary settings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deployment_notifications', path: '/path/to/your/local/gem'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+### Step 1: Configure the Gem in an Initializer
+Create a new initializer file in your Rails application, e.g., config/initializers/deployment_notifications.rb, and configure it as follows:
+
+```ruby
+DeploymentNotifications.configure do |config|
+  config.channel = '#your-slack-channel'
+  config.webhook = 'https://hooks.slack.com/services/YOUR/WEBHOOK/URL'
+end
+```
+
+### Step 2: Capfile Modifications
+The gem automatically adds the necessary require 'slackistrano/capistrano' line to your Capfile. If you need to verify or manually add it, your Capfile should include:
+
+```ruby
+require 'slackistrano/capistrano'
+```
+
+### Step 3: Deployment Configuration
+Ensure that your Capistrano deploy configuration is set up correctly. The gem will automatically set the Slackistrano configuration based on the provided initializer settings.
+
+## Usage
+Once configured, you can deploy your application using Capistrano as usual:
+
+```bash
+cap production deploy
+```
+
+Deployment notifications will be sent to your specified Slack channel using the custom messaging format defined in the DeploymentNotifications gem.
+
+## Custom Messaging
+The gem provides a custom messaging format for deployment notifications. It sends detailed deployment information at the start, success, and failure stages of your deployment process.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/your-username/deployment_notifications.
+
+## License
+The gem is available as open-source under the terms of the MIT License.
+
+Make sure to replace `'/path/to/your/local/gem'` with the actual path to your gem and update the GitHub repository URL to your actual repository.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/deployment_notifications.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/deployment_notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deployment_notifications'
+  spec.version       = DeploymentNotifications::VERSION
+  spec.authors       = ['Ashish Garg']
+  spec.email         = '01ashishgarg@gmail.com'
+
+  spec.summary       = 'Deliver deployment notifications to Slack'
+  spec.description   = 'Deliver Capistrano deployment notifications to Slack'
+  spec.homepage      = 'https://github.com/aashishgarg/deployment_notifications'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/aashishgarg/deployment_notifications'
+  spec.metadata['changelog_uri']   = 'https://github.com/aashishgarg/deployment_notifications/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Specify the dependencies of the gem
+  spec.add_dependency 'slackistrano'
+end

data/lib/deployment_notifications/deployment_messaging.rb

@@ -0,0 +1,104 @@
+if defined?(Slackistrano::Messaging)
+  module Slackistrano
+    class DeploymentMessaging < Messaging::Base
+
+      def info_item(item, value)
+        "• #{item} - _*#{value.to_s.gsub("\n", '')}*_"
+      end
+
+      def info_list(items)
+        items.join(" \n ")
+      end
+
+      def payload_for_starting
+        deployer_name = ENV['DEPLOYER_NAME'] || `git log -n 1 --format='%ae'`
+
+        if ENV['DEPLOYMENT_IDENTIFIER']
+          deployment_identifier = ENV['DEPLOYMENT_IDENTIFIER']
+        else
+          deployment_identifier = Time.now.strftime("%Y%m%d_%H%M%S")
+          ENV['DEPLOYMENT_IDENTIFIER'] = deployment_identifier
+        end
+
+        {
+          "blocks": [
+            {
+              "type": 'section',
+              "text": {
+                "type": 'mrkdwn',
+                "text": 'Deployment _*Started*_ for _*Eportfolio*_ application :wave:'
+              }
+            },
+            { "type": 'divider' },
+            {
+              "type": 'section',
+              "text": {
+                "type": 'mrkdwn',
+                "text": '_Information related to this deployment_:'
+              }
+            },
+            {
+              "type": 'section',
+              "text": {
+                "type": 'mrkdwn',
+                "text": info_list([
+                                    info_item('Deployer name', deployer_name),
+                                    info_item('Deployment identifier', deployment_identifier),
+                                    info_item('Env', ENV['ENV_NAME'] || stage),
+                                    info_item('Branch', ENV['BRANCH_NAME'] || branch),
+                                    info_item('Last commit by', ENV['LAST_COMMIT_AUTHOR'] || `git log -n 1 --format='%ae'`),
+                                    info_item('Commit time', ENV['LAST_COMMIT_TIME'] || `git show -s --format=%cd`),
+                                    info_item('Commit id', ENV['LAST_COMMIT_ID'] || `git rev-parse --short HEAD`),
+                                    info_item('Commit message', ENV['LAST_COMMIT_MESSAGE'] || `git show -s --format=%s`)
+                                  ])
+              }
+            }
+          ]
+        }
+      end
+
+      # Suppress updating message.
+      def payload_for_updating
+        nil
+      end
+
+      # Fancy updated message.
+      # See https://api.slack.com/docs/message-attachments
+      def payload_for_updated
+        {
+          attachments: [{
+                          color: 'good',
+                          title: "#{application} Deployed :boom::bangbang:",
+                          fields: [{
+                                     title: 'Deployment Identifier',
+                                     value: ENV['DEPLOYMENT_IDENTIFIER'],
+                                     short: true
+                                   },{
+                                     title: 'Environment',
+                                     value: stage,
+                                     short: true
+                                   }, {
+                                     title: 'Branch',
+                                     value: branch,
+                                     short: true
+                                   }, {
+                                     title: 'Time',
+                                     value: elapsed_time,
+                                     short: true
+                                   }],
+                          fallback: super[:text]
+                        }],
+          text: "<!here> #{application} Application Deployed!"
+        }
+      end
+
+      # Slightly tweaked failed message.
+      # See https://api.slack.com/docs/message-formatting
+      def payload_for_failed
+        payload = super
+        payload[:text] = "OMG :fire: #{payload[:text]}"
+        payload
+      end
+    end
+  end
+end

data/lib/deployment_notifications/notifier.rb

@@ -0,0 +1,15 @@
+require 'slackistrano'
+require 'deployment_notifications/deployment_messaging'
+
+module DeploymentNotifications
+  class Notifier
+    def self.setup_slackistrano
+      Slackistrano.configure do |config|
+        config.channel = DeploymentNotifier.channel
+        config.webhook = DeploymentNotifier.webhook
+
+        config.messaging = Slackistrano::DeploymentMessaging
+      end
+    end
+  end
+end

data/lib/deployment_notifications/railtie.rb

@@ -0,0 +1,33 @@
+require 'rails/railtie'
+require 'deployment_notifications/notifier'
+
+module DeploymentNotifications
+  class Railtie < Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer 'deployment_notifier.add_to_capfile' do
+        capfile_path = Rails.root.join('Capfile')
+        if File.exist?(capfile_path)
+          content = File.read(capfile_path)
+          unless content.include?("require 'slackistrano/capistrano'")
+            File.open(capfile_path, 'a') do |file|
+              file.puts("\nrequire 'slackistrano/capistrano'\n")
+            end
+          end
+        end
+      end
+
+      initializer 'deployment_notifications.configure_capistrano' do |app|
+        # Automatically configure Capistrano settings
+        if defined?(Capistrano::Configuration)
+          Capistrano::Configuration.instance.load do
+            set :slackistrano, {
+              channel: DeploymentNotifications.channel,
+              webhook: DeploymentNotifications.webhook,
+              klass: Slackistrano::DeploymentMessaging
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deployment_notifications/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeploymentNotifications
+  VERSION = "0.1.3"
+end

data/lib/deployment_notifications.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'slackistrano'
+require_relative "deployment_notifications/railtie"
+require_relative "deployment_notifications/version"
+
+module DeploymentNotifications
+  class << self
+    attr_accessor :channel, :webhook
+
+    def configure
+      yield self
+    end
+  end
+
+  class Notifier; end
+
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/deployment_notifications.rbs

@@ -0,0 +1,4 @@
+module DeploymentNotifications
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: deployment_notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Ashish Garg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slackistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deliver Capistrano deployment notifications to Slack
+email: 01ashishgarg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- deployment_notifications.gemspec
+- lib/deployment_notifications.rb
+- lib/deployment_notifications/deployment_messaging.rb
+- lib/deployment_notifications/notifier.rb
+- lib/deployment_notifications/railtie.rb
+- lib/deployment_notifications/version.rb
+- sig/deployment_notifications.rbs
+homepage: https://github.com/aashishgarg/deployment_notifications
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aashishgarg/deployment_notifications
+  source_code_uri: https://github.com/aashishgarg/deployment_notifications
+  changelog_uri: https://github.com/aashishgarg/deployment_notifications/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Deliver deployment notifications to Slack
+test_files: []