teamistrano 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f11144d6eb840b836dd0150e7427fd12ac5bbbc0f8ee902fa9fcd1e37656d76
+  data.tar.gz: d554dd263e85435706e7a1b0ddaf3f267f1562c7505e5fb62d01df1c54c8ed3f
+SHA512:
+  metadata.gz: 78b8fc81ad8a675bc562c80b081480c4c02367348d23457725013d6768335f8d01caf120f94272a23e07efde819cd3c8fd45cb05e84bf10084ab897d041a9d18
+  data.tar.gz: fe8bfdda9d4f466bffdd9adf1a70de44c3482ec2795993dce83f83dec813b5e5630d815ea587994c9257e341286d602041f21f6eb8baa64fbc670fb0c3b576f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

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 eric.crane@mac.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in teamistrano.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Eric Crane
+
+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,42 @@
+# Teamistrano
+
+The Teamistrano gem can be used to post deployment notices in Microsoft Teams.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teamistrano'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teamistrano
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ecrane/teamistrano. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Teamistrano project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/teamistrano/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teamistrano"
+
+# 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/lib/teamistrano/notifier.rb

@@ -0,0 +1,83 @@
+require 'teamistrano/settings'
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Teamistrano
+  class Notifier
+    
+    DEFAULT_COLOR = "0033CC"  # blue
+    GREEN = "00CC66"
+    RED = "CC0000"
+    
+    def initialize( env )
+      @env = env
+      @settings = Teamistrano::Settings.new( @env )
+      @color = DEFAULT_COLOR
+      @msg = ""
+    end
+    
+        
+    # Send notice that deployment started.
+    def notify_updating
+      @msg = "Deployment Started"
+      post
+    end
+
+    # Send notice that deployment is reverting.
+    def notify_reverting
+      @msg = "Deployment Reverting"
+      post
+    end
+
+    # Send notice that deployment finished.
+    def notify_finishing
+      @color = GREEN
+      @msg = "Deployment Finished"
+      post
+    end
+
+    # Send notice that deployment rollback finished.
+    def notify_finishing_rollback
+      @msg = "Deployment Rollback Finished"
+      post
+    end
+
+    # Send notice that deployment failed.
+    def notify_failed
+      @color = RED
+      @msg = "Deployment Failed"
+      post
+    end
+    
+    # Get the full message to be delieved.
+    def get_msg
+      return "#{@msg} for #{@settings.application}.  (#{@settings.stage})
+        \n Branch: #{@settings.branch} 
+        \n Deployed by: #{@settings.deployer}"
+    end
+    
+    # Get the body of the POST message as JSON.
+    def get_body
+      return {
+        'title' => "Deployment Notice",
+        'text' => get_msg,
+        'themeColor' => @color
+      }.to_json
+    end
+    
+    # Post to Teams.
+    def post
+      uri = URI.parse( @settings.webhook_url )
+      request = Net::HTTP::Post.new( uri.path )
+      request.content_type = 'application/json'
+      request.body = get_body
+      n = Net::HTTP.new( uri.host, uri.port )
+      n.use_ssl = true
+
+      # Send the payload to the endpoint.
+      n.start { |http| http.request( request ) }
+    end
+    
+  end
+end

data/lib/teamistrano/settings.rb

@@ -0,0 +1,56 @@
+# 
+# Helper class: used to access settings/configuration.
+# 
+module Teamistrano
+  class Settings
+    
+    def initialize( env )
+      @env = env
+      @config = @env.fetch( :teamistrano, {} )
+    end
+
+    # Get the URL for the webhook call.
+    def webhook_url
+      return @config[ :webhook ]
+    end
+
+    # Get the local user name.
+    def get_local_user
+      return ENV['USER'] || ENV['USERNAME']
+    end
+    
+    # Get the name of the deployer.
+    def deployer
+      return @env.fetch( :local_user, get_local_user)
+    end
+    
+    # Get the branch being deployed.
+    def branch
+      @env.fetch( :branch, "N/A" )
+    end
+    
+    # Get the name of the application being deployed.
+    def application
+      @env.fetch( :application, "N/A" )
+    end
+    
+    # Get the stage of deployment (TEST, PROD).
+    def stage
+      @env.fetch( :stage, "N/A" )
+    end
+    
+    # Show the settings.
+    # This is a debugging function only.
+    def show
+      puts "------------------- settings -------------------"
+      puts "Application: #{application}"
+      puts "Branch: #{branch}"
+      puts "Stage: #{stage}"
+      puts "Deployer: #{deployer}"
+      puts "Local User: #{get_local_user}"
+      puts "URL: #{webhook_url}"
+      puts "------------------------------------------------"
+    end
+
+  end
+end

data/lib/teamistrano/tasks/teamistrano.rake

@@ -0,0 +1,38 @@
+require 'teamistrano/notifier'
+
+namespace :teamistrano do
+  namespace :deploy do
+
+    desc 'Deployment has started.'
+    task :updating do
+      Teamistrano::Notifier.new( self ).notify_updating
+    end
+
+    desc 'Deployment has started reverting.'
+    task :reverting do
+      Teamistrano::Notifier.new( self ).notify_reverting
+    end
+
+    desc 'Deployment has finished'
+    task :finishing do
+      Teamistrano::Notifier.new( self ).notify_finishing
+    end
+
+    desc 'Deployment rollback has finished.'
+    task :finishing_rollback do
+      Teamistrano::Notifier.new( self ).notify_finishing_rollback
+    end
+
+    desc 'Deployment has failed.'
+    task :failed do
+      Teamistrano::Notifier.new( self ).notify_failed
+    end
+
+  end
+end
+
+before 'deploy:updating', 'teamistrano:deploy:updating'
+before 'deploy:reverting', 'teamistrano:deploy:reverting'
+after  'deploy:finishing', 'teamistrano:deploy:finishing'
+after  'deploy:finishing_rollback', 'teamistrano:deploy:finishing_rollback'
+after  'deploy:failed', 'teamistrano:deploy:failed'

data/lib/teamistrano/version.rb

@@ -0,0 +1,3 @@
+module Teamistrano
+  VERSION = "1.0.0"
+end

data/lib/teamistrano.rb

@@ -0,0 +1,6 @@
+require "teamistrano/version"
+
+load File.expand_path("../teamistrano/tasks/teamistrano.rake", __FILE__)
+
+module Teamistrano
+end

data/teamistrano.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "teamistrano/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "teamistrano"
+  spec.version       = Teamistrano::VERSION
+  spec.authors       = ["Eric Crane"]
+  spec.email         = ["eric.crane@mac.com"]
+
+  spec.summary       = %q{Post notices in Teams of Capistrano deployments.}
+  spec.description   = %q{Post notices in Teams of Capistrano deployments.}
+  spec.homepage      = "https://github.com/ecrane/teamistrano"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  # spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  #   f.match(%r{^(test|spec|features)/})
+  # end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: teamistrano
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Crane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Post notices in Teams of Capistrano deployments.
+email:
+- eric.crane@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teamistrano.rb
+- lib/teamistrano/notifier.rb
+- lib/teamistrano/settings.rb
+- lib/teamistrano/tasks/teamistrano.rake
+- lib/teamistrano/version.rb
+- teamistrano.gemspec
+homepage: https://github.com/ecrane/teamistrano
+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.4
+signing_key: 
+specification_version: 4
+summary: Post notices in Teams of Capistrano deployments.
+test_files: []