capistrano-slacky 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d8a000422ee77540816f23c92063aaafbc39d62c1d7328bca687abe74c42976
-  data.tar.gz: 96fea627fc2ef504cb8597a3c4c904ac75fda310b142f4e0e700e96659b9a6ea
+  metadata.gz: 00b2aed8c3c0bcd18970ed47c305cca3143c5c535bcb5ca10a693e29b4c1bc5b
+  data.tar.gz: 7c90f64ceefb7e2ea35379e018d9ce95a0d9f271e20959671ad7b512fd50818d
 SHA512:
-  metadata.gz: a2290b5b024df873244e1a0196befec28381519aa5ad8ccdecf5c2d67931e0653cc68fc8c4325809381a038d8fe890ccff88dcfdb6969994337ffc61ad52d7d4
-  data.tar.gz: bbca074fb05c97288aecbdf858cfcdb03dabbcd2cc969c183e42d39f17e9f32171cb29f5fe762e6df3301dbaf3fb71d88e703312d37adedc2f4a7b64a9984689
+  metadata.gz: 91e5c94bb9316628a420db5b6c3b94afbb71df72beb437921475835bfb903f92d261b9dfd59a8f038043633ccfd73d7f73ace86983254ed78048d306c948f2de
+  data.tar.gz: f31562940b77ca44bde8912af5368fc32e0012049d6a8f196fe761799149658d49ce44d1384e062ceb3a07d8da886bf3512e3e8aa1dce167a50f050d4c0a1d61

data/CHANGELOG.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.2.0] - 2021-12-20
+### Added
+- Add new header emoticons. ([@chubchenko][])
+
+## [0.1.5] - 2021-11-11
+### Fixed
+- Add fall back in case of the primary server is not defined. ([@chubchenko][])
+- Require `json` to convert `Hash` object to `JSON`. ([@chubchenko][])
+
+## [0.1.4] - 2021-07-27
+### Fixed
+- Ensure that `:current_revision` exists during rollback. ([@chubchenko][])
+
+## [0.1.3] - 2021-06-14
+### Changed
+- Update `README.md`. ([@chubchenko][])
+
+### Fixed
+- Change commit message encoding to `UTF-8`. ([@chubchenko][])
+
 ## [0.1.2] - 2021-06-03
 ### Changed
 - Use `I18n.t` instead of `t`. ([@chubchenko][])
@@ -31,7 +53,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial version. ([@chubchenko][])
 
 [@chubchenko]: https://github.com/chubchenko
-[Unreleased]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/chubchenko/capistrano-slacky/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.5...v0.2.0
+[0.1.5]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.4...v0.1.5
+[0.1.4]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/chubchenko/capistrano-slacky/releases/tag/v0.1.0

data/README.md

@@ -1,14 +1,123 @@
+<div align="center">
+  <img align="center"
+       height="100"
+       title="capistrano-slacky logo"
+       src="./assets/images/logo.svg">
+</div>
+
+[![gem version][9]][10]
 [![build][1]][2]
+[![downloads][11]][12]
 
 # capistrano-slacky
 
-Send `Capistrano` deployment status to `Slack`.
+Send `Capistrano` deployment status to `Slack` via the Incoming Webhooks integration.
+
+- Messages are built on the basis of the [Block Kit][13]. See [Demo](#demo) section.
+- Fires after every successful/failed deployment or rollback.
+- Use _Incoming Webhook URL_ from the remote server.
+- Send commit log between 2 deployments.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+- [Demo](#demo)
+
+## Requirements
+
+- Ruby >= 2.5
+- Capistrano ~> 3.0
+- Slack
+
+## Installation
+
+Add the following line to your `Gemfile`:
+
+```ruby
+gem "capistrano-slacky", "~> 0.1", require: false
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Out of the box, the gem has a default configuration:
+
+```ruby
+set :slacky, username: "ChatOps", # Set your bot's user name.
+             icon_emoji: ":robot_face:", # Emoji to use as the icon for this message.
+             channel: "#deployment", # The name of the channel to send a message to.
+             klass: Capistrano::Slacky::Messaging::Default # The class that responsible for creating a message.
+```
+
+So you can easily tweak your deployment messages and all other configuration to what you want.
+
+## Usage
+
+Require the library in your application's Capfile
+
+```ruby
+require "capistrano/slacky"
+```
+
+- Add an [Incoming Webhooks][4] to your Slack.
+- The received _Incoming Webhook URL_ must be uploaded to the remote server. It should be stored in a `shared` directory under the following path `config/slacky.yml`.
+- Run `cap production slacky:ping` command to test your integration.
+
+That's all, deploy your application as usual and you will see a deployment notification in your Slack channel.
+
+In case if you want to disable deployment notifications for a specific stage just set `slacky` to `false`.
+
+```ruby
+set :slacky, false
+```
+
+## Demo
+
+![Deployed successfully][5]
+
+![Reverted successfully][6]
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][2] the following Ruby implementations:
+
+- Ruby 2.5
+- Ruby 2.6
+- Ruby 2.7
+- Ruby 3.0
+
+If something doesn't work on one of these Ruby versions, it's a bug.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][4]. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked, and/or a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the [Pessimistic Version Constraint][5] with two digits of precision. For example:
+
+```ruby
+gem "capistrano-slacky", "~> 0.1"
+```
 
 ## License
 
 [MIT][3]
 
-
 [1]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml/badge.svg
 [2]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml
 [3]: https://choosealicense.com/licenses/mit
+[4]: https://api.slack.com/messaging/webhooks
+[5]: ./assets/images/deployed_successfully.jpg
+[6]: ./assets/images/deployment_failed.jpg
+[7]: ./assets/images/reverted_successfully.jpg
+[8]: ./assets/images/rollback_failed.jpg
+[9]: https://badge.fury.io/rb/capistrano-slacky.svg
+[10]: https://badge.fury.io/rb/capistrano-slacky
+[11]: https://img.shields.io/gem/dt/capistrano-slacky
+[12]: https://rubygems.org/gems/capistrano-slacky
+[13]: https://api.slack.com/block-kit

data/lib/capistrano/slacky/command/current_revision.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Slacky
+    module Command
+      class CurrentRevision
+        REVISION_FILE = "REVISION"
+
+        private_constant :REVISION_FILE
+
+        def self.call
+          output = nil
+
+          ::Capistrano::Slacky.on(within: :release) do
+            output = ::SSHKit::Backend.current.capture(:cat, REVISION_FILE)
+          end
+
+          output
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/slacky/command/diff.rb

@@ -54,6 +54,9 @@ module Capistrano
           "0" => ":zero:"
         }.freeze
 
+        DEFAULT_ENCODING = "UTF-8"
+        private_constant :DEFAULT_ENCODING
+
         def initialize(index:, sha:, commit:)
           @index = index
           @sha = sha
@@ -71,7 +74,7 @@ module Capistrano
         end
 
         def commit
-          @commit.delete('"').strip
+          @commit.delete('"').strip.force_encoding(DEFAULT_ENCODING)
         end
 
         def to_a

data/lib/capistrano/slacky/command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+require_relative "command/current_revision"
 require_relative "command/duration"
 require_relative "command/diff"

data/lib/capistrano/slacky/facade/header.rb

@@ -9,14 +9,18 @@ module Capistrano
           ":drooling_face:",
           ":sunglasses:",
           ":partying_face:",
-          ":heart_eyes:"
+          ":heart_eyes:",
+          ":star-struck:",
+          ":yum:"
         ].freeze
 
         REVERTED_SUCCESSFULLY = [
           ":upside_down_face:",
           ":pensive:",
           ":face_with_raised_eyebrow:",
-          ":worried:"
+          ":worried:",
+          ":pleading_face:",
+          ":shushing_face:"
         ].freeze
 
         DEPLOYMENT_FAILED = [
@@ -26,7 +30,10 @@ module Capistrano
           ":woozy_face:",
           ":exploding_head:",
           ":sob:",
-          ":cry:"
+          ":cry:",
+          ":dizzy_face:",
+          ":face_with_hand_over_mouth:",
+          ":broken_heart:"
         ].freeze
 
         ROLLBACK_FAILED = DEPLOYMENT_FAILED

data/lib/capistrano/slacky/on.rb

@@ -9,7 +9,8 @@ module Capistrano
 
       PATH_MAP = {
         repository: -> { Path.repo_path },
-        shared: -> { Path.shared_path }
+        shared: -> { Path.shared_path },
+        release: -> { Path.release_path }
       }.freeze
 
       private_constant :PATH_MAP
@@ -17,7 +18,9 @@ module Capistrano
       module_function
 
       def on(within:, &block)
-        ::Capistrano::DSL.on(::Capistrano::Configuration.env.primary(:app)) do
+        role = ::Capistrano::Configuration.env.primary(:app) || ::Capistrano::Configuration.env.roles(:all).first
+
+        ::Capistrano::DSL.on(role) do
           ::SSHKit::Backend.current.within(PATH_MAP.fetch(within).call, &block)
         end
       end

data/lib/capistrano/slacky/payload.rb

@@ -5,6 +5,8 @@ require_relative "messaging"
 module Capistrano
   module Slacky
     class Payload
+      require "json"
+
       def initialize(env:, action:)
         @env = env
         @action = action

data/lib/capistrano/slacky/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Slacky
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/tasks/defaults.rake

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 namespace :load do
+  desc "Load default configuration for slacky"
   task :defaults do
     append :linked_files, "config/slacky.yml"
   end

data/lib/tasks/slacky.rake

@@ -7,7 +7,7 @@ namespace :slacky do
   end
 
   desc "Slacky after successful rollback"
-  task :reverted do
+  task reverted: [:ensure_current_revision] do
     Capistrano::Slacky::Runner.call(action: :reverted)
   end
 
@@ -25,4 +25,9 @@ namespace :slacky do
       Capistrano::Slacky::Runner.call(action: action)
     end
   end
+
+  desc "Ensure that the current revision is set"
+  task :ensure_current_revision do
+    set_if_empty(:current_revision) { Capistrano::Slacky::Command::CurrentRevision.call }
+  end
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slacky
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-description: Send Capistrano deployment status to Slack via the incoming webhooks
+description: Send Capistrano deployment status to Slack via the Incoming Webhooks
   integration
 email: artem.chubchenko@gmail.com
 executables: []
@@ -90,6 +90,7 @@ files:
 - lib/capistrano/slacky/block/root.rb
 - lib/capistrano/slacky/block/section.rb
 - lib/capistrano/slacky/command.rb
+- lib/capistrano/slacky/command/current_revision.rb
 - lib/capistrano/slacky/command/diff.rb
 - lib/capistrano/slacky/command/duration.rb
 - lib/capistrano/slacky/configuration.rb
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Send Capistrano deployment status to Slack