shamebot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b2ee07b476080c883e634f018cb592c6711bdd2
+  data.tar.gz: 5ada437031bfef93ae685e07b493881d320516ca
+SHA512:
+  metadata.gz: c0197735f7035b1ba8b4e74d92da55274ac6a3044115aa0115d27f5312181720fb4a6082c576dc47c44f379f0faee22861d501d04d1239bf02eb735b86b1bc76
+  data.tar.gz: 4794f144c0b6b8dc9169ebee977d0f4d39de63e7b3aad568e85ead6f57a1e3f84d2ee29eaf6c52b7ff66f8063465587558807ae6a58b161a8995bdcc9a66eac3

data/.gitignore

@@ -0,0 +1,13 @@
+*~
+*.gem
+*.out
+*.pid
+*.swp
+*.json
+*.log
+.chef
+.kitchen
+.vagrant
+.DS_Store
+pkg
+doc

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'rake'
+  gem 'yard'
+  gem 'version'
+  gem 'rubygems-tasks'
+end
+
+group :test do
+  gem 'minitest'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    shamebot (0.0.0)
+      gitlab (~> 3.1.0)
+      hipchat (~> 1)
+      sinatra (~> 1)
+      sys-proctable (~> 0)
+      trollop (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    gitlab (3.1.0)
+      httparty
+      terminal-table
+    hipchat (1.4.0)
+      httparty
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.5.0)
+    multi_xml (0.5.5)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    rubygems-tasks (0.2.4)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    sys-proctable (0.9.4)
+    terminal-table (1.4.5)
+    tilt (1.4.1)
+    trollop (2.0)
+    version (1.0.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  pry
+  rake
+  rubygems-tasks
+  shamebot!
+  version
+  yard

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test*.rb']
+  test.verbose = true
+end
+
+task :default => :test
+
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[ --readme Readme.md lib/**/*.rb - VERSION ]
+end
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new({
+  push: true,
+  sign: {}
+}) do |tasks|
+  tasks.console.command = 'pry'
+end
+Gem::Tasks::Sign::Checksum.new sha2: true
+
+
+require 'rake/version_task'
+Rake::VersionTask.new

data/Readme.md

@@ -0,0 +1,23 @@
+# Shamebot
+
+Shame users who commit with bad messages.
+
+    $ cat config.json
+    {
+      "nick": "Shame (bot)",
+      "room": "YOUR_ROOM",
+      "gitlab": {
+        "endpoint": "GITLAB_V3_API_ENDPOINT",
+        "private_token": "GITLAB_PRIVATE_TOKEN",
+        "user_agent": "shamebot"
+      },
+      "hipchat": {
+        "auth_token": "HIPCHAT_V1_API_TOKEN",
+        "auth_token_v2": "HIPCHAT_V2_API_TOKEN"
+      },
+      "jira": {
+        "user": "JIRA_USERNAME",
+        "pass": "JIRA_PASSWORD"
+      }
+    }
+    $ shamebot config.json

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/shamebot

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'date'
+require 'time'
+require 'logger'
+
+require 'trollop'
+
+Opts = Trollop::options do
+  version Shamebot::VERSION
+  banner Shamebot::ART + "\n\n" + <<-EOS.gsub(/^    /, '')
+    #{Shamebot::SUMMARY}
+
+    Usage: shamebot [<options>]
+
+    Options:
+  EOS
+  opt :config, 'Path to configuration', type: :string, required: true, short: 'c'
+  opt :debug, 'Enable debugging', default: false, short: 'd'
+  opt :port, 'Port to listen on', default: 4567, short: 'p'
+  opt :env, 'Sinatra environment', default: 'production', short: 'e'
+  opt :bind, 'Interface to listen on', default: '0.0.0.0', short: 'b'
+end
+
+DEBUG = Opts[:debug]
+CONFIG = JSON.parse File.read(Opts[:config])
+
+unless DEBUG
+  at_exit do
+    puts "Writing back to '#{Opts[:config]}'"
+    File.open(Opts[:config], 'w') do |f|
+      f.puts JSON.pretty_generate(CONFIG)
+    end
+  end
+end
+
+
+
+
+# Part 1. Setup configuration from JSON file
+JIRA_TAG = /\b([a-z]{2,4})\-(\d+)\b/i
+MERGE_COMMIT = /\b(merge|merging)\b/i
+
+def die message
+  $stderr.puts message
+  exit 1
+end
+
+unless CONFIG.has_key?('hipchat') && CONFIG['hipchat'].has_key?('auth_token')
+  die "Error: 'hipchat:auth_token' required in configuration"
+end
+
+
+GITLAB = {
+  'endpoint'      => (CONFIG['gitlab']['endpoint']      rescue die("Error: 'gitlab:endpoint' required in configuration")),
+  'private_token' => (CONFIG['gitlab']['private_token'] rescue die("Error: 'gitlab:private_token' required in configuration")),
+  'user_agent'    => (CONFIG['gitlab']['user_agent']    rescue die("Error: 'gitlab:user_agent' required in configuration"))
+}
+BOTNAME = CONFIG.has_key?('nick')  ? CONFIG['nick']  : 'shamebot'
+ROOM    = CONFIG.has_key?('room')  ? CONFIG['room']  : 'test'
+
+TEMPLATES = CONFIG.has_key?('templates') ? CONFIG['templates'] : [
+  '%{name}, shame on you for not including a valid JIRA tag in your commit message!  %{urls}'
+]
+
+def random_template
+  TEMPLATES[rand(0...TEMPLATES.length)]
+end
+
+CONFIG['shamings'] = CONFIG.has_key?('shamings') ? CONFIG['shamings'] : {}
+
+
+
+
+# Part 2. Get connected to Hipchat and Gitlab
+require 'hipchat'
+require 'gitlab'
+
+HIPCHAT = HipChat::Client.new CONFIG['hipchat']['auth_token']
+
+Gitlab.configure do |config|
+  config.endpoint      = GITLAB['endpoint']
+  config.private_token = GITLAB['private_token']
+  config.user_agent    = GITLAB['user_agent']
+end
+
+def shame_user msg, args, room, hipchat, botname
+  hipchat[room].send(botname, msg % args, {
+    :notify => true,
+    :color => 'red',
+    :message_format => 'text'
+  })
+end
+
+
+
+
+# Part 3. Take requests from Gitlab WebHooks
+require 'sinatra'
+
+set :port, Opts[:port]
+set :environment, Opts[:env]
+set :bind, Opts[:bind]
+set :raise_errors, true
+set :dump_errors, true
+set :show_exceptions, true
+set :logging, ::Logger::DEBUG if DEBUG
+
+get '/' do
+  content_type :text
+  "shamebot #{Shamebot::VERSION}"
+end
+
+post '/' do
+  now = Time.now
+  last_half_hour = now - 30 * 60
+  request.body.rewind
+  data = JSON.parse request.body.read
+
+  # Bad commits don't contain JIRA tags...
+  # And they aren't merge commits
+  commits = data['commits'].delete_if { |c| c['message'] =~ MERGE_COMMIT }
+  good_commits, bad_commits = commits.partition { |c| c['message'] =~ JIRA_TAG }
+
+  # Good commits might contain bogus JIRA tags
+  bad_commits += good_commits.keep_if do |c|
+    good_tag = false
+    c['message'].scan(JIRA_TAG).each do |(project, number)|
+      tag      = '%s-%d' % [project.upcase, number.to_i]
+      tag_page = `curl --silent http://jira.bluejeansnet.com/browse/#{tag}` rescue ''
+      next if tag_page =~ /The issue you are trying to view does not exist/i
+      good_tag = true
+      break
+    end
+    !good_tag
+  end
+
+  # Grab user info from Gitlab
+  begin
+    user = Gitlab.user(data['user_id'].to_i)
+  rescue
+    $stderr.puts "Warning: Gitlab user for commit author not found"
+    return
+  end
+
+  # For whatever reason we get a lot of duplicate POSTs, so we need to
+  # keep track of which commits have already triggered shamings so we
+  # don't end up repeatedly shaming users for the same mistake. We also
+  # make sure the commits aren't too old.
+  new_bad_commits = []
+  bad_commits.each do |commit|
+    unless DEBUG
+      next if CONFIG['shamings'].has_key? commit['id']
+      commit_time = DateTime.strptime(commit['timestamp']).to_time
+      next unless commit_time >= last_half_hour
+    end
+    new_bad_commits << commit
+    CONFIG['shamings'][commit['id']] = true
+  end
+
+  # Shame the user with a random template
+  commit_ids  = new_bad_commits.map { |c| c['id']  }
+  commit_urls = new_bad_commits.map { |c| c['url'] }
+  puts "%s: %s" % [ user.username, commit_ids.inspect ]
+
+  hipchat_users = []
+  0.upto(5) do |i|
+    hipchat_users += HTTParty.get("https://api.hipchat.com/v2/user", :query => { 'start-index' => 100 * i, :start_index => 100 * i, 'max-results' => 100, :max_results => 1000, :auth_token => CONFIG['hipchat']['auth_token_v2'] })['items']
+  end
+
+  hipchat_user = hipchat_users.select { |u| u['name'] =~ /#{user.name}/i }
+  $stderr.puts hipchat_user
+
+  if hipchat_user.empty?
+    hipchat_user = user.name
+  else
+    hipchat_user = '@' + hipchat_user.first['mention_name']
+  end
+
+  shame_user(random_template, {
+    :name => hipchat_user,
+    :nick => user.username,
+    :urls => commit_urls.join(' ')
+  }, ROOM, HIPCHAT, BOTNAME) unless commit_ids.empty? || DEBUG
+  return commit_ids.inspect
+end

data/lib/shamebot.rb

@@ -0,0 +1 @@
+require_relative 'shamebot/metadata'

data/lib/shamebot/metadata.rb

@@ -0,0 +1,26 @@
+module Shamebot
+
+  # We use a VERSION file to tie into our build pipeline
+  VERSION  = File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip
+
+  # We don't really do all that much, be humble
+  SUMMARY  = 'Shame users who commit with bad messages'
+
+  # Your benevolent dictator for life
+  AUTHOR   = 'Sean Clemmer'
+
+  # Turn here to strangle your dictator
+  EMAIL    = 'sclemmer@bluejeans.com'
+
+  # Every project deserves its own ASCII art
+  ART      = <<-'EOART' % VERSION
+
+      _____ __ __   ____  ___ ___    ___  ____    ___   ______
+     / ___/|  |  | /    ||   |   |  /  _]|    \  /   \ |      |
+    (   \_ |  |  ||  o  || _   _ | /  [_ |  o  )|     ||      |
+     \__  ||  _  ||     ||  \_/  ||    _]|     ||  O  ||_|  |_|
+     /  \ ||  |  ||  _  ||   |   ||   [_ |  O  ||     |  |  |
+     \    ||  |  ||  |  ||   |   ||     ||     ||     |  |  |
+      \___||__|__||__|__||___|___||_____||_____| \___/   |__|  v%s
+  EOART
+end

data/shamebot.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path(File.join('..', 'lib'), __FILE__)
+require 'shamebot'
+
+Gem::Specification.new do |s|
+  s.name        = 'shamebot'
+  s.version     = Shamebot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = Shamebot::AUTHOR
+  s.email       = Shamebot::EMAIL
+  s.summary     = Shamebot::SUMMARY
+  s.description = Shamebot::SUMMARY + '.'
+
+  s.add_runtime_dependency 'sinatra', '~> 1'
+  s.add_runtime_dependency 'hipchat', '~> 1'
+  s.add_runtime_dependency 'gitlab', '~> 3.1.0'
+  s.add_runtime_dependency 'trollop', '~> 2'
+  s.add_runtime_dependency 'sys-proctable', '~> 0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File::basename(f) }
+  s.require_paths = %w[ lib ]
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: shamebot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Clemmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  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: Shame users who commit with bad messages.
+email: sclemmer@bluejeans.com
+executables:
+- shamebot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- bin/shamebot
+- lib/shamebot.rb
+- lib/shamebot/metadata.rb
+- shamebot.gemspec
+homepage: 
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Shame users who commit with bad messages
+test_files: []