tracker-hook-forwarder 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+tmp
+doc
+coverage
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Capita Unternehmensberatung GmbH
+
+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,69 @@
+# Pivotal Tracker Activity Webhook Forwarder
+
+**A simple Rack app that allows you to use any number of Activity Web Hooks on your Pivotal Tracker projects by acting as an endpoint to them and forwarding the calls from Tracker to any number of configurable other urls**
+
+## Usage
+
+In a new app folder, add those files:
+
+A `Gemfile` containing:
+
+    source :rubygems
+    gem 'tracker-hook-forwarder'
+
+A `config.ru` containing:
+
+    require 'bundler/setup'
+    require 'tracker-hook-forwarder'
+
+    forward 'project_a', 'https://your.endpoint.com/for/tracker'
+    forward 'project_a', 'https://someother.com/tracker?token=1234'
+
+    forward 'project_b', 'https://someother.com/tracker?token=1234'    
+
+    run TrackerHookForwarder
+
+Deploy the application using a rack-compatible web server (or Heroku, see section below), then configure your individual Pivotal Tracker projects to post Activity Web Hooks to:
+
+    http://yourproxy.url/activity/project_a # for Project A
+    http://yourproxy.url/activity/project_b # for Project B
+
+For example, we use it to notify both our [Hipchat](http://www.hipchat.com) team room and our own 
+[Redmine-Tracker plugin](https://github.com/capita/redmine_trackmine) using a config like this:
+
+    forward 'some_project', 'http://redmine.url.com/pivotal_activity.xml'
+    forward 'some_project', 'https://api.hipchat.com/v1/webhooks/pivotaltracker/?auth_token=API_TOKEN&room_id=ROOM_ID'
+
+## Running on Heroku
+
+Arguably the easiest way to get the proxy up and running is to spin up a Heroku app.
+Assuming you've got the `heroku` gem installed and configured and the configuration
+set up as above using git, run:
+
+    heroku create your-app-name --stack cedar
+
+You might also want to add `thin` to your Gemfile and a `Procfile` containing:
+
+    web: bundle exec thin start -p $PORT
+
+Then commit your changes and push your app to heroku:
+
+    git push heroku master
+
+Going to your newly created app's url should now give you "Hello."
+
+**Important:** Heroku by default idles out free applications (those that only use 1 dyno)
+after a couple of minutes and further requests need to spin up a whole new instance, which
+takes some time. To prevent your app from idling out, and also to get the benefit of availability monitoring, use a service like [WasItUp](http://wasitup.com/) to monitor
+the site. Simply go to WasItUp, enter your app url, expect the content to be "Hello." and
+enter your mail address. Your proxy should be up all night.
+
+## Developer notes
+
+  * Clone the project
+  * bundle install
+  * rake test
+
+## Copyright
+
+Copyright (c) 2011 Christoph Olszowka, Capita Unternehmensberatung GmbH. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/config.ru

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'pivotal-hook-proxy'
+
+forward 'my_proj', 'http://www.foo.com'
+
+run PivotalHookProxy

data/lib/tracker-hook-forwarder.rb

@@ -0,0 +1,91 @@
+require 'logger'
+
+class TrackerHookForwarder
+  autoload :Forwarding, 'tracker-hook-forwarder/forwarding'
+  autoload :RackIntegration, 'tracker-hook-forwarder/rack_integration'
+
+  class << self
+    def call(env)
+      new(env).process
+    end
+
+    def logger
+      return @logger if @logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+      @logger
+    end
+
+    def forwardings
+      @forwardings ||= {}
+    end
+
+    def add_forwarding(project, url)
+      forwardings[project.to_sym] ||= []
+      forwardings[project.to_sym] << Forwarding.new(url)
+    end
+
+    def forwardings_for(project)
+      return nil if project.nil? or project.length == 0
+      forwardings[project.to_sym]
+    end
+
+    def reset_forwardings!
+      @forwardings = nil
+    end
+  end
+
+  attr_reader :env, :request
+  private :env, :request
+
+  def initialize(env)
+    @env = env
+    @request = Rack::Request.new(env)
+    TrackerHookForwarder.logger.info "#{request.request_method} #{request.fullpath}"
+  end
+
+  def process
+    if activity_hook_triggered?
+      TrackerHookForwarder.logger.info "Activity Hook triggered for #{requested_project_name} with:\n#{post_body}"
+      forwardings.each {|forwarding| forwarding.forward post_body }
+      return [201, {"Content-Type" => 'application/xml'}, [post_body]]
+
+    elsif request.get? and request.path == '/'
+      return [200, {"Content-Type" => 'text/plain'}, ['Hello.']]
+    else
+      TrackerHookForwarder.logger.info "Could not find #{request.request_method} #{request.fullpath}"
+      return [404, {"Content-Type" => 'text/plain'}, ['Resource not found']]
+    end
+  rescue => err
+    TrackerHookForwarder.logger.warn "#{request.request_method} #{request.fullpath} caused an exception: #{err}\n#{err.backtrace}"
+    return [500, {"Content-Type" => 'text/plain'}, ['Something went wrong :(']]
+  end
+
+  def activity_hook_triggered?
+    request.post? and not forwardings.nil?
+  end
+
+  def post_body
+    return @post_body if @post_body
+    @post_body = ""
+    while data = request.body.read(1024)
+      @post_body << data
+    end
+    @post_body
+  end
+
+  def requested_project_name
+    path_parts = request.path.split('/').reject {|part| part.strip.length == 0 }
+    if path_parts.count == 2 and path_parts.first == 'activity'
+      path_parts[1]
+    end
+  end
+
+  def forwardings
+    @forwardings ||= TrackerHookForwarder.forwardings_for(requested_project_name)
+  end
+end
+
+# Rack config.ru shorthand for setting up forwardings
+Rack::Builder.send :include, TrackerHookForwarder::RackIntegration if defined?(Rack::Builder)

data/lib/tracker-hook-forwarder/forwarding.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+require 'uri'
+
+class TrackerHookForwarder
+  class Forwarding
+    attr_reader :url
+    include HTTParty
+
+    def initialize(url)
+      @url = url.freeze
+      unless [URI::HTTP, URI::HTTPS].include? URI.parse(url).class
+        raise ArgumentError, "Forwarding url must be either http or https!"
+      end
+    end
+
+    def forward(body)
+      response = Forwarding.post(url, :body => body, :headers => {"Content-Type" => 'application/xml'}).response
+      if response.kind_of?(Net::HTTPSuccess)
+        TrackerHookForwarder.logger.info "Forwarded to #{url}:\n#{body}"
+        true
+      else 
+        TrackerHookForwarder.logger.warn "Forwarding to #{url} failed with #{response.class}:\n#{body}"
+        false
+      end
+    rescue => err
+      TrackerHookForwarder.logger.error "Forwarding to #{url} caused an error #{err}:\n#{body}"
+      false
+    end
+  end
+end

data/lib/tracker-hook-forwarder/rack_integration.rb

@@ -0,0 +1,10 @@
+# Makes it possible to simply use the following in config.ru
+#   
+#   forward 'my_project', 'https://xyz.com'
+#
+module TrackerHookForwarder::RackIntegration
+  def forward(project, url)
+    TrackerHookForwarder.add_forwarding project, url
+    STDOUT.puts "Will forward POSTs on /activity/#{project} to #{url}"
+  end
+end

data/lib/tracker-hook-forwarder/version.rb

@@ -0,0 +1,3 @@
+class TrackerHookForwarder
+  VERSION = '0.1.0'
+end

data/spec/forwarding_spec.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe TrackerHookForwarder::Forwarding do
+  before do
+    TrackerHookForwarder.reset_forwardings!
+    @forwarding = TrackerHookForwarder::Forwarding.new('http://foo.bar/pivotal_hook')
+  end
+
+  describe 'url' do
+    it "should return the correct url" do
+      @forwarding.url.must_equal 'http://foo.bar/pivotal_hook'
+    end
+    it "should have freezed the url" do
+      @forwarding.url.frozen?.must_equal true
+      lambda { @forwarding.url.gsub!('http', 'https') }.must_raise(RuntimeError)
+    end
+    it "should raise an error when the url is not http(s)" do
+      lambda { TrackerHookForwarder::Forwarding.new('ftp://foo.bar/pivotal_hook') }.must_raise(ArgumentError)
+      lambda { TrackerHookForwarder::Forwarding.new('telnet://foo.bar/pivotal_hook') }.must_raise(ArgumentError)
+    end
+  end
+
+  describe "configuration" do
+    it "should be empty initially" do
+      TrackerHookForwarder.forwardings.empty?.must_equal true
+    end
+
+    it "should not be empty after adding a forwarding" do
+      TrackerHookForwarder.add_forwarding 'awesome_project', 'https://foo'
+      TrackerHookForwarder.forwardings.empty?.must_equal false
+      TrackerHookForwarder.forwardings.keys.must_equal [:awesome_project]
+    end
+
+    describe "having multiple forwardings configured" do
+      before do
+        TrackerHookForwarder.add_forwarding 'awesome_project', 'https://foo'
+        TrackerHookForwarder.add_forwarding :awesome_project, 'http://foo.com'
+        TrackerHookForwarder.add_forwarding :other_project, 'http://foo.com'
+      end
+
+      it "should have the 2 projects configured" do
+        TrackerHookForwarder.forwardings.keys.sort.must_equal [:awesome_project, :other_project]
+      end
+      it "should have 2 forwardings for awesome_project" do
+        TrackerHookForwarder.forwardings_for(:awesome_project).count.must_equal 2
+        TrackerHookForwarder.forwardings_for(:awesome_project).first.url.must_equal 'https://foo'
+        TrackerHookForwarder.forwardings_for("awesome_project").last.url.must_equal 'http://foo.com'
+      end
+
+      it "should have 1 forwarding for the other project" do
+        TrackerHookForwarder.forwardings_for(:other_project).count.must_equal 1
+        TrackerHookForwarder.forwardings_for(:other_project).first.url.must_equal 'http://foo.com'
+      end
+
+      it "should return nil for unknown_project for forwardings" do
+        TrackerHookForwarder.forwardings_for(:unknown_project).must_be_nil
+      end
+
+      it "should return nil for empty or nil project name" do
+        TrackerHookForwarder.forwardings_for('').must_be_nil
+        TrackerHookForwarder.forwardings_for(nil).must_be_nil
+      end
+    end
+  end
+
+  describe "forwarding to an actual endpoint" do
+    before do
+      # Simple rack app that receives the POSTs from the forwarding
+      Artifice.activate_with lambda { |env|
+        request = Rack::Request.new(env)
+        body = request.body.read
+        if request.fullpath == '/project'
+          raise "Requst should have been post!" unless request.post?
+          raise "Wrong url: #{request.url}" unless request.url == 'https://awesome.com/project'
+          raise "Wrong body: #{body}" unless body == '<myxml></myxml>'
+          [200, {}, []]
+        else
+          [404, {}, []]
+        end
+      }
+
+      TrackerHookForwarder.add_forwarding 'awesome_project', 'https://awesome.com/project'
+      TrackerHookForwarder.add_forwarding 'awesome_project', 'https://awesome.com/404'
+    end
+
+    it "should forward the given body to our configured valid endpoint" do
+      TrackerHookForwarder.forwardings_for('awesome_project').first.forward('<myxml></myxml>').must_equal true
+    end
+
+    it "should forward the given body to our configured invalid endpoint and handle failure gracefully" do
+      TrackerHookForwarder.forwardings_for('awesome_project').last.forward('<myxml></myxml>').must_equal false
+    end
+
+    after do
+      Artifice.deactivate
+    end
+  end
+
+  describe "forwarding to an endpoint with query params" do
+    before do
+      # Simple rack app that receives the POSTs from the forwarding
+      Artifice.activate_with lambda { |env|
+        request = Rack::Request.new(env)
+        raise "Wrong token passed on!" if request.params["token"] != '123123asdf'
+        raise "Wrong room passed on!" if request.params["room"] != 'abcdef'
+        [200, {}, []]
+      }
+
+      TrackerHookForwarder.add_forwarding 'awesome_project', 'https://awesome.com/project/?token=123123asdf&room=abcdef'
+    end
+
+    it "should forward the given body to our configured valid endpoint including the expected params" do
+      TrackerHookForwarder.forwardings_for('awesome_project').first.forward('<myxml></myxml>').must_equal true
+    end
+
+    after do
+      Artifice.deactivate
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+require 'bundler/setup'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'rack/test'
+require 'rr'
+require 'artifice'
+require 'tracker-hook-forwarder'
+
+# Do not show log statements while testing
+TrackerHookForwarder.logger.level = Logger::FATAL

data/spec/tracker-hook-forwarder_spec.rb

@@ -0,0 +1,73 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe TrackerHookForwarder do
+  include Rack::Test::Methods
+  include RR::Adapters::TestUnit
+
+  def app
+    TrackerHookForwarder
+  end
+
+  before { TrackerHookForwarder.reset_forwardings! }
+
+  describe "GET /" do
+    before(:each) { get "/" }
+    it "should respond with status 200" do
+      last_response.status.must_equal 200
+    end
+    it "should give a greeting in response body" do
+      last_response.body.must_equal "Hello."
+    end
+    it "should respond with Content-Type text/plain" do
+      last_response.headers["Content-Type"].must_equal 'text/plain'
+    end
+  end
+
+  describe "POST /" do
+    before(:each) { post "/" }
+    it "should respond with status 404" do
+      last_response.status.must_equal 404
+    end
+  end
+
+  describe "GET /foobar" do
+    before(:each) { get "/foobar" }
+    it "should respond with status 404" do
+      last_response.status.must_equal 404
+    end
+    it "should give an error in response body" do
+      last_response.body.must_equal "Resource not found"
+    end
+    it "should respond with Content-Type text/plain" do
+      last_response.headers["Content-Type"].must_equal 'text/plain'
+    end
+  end
+
+  describe "POST /activity/unknown" do
+    before(:each) { post '/activity/unknown', "<xml></xml>" }
+    it "should respond with status 404" do
+      last_response.status.must_equal 404
+    end
+    it "should give an error in response body" do
+      last_response.body.must_equal "Resource not found"
+    end
+  end
+
+  describe "POST /activity/my_project with forwardings" do
+    before(:each) do
+      TrackerHookForwarder.add_forwarding 'my_project', 'http://localhost:9292'
+
+      # Expect forward method to be called on this only forwarding, using the request body
+      # and returning true
+      mock(TrackerHookForwarder.forwardings_for(:my_project).first).forward('<xml></xml>') { true }
+
+      post '/activity/my_project', "<xml></xml>"
+    end
+    it "should respond with status 201" do
+      last_response.status.must_equal 201
+    end
+    it "should echo the request body" do
+      last_response.body.must_equal "<xml></xml>"
+    end
+  end
+end

data/tracker-hook-forwarder.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tracker-hook-forwarder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christoph Olszowka"]
+  gem.email         = ["colszowka at capita.de"]
+  gem.description   = %q{A simple rack app that acts as an Activity Web Hook endpoint to Pivotal Tracker and forwards activity to any number of other endpoints, allowing you to have multiple Tracker Activity Web Hooks for any project}
+  gem.summary       = %q{A simple rack app that acts as an Activity Web Hook endpoint to Pivotal Tracker and forwards activity to any number of other endpoints, allowing you to have multiple Tracker Activity Web Hooks for any project}
+  gem.homepage      = "https://github.com/capita/tracker-hook-forwarder"
+
+  gem.add_dependency 'rack', '~> 1.3.5'
+  gem.add_dependency 'httparty', '~> 0.8.1'
+
+  gem.add_development_dependency 'minitest', '~> 2.6.2'
+  gem.add_development_dependency 'rack-test', '~> 0.6.1'
+  gem.add_development_dependency 'rr', '~> 1.0.4'
+  gem.add_development_dependency 'artifice', '~> 0.6'
+  gem.add_development_dependency 'simplecov'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "tracker-hook-forwarder"
+  gem.require_paths = ["lib"]
+  gem.version       = TrackerHookForwarder::VERSION
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: tracker-hook-forwarder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-24 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &5918860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *5918860
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &5917400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *5917400
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &5915220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *5915220
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &5928600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *5928600
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &5976080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: *5976080
+- !ruby/object:Gem::Dependency
+  name: artifice
+  requirement: &6000360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: *6000360
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &6014720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6014720
+description: A simple rack app that acts as an Activity Web Hook endpoint to Pivotal
+  Tracker and forwards activity to any number of other endpoints, allowing you to
+  have multiple Tracker Activity Web Hooks for any project
+email:
+- colszowka at capita.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/tracker-hook-forwarder.rb
+- lib/tracker-hook-forwarder/forwarding.rb
+- lib/tracker-hook-forwarder/rack_integration.rb
+- lib/tracker-hook-forwarder/version.rb
+- spec/forwarding_spec.rb
+- spec/spec_helper.rb
+- spec/tracker-hook-forwarder_spec.rb
+- tracker-hook-forwarder.gemspec
+has_rdoc: true
+homepage: https://github.com/capita/tracker-hook-forwarder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple rack app that acts as an Activity Web Hook endpoint to Pivotal Tracker
+  and forwards activity to any number of other endpoints, allowing you to have multiple
+  Tracker Activity Web Hooks for any project
+test_files: []