github_concern 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Adam Gamble
+
+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.markdown

@@ -0,0 +1,78 @@
+# Github Concern
+
+Github Concern is a library to make integrating your application with github
+braindead simple.  It has the following useful features:
+
+* Provides a controller to respond to github post-push service hooks.
+* Provides models to store the information github sends you.
+* Provides a DSL for easily specifying which objects in your system should be
+  associated with commits.
+* Provides a DSL to specify actions in your system that should be taken as a
+  result of specific commits being seen.  For instance, in a time tracking
+  system you might add something that responded to commits that had "\[HOURS:
+  3.5\]" in them by creating a WorkUnit in the system, associated with that
+  commit, for 3.5 hours.
+
+## Installation
+
+First, add github\_concern to your Gemfile:
+
+```ruby
+gem 'github_concern', :git => 'http://github.com/adamgamble/github_concern.git'
+```
+
+    bundle install
+
+Now github\_concern is available to your application.  Next, add a service hook
+to your github repo that posts to http://your\_url/github\_integration
+
+Add this to config/initializers/github\_concern.rb:
+
+```ruby
+GithubConcern::Engine.config do |gc|
+  gc.user_lambda = lambda {|email| User.find_by_email email}
+  gc.user_class  = User
+end
+```
+
+You can adjust the lambda to fit your needs for determining a user.
+
+You need to create tables to store the commits and pushes that the github web
+hook is going to be sending you.  Run this command to install the migrations:
+
+    rake github_concern_engine:install:migrations
+
+You can configure whatever models you want to be associated with the git pushes:
+
+```ruby
+class SomeModel < ActiveRecord::Base
+  github_concern :repo => :github_repo, :branch => :github_branch
+
+  def github_concern_callback git_push
+  end
+end
+```
+
+`:github_repo`, and `:github_branch` represent attributes on the model
+
+Now when someone pushes to a repo that has the service hook, information about
+that will be stored in the database and associated to whatever models specified.
+It will also call the `github_concern_callback` method on the object if it
+exists.
+
+## Contributing
+
+Fork our repo, make a feature branch, push to it.  Send us a pull request.
+We'll communicate back and forth via the github interface.  All contributions
+are welcome.  Plase inform us of issues via the github issue tracker
+
+## Authors
+
+* Adam Gamble
+* Josh Adams*
+
+\* Hasn't actually commited any code yet
+
+## License
+
+See the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GithubConcern'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/github.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/github.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/app/controllers/github_controller.rb

@@ -0,0 +1,7 @@
+class GithubController < ApplicationController
+  def payload
+    render :nothing => true, :status => 500 and return unless params["payload"]
+    GitPush.create(:payload => JSON.parse(params["payload"]))
+    render :nothing => true, :status => 200
+  end
+end

data/app/helpers/github_helper.rb

@@ -0,0 +1,2 @@
+module GithubHelper
+end

data/app/models/git_commit.rb

@@ -0,0 +1,4 @@
+class GitCommit < ActiveRecord::Base
+  belongs_to :git_push
+  serialize :payload
+end

data/app/models/git_push.rb

@@ -0,0 +1,56 @@
+class GitPush < ActiveRecord::Base
+  before_create :associate_user
+  after_create :associate_git_concernables, :build_commits
+
+  serialize :payload
+  belongs_to GithubConcern::Engine.user_class_symbol, :foreign_key => :user_id
+  has_many :github_concernable_git_pushes
+  has_many :github_concernables, :through => :github_concernable_git_pushes
+  has_many :git_commits
+
+  private
+  def associate_user
+    email = payload["pusher"]["email"]
+    user = GithubConcern::Engine.determine_user(email)
+    self.user_id = user.id if user
+  end
+
+  def build_commits
+    payload["commits"].each do |commit|
+      git_commits.create(:payload => commit)
+    end
+  end
+
+  def associate_git_concernables
+    GithubConcern::Engine.github_concerns.each_pair do |class_name, github_concern_hash|
+      bucket = class_name.constantize
+      github_concern_hash.each_pair do |github_concern_key, github_concern_method|
+        case github_concern_key
+        when :repo
+          git_variable = payload["repository"]["name"]
+        when :branch
+          git_variable = payload["ref"].gsub("refs/heads/","")
+        when :class_method
+          objects = bucket.send(github_concern_method,payload["repository"]["name"],payload["ref"].gsub("refs/heads/",""))
+          if objects.respond_to?(:each)
+            objects.each {|object| associate_to_object object }
+          else
+            associate_to_object objects
+          end
+          next
+        end
+        bucket = bucket.where(github_concern_method => git_variable)
+      end
+      bucket.all.each do |object|
+        associate_to_object object
+      end
+    end
+  end
+
+  def associate_to_object object
+    github_concernable_git_push = self.github_concernable_git_pushes.new
+    github_concernable_git_push.github_concernable = object
+    github_concernable_git_push.save
+    object.github_concern_callback(self) if object.respond_to?(:github_concern_callback)
+  end
+end

data/app/models/github_concernable_git_push.rb

@@ -0,0 +1,4 @@
+class GithubConcernableGitPush < ActiveRecord::Base
+  belongs_to :github_concernable, :polymorphic => true
+  belongs_to :git_push
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  post "/github_integration", :to => "github#payload"
+end

data/db/migrate/20111204031658_create_git_pushes.rb

@@ -0,0 +1,9 @@
+class CreateGitPushes < ActiveRecord::Migration
+  def change
+    create_table :git_pushes do |t|
+      t.text :payload
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111204031730_create_git_commits.rb

@@ -0,0 +1,10 @@
+class CreateGitCommits < ActiveRecord::Migration
+  def change
+    create_table :git_commits do |t|
+      t.text :payload
+      t.integer :git_push_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20111204041743_add_user_id_to_git_push.rb

@@ -0,0 +1,5 @@
+class AddUserIdToGitPush < ActiveRecord::Migration
+  def change
+    add_column :git_push, :user_id, :integer
+  end
+end

data/db/migrate/20111204055027_create_github_concernable_git_pushes.rb

@@ -0,0 +1,11 @@
+class CreateGithubConcernableGitPushes < ActiveRecord::Migration
+  def change
+    create_table :github_concernable_git_pushes do |t|
+      t.string :github_concernable_type
+      t.integer :github_concernable_id
+      t.integer :git_push_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/github_concern/engine.rb

@@ -0,0 +1,50 @@
+require 'rails/all'
+module GithubConcern
+  class Engine < Rails::Engine
+    @@github_concerns = {}
+    def self.config
+      yield(self)
+    end
+
+    def self.add_class(class_constant, options)
+      @@github_concerns[class_constant.to_s] = options
+    end
+
+    def self.github_concerns
+      @@github_concerns
+    end
+
+    def self.user_lambda= find_user_lambda
+      @@user_lambda = find_user_lambda
+    end
+
+    def self.user_lambda
+      @@user_lambda
+    end
+
+    def self.user_class= user_class_constant
+      @@user_class= user_class_constant
+      @@user_class.class_eval { has_many :git_pushes }
+      @@user_class
+    end
+
+    def self.user_class
+      @@user_class
+    end
+
+    def self.user_class_symbol
+      @@user_class.try(:to_s).try(:downcase).try(:to_sym)
+    end
+
+    def self.determine_user(email)
+      @@user_lambda.call(email)
+    end
+
+    def self.add_github_concernable_relationship_to_class(class_constant)
+      class_constant.class_eval {
+        has_many :github_concernables, :class_name => "GithubConcernableGitPush", :as => :github_concernable
+        has_many :git_pushes, :through => :github_concernables
+      }
+    end
+  end
+end

data/lib/github_concern/version.rb

@@ -0,0 +1,3 @@
+module GithubConcern
+  VERSION = "0.0.1"
+end

data/lib/github_concern.rb

@@ -0,0 +1,15 @@
+require "github_concern/engine"
+
+module GithubConcern
+  extend ActiveSupport::Concern
+  included do
+  end
+
+  module ClassMethods
+    def github_concern(options = {})
+      GithubConcern::Engine.add_class(self, options)
+      GithubConcern::Engine.add_github_concernable_relationship_to_class(self)
+    end
+  end
+end
+ActiveRecord::Base.send :include, GithubConcern

data/lib/tasks/github_concern_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :github_concern do
+#   # Task goes here
+# end

data/spec/controllers/github_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe GithubController do
+  describe "POST payload" do
+    it "returns 500 when not sending a payload" do
+      post :payload
+      response.code.should == "500"
+    end
+
+    describe "when sending a valid payload" do
+      before(:each) do
+        payload = valid_payload_hash.to_json
+        post :payload, :payload => payload
+      end
+
+      it "returns 200 when sending a valid payload" do
+        response.should be_success
+      end
+
+      it "should create a git push" do
+        GitPush.count.should == 1
+      end
+
+      it "should set the payload of that git push to payload" do
+        GitPush.last.payload.should == valid_payload_hash
+      end
+    end
+  end
+end

data/spec/internal/app/models/project.rb

@@ -0,0 +1,2 @@
+class Project < ActiveRecord::Base
+end

data/spec/internal/app/models/ticket.rb

@@ -0,0 +1,6 @@
+class Ticket < ActiveRecord::Base
+
+  def self.github_concern_class_method repo, branch
+
+  end
+end

data/spec/internal/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/internal/config/application.rb

@@ -0,0 +1 @@
+require 'github_concern'

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/initializers/github_concern.rb

@@ -0,0 +1,11 @@
+GithubConcern::Engine.config do |gc|
+  gc.user_lambda = lambda {|email| User.find_by_email email}
+  gc.user_class  = User
+end
+
+Module.constants.select do |constant_name|
+  constant = constant_name.to_s.constantize
+  if not constant.nil? and constant.is_a? Class and constant.superclass == ActiveRecord::Base
+    constant.inspect
+  end
+end

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,36 @@
+ActiveRecord::Schema.define do
+  create_table(:users, :force => true) do |t|
+    t.string :email
+    t.timestamps
+  end
+
+  create_table(:projects, :force => true) do |t|
+    t.string :github_repo
+    t.timestamps
+  end
+
+  create_table(:tickets, :force => true) do |t|
+    t.string :github_repo
+    t.string :github_branch
+    t.timestamps
+  end
+
+  create_table(:git_pushes, :force => true) do |t|
+    t.text :payload
+    t.integer :user_id
+    t.timestamps
+  end
+
+  create_table(:git_commits, :force => true) do |t|
+    t.text :payload
+    t.integer :git_push_id
+    t.timestamps
+  end
+
+  create_table(:github_concernable_git_pushes, :force => true) do |t|
+    t.string  :github_concernable_type
+    t.integer :github_concernable_id
+    t.integer :git_push_id
+    t.timestamps
+  end
+end