capistrano-teams 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 109610593702b3c23d33d6a4deac385fbfe1f0fd541b262c7446a584b061e784
+  data.tar.gz: 61948c2f8f58d0987eb97127014691c57b8397a8e15974b500c57b520f13a8cd
+SHA512:
+  metadata.gz: ab50b9a83b8d2fa6ba44e11eb8b88288f16d4d3d7cd1e03704df6ca015e16d19803b1e6382a1e0050c6467cb0d6098b2cf6aa1d36dc22b24e7233455af48291b
+  data.tar.gz: 4730104e2d1164d9ffd594d3a1893ad27da180625fc2cc9f6487866dc2876f775a089a412ec5f6ef5779ddf24210429092c9303315eaeffddaef17e1e97f0019

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+.config
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+# This is the configuration used to check the capistrano-graphite source code.
+inherit_from: .rubocop_todo.yml
+
+Style/Encoding:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,53 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-03 09:21:59 UTC using RuboCop version 0.88.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - '**/**/**/*.rake'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/capistrano-teams.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'capistrano-teams.gemspec'
+    - 'lib/capistrano/tasks/teams.rake'
+    - 'lib/capistrano/teams.rb'
+    - 'lib/capistrano/teams/defaults.rb'
+    - 'lib/capistrano/teams/version.rb'
+    - 'lib/capistrano/teams/web_hook.rb'
+    - 'spec/capistrano/teams/web_hook_spec.rb'
+    - 'spec/capistrano/teams_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/capistrano/teams/web_hook.rb'

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0
+before_install: gem install bundler -v 1.3
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-08-09
+
+### Added
+
+- Plugin logic
+
+[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/danieltoader/capistrano-teams/releases/tag/v1.0.0

data/CODEOWNERS

@@ -0,0 +1,11 @@
+##########################################################
+#
+# List of approvers for danieltoader/capistrano-teams
+#
+##########################################################
+#
+# Learn about CODEOWNERS file format:
+#  https://help.github.com/en/articles/about-code-owners
+#
+
+* @danieltoader

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daniel.toader@emag.ro. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Toader
+
+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,256 @@
+# Capistrano::Teams
+
+[![Gem Downloads](http://img.shields.io/gem/dt/capistrano-teams.svg)](https://rubygems.org/gems/capistrano-teams)
+[![GitHub](https://img.shields.io/github/license/danieltoader/capistrano-teams?color=113399)](https://github.com/danieltoader/capistrano-teams/blob/master/LICENSE.md)
+[![Changelog](https://img.shields.io/badge/capistrano-capistran--teams-E05735)](https://github.com/danieltoader/capistrano-teams/blob/master/CHANGELOG.md)
+[![Gem Version](http://img.shields.io/gem/v/capistrano-teams.svg)](https://rubygems.org/gems/capistrano-teams)
+[![Build Status](http://img.shields.io/travis/danieltoader/capistrano-teams.svg)](http://travis-ci.org/danieltoader/capistrano-teams)
+[![Build status](https://ci.appveyor.com/api/projects/status/8e9dteu7ibxsb4ou?svg=true)](https://ci.appveyor.com/project/danieltoader/capistrano-teams)
+[![Coverage Status](https://img.shields.io/coveralls/danieltoader/capistrano-teams.svg)](https://coveralls.io/r/danieltoader/capistrano-teams?branch=master)
+
+This gem extends Capistrano functionality to push notices to Microsoft Teams via an incoming webhook.
+
+With just the webhook url configured and the default values, the plugin registers hooks for the base 
+deploy tasks (start, revert, finish, rollback and failed) and pushes simple notifications to the room
+where the used webhook was created.
+
+This project is meant to be highly customisable, you can find all the details below.
+
+This gem works with Capistrano v3.x+. Please check the capistrano gem version you're using before 
+installing this gem:
+```shell script
+ bundle show | grep capistrano
+```
+If you are new to Capistrano, check the [Capistrano 3 documentation](http://capistranorb.com/).
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'capistrano', '~> 3.0.0'
+gem 'capistrano-teams'
+```
+
+And then execute:
+```shell script
+bundle install
+```
+
+Or install it manually:
+```shell script
+gem install capistrano-teams
+```
+
+## Usage
+In Microsoft Teams, add an "Incoming Webhook" connector in the channel where you want to 
+see deployment notices as described [here](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook). 
+Copy the generated Webhook URL since you will need to add it in one of the detailed steps below.
+
+### Setup your application
+Add the following line to your `Capfile`.
+```ruby
+require "capistrano/teams"
+```
+
+In order to send notifications you must set the following options in your `deploy.rb` or 
+stage file (staging.rb, production.rb, etc). The only required option is the `:teams_webhook_url` setting. 
+
+```ruby
+set :teams_webhook_url, "https://outlook.office.com/webhook/{groupId}@{tenantId}/IncomingWebhook/{connectorId}/{webHookId}"
+
+set :teams_suppress_events, false
+set :teams_content_mode, Message::TYPE_CARD
+set :teams_http_options, verify_mode: OpenSSL::SSL::VERIFY_PEER 
+```
+
+To disable sending notifications for a certain stage, or to change the team/channel/room the message is 
+posted to, you need to edit the stage file and set the following:
+```ruby
+set :teams_suppress_events, true # Default value: false
+```
+
+#### Automated notifications
+After setting the minimum options needed for your application, the plugin will push notifications to 
+the teams room where the webhook was created for all the deploy events. Listed below you can see the
+hooks where the plugin injects itself:
+```ruby
+namespace :deploy do
+  before 'deploy:starting', 'teams:deploy:starting'
+  before 'deploy:reverting', 'teams:deploy:reverting'
+  after 'deploy:finishing', 'teams:deploy:finishing'
+  after 'deploy:finishing_rollback', 'teams:deploy:finishing_rollback'
+  after 'deploy:failed', 'teams:deploy:failed'
+end
+```
+
+#### Custom notifications
+If you want to send a custom notification you can invoke or execute the rake task `teams:notify` as shown below
+
+```ruby
+# with invoke
+Rake::Task["teams:notify"].invoke(
+  "{status}", 
+  [
+    {"name"=>"{first_fact_name}", "value"=>"{first_fact_value}"},
+    {"name"=>"{second_fact_name}", "value"=>"{second_fact_value}"},
+    # ...    
+  ],
+  "{theme_color}"
+)
+# with execute
+Rake::Task["teams:notify"].execute(
+  Rake::TaskArguments.new(
+    [:status, :facts, :theme_color],
+    [
+      "{status}",
+      [
+        {"name"=>"{first_fact_name}", "value"=>"{first_fact_value}"},
+        {"name"=>"{second_fact_name}", "value"=>"{second_fact_value}"},
+        # ...    
+      ],
+      "{theme_color}"
+    ]
+  )
+)
+```
+
+#### Remove default hooks for an action
+To remove a default hook from this plugin you can use the following line, it can be used
+anywhere in the desired `deploy.rb` or stage file
+```ruby
+Rake::Task['deploy:starting'].prerequisites.delete('teams:deploy:starting')
+```
+
+#### Custom Hook for rake task with arguments
+If you want to create a custom hook for tasks with arguments you can use the snippet below
+(with both invoke and execute shown above):
+```ruby
+before 'deploy:starting', :only => :deploy do
+  Rake::Task["teams:notify"].invoke(
+    "{status}", 
+    [
+      {"name"=>"{first_fact_name}", "value"=>"{first_fact_value}"},
+      {"name"=>"{second_fact_name}", "value"=>"{second_fact_value}"},
+      # ...    
+    ],
+    "{theme_color}"
+  )
+end
+```
+
+
+#### Message Types
+You can use this plugin with two message types: `Message::TYPE_BASIC` or `Message::TYPE_CARD`
+
+##### Basic message type (default)
+![Basic message type](docs/img/message_type_basic.png)
+The basic message type is the simple way to send notifications from capistrano to Teams.
+
+```ruby
+set :teams_basic_message_title, 'Deployment Notice » %<application>s'
+set :teams_basic_message_text, '<h1>Deploy for %<application>s' \
+      ' on <strong>%<stage>s</strong> by ' \
+      '<strong>%<user>s</strong></h1> ' \
+      "Branch: %<branch>s \n\n" \
+      'Status: %<status>s'
+```
+
+##### Card message type
+![Card message type](docs/img/message_type_card.png)
+The card message type has a few more options and can be configured more and can list several facts (name => value)
+
+
+```ruby
+set :teams_card_message_title, 'Deployment Notice » %<application>s'
+set :teams_card_message_sub_title, 'On %<stage>s'
+set :teams_card_message_image, ''
+set :teams_card_message_summary, 'Deploy for %<application>s on %<stage>s by %<user>s'
+set :teams_card_message_markdown, true
+```
+#### Configurable options
+
+##### Available options and default values
+```ruby
+set :teams_webhook_url, "https://outlook.office.com/webhook/{groupId}@{tenantId}/IncomingWebhook/{connectorId}/{webHookId}"
+
+set :teams_suppress_events, false # Default value: false
+set :teams_content_mode, Message::TYPE_BASIC # Message::TYPE_BASIC or Message::TYPE_CARD
+set :teams_http_options, verify_mode: OpenSSL::SSL::VERIFY_PEER # Default verify mode
+
+# Theme colors
+set :teams_starting_color, '0000FF' # Default color: blue
+set :teams_reverting_color, 'FFFF00' # Default color: yellow
+set :teams_finishing_color, '00FF00' # Default color: green
+set :teams_rollback_color, 'FFFF00' # Default color: yellow
+set :teams_failed_color, 'FF0000' # Default color: red
+
+# Statuses
+set :teams_starting_status, 'STARTING'
+set :teams_reverting_status, 'REVERTING'
+set :teams_finishing_status, 'FINISHED'
+set :teams_rollback_status, 'ROLLBACK'
+set :teams_failed_status, 'FAILED'
+
+# Used for Message::TYPE_BASIC
+set :teams_basic_message_title, 'Deployment Notice » %<application>s'
+set :teams_basic_message_text, '<h1>Deploy for %<application>s' \
+      ' on <strong>%<stage>s</strong> by ' \
+      '<strong>%<user>s</strong></h1> ' \
+      "Branch: %<branch>s \n\n" \
+      'Status: %<status>s'
+
+# Used for Message::TYPE_CARD
+set :teams_card_message_title, 'Deployment Notice » %<application>s'
+set :teams_card_message_sub_title, 'On %<stage>s'
+set :teams_card_message_image, ''
+set :teams_card_message_summary, 'Deploy for %<application>s on %<stage>s by %<user>s'
+set :teams_card_message_markdown, false # Enable markdown inside message
+
+# Default values
+set :teams_default_color, '333333' # Default color: grey
+set :teams_default_status, 'UNKNOWN'
+set :teams_default_application, 'N/A'
+set :teams_default_branch, 'N/A'
+set :teams_default_stage, 'N/A'
+set :teams_default_user, 'UNKNOWN'
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the 
+tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, 
+update the version number in `version.rb`, and then run `bundle exec rake release`, which will create 
+a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Deployment
+Run deploy
+```shell script
+cap <stage_name> deploy
+```
+
+You should then be able to proceed as you would usually, you may want to familiarise yourself 
+with the truncated list of tasks, you can get a full list with:
+```shell script
+cap -T
+```
+    
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+If something is not working for you, or you find a bug, please report it.
+Bug reports and pull requests are welcome on GitHub at https://github.com/danieltoader/capistrano-teams. 
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://github.com/danieltoader/capistrano-teams/blob/master/LICENSE.md).
+
+## Code of Conduct
+Everyone interacting in the Capistrano::Teams project's codebase, issue trackers, chat rooms and mailing 
+lists is expected to follow the [code of conduct](https://github.com/danieltoader/capistrano-teams/blob/master/CODE_OF_CONDUCT.md).
+
+## Todo's
+[] Add tests
+[] Add functionality for sending "potentialAction" key for the card message type

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/appveyor.yml

@@ -0,0 +1,21 @@
+version: '{build}'
+
+skip_tags: true
+
+skip_branch_with_pr: true
+
+environment:
+  matrix:
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - gem uninstall bundler --all --executables
+  - gem install bundler --no-document -v ">=1.16"
+  - bundle install --retry=3
+
+test_script:
+  - bundle exec rake
+
+build: off

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/teams'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-teams.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/capistrano/teams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-teams'
+  spec.version       = Capistrano::Teams::VERSION
+  spec.authors       = ['Daniel Toader']
+  spec.email         = ['developer@danieltoader.com']
+
+  spec.summary       = 'Microsoft Teams integration for Capistrano 3.x'
+  # spec.description   = %q{Microsoft Teams integration for Capistrano 3.x}
+  spec.homepage      = 'https://rubygems.org/gems/capistrano-teams'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/danieltoader/capistrano-teams'
+  spec.metadata['changelog_uri'] = 'https://github.com/danieltoader/capistrano-teams/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  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.0'
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
+end

data/lib/capistrano-teams.rb

@@ -0,0 +1 @@
+

data/lib/capistrano/tasks/teams.rake

@@ -0,0 +1,52 @@
+require 'capistrano/teams/web_hook'
+require 'capistrano'
+
+namespace :teams do
+  task :notify, :status, :facts, :theme_color do |task, args|
+    send_notification(
+      args[:status] || fetch(:teams_default_status),
+      args[:theme_color] || fetch(:teams_default_color),
+      args[:facts] || []
+    )
+    task.reenable
+  end
+  namespace :deploy do
+    task :starting do |task|
+      notify_event(fetch(:teams_starting_status), fetch(:teams_starting_color))
+      task.reenable
+    end
+
+    task :reverting do |task|
+      notify_event(fetch(:teams_reverting_status), fetch(:teams_reverting_color))
+      task.reenable
+    end
+
+    task :finishing do |task|
+      notify_event(fetch(:teams_finishing_status), fetch(:teams_finishing_color))
+      task.reenable
+    end
+
+    task :finishing_rollback do |task|
+      notify_event(fetch(:teams_rollback_status), fetch(:teams_rollback_color))
+      task.reenable
+    end
+
+    task :failed do |task|
+      notify_event(fetch(:teams_failed_status), fetch(:teams_failed_color))
+      task.reenable
+    end
+  end
+end
+
+def send_notification(status, color, facts)
+  Capistrano::Teams::WebHook.new.notify(status, color, facts)
+  puts "'#{status.capitalize}' event notification sent to teams."
+end
+
+def notify_event(status, color)
+  if fetch(:teams_suppress_events) == false
+    send_notification(status, color, [])
+  else
+    puts 'Notification not sent, `teams_suppress_events` is set to true or is invalid.'
+  end
+end

data/lib/capistrano/teams.rb

@@ -0,0 +1,20 @@
+require 'rake'
+require 'capistrano/teams/version'
+require 'capistrano/teams/message/types'
+
+# Core tasks for teams integration
+load File.expand_path('tasks/teams.rake', __dir__)
+
+namespace :deploy do
+  before 'deploy:starting', 'teams:deploy:starting'
+  before 'deploy:reverting', 'teams:deploy:reverting'
+  after 'deploy:finishing', 'teams:deploy:finishing'
+  after 'deploy:finishing_rollback', 'teams:deploy:finishing_rollback'
+  after 'deploy:failed', 'teams:deploy:failed'
+end
+
+namespace :load do
+  task :defaults do
+    load 'capistrano/teams/defaults.rb'
+  end
+end

data/lib/capistrano/teams/defaults.rb

@@ -0,0 +1,42 @@
+# Teams defaults
+
+# set :teams_webhook_url,  "url"
+set :teams_suppress_events, false
+set :teams_message_type, Message::TYPE_BASIC # Message::TYPE_BASIC or Message::TYPE_CARD
+set :teams_http_options, verify_mode: OpenSSL::SSL::VERIFY_PEER
+
+# Theme colors
+set :teams_starting_color, '0033CC'
+set :teams_reverting_color, 'FFFF00'
+set :teams_finishing_color, '00FF00'
+set :teams_rollback_color, 'FFFF00'
+set :teams_failed_color, 'FF0000'
+
+# Statuses
+set :teams_starting_status, 'STARTING'
+set :teams_reverting_status, 'REVERTING'
+set :teams_finishing_status, 'FINISHED'
+set :teams_rollback_status, 'ROLLBACK'
+set :teams_failed_status, 'FAILED'
+
+# Used for Message::TYPE_BASIC
+set :teams_basic_message_title, 'Deployment Notice » %<application>s'
+set :teams_basic_message_text, '<h1>Deploy on <strong>%<stage>s</strong> by ' \
+      '<strong>%<user>s</strong></h1> ' \
+      "Branch: %<branch>s \n\n" \
+      'Status: %<status>s'
+
+# Used for Message::TYPE_CARD
+set :teams_card_message_title, 'Deployment Notice » %<application>s'
+set :teams_card_message_sub_title, 'On %<stage>s'
+set :teams_card_message_image, ''
+set :teams_card_message_summary, 'Deploy for %<application>s on %<stage>s by %<user>s'
+set :teams_card_message_markdown, false
+
+# Default values
+set :teams_default_color, '333333'
+set :teams_default_status, 'UNKNOWN'
+set :teams_default_application, 'N/A'
+set :teams_default_branch, 'N/A'
+set :teams_default_stage, 'N/A'
+set :teams_default_user, 'UNKNOWN'

data/lib/capistrano/teams/message/placeholders.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Message
+  # Placeholder
+  class Placeholders
+    attr_reader :placeholders
+
+    def initialize(placeholders)
+      @placeholders = defaults.merge(placeholders)
+    end
+
+    private
+
+    def defaults
+      {
+        application: fetch(:application, fetch(:teams_default_application)),
+        branch: fetch(:branch, fetch(:teams_default_branch)),
+        stage: fetch(:stage, :teams_default_stage),
+        user: ENV.fetch('USER', ENV.fetch('USERNAME', :teams_default_user))
+      }
+    end
+  end
+end

data/lib/capistrano/teams/message/types.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'capistrano/teams/message/placeholders'
+
+module Message
+  TYPE_BASIC = 1
+  TYPE_CARD = 2
+  # Message builder class
+  class Builder
+    def self.of_type(type, placeholder_list, theme_color, facts)
+      case type
+      when Message::TYPE_BASIC
+        Basic.new(placeholder_list, theme_color, facts)
+      when Message::TYPE_CARD
+        MessageCard.new(placeholder_list, theme_color, facts)
+      else
+        raise 'Capistrano Teams: Unknown message type'
+      end
+    end
+  end
+
+  # Type
+  class Type
+    def initialize(placeholder_list, theme_color, facts = [])
+      @placeholder_list = placeholder_list
+      @theme_color = theme_color
+      @facts = facts
+    end
+
+    def placeholders
+      Message::Placeholders.new(@placeholder_list).placeholders
+    end
+
+    def content
+      raise 'Abstract method called'
+    end
+  end
+
+  # Basic type
+  class Basic < Type
+    # Get the body of the POST message as JSON.
+    def content
+      {
+        title: fetch(:teams_basic_message_title),
+        text: fetch(:teams_basic_message_text),
+        themeColor: @theme_color
+      }.to_json % placeholders
+    end
+  end
+
+  # MessageCard type
+  class MessageCard < Type
+    # Get the body of the POST message as JSON.
+    def content
+      {
+        '@type' => 'MessageCard',
+        '@context' => 'http://schema.org/extensions',
+        'themeColor' => @theme_color,
+        'summary' => fetch(:teams_card_message_summary),
+        'sections' => sections,
+        'potentialAction' => []
+      }.to_json % placeholders
+    end
+
+    private
+
+    def sections
+      [{
+        'activityTitle' => fetch(:teams_card_message_title),
+        'activitySubtitle' => fetch(:teams_card_message_sub_title),
+        'activityImage' => fetch(:teams_card_message_image),
+        'facts' => facts,
+        'markdown' => fetch(:teams_card_message_markdown)
+      }]
+    end
+
+    def facts
+      [
+        {
+          'name' => 'Deploy by',
+          'value' => '%<user>s'
+        },
+        {
+          'name' => 'Branch',
+          'value' => '%<branch>s'
+        },
+        {
+          'name' => 'Deploy date',
+          'value' => Time.now.strftime('%d/%m/%Y %H:%M:%S')
+        }, {
+          'name' => 'Status',
+          'value' => '%<status>s'
+        }
+      ].concat(@facts)
+    end
+  end
+end

data/lib/capistrano/teams/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Teams
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/capistrano/teams/web_hook.rb

@@ -0,0 +1,45 @@
+require 'capistrano'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'capistrano/teams/message/types'
+
+module Capistrano
+  module Teams
+    class Error < StandardError; end
+
+    # Teams Webhook class
+    class WebHook
+      def notify(
+        status = fetch(:teams_default_status),
+        theme_color = fetch(:teams_default_color),
+        facts = []
+      )
+        content = Message::Builder.of_type(
+          fetch(:teams_message_type),
+          {
+            status: status
+          },
+          theme_color,
+          facts
+        ).content
+        send_message_to_webhook(content)
+      end
+
+      # Post to Teams.
+      def send_message_to_webhook(body)
+        uri = URI.parse(fetch(:teams_webhook_url).to_s)
+        request = Net::HTTP::Post.new(uri.path)
+        request.content_type = 'application/json'
+        request.body = body
+
+        opts = { use_ssl: uri.scheme == 'https' } \
+               .merge(fetch(:teams_http_options))
+
+        Net::HTTP.start(uri.host, uri.port, opts) do |http|
+          http.request(request)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-teams
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Toader
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-09 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- developer@danieltoader.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- capistrano-teams.gemspec
+- docs/img/message_type_basic.png
+- docs/img/message_type_card.png
+- lib/capistrano-teams.rb
+- lib/capistrano/tasks/teams.rake
+- lib/capistrano/teams.rb
+- lib/capistrano/teams/defaults.rb
+- lib/capistrano/teams/message/placeholders.rb
+- lib/capistrano/teams/message/types.rb
+- lib/capistrano/teams/version.rb
+- lib/capistrano/teams/web_hook.rb
+homepage: https://rubygems.org/gems/capistrano-teams
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/capistrano-teams
+  source_code_uri: https://github.com/danieltoader/capistrano-teams
+  changelog_uri: https://github.com/danieltoader/capistrano-teams/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Microsoft Teams integration for Capistrano 3.x
+test_files: []