circleci_deployment_notifier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 214c419d82d11a261c0380fd0f0431c892fb4923
+  data.tar.gz: 9a58c249f3419846c69a220988d83dfabe529471
+SHA512:
+  metadata.gz: 2a361d88285b294255969f8a9fd52b6b97680292512d70d761128ed8ff835b1d890f150f47b89d879170a4416dd596f72a29e6951587dd62094eaba5aed57ac7
+  data.tar.gz: a3545c4d0505905c6e36a4af31e56ee249363900f497a43e4e079777745d15b7750c8025939a391eddcb013f7ac55b56308ad60e510c88618e76d2084b6bd378

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Robin Daugherty
+
+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,39 @@
+# CircleCI Deployment Notifier
+
+Sends deployment notifications based on deployments that occur on CircleCI.
+
+Assumptions:
+
+- Using CircleCI.
+- Using Github.
+- Using Slack for notifications.
+
+You can also:
+
+- Deploy releases that are tagged using Github Releases.
+
+## Installation
+
+Requires Ruby 2.0.0 or higher.
+
+```sh
+gem install circleci_deployment_notifier
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RobinDaugherty/circleci_deployment_notifier.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

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/circleci_deployment_notifier.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circleci_deployment_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "circleci_deployment_notifier"
+  spec.version       = CircleciDeploymentNotifier::VERSION
+  spec.authors       = ["Robin Daugherty"]
+  spec.email         = ["robin@robindaugherty.net"]
+
+  spec.summary       = %q{Sends deployment notifications based on deployments that occur on CircleCI.}
+  spec.homepage      = "https://github.com/RobinDaugherty/circleci_deployment_notifier"
+  spec.license       = "MIT"
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+  spec.add_dependency "slack-notifier", "~> 2.0"
+  spec.add_dependency "slop", "~> 4.4"
+end

data/exe/circleci_deployment_notify_slack

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'circleci_deployment_notifier'
+require 'slop'
+require 'uri'
+
+puts "CircleCI Deployment Notify Slack"
+
+opts = Slop.parse do |o|
+  o.string '-a', '--app-name', 'Name of the application that was deployed (e.g. "Asgard Production")'
+  o.string '-u', '--webhook-url', 'Slack Webhook URL'
+  o.on '--version', 'print the version' do
+    puts CircleciDeploymentNotifier::VERSION
+    exit
+  end
+end
+
+unless ENV['CIRCLECI']
+  STDERR.puts "ERROR: This is not a CircleCI build (missing environment variables)."
+  exit 1
+end
+
+# unless ARGV.size == 2
+#   STDERR.puts "Not enough arguments."
+#   print_help
+# end
+
+app_name = opts[:app_name]
+webhook_url = opts[:webhook_url]
+
+if webhook_url.nil?
+  STDERR.puts "ERROR: Missing Slack Webhook URL"
+  puts opts
+  exit 1
+end
+
+if app_name.nil?
+  STDERR.puts "ERROR: Missing App Name"
+  puts opts
+  exit 1
+end
+
+unless webhook_url =~ /\A#{URI::regexp(['http', 'https'])}\z/
+  STDERR.puts "ERROR: Slack Webhook URL is not a valid URL: #{webhook_url}"
+  puts opts
+  exit 1
+end
+
+CircleciDeploymentNotifier::Build.new(app_name: app_name).send_to_slack(webhook_url: webhook_url)

data/lib/circleci_deployment_notifier.rb

@@ -0,0 +1,5 @@
+require "circleci_deployment_notifier/version"
+require "circleci_deployment_notifier/build"
+
+module CircleciDeploymentNotifier
+end

data/lib/circleci_deployment_notifier/build.rb

@@ -0,0 +1,22 @@
+require "circleci_deployment_notifier/build_info"
+require "circleci_deployment_notifier/slack"
+
+module CircleciDeploymentNotifier
+  class Build
+    def initialize(app_name:)
+      self.app_name = app_name
+    end
+
+    def send_to_slack(webhook_url:)
+      Slack.new(webhook_url: webhook_url, app_name: app_name, build_info: build_info).send
+    end
+
+    private
+
+    attr_accessor :app_name
+
+    def build_info
+      @build_info ||= BuildInfo.new
+    end
+  end
+end

data/lib/circleci_deployment_notifier/build_info.rb

@@ -0,0 +1,59 @@
+module CircleciDeploymentNotifier
+  class BuildInfo
+    def commit_hash
+      ENV['CIRCLE_SHA1']
+    end
+
+    def commit_browse_url
+      "#{repository_url}/tree/#{commit_hash}"
+    end
+
+    def branch_name
+      ENV['CIRCLE_BRANCH']
+    end
+
+    def tag_name
+      ENV['CIRCLE_TAG']
+    end
+
+    def tag_url
+      return unless tag_name
+      "#{repository_url}/tree/#{tag_name}"
+    end
+
+    def tag_release_notes_url
+      return unless tag_name
+      "#{repository_url}/releases/tag/#{tag_name}"
+    end
+
+    def tag?
+      tag_name
+    end
+
+    def builder_username
+      ENV['CIRCLE_USERNAME']
+    end
+
+    def builder_icon
+      return unless builder_username
+      "https://github.com/#{builder_username}.png"
+    end
+
+    def builder_url
+      return unless builder_username
+      "https://github.com/#{builder_username}"
+    end
+
+    def repository_url
+      ENV['CIRCLE_REPOSITORY_URL']
+    end
+
+    def build_identifier
+      ENV['CIRCLE_BUILD_NUM']
+    end
+
+    def build_url
+      ENV['CIRCLE_BUILD_URL']
+    end
+  end
+end

data/lib/circleci_deployment_notifier/slack.rb

@@ -0,0 +1,71 @@
+require 'slack-notifier'
+
+module CircleciDeploymentNotifier
+  ##
+  # Sends notifications to Slack.
+  # Builds the message from a BuildInfo object.
+  class Slack
+    def initialize(webhook_url:, app_name:, build_info:)
+      self.webhook_url = webhook_url
+      self.app_name = app_name
+      self.build_info = build_info
+    end
+
+    def send
+      slack_notifier.post message
+    end
+
+    private
+
+    attr_accessor :webhook_url
+    attr_accessor :app_name
+    attr_accessor :build_info
+
+    def message
+      {
+        username: username,
+        attachments: [
+          {
+            fallback: fallback_text,
+            color: "good",
+            text: text,
+            footer: footer_text,
+            footer_icon: footer_icon,
+          },
+        ],
+      }
+    end
+
+    def username
+      "#{app_name} Deployments"
+    end
+
+    def fallback_text
+      "#{build_info.tag_name || build_info.branch_name} deployed"\
+        "#{build_info.builder_username ? " by #{build_info.builder_username}" : ""}"
+    end
+
+    def text
+      if build_info.tag_name
+        "<#{build_info.tag_url}|#{build_info.tag_name}>" \
+          " (<#{build_info.tag_release_notes_url}|release notes>)"
+      elsif build_info.branch_name
+        "<#{build_info.commit_browse_url}|#{build_info.branch_name}>"
+      end
+    end
+
+    def footer_text
+      return unless build_info.builder_url
+      "deployed by <#{build_info.builder_url}|#{build_info.builder_username}>" \
+        " in <#{build_info.build_url}|build #{build_info.build_identifier}>"
+    end
+
+    def footer_icon
+      build_info.builder_icon
+    end
+
+    def slack_notifier
+      @slack_notifier ||= ::Slack::Notifier.new(webhook_url)
+    end
+  end
+end

data/lib/circleci_deployment_notifier/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: circleci_deployment_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robin Daugherty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+description: 
+email:
+- robin@robindaugherty.net
+executables:
+- circleci_deployment_notify_slack
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circleci_deployment_notifier.gemspec
+- exe/circleci_deployment_notify_slack
+- lib/circleci_deployment_notifier.rb
+- lib/circleci_deployment_notifier/build.rb
+- lib/circleci_deployment_notifier/build_info.rb
+- lib/circleci_deployment_notifier/slack.rb
+- lib/circleci_deployment_notifier/version.rb
+homepage: https://github.com/RobinDaugherty/circleci_deployment_notifier
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Sends deployment notifications based on deployments that occur on CircleCI.
+test_files: []