hookworm-handlers 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGNjNDE5NjRiZmU2MjEwMTYyZTY1NjliZTA5NTRhNzFlZjY2NzZlNg==
+  data.tar.gz: !binary |-
+    NWY5NzA3NzUyN2FmOGE3OTY4NThmOWQzODRlYjQ0MTQzMWM2NWViMQ==
+SHA512:
+  metadata.gz: !binary |-
+    M2Q2ODhkOWZmNTYxZDcyZWZlMzExZmUwZTJiNDcyODM3NDYzZDkwYTQxOTJi
+    MDNlMWYxNGVmZDQ2ODY0NjgzNzZiODM1NGY0Njk0NzI5OTE1ODQ0ZTQxNGM1
+    YTZiYmU3MGMyZmRiN2YwYWQ4ODU1ZmE3ZTBmMDgxNmJkN2JiZGE=
+  data.tar.gz: !binary |-
+    M2ZjNmE0MTAyNDg4MzY4MzYwMjUxZDFiN2U3NGY1NDJjNjEzYTYzYWM3NTY5
+    OWY1ZWU3NzE0MGE3MjQxOGJmZWU3N2Y0Yjg3MTA2YjliOTJhZTY1MWE0Nzg1
+    MjBiYzYyYTdmN2RjZDY3OGE0OGU3NTg3OTNmOGM1MmQ0NjM1MWY=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require pry
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,6 @@
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+# vim:filetype=ruby

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.0
+notifications:
+  email: github+hookworm-handlers-ruby@modcloth.com
+deploy:
+  provider: rubygems
+  api_key:
+    secure: C086LrlDlbLZpHSgKFWnCfsLqx4iaQRu/1CYCUgMCBkdGahaBNhR09C0JHosHQ7zshhoy+5EX4Oj7FDlqW/+tJbmMvkb5C6WkK87NqYM4UTB8NRvK5fzrQXh8a5pCE4ynoUrKMpN6nY43qeM5izHhk22Zkj35r+4OP4tYlf6lUw=
+  gem: hookworm-handlers
+  on:
+    tags: true
+    repo: modcloth-labs/hookworm-handlers-ruby
+    branch: master
+    rvm: 2.0.0

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright © 2014 ModCloth, Inc.
+====================================
+
+## 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,29 @@
+# Hookworm Handlers
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hookworm-handlers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hookworm-handlers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.rspec_opts = '--format doc'
+end
+
+Rubocop::RakeTask.new(:rubocop)
+
+YARD::Rake::YardocTask.new
+
+desc 'Run rspec with coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+  Rake::Task['test'].invoke
+end
+
+task default: [:rubocop, :coverage]

data/bin/hookworm-annotator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim:fileencoding=utf-8
+require 'hookworm-handlers'
+require 'English'
+
+exit Hookworm::Annotator.new.run!(ARGV) if $PROGRAM_NAME == __FILE__

data/bin/hookworm-build-index-handler

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim:fileencoding=utf-8
+require 'hookworm-handlers'
+require 'English'
+
+exit Hookworm::BuildIndexHandler.new.run!(ARGV) if $PROGRAM_NAME == __FILE__

data/bin/hookworm-logging-handler

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim:fileencoding=utf-8
+require 'English'
+require 'hookworm-handlers'
+
+exit Hookworm::LoggingHandler.new.run!(ARGV) if $PROGRAM_NAME == __FILE__

data/bin/hookworm-rogue-commit-handler

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim:fileencoding=utf-8
+require 'English'
+require 'hookworm-handlers'
+
+exit Hookworm::RogueCommitHandler.new.run!(ARGV) if $PROGRAM_NAME == __FILE__

data/hookworm-handlers.gemspec

@@ -0,0 +1,32 @@
+# vim:fileencoding=utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hookworm/handlers/version'
+require 'English'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hookworm-handlers'
+  spec.version       = Hookworm::Handlers::VERSION
+  spec.authors       = ['Dan Buch']
+  spec.email         = %w(d.buch@modcloth.com)
+  spec.description   = %q{}
+  spec.summary       = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'mail', '~> 2.5.4'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
+
+  spec.add_runtime_dependency 'hookworm-base', '~> 0.1'
+end

data/lib/hookworm/annotator.rb

@@ -0,0 +1,49 @@
+# vim:fileencoding=utf-8
+
+require 'json'
+require 'hookworm-base'
+require_relative 'github_payload_annotator'
+require_relative 'travis_payload_annotator'
+
+module Hookworm
+  # # Hookworm Annotator
+  #
+  # The annotator is responsible for adding fields to the incoming payloads so
+  # that subsequent handlers do not have to duplicate decision-making logic.
+  #
+  # ## GitHub payload annotation
+  # GitHub payloads are given the following additional fields dependending on
+  # the presence of certain options.
+  #
+  # ### `is_pr_merge`
+  # Is the payload the result of a pull request merge?
+  #
+  # ### `is_watched_branch`
+  # Is the payload for a branch that is "watched", depending on the presence of
+  # the `watched_branches` postfix keyword argument?
+  #
+  # ### `has_watched_path`
+  # Does the payload contain changes to a "watched" path, depending on the
+  # presence of the `watched_paths` postfix keyword argument?
+  class Annotator
+    include Hookworm::Base
+
+    private
+
+    def handle(type)
+      payload = JSON.parse(input_stream.read, symbolize_names: true)
+      output_stream.puts JSON.pretty_generate(
+        send(:"annotate_#{type}_payload", payload)
+      )
+      0
+    end
+
+    def annotate_github_payload(github_payload)
+      Hookworm::GitHubPayloadAnnotator.new(cfg).annotate(github_payload)
+    end
+
+    def annotate_travis_payload(travis_payload)
+      Hookworm::TravisPayloadAnnotator.new.annotate(travis_payload)
+    end
+  end
+end

data/lib/hookworm/build_index_handler.rb

@@ -0,0 +1,132 @@
+# vim:fileencoding=utf-8
+
+require 'erb'
+require 'fileutils'
+require 'json'
+require 'time'
+require 'hookworm-base'
+require 'hookworm/directory_index_updater'
+
+module Hookworm
+  class BuildIndexHandler
+    include Hookworm::Base
+
+    private
+
+    def handle_travis
+      payload = JSON.parse(input_stream.read, symbolize_names: true)
+      TravisPayloadBuildIndexer.new(cfg, log).index(payload)
+      0
+    rescue TravisPayloadBuildIndexer::InvalidPayload => e
+      log.error { e }
+      1
+    ensure
+      output_stream.puts JSON.pretty_generate(payload)
+      0
+    end
+  end
+
+  class TravisPayloadBuildIndexer
+    InvalidPayload = Class.new(StandardError)
+
+    attr_reader :cfg, :log
+
+    include FileUtils
+
+    def initialize(cfg, log)
+      @cfg = cfg
+      @log = log
+    end
+
+    def index(payload)
+      mkdir_p(index_prefix)
+      repo_slug = (payload[:repository] || {})[:slug]
+      unless repo_slug
+        fail InvalidPayload, "Invalid repo slug #{repo_slug.inspect}"
+      end
+      build_id_path = payload_build_id_path(repo_slug, payload)
+      mkdir_p(File.dirname(build_id_path))
+      write_payload(payload, build_id_path)
+      link_all_category_paths(payload, repo_slug, build_id_path)
+      update_all_directory_indexes(repo_slug)
+    end
+
+    private
+
+    def write_payload(payload, path)
+      File.open(path, 'w:UTF-8') do |f|
+        f.puts JSON.pretty_generate(payload)
+      end
+    end
+
+    def payload_build_id_path(repo_slug, payload)
+      "#{index_prefix}/#{repo_slug}/builds/#{payload[:id]}.json"
+    end
+
+    def link_all_category_paths(payload, repo_slug, build_id_path)
+      link_by_number_path(payload, repo_slug, build_id_path)
+      link_by_commit_paths(payload, repo_slug, build_id_path)
+      link_by_datetime_path(payload, repo_slug, build_id_path)
+      link_latest_build(repo_slug)
+    end
+
+    def link_by_number_path(payload, repo_slug, build_id_path)
+      mkdir_p_ln_sf(
+        build_id_path,
+        "#{index_prefix}/#{repo_slug}/builds/" <<
+          "_by_number/#{payload[:number]}.json"
+      )
+    end
+
+    def link_by_commit_paths(payload, repo_slug, build_id_path)
+      mkdir_p_ln_sf(
+        build_id_path,
+        "#{index_prefix}/#{repo_slug}/builds/" <<
+          "_by_commit/#{payload[:commit]}.json"
+      )
+      mkdir_p_ln_sf(
+        build_id_path,
+        "#{index_prefix}/#{repo_slug}/builds/_by_commit/" <<
+        "#{payload[:commit][0, 7]}.json"
+      )
+    end
+
+    def link_by_datetime_path(payload, repo_slug, build_id_path)
+      timestamp = Time.parse(payload[:finished_at]).strftime('%Y%m%d_%H%M%S')
+      mkdir_p_ln_sf(
+        build_id_path,
+        "#{index_prefix}/#{repo_slug}/builds/_by_datetime/#{timestamp}.json"
+      )
+    end
+
+    def link_latest_build(repo_slug)
+      builds_glob = "#{index_prefix}/#{repo_slug}/builds/_by_datetime/*.json"
+      latest = ''
+      Dir.glob(builds_glob) do |f|
+        latest = f if File.basename(f) > File.basename(latest)
+      end
+      mkdir_p_ln_sf(latest, "#{index_prefix}/#{repo_slug}/builds/_latest.json")
+    end
+
+    def update_all_directory_indexes(repo_slug)
+      indexer = Hookworm::DirectoryIndexUpdater.new(cfg)
+      %W(
+      #{index_prefix}
+      #{index_prefix}/#{File.dirname(repo_slug)}
+      ).each do |dir|
+        indexer.update_index!(dir)
+      end
+      indexer.update_all!("#{index_prefix}/#{repo_slug}")
+    end
+
+    def mkdir_p_ln_sf(src, dest)
+      mkdir_p(File.dirname(dest))
+      log.debug { "Linking #{src} -> #{dest}" }
+      ln_sf(src, dest)
+    end
+
+    def index_prefix
+      @index_prefix ||= "#{cfg[:static_dir]}/build-index"
+    end
+  end
+end

data/lib/hookworm/github_payload_annotator.rb

@@ -0,0 +1,110 @@
+require 'logger'
+
+module Hookworm
+  class GitHubPayloadAnnotator
+    attr_reader :cfg
+
+    PULL_REQUEST_MESSAGE_RE = /Merge pull request #[0-9]+ from.*/
+
+    def initialize(cfg)
+      @cfg = cfg
+    end
+
+    def annotate(payload)
+      payload.merge(
+        is_pr_merge: pr_merge?(payload),
+        is_watched_branch: watched_branch?(payload[:ref]),
+        has_watched_path: watched_path?(payload)
+      )
+    end
+
+    private
+
+    def pr_merge?(payload)
+      truth = (
+        (payload[:commits] || []).length > 1 &&
+        !!PULL_REQUEST_MESSAGE_RE.match(payload[:head_commit][:message])
+      )
+      log.debug { "pull request merge? #{truth}" }
+      truth
+    end
+
+    def watched_branch?(ref)
+      sans_refs_heads = ref.sub(%r{^refs/heads/}, '')
+      watched_branches.each do |br|
+        if sans_refs_heads =~ br
+          log.debug { "#{sans_refs_heads} =~ #{br.inspect} -> true" }
+          return true
+        end
+        log.debug { "#{sans_refs_heads} =~ #{br.inspect} -> false" }
+      end
+      false
+    end
+
+    def watched_branches
+      @watched_branches ||= watched_branch_strings.map { |wb| /#{wb}/ }
+    end
+
+    def watched_branch_strings
+      (
+        (cfg[:worm_flags] || {})[:watched_branches] || ''
+      ).cleanquotes.commasplit
+    end
+
+    def watched_path?(payload)
+      watched_paths.each do |wp|
+        payload_paths(payload).each do |path|
+          if path =~ wp
+            log.debug { "#{path} =~ #{wp.inspect} -> true" }
+            return true
+          end
+          log.debug { "#{path} =~ #{wp.inspect} -> false" }
+        end
+      end
+      false
+    end
+
+    def watched_paths
+      @watched_paths ||= watched_path_strings.map { |wp| /#{wp}/ }
+    end
+
+    def watched_path_strings
+      ((cfg[:worm_flags] || {})[:watched_paths] || '').cleanquotes.commasplit
+    end
+
+    def payload_paths(payload)
+      paths = []
+      commits = payload[:commits] || []
+      commits << payload[:head_commit]
+
+      commits.each_with_index do |commit, i|
+        next if payload[:is_pr_merge] && i == 0
+
+        paths += commit_paths(commit)
+      end
+
+      paths
+    end
+
+    def commit_paths(commit)
+      path_set = {}
+      return [] if commit.nil? || commit.empty?
+
+      [commit[:added], commit[:removed], commit[:modified]].each do |path_list|
+        path_list.each do |path|
+          path_set[path] = true
+        end
+      end
+
+      path_set.keys.sort
+    end
+
+    def log
+      @log ||= Logger.new(log_stream)
+    end
+
+    def log_stream
+      $stderr.set_encoding('UTF-8')
+    end
+  end
+end

data/lib/hookworm/handlers/version.rb

@@ -0,0 +1,5 @@
+module Hookworm
+  module Handlers
+    VERSION = '0.1.0'
+  end
+end

data/lib/hookworm/handlers.rb

@@ -0,0 +1,5 @@
+module Hookworm
+  module Handlers
+    autoload :VERSION, 'hookworm/handlers/version'
+  end
+end

data/lib/hookworm/logging_handler.rb

@@ -0,0 +1,55 @@
+# vim:fileencoding=utf-8
+
+require 'json'
+require 'syslog'
+
+require 'hookworm-base'
+
+module Hookworm
+  # # Hookworm Logging Handler
+  #
+  # The logging handler is responsible for logging valid incoming requests,
+  # optionally logging to syslog if the `syslog=true` option is provided.
+  class LoggingHandler
+    include Hookworm::Base
+
+    private
+
+    def handle_github
+      payload = JSON.parse(input_stream.read, symbolize_names: true)
+      re_serialized_payload = JSON.pretty_generate(payload)
+
+      log_payload(payload, re_serialized_payload)
+      return 0
+    rescue => e
+      log.error { "#{e.class.name} #{e.message}" }
+      log.debug { e.backtrace.join("\n") }
+      return 1
+    end
+
+    def handle_travis
+      payload = JSON.parse(input_stream.read, symbolize_names: true)
+      re_serialized_payload = JSON.pretty_generate(payload)
+
+      log_payload(payload, re_serialized_payload)
+      return 0
+    rescue => e
+      log.error { "#{e.class.name} #{e.message}" }
+      log.debug { e.backtrace.join("\n") }
+      return 1
+    end
+
+    def log_payload(payload, re_serialized_payload)
+      log.debug { "payload=#{payload.inspect}" }
+      log.debug { "payload json=#{re_serialized_payload.inspect}" }
+
+      if (cfg[:worm_flags] || {})[:syslog]
+        Syslog.open($PROGRAM_NAME, Syslog::LOG_PID | Syslog::LOG_CONS) do |sl|
+          sl.info(re_serialized_payload)
+        end
+      end
+
+      output_stream.puts(re_serialized_payload)
+    end
+  end
+end