circleci_deployment_notifier 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35da5d43b5ea74ce0d122ab2626a4150de8b8a09
-  data.tar.gz: 556b7b145b1ff5514e61e267f984897c488ab8d7
+  metadata.gz: d33310b4336ae0ac91b9649691dbeaf7070569fe
+  data.tar.gz: 4714fc08c4a00f01c33091d366975608687b27e9
 SHA512:
-  metadata.gz: 6ac68e893bd18dcdbb25e117f0d8480a2bf3c50d63ffe2c3e29eddbf45abe941a5391d2f73c98fcb4e3b319396c2c092db44291d228d99ce5121d9781d95bd42
-  data.tar.gz: 41e5dfc603b75eb9700ad5503aeb3ae9ea0e21f947befc4e947eedc953a8b2eed565e43725797e2debabbb8607f7409c1f40c3e47827627f382a55c9c58e302a
+  metadata.gz: 1818a8cdb6e29cd6d81a79fce46352bf208370e9a7619812599c27cf71bd4a36c089e42a508c9eb45916565cb6ef24a23c137cd6f0dd1e83d18e8fae5681715d
+  data.tar.gz: 50969eaeef8bc73658c2d212addec59381f256e71ff00a0b493d2b9f10c03e02f8b0b54cf52979d5fa524e39eb9e768895cb32759f73d835683347692f69cece

data/.rubocop.yml

@@ -0,0 +1,39 @@
+#
+# For more information see https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# However, do not include entire blocks here just because you want to change them.
+# Include only the specific lines that you're changing from the defaults.
+#
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+Style/WhileUntilModifier:
+  MaxLineLength: 100
+Metrics/LineLength:
+  Max: 100
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/ClassCheck:
+  Enabled: false
+Style/DotPosition:
+  EnforcedStyle: leading
+Style/IndentHash:
+  EnforcedStyle: consistent
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+Style/StringLiterals:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: true
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
+- 2.1.10
+- 2.2.6
+- 2.3.3
+- 2.4.0
 before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -2,4 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in circleci_deployment_notifier.gemspec
 gemspec
-gem 'codacy-coverage', require: false

data/README.md

@@ -1,6 +1,7 @@
-
+[![Build Status](https://travis-ci.org/RobinDaugherty/circleci_deployment_notifier.svg?branch=master)](https://travis-ci.org/RobinDaugherty/circleci_deployment_notifier)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b76abb83eb5449499cbe3740c147715e)](https://www.codacy.com/app/robindaugherty/circleci_deployment_notifier?utm_source=github.com&utm_medium=referral&utm_content=RobinDaugherty/circleci_deployment_notifier&utm_campaign=Badge_Grade)
 [![Codacy Coverage](https://api.codacy.com/project/badge/Coverage/b76abb83eb5449499cbe3740c147715e)](https://www.codacy.com/app/robindaugherty/circleci_deployment_notifier?utm_source=github.com&utm_medium=referral&utm_content=RobinDaugherty/circleci_deployment_notifier&utm_campaign=Badge_Coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/RobinDaugherty/circleci_deployment_notifier.svg)](https://gemnasium.com/github.com/RobinDaugherty/circleci_deployment_notifier)
 
 # CircleCI Deployment Notifier
 
@@ -16,24 +17,21 @@ You can also:
 
 - Deploy releases that are tagged using Github Releases.
 
-## Installation
+## Usage
 
 Requires Ruby 2.0.0 or higher.
 
-```sh
-gem install circleci_deployment_notifier
-```
-
-## Usage
-
-Add the following lines to your `circle.yml` in the deployments section:
+Add the following commands to your `circle.yml` deployment section:
 
 ```sh
 gem install circleci_deployment_notifier
 circleci_deployment_notify_slack -a "Application Name" -u "https://hooks.slack.com/services/WEBHOOK"
 ```
 
-Here's an example deployment section from `circle.yml`:
+It's best to use environment variables for sensitive information list Slack webhook URLs.
+
+So here's an example `circle.yml` deployment section that 
+assumes you've set the environment variable `DEPLOYMENT_SLACK_WEBHOOK_URL`:
 ```yml
 deployment:
   staging:
@@ -41,16 +39,21 @@ deployment:
     commands:
     - # TODO: something to deploy the application to staging
     - gem install circleci_deployment_notifier
-    - circleci_deployment_notify_slack -a "Application Staging" -u "https://hooks.slack.com/services/WEBHOOK"
+    - circleci_deployment_notify_slack -a "Application Staging" -u $DEPLOYMENT_SLACK_WEBHOOK_URL
   production:
     tag: /v[0-9]+\.[0-9]+\.[0-9]+/
     owner: MyOrganization
     commands:
     - # TODO: something to deploy the application to production
     - gem install circleci_deployment_notifier
-    - circleci_deployment_notify_slack -a "Application Production" -u "https://hooks.slack.com/services/WEBHOOK"
+    - circleci_deployment_notify_slack -a "Application Production" -u $DEPLOYMENT_SLACK_WEBHOOK_URL
 ```
 
+That `production` section is designed to build and deploy for tags like "v1.0.0" that are created in
+the fork of the repo that belongs to MyOrganization.
+(So tags created in forks do not cause a build or deployment.)
+See [CircleCI docs](https://circleci.com/docs/configuration/#tags) for more info.
+
 ## 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.
@@ -61,6 +64,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/RobinDaugherty/circleci_deployment_notifier.
 
+## FAQ
+
+### Why is this project built on Travis when it's specifically for CircleCI?
+
+CircleCI does not support builds against multiple versions of Ruby, so for a tool like this, Travis
+is a better fit.
+This gem is for use by applications, where it will be built on a single version of Ruby and deployed
+to staging and/or production infrastructure owned by the team.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/circleci_deployment_notifier.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 2.3"
+  spec.add_development_dependency "codacy-coverage"
   spec.add_dependency "slack-notifier", "~> 2.0"
   spec.add_dependency "slop", "~> 4.4"
 end

data/exe/circleci_deployment_notify_new_relic

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'circleci_deployment_notifier'
+require 'slop'
+require 'uri'
+
+puts "CircleCI Deployment Notify New Relic"
+
+opts = Slop.parse do |o|
+  o.string '-a', '--app-name', 'Name of the application that was deployed (e.g. "Asgard Production")'
+  o.string '-k', '--api-key', 'New Relic API Key'
+  o.string '-i', '--app-id', 'New Relic App ID'
+  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
+
+app_name = opts[:app_name]
+app_id = opts[:app_id]
+api_key = opts[:api_key]
+
+if app_name.nil?
+  STDERR.puts "ERROR: Missing App Name"
+  puts opts
+  exit 1
+end
+
+if api_key.nil?
+  STDERR.puts "ERROR: Missing New Relic API Key"
+  puts opts
+  exit 1
+end
+
+if app_id.nil?
+  STDERR.puts "ERROR: Missing New Relic App ID"
+  puts opts
+  exit 1
+end
+
+CircleciDeploymentNotifier::Build.new(app_name: app_name)
+  .send_to_new_relic(new_relic_api_key: api_key, new_relic_app_id: app_id)

data/exe/circleci_deployment_notify_slack

@@ -20,22 +20,17 @@ unless ENV['CIRCLECI']
   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"
+if app_name.nil?
+  STDERR.puts "ERROR: Missing App Name"
   puts opts
   exit 1
 end
 
-if app_name.nil?
-  STDERR.puts "ERROR: Missing App Name"
+if webhook_url.nil?
+  STDERR.puts "ERROR: Missing Slack Webhook URL"
   puts opts
   exit 1
 end

data/lib/circleci_deployment_notifier/build.rb

@@ -1,16 +1,37 @@
 require "circleci_deployment_notifier/build_info"
 require "circleci_deployment_notifier/slack"
+require "circleci_deployment_notifier/new_relic"
 
 module CircleciDeploymentNotifier
+  ##
+  # The main object of this gem. Instantiated with the name of the application,
+  # can then be used to send a notification.
   class Build
+    ##
+    # @param app_name [String] Name of the application that was deployed.
     def initialize(app_name:)
       self.app_name = app_name
     end
 
+    ##
+    # Sends a notification to Slack using the Slack Webhook URL.
+    # @param webhook_url [String] Slack Webhook URL
     def send_to_slack(webhook_url:)
       Slack.new(webhook_url: webhook_url, app_name: app_name, build_info: build_info).send
     end
 
+    ##
+    # Sends a deployment notification to New Relic.
+    # @param new_relic_api_key [String] New Relic API Key
+    # @param new_relic_app_id [String] New Relic Application ID
+    def send_to_new_relic(new_relic_api_key:, new_relic_app_id:)
+      NewRelic.new(
+        new_relic_api_key: new_relic_api_key,
+        new_relic_app_id: new_relic_app_id,
+        build_info: build_info,
+      ).send
+    end
+
     private
 
     attr_accessor :app_name

data/lib/circleci_deployment_notifier/build_info.rb

@@ -1,4 +1,7 @@
 module CircleciDeploymentNotifier
+  ##
+  # Gets build information from the environment.
+  # Expects and currently only works with builds of Github repositories.
   class BuildInfo
     def commit_hash
       ENV['CIRCLE_SHA1']

data/lib/circleci_deployment_notifier/new_relic.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module CircleciDeploymentNotifier
+  ##
+  # Sends deployment notification to New Relic.
+  # Builds the message using a BuildInfo object.
+  class NewRelic
+    ##
+    # @param new_relic_api_key [String] New Relic API Key
+    # @param new_relic_app_id [String] New Relic Application ID
+    # @param build_info [BuildInfo]
+    def initialize(new_relic_api_key:, new_relic_app_id:, build_info:)
+      self.new_relic_api_key = new_relic_api_key
+      self.new_relic_app_id = new_relic_app_id
+      self.build_info = build_info
+    end
+
+    ##
+    # Sends the deployment notification to New Relic.
+    # @return [Boolean] Whether the request was successful.
+    def send
+      http_response.code == 201
+    end
+
+    private
+
+    attr_accessor :new_relic_api_key
+    attr_accessor :new_relic_app_id
+    attr_accessor :build_info
+
+    def uri
+      URI("https://api.newrelic.com/v2/applications/#{new_relic_app_id}/deployments.json")
+    end
+
+    def http_connection
+      Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    def http_request
+      Net::HTTP::Post.new(uri).tap do |req|
+        req.add_field "X-Api-Key", new_relic_api_key
+        req.add_field "Content-Type", "application/json"
+        req.body = JSON.dump body_data
+      end
+    end
+
+    def body_data
+      {
+        deployment: {
+          revision: build_info.tag_name || build_info.branch_name,
+          user: build_info.builder_username,
+          description: build_info.tag_release_notes_url || build_info.commit_browse_url,
+        },
+      }
+    end
+
+    def http_response
+      @http_response ||= http_connection.request http_request
+    end
+  end
+end

data/lib/circleci_deployment_notifier/slack.rb

@@ -3,14 +3,19 @@ require 'slack-notifier'
 module CircleciDeploymentNotifier
   ##
   # Sends notifications to Slack.
-  # Builds the message from a BuildInfo object.
+  # Builds the message using a BuildInfo object.
   class Slack
+    ##
+    # @param webhook_url [String] Slack Webhook URL
+    # @param app_name [String] Name of the application that was deployed.
+    # @param build_info [BuildInfo]
     def initialize(webhook_url:, app_name:, build_info:)
       self.webhook_url = webhook_url
       self.app_name = app_name
       self.build_info = build_info
     end
 
+    # Sends the message to Slack.
     def send
       slack_notifier.post message
     end

data/lib/circleci_deployment_notifier/version.rb

@@ -1,3 +1,3 @@
 module CircleciDeploymentNotifier
-  VERSION = "1.0.1"
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci_deployment_notifier
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Robin Daugherty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: codacy-coverage
+  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: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -98,12 +112,14 @@ description:
 email:
 - robin@robindaugherty.net
 executables:
+- circleci_deployment_notify_new_relic
 - circleci_deployment_notify_slack
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -112,10 +128,12 @@ files:
 - bin/console
 - bin/setup
 - circleci_deployment_notifier.gemspec
+- exe/circleci_deployment_notify_new_relic
 - 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/new_relic.rb
 - lib/circleci_deployment_notifier/slack.rb
 - lib/circleci_deployment_notifier/version.rb
 homepage: https://github.com/RobinDaugherty/circleci_deployment_notifier