git_trello_post_commit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 650ea741b6a6a41902715be311f92a0e01bdd365
+  data.tar.gz: 29659334553f6b7c9e92a241212385595215b7c1
+SHA512:
+  metadata.gz: d12535d71a22eb1fb3554852f4200cd85cb99447f36daa53754cecf1f2a71942604b18af7d909b4ad8826fdeaf45ec7a83f954d74e10f8773e7b80da239ec248
+  data.tar.gz: c2f80d764567d0f398833e460949d36f6cbcabc48f6c0cf1e81518412605aea64ebf9f5197e9b0423bf1ef7f15add9f7227a235a4a0822500d2922da59278934

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/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git_trello_post_commit.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jmchambers
+
+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,85 @@
+# git_trello_post_commit
+
+This gem can be used in a post-commit hook in any Git repository to comment on and move Trello cards in a specified board. The actions performed by the hook depend on the Git commit message. For example, if a message contains 'Card #20', the hook will add the rest of the commit message as a comment on card #20.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'git_trello_post_commit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git_trello_post_commit
+
+## Setup
+
+Add a file like this to your repo:
+
+**my_repo/.git/hooks/post-commit**
+
+    #!/usr/bin/env ruby
+    require 'git_trello_post_commit'
+    GitTrelloPostCommit::Hook.new(
+      :api_key              => 'API_KEY',
+      :oauth_token          => 'OAUTH_TOKEN',
+      :list_id_in_progress  => 'LIST_ID_IN_PROGRESS',
+      :list_id_done         => 'LIST_ID_IN_DONE',
+      :board_id             => 'TRELLO_BOARD_ID',
+      :commit_url_prefix    => 'https://github.com/my_github_username/my_repo/commits/' 
+    ).run
+
+
+Filling in the details using the following approach...
+
+### api_key
+
+Get your developer key from: https://trello.com/1/appKey/generate
+
+### oauth_token
+
+You need to authorize the app with `API_KEY` to access each board separatelly. To do that:
+
+https://trello.com/1/authorize?response_type=token&name=`BOARD_NAME_AS_SHOWN_IN_URL`&scope=read,write&expiration=never&key=`API_KEY`
+
+### list_id_in_progress & list_id_done
+
+Open a card from your "in progress" and "completed" lists (or whatever you've called them), click the 'More' link in the bottom-right-hand corner, select 'Export JSON' and find the `idList` value.
+
+### board_id
+
+While examining the JSON from the previous step, you can also grab the value of `idBoard`.
+
+### commit_url_prefix
+
+If you have a web view of your Git repo (such as Github), you can enter the URL which, when sufixed with the commit SHA will show the commit in question. The hook will add a link to the commit in the comment it adds to the card.
+
+If you ommit the parameter, a link won't be added.
+
+## Usage
+
+The gem uses the following regex to detect a reference to a card:
+
+    /((case|card|close|fix)e?s? \D?([0-9]+))/i
+
+So an example commit message might be:
+
+    Added that awesome feature closes #42
+
+For the 'case' and 'card' keywords, the card is moved to the list with id `LIST_ID_IN_PROGRESS`, while for keywords 'close' and 'fix', the card is moved to the list with id `LIST_ID_IN_DONE` .
+
+## 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
+
+## Acknowledgments
+
+This gem is a quick-and-dirty mod of https://github.com/zmilojko/git-trello, so credit to [@zmilojko](https://github.com/zmilojko).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/git_trello_post_commit.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_trello_post_commit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_trello_post_commit"
+  spec.version       = GitTrelloPostCommit::VERSION
+  spec.authors       = ["jmchambers"]
+  spec.email         = ["j.chambers@gmx.net"]
+  spec.description   = %q{This gem can be used in a post-commit hook in any Git repository to comment on and move Trello cards in a specified board. What will be done is based on a Git commit message:for example, if a message contains 'Card #20', post-commit will add the rest of comment message as a comment on card #20.}
+  spec.summary       = %q{Update Trello cards with git commit messages.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency "git", "~> 1.2"
+end

data/lib/git_trello_post_commit/trello-http.rb

@@ -0,0 +1,62 @@
+#Copyright (c) 2011 Zachary Anker
+#Minor modifications by Zeljko Milojkovic
+
+require "cgi"
+require "net/https"
+
+module GitTrelloPostCommit
+  module Trello
+    class HTTP
+      def initialize(token, api_key)
+        @token, @api_key = token, api_key
+        @uri = URI("https://api.trello.com")
+      end
+
+      def get_card(board_id, card_id)
+        http_request(:get, "/1/boards/#{board_id}/cards/#{card_id}", :params => {:fields => "idList,closed"})
+      end
+
+      def update_card(card_id, params)
+        http_request(:put, "/1/cards/#{card_id}", :params => params)
+      end
+
+      def add_comment(card_id, comment)
+        http_request(:post, "/1/cards/#{card_id}/actions/comments", :body => "text=#{CGI::escape(comment)}")
+      end
+
+      def get_cards(list_id)
+        http_request(:get, "/1/lists/#{list_id}/cards", :params => {:fields => "idList"})
+      end
+
+      private
+      
+      def http_request(method, request_path, args={})
+        request_path << "?"
+        args[:params] ||= {}
+        args[:params][:key] = @api_key
+        args[:params][:token] = @token
+        args[:params].each {|k, v| request_path << "#{k}=#{CGI::escape(v.to_s)}&"}
+
+        http = Net::HTTP.new(@uri.host, @uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        http.start
+
+        if method == :get
+          response = http.request_get(request_path)
+        elsif method == :post
+          response = http.request_post(request_path, args.delete(:body))
+        elsif method == :put
+          response = http.request_put(request_path, args.delete(:body))
+        end
+
+        unless response.code == "200" or response.code == "201"
+          raise Net::HTTPError.new("#{response.body == "" ? response.message : response.body.strip} (#{response.code})", response)
+        end
+
+        response.body
+      end
+    end
+  end
+end

data/lib/git_trello_post_commit/version.rb

@@ -0,0 +1,3 @@
+module GitTrelloPostCommit
+  VERSION = "0.1.0"
+end

data/lib/git_trello_post_commit.rb

@@ -0,0 +1,69 @@
+require "git_trello_post_commit/version"
+require "git_trello_post_commit/trello-http"
+require "json"
+require "git"
+
+module GitTrelloPostCommit
+
+  class Hook
+
+    def initialize(config)
+      @api_key = config[:api_key]
+      @oauth_token = config[:oauth_token]
+      @repodir = config[:repodir] || Dir.pwd
+      @board_id = config[:board_id]
+      @list_id_in_progress = config[:list_id_in_progress]
+      @list_id_done = config[:list_id_done]
+      @commit_url_prefix = config[:commit_url_prefix]
+
+      @http = GitTrelloPostCommit::Trello::HTTP.new(@oauth_token, @api_key)
+      @repo = Git.open(@repodir)
+    end
+
+    def run
+
+      #get the commit and it's sha from HEAD
+      commit  = @repo.gcommit('HEAD')
+      new_sha = commit.sha
+
+      # Figure out the card short id
+      match = commit.message.match(/((case|card|close|fix)e?s? \D?([0-9]+))/i)
+      return unless match and match[3].to_i > 0
+
+      puts "Trello: Commenting on card ##{match[3].to_i}"
+
+      results = @http.get_card(@board_id, match[3].to_i)
+      unless results
+        puts "Trello: Cannot find card matching ID #{match[3]}"
+        return
+      end
+      results = JSON.parse(results)
+
+      # Determine the action to take
+      target_list_id = ""
+      target_list_id = case match[2].downcase
+        when "case", "card" then @list_id_in_progress
+        when "close", "fix" then @list_id_done
+      end
+    
+      # Add the commit comment
+      message = "#{commit.author.name}:\n#{commit.message}"
+      message << "\n\n#{@commit_url_prefix}#{new_sha}" unless @commit_url_prefix.nil?
+      message.gsub!(match[1], "")
+      message.gsub!(/\(\)$/, "")
+      message.gsub!(/Signed-off-by: (.*) <(.*)>/,"")
+      @http.add_comment(results["id"], message)
+
+      unless target_list_id == ""
+        to_update = {}
+        unless results["idList"] == target_list_id
+          puts "Trello: Moving card ##{match[3].to_i} to list #{target_list_id}"
+          to_update[:idList] = target_list_id
+          @http.update_card(results["id"], to_update)
+        end
+      end
+          
+    end
+
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: git_trello_post_commit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jmchambers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 'This gem can be used in a post-commit hook in any Git repository to
+  comment on and move Trello cards in a specified board. What will be done is based
+  on a Git commit message:for example, if a message contains ''Card #20'', post-commit
+  will add the rest of comment message as a comment on card #20.'
+email:
+- j.chambers@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- git_trello_post_commit.gemspec
+- lib/git_trello_post_commit.rb
+- lib/git_trello_post_commit/trello-http.rb
+- lib/git_trello_post_commit/version.rb
+homepage: ''
+licenses:
+- MIT
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Update Trello cards with git commit messages.
+test_files: []