flowdock-git-hook 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+-
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "grit", ">= 2.4.1"
+gem "multi_json"
+
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "webmock", ">= 1.6.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Flowdock Ltd.
+
+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.rdoc

@@ -0,0 +1,65 @@
+= Flowdock Git Hook
+
+Git Post-Receive hook for Flowdock[http://flowdock.com]
+
+== Installation
+
+First, you need to install this gem. You need to have Ruby 1.8.6 and Rubygems installed in your system.
+
+  gem install flowdock-git-hook
+
+Then, download the post-receive hook file to the hooks directory and make it executable
+
+  curl -o hooks/post-receive http://github.com/flowdock/flowdock-git-hook/raw/master/post-receive
+  chmod +x hooks/post-receive
+
+Configure your Flow API tokens to git configuration
+
+  git config flowdock.token <Flow API token>
+
+After this, you should get updates from your git repo every time you push to it.
+
+== Advanced usage
+
+The git hook allows Flowdock tags to be attached to push messages. If you only need static tags, e.g. git repo name as tag, this can be configured in git config:
+
+  git config flowdock.tags git,push
+
+For programmatic control over tagging, you can change how the hook is called in post-receive hook file.
+
+  Flowdock::Git.new(ref, before, after, :tags => ["git", "push"])
+
+Note that you can also define token as parameter allowing multiple Flows to be notified.
+
+  Flowdock::Git.new(ref, before, after, :token => "flow-token")
+  Flowdock::Git.new(ref, before, after, :token => "another-flow")
+
+== Example data
+
+The hook uses {GitHub webhook}[http://help.github.com/post-receive-hooks/] format.
+
+  payload {
+    "after": "122b95a8808ea0cf708fb43b400a377c25c35d7f",
+    "before": "2a445d1d348d9d45217cb9c89c12b67d3767ce42",
+    "commits": [
+      {
+        "added": [],
+        "author": {
+          "email": "raine.virta@nodeta.fi",
+          "name": "Raine Virta"
+        },
+        "id": "122b95a8808ea0cf708fb43b400a377c25c35d7f",
+        "message": "yeah!",
+        "modified": [
+          "TEST_FILE"
+        ],
+        "removed": [],
+        "timestamp": "2010-08-11T13:46:39+03:00"
+      }
+    ],
+    "ref": "refs\/heads\/master",
+    "ref_name": "master",
+    "repository": {
+      "name": "testrepo"
+    }
+  }

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "flowdock-git-hook"
+  gem.homepage = "http://github.com/flowdock/flowdock-git-hook"
+  gem.license = "MIT"
+  gem.summary = %Q{Git Post-Receive hook for Flowdock}
+  gem.email = "lautis@gmail.com"
+  gem.authors = ["Ville Lautanala"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flowdock-git-hook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/flowdock-git-hook.rb

@@ -0,0 +1 @@
+require 'flowdock/git'

data/lib/flowdock/git.rb

@@ -0,0 +1,74 @@
+require "multi_json"
+require "net/https"
+require "cgi"
+
+require "flowdock/git/builder"
+
+module Flowdock
+  class Git
+    class TokenError < StandardError; end
+    API_ENDPOINT = "https://api.flowdock.com/v1/git"
+
+    def initialize(ref, from, to, options = {})
+      @ref = ref
+      @from = from
+      @to = to
+
+      @options = options
+
+      @token = options[:token] || config["flowdock.token"] || raise(TokenError.new("Flowdock API token not found"))
+    end
+
+    # Send git push notification to Flowdock
+    def post
+      uri = URI.parse("#{API_ENDPOINT}/#{([@token] + tags).join('+')}")
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(:payload => MultiJson.encode(payload))
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == 'https'
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = true
+      end
+
+      http.start { |http| http.request(req) }
+    end
+
+    # Create and post notification in background process. Avoid blocking the push notification.
+    def background_post
+      pid = Process.fork
+      if pid.nil?
+        Grit::Git.with_timeout(600) do
+          post # Child
+        end
+      else
+        Process.detach(pid) # Parent
+      end
+    end
+
+    private
+
+    # Flowdock tags attached to the push notification
+    def tags
+      if @options[:tags]
+        @options[:tags]
+      else
+        config["flowdock.tags"].to_s.split(",")
+      end.map do |t|
+        CGI.escape(t)
+      end
+    end
+
+    def payload
+      Builder.new(repo, @ref, @from, @to).to_hash
+    end
+
+    def repo
+      @repo ||= Grit::Repo.new(@options[:repo] || Dir.pwd)
+    end
+
+    def config
+      @config ||= Grit::Config.new(repo)
+    end
+  end
+end

data/lib/flowdock/git/builder.rb

@@ -0,0 +1,61 @@
+require "grit"
+
+module Flowdock
+  class Git
+    # Class used to build Git payload
+    class Builder
+      def initialize(repo, ref, before, after)
+        @repo = repo
+        @ref = ref
+        @before = before
+        @after = after
+      end
+
+      def commits
+        @repo.commits_between(@before, @after).map do |commit|
+          {
+            :id => commit.sha,
+            :message => commit.message,
+            :timestamp => commit.authored_date.iso8601,
+            :author => {
+              :name => commit.author.name,
+              :email => commit.author.email
+            },
+            :removed => filter(commit.diffs) { |d| d.deleted_file },
+            :added => filter(commit.diffs) { |d| d.new_file },
+            :modified => filter(commit.diffs) { |d| !d.deleted_file && !d.new_file }
+          }
+        end
+      end
+
+      def ref_name
+        @ref.to_s.sub(/\Arefs\/(heads|tags)\//, '')
+      end
+
+      def to_hash
+        {
+          :before   => @before,
+          :after    => @after,
+          :ref      => @ref,
+          :commits  => commits,
+          :ref_name => @ref.to_s.sub(/\Arefs\/(heads|tags)\//, ''),
+          :repository => {
+            :name => File.basename(Dir.pwd).sub(/\.git$/,'')
+          }
+        }.merge(if @before == "0000000000000000000000000000000000000000"
+          {:created => true}
+        elsif @after == "0000000000000000000000000000000000000000"
+          {:deleted => true}
+        else
+          {}
+        end)
+      end
+
+      private
+
+      def filter(diffs)
+        diffs.select { |e| yield e }.map { |diff| diff.b_path }
+      end
+    end
+  end
+end

data/post-receive

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby -w
+require 'rubygems'
+require 'flowdock-git-hook'
+
+before, after, ref = gets.split
+Flowdock::Git.new(ref, before, after).background_post

data/spec/builder_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Git Payload Builder" do
+  before :each do
+    @repo = Grit::Repo.new(".")
+    @before = "7e32af569ba794b0b1c5e4c38fef1d4e2e56be51"
+    @after = "a1a94ba4bfa5f855676066861604b8edae1a20f5"
+  end
+
+  it "parses ref name from head" do
+    Flowdock::Git::Builder.new(@repo, "refs/heads/master", @before, @after).ref_name.should == "master"
+  end
+
+  it "parses ref name from tag" do
+    Flowdock::Git::Builder.new(@repo, "refs/tags/release-1.0", @before, @after).ref_name.should == "release-1.0"
+  end
+
+  it "detects new branch and sets created=true in data" do
+    hash = Flowdock::Git::Builder.new(@repo, "refs/heads/master", "0000000000000000000000000000000000000000", @after).to_hash
+    hash[:created].should == true
+    hash[:deleted].should_not == true
+  end
+
+  it "detects deleted branch and sets deleted=true in data" do
+    hash = Flowdock::Git::Builder.new(@repo, "refs/heads/master", @before, "0000000000000000000000000000000000000000").to_hash
+    hash[:deleted].should == true
+    hash[:created].should_not == true
+  end
+
+  it "doesn't include commits in branch delete" do
+    hash = Flowdock::Git::Builder.new(@repo, "refs/heads/master", @before, "0000000000000000000000000000000000000000").to_hash
+    hash[:commits].should be_empty
+  end
+
+  describe "data hash" do
+    before :each do
+      @repo.stub!(:path).and_return("/foo/bar/flowdock-git-hook/.git")
+      @hash = Flowdock::Git::Builder.new(@repo, "refs/heads/master", @before, @after).to_hash
+    end
+
+    it "contains before" do
+      @hash[:before].should == @before
+    end
+
+    it "contains after" do
+      @hash[:after].should == @after
+    end
+
+    it "contains ref" do
+      @hash[:ref].should == "refs/heads/master"
+    end
+
+    it "contains ref name" do
+      @hash[:ref_name].should == "master"
+    end
+
+    describe "commits" do
+      it "contains all changed commits" do
+        @hash[:commits].should have(2).items
+      end
+
+      it "has commit author information" do
+        @hash[:commits].first[:author][:name].should == "Ville Lautanala"
+        @hash[:commits].first[:author][:email].should == "lautis@gmail.com"
+      end
+
+      it "has commit id" do
+        @hash[:commits].first[:id].should == "cf4a78c59cf9e06ebd7336900b2a66b85a88b76c"
+      end
+
+      it "puts deleted files in an array" do
+        @hash[:commits].first[:removed].should include("spec/flowdock-git-hook_spec.rb")
+      end
+
+      it "puts added files to an array" do
+        @hash[:commits].first[:added].should include("lib/flowdock/git.rb")
+      end
+
+      it "detects modified files" do
+        @hash[:commits].first[:modified].should_not include("spec/flowdock-git-hook_spec.rb")
+        @hash[:commits].first[:modified].should_not include("lib/flowdock/git.rb")
+        @hash[:commits].first[:modified].should include("lib/flowdock-git-hook.rb")
+      end
+    end
+
+    describe "repository information" do
+      it "contains repository name based on file path" do
+        @hash[:repository][:name] = "flowdock-git-hook"
+      end
+    end
+  end
+end

data/spec/flowdock_git_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Flowdock Git Hook" do
+  it "raises error if git token is not defined" do
+    lambda {
+      Flowdock::Git.new("refs/heads/master", "random-hash", "random-hash")
+    }.should raise_error(Flowdock::Git::TokenError)
+  end
+
+  it "can read token from git config" do
+    Grit::Config.stub!(:new).and_return({
+      "flowdock.token" => "flowdock-token"
+    })
+
+    lambda {
+      Flowdock::Git.new("refs/heads/master", "random-hash", "random-hash")
+    }.should_not raise_error
+  end
+
+  it "builds payload" do
+    stub_request(:post, "https://api.flowdock.com/v1/git/flowdock-token")
+    Flowdock::Git.new("refs/heads/master", "7e32af569ba794b0b1c5e4c38fef1d4e2e56be51", "a1a94ba4bfa5f855676066861604b8edae1a20f5", :token => "flowdock-token").post
+    a_request(:post, "https://api.flowdock.com/v1/git/flowdock-token").with { |req|
+      req.body.match(/7e32af569ba794b0b1c5e4c38fef1d4e2e56be51/)
+    }.should have_been_made
+  end
+
+  describe "Tagging" do
+    it "reads tags from initializer parameter" do
+      tags = Flowdock::Git.new("ref", "before", "after", :token => "flowdock-token", :tags => ["foo", "bar"]).send(:tags)
+      tags.should include("foo", "bar")
+    end
+
+    it "reads tags from gitconfig as fallback" do
+      Grit::Config.stub!(:new).and_return({
+        "flowdock.tags" => "foo,bar"
+      })
+      tags = Flowdock::Git.new("ref", "before", "after", :token => "flowdock-token").send(:tags)
+      tags.should include("foo", "bar")
+    end
+
+    it "encodes tags suitable for URI" do
+      Flowdock::Git.new("ref", "before", "after", :token => "flowdock-token", :tags => "foo%bar").send(:tags).should include("foo%25bar")
+    end
+  end
+end
+
+describe "Flowdock Git Hook", "HTTP Post" do
+  before :each do
+    @notifier = Flowdock::Git.new("origin/refs/master", "random-hash", "random-hash", :token => "flowdock-token", :tags => ["foo", "bar"])
+    @notifier.stub(:payload) { {} }
+    stub_request(:post, "https://api.flowdock.com/v1/git/flowdock-token+foo+bar")
+  end
+
+  it "posts to api.flowdock.com" do
+    @notifier.post
+    a_request(:post, "https://api.flowdock.com/v1/git/flowdock-token+foo+bar").should have_been_made
+  end
+
+  it "sends payload encoded as JSON" do
+    @notifier.post
+    a_request(:post, "https://api.flowdock.com/v1/git/flowdock-token+foo+bar").with(:body => {:payload => "{}"}).should have_been_made
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'webmock/rspec'
+require 'flowdock-git-hook'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: flowdock-git-hook
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 4
+        - 1
+        version: 2.4.1
+  prerelease: false
+  version_requirements: *id001
+  name: grit
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  version_requirements: *id002
+  name: multi_json
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  prerelease: false
+  version_requirements: *id003
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  version_requirements: *id004
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  prerelease: false
+  version_requirements: *id005
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  version_requirements: *id006
+  name: rcov
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  version_requirements: *id007
+  name: webmock
+description: 
+email: lautis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/flowdock-git-hook.rb
+- lib/flowdock/git.rb
+- lib/flowdock/git/builder.rb
+- post-receive
+- spec/builder_spec.rb
+- spec/flowdock_git_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/flowdock/flowdock-git-hook
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Git Post-Receive hook for Flowdock
+test_files: []
+