tutter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b51fa2f78d6e5c075b9e5d5277d8bbe842e3a7bb
+  data.tar.gz: e066f2ee612e05aaf55d40faf93429a835da4f95
+SHA512:
+  metadata.gz: dfa1ad7f83fa9d5598c4d3ce254e3bce5b29690fe46d3ae3f7b95e7d6d9eb9ebc7342ca971c9534bb4e2375cc16131f265406879bb7569eb769f98f61cc73016
+  data.tar.gz: 41d9de92f0dab613efbc2e2323fae987582eed6ed9e24b464cff5b557b46e5160438a107aeef807cb14c160b08869891baaf335d15f29f685df5535c5eacca1b

data/.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'tutter'
+  s.version     = '0.0.1'
+  s.author      = 'Johan Haals'
+  s.email       = ['johan.haals@gmail.com']
+  s.homepage    = 'https://github.com/jhaals/tutter'
+  s.summary     = 'Plugin based Github robot'
+  s.description = 'Tutter is a web app that trigger actions based on Github events(push, pull_reqeust, release, issue, ...)'
+  s.license     = 'Apache 2.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files bin`.split("\n").map { |f| File.basename f }
+  s.require_paths = ['lib', 'conf']
+
+  s.required_ruby_version = '>= 1.8.7'
+  s.add_runtime_dependency 'sinatra', '~> 1.4.4'
+  s.add_runtime_dependency 'octokit', '~> 2.7.1'
+end
+

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+Gemfile.lock
+vendor/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'octokit', '~> 2.7.1'
+gem 'sinatra', '~> 1.4.4'
+
+group :dev do
+  gem 'sinatra-contrib'
+  gem 'tutter', :path => '.'
+end

data/README.md

@@ -0,0 +1,59 @@
+# Tutter - Plugin based Github robot
+Tutter is a web app that trigger actions based on Github events(push, pull_reqeust, release, issue, ...)
+
+# Features
+* Pluggable with custom actions
+* Supports multiple projects
+
+# Installation
+
+    gem install tutter
+
+put a configuration file in `/etc/tutter.yaml`
+an example can be found under `conf/tutter.yaml`
+
+Let's install the `thanks` action that thank anyone that creates an issue in your project.
+
+### tutter.yaml settings
+
+* `name` - username/projectname
+* `access_token` - github access token (can be generated [here](https://github.com/settings/applications))
+* `github_site` - github website
+* `github_api_enpoint` - github api endpint
+* `action` - action you wish to use for the project
+* `action_settings` - whatever settings your action require
+
+### Create the Github hook
+Github has no UI for creating hooks other then hooks triggered on push.
+
+Let's create one that triggers on issues
+
+    $ tutter --project jhaals/testing \
+    --url https://tutter.jhaals.se \
+    --access-token <github_api_token> \
+    --github-web-url https://github.com \
+    --github-api-endpoint https://api.github.com \
+    --events issues
+
+## Build custom action
+
+Another example action [github.com/jhaals/tutter-sppuppet](https://github.com/jhaals/tutter-sppuppet)
+
+#####Required methods and their arguments
+
+`initialize`
+
+    settings - contains a hash of action specific settings
+    client - Used to access the github api, all authentication is already done by tutter
+    project - Project name, eg jhaals/tutter
+    data - POST data that github send when a hook is triggered
+
+`run` - Run action
+
+Tutter uses [octokit.rb](https://github.com/octokit/octokit.rb) to communicate with the Github [API](http://developer.github.com/v3/)
+
+### Features to implement
+* Add web hooks in Github automatically
+* Support multiple actions per project
+* Authenticate as a Github application
+* Features your're missing (please contribute)

data/bin/tutter

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'octokit'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: tutter --project [project] [options]"
+  opts.on("-p", "--project [PROJECT]", "Github project name (jhaals/tutter)") do |p|
+    options[:project] = p
+  end
+  opts.on("-e", "--events [EVENTS]", "Github events that will trigger tutter") do |e|
+    options[:events] = e
+  end
+  opts.on("-u", "--url [URL]", "URL to the tutter service") do |u|
+    options[:url] = u
+  end
+  opts.on("-t", "--access-token [TOKEN]", "Github access token") do |t|
+    options[:access_token] = t
+  end
+  opts.on("--github-api-endpoint [api-endpoint]", "Github API endpoint") do |t|
+    options[:api_endpoint] = t
+  end
+  opts.on("--github-web-url [GITHUBWEBSITE]", "Github website url") do |t|
+    options[:base_url] = t
+  end
+end.parse!
+
+if options[:project].nil?
+  puts '--project required'
+  exit 1
+end
+
+if options[:url].nil?
+  puts '--url required'
+  exit 1
+end
+
+if options[:access_token].nil?
+  puts '--access-token required'
+  exit 1
+end
+
+if options[:base_url].nil?
+  puts '--github-web-url required'
+  exit 1
+end
+
+if options[:api_endpoint].nil?
+  puts '--github-api-endpoint required'
+  exit 1
+end
+
+Octokit.configure do |c|
+  c.api_endpoint = options[:api_endpoint]
+  c.web_endpoint = options[:base_url]
+end
+
+client = Octokit::Client.new :access_token => options[:access_token]
+client.login
+
+p client.create_hook(
+  options[:project],
+  'web',
+  {
+    :url => options[:url],
+    :content_type => 'json'
+  },
+  {
+    :events => options[:events].split(','),
+    :active => true
+  }
+)
+
+

data/conf/tutter.yaml

@@ -0,0 +1,11 @@
+projects:
+  - name: 'JHaals/testing'
+    access_token: ''
+    github_site: 'https://github.com'
+    github_api_endpoint: 'https://api.github.com'
+
+    action: 'thanks'
+    action_settings:
+        whatever_action_specific_setting: 'foo'
+        another_setting: false
+

data/lib/tutter/action/thanks.rb

@@ -0,0 +1,24 @@
+# Example action
+# Thank the person who submit an issue
+
+class Thanks
+  def initialize(settings, client, project, data)
+    @settings = settings # action specific settings
+    @client = client # Octokit client
+    @project = project # project name
+    @data = data
+  end
+
+  def run
+    # Only trigger if a new issue is created
+    return unless @data['action'] == 'opened'
+
+    issue = @data['issue']['number']
+    submitter = @data['issue']['user']['login']
+    comment = "@#{submitter} thanks for submitting this issue!"
+
+    puts comment # just for debug purpose
+    @client.add_comment(@project, issue, comment)
+  end
+
+end

data/lib/tutter/action.rb

@@ -0,0 +1,11 @@
+class Action
+  def self.create(action, settings, client, project, data)
+    begin
+      require "tutter/action/#{action.downcase}"
+    rescue LoadError => e
+      raise "Unsupported action #{action}: #{e}"
+    end
+    class_name = action.split("_").map {|v| v.capitalize }.join
+    const_get(class_name).new settings, client, project, data
+  end
+end

data/lib/tutter.rb

@@ -0,0 +1,68 @@
+require 'octokit'
+require 'yaml'
+require 'sinatra'
+require 'tutter/action'
+require 'json'
+
+class Tutter < Sinatra::Base
+  configure :development do
+    require 'sinatra/reloader'
+    register Sinatra::Reloader
+    set :config, YAML.load_file('conf/tutter.yaml')
+    set :bind, '0.0.0.0'
+  end
+
+  configure :production do
+    set :config, YAML.load_file('/etc/tutter.yaml')
+  end
+
+  # Return project settings from config
+  def get_project_settings project
+    settings.config['projects'].each do |p|
+      return p if p['name'] == project
+    end
+    false
+  end
+
+  post '/' do
+    # Github send data in JSON format, parse it!
+    data = JSON.parse request.body.read
+    project = data['repository']['full_name']
+
+    conf = get_project_settings(project)
+    return 'Project does not exist in tutter.conf' unless conf
+
+    # Setup octokit endpoints
+    Octokit.configure do |c|
+      c.api_endpoint = conf['github_api_endpoint']
+      c.web_endpoint = conf['github_site']
+    end
+
+    # Authenticate to Github
+    begin
+      client = Octokit::Client.new :access_token => conf['access_token']
+    rescue Octokit::Unauthorized
+      return "Authorization to #{project} failed, please verify your access token"
+    rescue Octokit::TooManyLoginAttempts
+      return "Account for #{project} has been temporary locked down due to to many failed login attempts"
+    end
+
+    # Load action
+    action = Action.create(conf['action'],
+                                 conf['action_settings'],
+                                 client,
+                                 project,
+                                 data)
+
+    action.run
+    # Github does not care about status codes or return values.
+    # Output url to source if someone is interested
+    'Source code and documentation at https://github.com/jhaals/tutter'
+  end
+
+  get '/' do
+    'Source code and documentation at https://github.com/jhaals/tutter'
+  end
+
+  run! if app_file == $0
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: tutter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Johan Haals
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: Tutter is a web app that trigger actions based on Github events(push,
+  pull_reqeust, release, issue, ...)
+email:
+- johan.haals@gmail.com
+executables:
+- tutter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .gitignore
+- Gemfile
+- README.md
+- bin/tutter
+- conf/tutter.yaml
+- lib/tutter.rb
+- lib/tutter/action.rb
+- lib/tutter/action/thanks.rb
+homepage: https://github.com/jhaals/tutter
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- conf
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Plugin based Github robot
+test_files: []