flowdock-git-hook 0.3.0 → 0.4.0

data/README.md

@@ -0,0 +1,89 @@
+# 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
+
+    $ wget -O hooks/post-receive https://raw.github.com/flowdock/flowdock-git-hook/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.
+
+## Configuration
+
+Service specific instructions for [Gitlab](https://github.com/flowdock/flowdock-git-hook/wiki/Gitlab) and [Redmine](https://github.com/flowdock/flowdock-git-hook/wiki/Redmine) can be found in [Wiki](https://github.com/flowdock/flowdock-git-hook/wiki).
+
+### Repository URL
+
+Each Team Inbox item sent from the post-receive hook can link back to the repository. To configure the URL for the repository, configure a `repository-url`:
+
+    $ git config flowdock.repository-url "http://example.com/mygitviewer/repo"
+
+### Commit URLs
+
+Commit SHAs links in the Team Inbox of Flowdock can be made clickable to view the change on the web. To configure the URL for viewing commits, configure a `commit-url-pattern`:
+
+    $ git config flowdock.commit-url-pattern "http://example.com/mygitviewer/commits/%s"
+
+The `%s` will be replaced with the commit SHA.
+
+### Diff URL
+
+Commit messages in Team Inbox can have a action for viewing the commit diff. To enable the Diff action for comparing commits, configure a `diff-url-pattern`:
+
+     $ gitconfig flowdock.diff-url-pattern "http://example.com/mygitviewer/compare/%s...%s"
+
+## 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.background_post(ref, before, after, :tags => ["git", "push"])
+
+Note that you can also define token as parameter allowing multiple Flows to be notified.
+
+    Flowdock::Git.background_post(ref, before, after, :token => "flow-token")
+    Flowdock::Git.background_post(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/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/flowdock-git-hook.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = "flowdock-git-hook"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ville Lautanala"]
-  s.date = "2012-10-18"
+  s.date = "2013-01-13"
   s.email = "lautis@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "flowdock-git-hook.gemspec",

data/lib/flowdock/git.rb

@@ -25,6 +25,8 @@ module Flowdock
       @options = options
       @token = options[:token] || config["flowdock.token"] || raise(TokenError.new("Flowdock API token not found"))
       @commit_url = config["flowdock.commit-url-pattern"] || nil
+      @diff_url = config["flowdock.diff-url-pattern"] || nil
+      @repo_url = config["flowdock.repository-url"] || nil
     end
 
     # Send git push notification to Flowdock
@@ -33,11 +35,17 @@ module Flowdock
       req = Net::HTTP::Post.new(uri.path)
 
       payload_hash = data.to_hash
+      if @repo_url
+        payload_hash[:repository][:url] = @repo_url
+      end
       if @commit_url
         payload_hash[:commits].each do |commit|
           commit[:url] = @commit_url % commit[:id]
         end
       end
+      if @diff_url
+        payload_hash[:compare] = @diff_url % [payload_hash[:before], payload_hash[:after]]
+      end
 
       req.set_form_data(:payload => MultiJson.encode(payload_hash))
       http = Net::HTTP.new(uri.host, uri.port)

data/spec/flowdock_git_spec.rb

@@ -33,6 +33,22 @@ describe "Flowdock Git Hook" do
     }.should have_been_made
   end
 
+  it "builds payload with repo url, diff url and commit urls" do
+    Grit::Config.stub!(:new).and_return({
+      "flowdock.token" => "flowdock-token",
+      "flowdock.repository-url" => "http://www.example.com",
+      "flowdock.diff-url-pattern" => "http://www.example.com/compare/%s...%s",
+      "flowdock.commit-url-pattern" => "http://www.example.com/commit/%s"
+    })
+    stub_request(:post, "https://api.flowdock.com/v1/git/flowdock-token")
+    Flowdock::Git.post("refs/heads/master", "7e32af569ba794b0b1c5e4c38fef1d4e2e56be51", "a1a94ba4bfa5f855676066861604b8edae1a20f5", :token => "flowdock-token")
+    a_request(:post, "https://api.flowdock.com/v1/git/flowdock-token").with { |req|
+      body = CGI.unescape(req.body)
+      body.match("http://www.example.com/") &&
+      body.match("http://www.example.com/compare/7e32af569ba794b0b1c5e4c38fef1d4e2e56be51...a1a94ba4bfa5f855676066861604b8edae1a20f5")
+    }.should have_been_made
+  end
+
   describe "Tagging" do
     it "reads tags from initializer parameter" do
       tags = Flowdock::Git.new(:token => "flowdock-token", :tags => ["foo", "bar"]).send(:tags)

metadata

@@ -1,158 +1,158 @@
 --- !ruby/object:Gem::Specification
 name: flowdock-git-hook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
   prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Ville Lautanala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: grit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.1
+    none: false
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.1
+    none: false
+  prerelease: false
+  name: grit
 - !ruby/object:Gem::Dependency
-  name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: multi_json
 - !ruby/object:Gem::Dependency
-  name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.2
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.4.2
+    none: false
+  prerelease: false
+  name: rdoc
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.8'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.8'
+    none: false
+  prerelease: false
+  name: rspec
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+    none: false
+  prerelease: false
+  name: bundler
 - !ruby/object:Gem::Dependency
-  name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.2
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.2
+    none: false
+  prerelease: false
+  name: jeweler
 - !ruby/object:Gem::Dependency
-  name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.4
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.4
+    none: false
+  prerelease: false
+  name: webmock
 - !ruby/object:Gem::Dependency
-  name: jruby-openssl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: jruby-openssl
 description: 
 email: lautis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - flowdock-git-hook.gemspec
@@ -171,20 +171,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      hash: -2102498903876344140
       version: '0'
       segments:
       - 0
-      hash: 3361873183891229684
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/README.rdoc

@@ -1,79 +0,0 @@
-= 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
-
-  $ wget -O hooks/post-receive https://raw.github.com/flowdock/flowdock-git-hook/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.
-
-== Commit URLs
-
-Commit SHAs links in the Team Inbox of Flowdock can be made clickable to view the change on the web. To configure the URL for viewing commits, configure a <tt>commit-url-pattern</tt>:
-
-  $ config flowdock.commit-url-pattern "http://example.com/mygitviewer/commits/%s"
-
-The <tt>%s</tt> will be replaced with the commit SHA.
-
-Example for Redmine:
-
-  $ git config flowdock.commit-url-pattern "http://developer.example.com/projects/myproject/repository/revisions/%s"
-
-Replace 'myproject' with the project the Git repository is associated with.
-
-== 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.background_post(ref, before, after, :tags => ["git", "push"])
-
-Note that you can also define token as parameter allowing multiple Flows to be notified.
-
-  Flowdock::Git.background_post(ref, before, after, :token => "flow-token")
-  Flowdock::Git.background_post(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"
-    }
-  }