flowdock-build-notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60e8e5babf52a78ed4235f6e6aff3894d8dc9154
+  data.tar.gz: 8f7f948ed568fd9f40330bdaab01f9941dd862b6
+SHA512:
+  metadata.gz: fb0c7dc0b8b2ee23a74a3a35903ad8586f52bcf05f84ad44e3a2c22cc446873467e0842d2f2920fdd7ec0a5f764bf308d25fd954e559284e1010478fac96e20a
+  data.tar.gz: 94de09af069a4b475e5bd018e81352f883682ef44eaa7943df7bf45c4a3e979420e9849e505d6ff7dfb3d9a9477ba5e83eac2867bb90c058a5e08d075cc78495

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.github_access_token
+.pivotal_api_token
+.ruby-gemset
+.ruby-version
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset.template

@@ -0,0 +1 @@
+flowdock_notify

data/.ruby-version.template

@@ -0,0 +1 @@
+ruby-2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Jensen
+
+MIT License
+
+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,86 @@
+# FlowdockNotify
+
+This is used by the build agent to notify the person who (most likely)
+started the build that their build is complete, whether or not it failed
+or passed.
+
+The teamcity api is used to fetch information about the build because we
+cannot find it out in the environment.
+
+## Installation
+
+1. Add this gem to your Gemfile
+
+2. Set up a TeamCity account with access to all the projects being reported on 
+   and a Flowdock account with access to your team's flow - it will be the
+   account sending messages to your team members. Put these bots'
+   credentials into the configuration below.
+
+2. Make a `.flowdock_build_notifier.yml` file in the root of your project. An
+   example is given below: 
+
+   ```yaml
+   flowdock_user_token: SECRET_FLOWDOCK_USER_TOKEN
+   flow_name: FLOW_NAME
+
+   teamcity_url: https://teamcity.your_account.com
+   teamcity_user: SECRET_TEAMCITY_USER_NAME
+   teamcity_password: SECRET_TEAMCITY_USER_PASSWORD
+
+   email_map:
+     miranda@gmail.com: miranda@company.com
+     jj@gmail.com: jacobson@company.com
+   ```
+
+   For privacy, you should put this file in your .gitignore.
+   Alternatively, TeamCity login information and flowdock user token can be left
+   out of the yaml configuration file by assigning the following ENV variables 
+   on TeamCity if you prefer.
+
+   ```
+   ENV['FLOWDOCK_USER_TOKEN']
+   ENV['FLOWDOCK_NOTIFIER_TEAMCITY_USER']
+   ENV['FLOWDOCK_NOTIFIER_TEAMCITY_PASSWORD']
+   ```
+
+   The email map is used to connect the author of the last commit to the
+   corresponding Flowdock account.
+
+3. Under project settings on TeamCity, upload the following xml document as a
+   meta-runner: 
+
+   ```xml
+   <?xml version="1.0" encoding="UTF-8"?>
+   <meta-runner name="Flowdock Notify">
+     <description>Notify build status via flowdock</description>
+     <settings>
+       <parameters />
+       <build-runners>
+         <runner name="" type="simpleRunner">
+           <parameters>
+             <param name="command.executable" value="bundle exec flowdock_notify" />
+             <param name="command.parameters" value="%teamcity.build.id%" />
+             <param name="teamcity.step.mode" value="default" />
+           </parameters>
+         </runner>
+       </build-runners>
+       <requirements />
+     </settings>
+   </meta-runner>
+   ```
+
+   ![Meta-runner section](./readme_screenshots/meta_runners_section.png)
+
+
+4. Set up your build configuration steps to run `bundle install`
+   initially. Make a final step which executes the notifier meta-runner
+   regardless of previous failures.
+
+   ![Meta-runner configuration step](./readme_screenshots/set_meta_runner_step.png)
+
+   ---
+
+   ![Use meta-runner in all cases](./readme_screenshots/use_runner_even_if_previous_steps_fail.png)
+
+5. If you want a particular build to report failure in the main flow instead of
+   private messages, set `ENV['FLOWDOCK_NOTIFY_ALL_ON_FAILURE']` to true.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/flowdock_notify

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require_relative '../lib/flowdock_build_notifier'
+
+begin
+  if ARGV.first == '--author_email'
+    puts FlowdockBuildNotifier::FlowdockNotification.new(nil).author_email
+  else
+    FlowdockBuildNotifier::FlowdockNotification.new(ARGV.first).notify
+  end
+rescue => e
+  $stderr.puts e
+  $stderr.puts e.backtrace
+end

data/flowdock-build-notifier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flowdock_build_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flowdock-build-notifier"
+  spec.version       = FlowdockNotify::VERSION
+  spec.authors       = ["Aaron Jensen", "Shaun Dern"]
+  spec.email         = ["aaronjensen@gmail.com", "shaun@substantial.com"]
+  spec.summary       = %q{Notifies Flowdock about builds.}
+  spec.description   = %q{Notifies Flowdock about builds.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "flowdock"
+end

data/lib/flowdock_build_notifier.rb

@@ -0,0 +1,50 @@
+require 'flowdock'
+
+require_relative 'flowdock_build_notifier/configuration'
+require_relative 'flowdock_build_notifier/notification_message'
+require_relative 'flowdock_build_notifier/flowdock_message_sender'
+require_relative 'flowdock_build_notifier/build_metadata'
+require_relative 'flowdock_build_notifier/flowdock_message_sender_factory'
+
+module FlowdockBuildNotifier
+  class FlowdockNotification
+    attr_reader :build_id, :config
+
+    def initialize(build_id)
+      @build_id = build_id
+      @config = Configuration.load
+    end
+
+    def notify
+      sender = FlowdockMessageSenderFactory
+        .new(config: config)
+        .create_sender(notify_email)
+
+      sender.send_message(message)
+      notify_all if ENV['FLOWDOCK_NOTIFY_ALL_ON_FAILURE'] && build.status == "FAILURE"
+    end
+
+    def notify_all
+      TeamRoomSender
+        .new(config: config)
+        .send_message("#{message} @all")
+    end
+
+    def message
+      NotificationMessage.new(build)
+    end
+
+    def build
+      @build ||= BuildMetadata.new(config: config).tap { |metadata| metadata.fetch(build_id) }
+    end
+
+    def author_email
+      `git show --format=format:%ae`.split("\n").first
+    end
+
+    def notify_email
+      return File.read('.flowdock_notify_email').strip if File.exists? '.flowdock_notify_email'
+      author_email
+    end
+  end
+end

data/lib/flowdock_build_notifier/build_metadata.rb

@@ -0,0 +1,43 @@
+require 'rexml/document'
+require 'net/https'
+
+require_relative 'configuration'
+
+module FlowdockBuildNotifier
+  class BuildMetadata
+    attr_reader :metadata, :config
+
+    def initialize(config: Configuration.load)
+      @config = config
+    end
+
+    def fetch(build_id)
+      build_uri = URI("#{config.teamcity_url}/httpAuth/app/rest/builds/#{build_id}")
+
+      Net::HTTP.start(build_uri.host, build_uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new(build_uri)
+        request.basic_auth config.teamcity_user, config.teamcity_password
+        @result = http.request(request).body
+      end
+      @metadata = REXML::Document.new(@result)
+    end
+
+    def status
+      metadata.root.attributes['status']
+    end
+
+    def url
+      metadata.root.attributes['webUrl']
+    end
+
+    def branch
+      metadata.root.attributes['branchName']
+    end
+
+    def name
+      project_name = metadata.root.elements['buildType'].attributes['projectName']
+      name = metadata.root.elements['buildType'].attributes['name']
+      [project_name, name].compact.join(" :: ")
+    end
+  end
+end

data/lib/flowdock_build_notifier/configuration.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module FlowdockBuildNotifier
+  class Configuration
+    FLOWDOCK_CONFIG = '.flowdock_build_notifier.yml'
+
+    def self.load
+      new(YAML.load_file(FLOWDOCK_CONFIG))
+    rescue Errno::ENOENT
+      raise "#{FLOWDOCK_CONFIG} configuration not found"
+    end
+
+    attr_reader :flow_name, :flowdock_user_token, :teamcity_user,
+      :teamcity_password, :teamcity_url, :email_map
+
+    def initialize(config)
+      @flowdock_user_token = ENV['FLOWDOCK_USER_TOKEN'] || config.fetch('flowdock_user_token')
+      @flow_name= config.fetch('flow_name')
+
+      @email_map = config.fetch('email_map') { {} }
+
+      @teamcity_url = config.fetch('teamcity_url')
+      @teamcity_user = ENV['FLOWDOCK_NOTIFIER_TEAMCITY_USER'] || config.fetch('teamcity_user')
+      @teamcity_password = ENV['FLOWDOCK_NOTIFIER_TEAMCITY_PASSWORD'] || config.fetch('teamcity_password')
+    end
+  end
+end

data/lib/flowdock_build_notifier/flowdock_message_sender.rb

@@ -0,0 +1,56 @@
+require_relative 'configuration'
+
+require 'flowdock'
+
+module FlowdockBuildNotifier
+  class FlowdockMessageSender
+    attr_reader :config, :client
+
+    def initialize(options = {})
+      @options = options
+      @config = @options.fetch(:config) { Configuration.load }
+      @client = @options.fetch(:client) { Flowdock::Client.new(api_token: config.flowdock_user_token) }
+    end
+
+    def send_message(message)
+      raise NotImplementedError
+    end
+
+    def messages_path
+      raise NotImplementedError
+    end
+  end
+
+  class PrivateMessageSender < FlowdockMessageSender
+    def user_id
+      @options.fetch :user_id
+    end
+
+    def send_message(message)
+      client.post("/private/#{user_id}/messages", event: 'message', content: message.to_s)
+    end
+  end
+
+  class TeamRoomSender < FlowdockMessageSender
+    def flow
+      @flow_id ||= client.get('/flows').detect do |flow|
+        flow['name'] == config.flow_name
+      end
+    end
+
+    def send_message(message)
+      client.chat_message(flow: flow['id'], content: message.to_s)
+    end
+  end
+
+  class UnknownUserSender < TeamRoomSender
+    def email
+      @options.fetch :email
+    end
+
+    def send_message(message)
+      super
+      super "Please add #{email} to .flowdock_build_notifier.yml"
+    end
+  end
+end

data/lib/flowdock_build_notifier/flowdock_message_sender_factory.rb

@@ -0,0 +1,31 @@
+require_relative 'flowdock_message_sender'
+require_relative 'configuration'
+
+require 'flowdock'
+
+module FlowdockBuildNotifier
+  class FlowdockMessageSenderFactory
+    attr_reader :config, :client
+
+    def initialize(config: Configuration.load, client: Flowdock::Client.new(api_token: config.flowdock_user_token))
+      @config = config
+      @client = client
+    end
+
+    def create_sender(email)
+      user = user_by_email(email)
+      return UnknownUserSender.new(email: email, config: config) unless user
+      PrivateMessageSender.new(user_id: user['id'], client: client)
+    end
+
+    def users
+      @users ||= client.get('/users')
+    end
+
+    def user_by_email(email)
+      @user ||= users.detect do |user|
+        user['email'] == config.email_map[email] || user['email'] == email
+      end
+    end
+  end
+end

data/lib/flowdock_build_notifier/notification_message.rb

@@ -0,0 +1,35 @@
+module FlowdockBuildNotifier
+  class NotificationMessage
+    attr_reader :build
+    def initialize(build)
+      @build = build
+    end
+
+    def to_s
+      "#{status}: \"#{build.name}\" build#{branch} - #{build.url}"
+    end
+
+    def branch
+      " for branch #{build.branch}" if build.branch
+    end
+
+    def status
+      {
+        "SUCCESS" => "#{pass_status}",
+        "FAILURE" => "❌ FAILED",
+        "UNKNOWN" => "🚧 CANCELED",
+      }[build.status]
+    end
+
+    def pass_status
+      case build.name
+      when /deploy/i
+        "🚀 DEPLOYED"
+      when /smoke/i
+        "🚬 SMOKED"
+      else
+        "✅ PASSED"
+      end
+    end
+  end
+end

data/lib/flowdock_build_notifier/version.rb

@@ -0,0 +1,3 @@
+module FlowdockNotify
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: flowdock-build-notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aaron Jensen
+- Shaun Dern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: flowdock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Notifies Flowdock about builds.
+email:
+- aaronjensen@gmail.com
+- shaun@substantial.com
+executables:
+- flowdock_notify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset.template"
+- ".ruby-version.template"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/flowdock_notify
+- flowdock-build-notifier.gemspec
+- lib/flowdock_build_notifier.rb
+- lib/flowdock_build_notifier/build_metadata.rb
+- lib/flowdock_build_notifier/configuration.rb
+- lib/flowdock_build_notifier/flowdock_message_sender.rb
+- lib/flowdock_build_notifier/flowdock_message_sender_factory.rb
+- lib/flowdock_build_notifier/notification_message.rb
+- lib/flowdock_build_notifier/version.rb
+- readme_screenshots/meta_runners_section.png
+- readme_screenshots/set_meta_runner_step.png
+- readme_screenshots/use_runner_even_if_previous_steps_fail.png
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Notifies Flowdock about builds.
+test_files: []