got_fixed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06053ffaa7bbed644b183004e7cd0472244b5eca
+  data.tar.gz: 794581561dc0dadb1419dde9fb7b74ff70551c7c
+SHA512:
+  metadata.gz: 2b02a550514de17c217f974db7762817b4f192eb23ae300d82a8cdc105d536412a979aa7c5f2bb7c9a6befbe1b8198375d167e814fe83066994efa087f8d9e54
+  data.tar.gz: ce6827d303f5777f1f37c7b58ee381a77ba0d9e85ede71295a137680eefa2519cc02be6be163f3c74e7fcd70ddcca5e93a2b275e9d3b46635a1a46a78aae137a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sébastien Saunier
+
+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.rdoc

@@ -0,0 +1,3 @@
+= GotFixed
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/got_fixed/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/got_fixed/issues.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/got_fixed/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/got_fixed/issues.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/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/got_fixed/application_controller.rb

@@ -0,0 +1,4 @@
+module GotFixed
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/got_fixed/issues_controller.rb

@@ -0,0 +1,84 @@
+require_dependency "got_fixed/application_controller"
+
+module GotFixed
+  class IssuesController < ApplicationController
+    # before_action :set_issue, only: [:destroy]
+    before_action :check_hub_signature!, :only => :github_webhook
+
+    respond_to :json
+    respond_to :js
+
+    # GET /issues
+    def index
+      @issues = Issue.all
+    end
+
+    def github_webhook
+      # TODO(ssaunier): json payload as "action" set to opened, closed or repoend
+      #                 figure out how to get it (conflict with rails action param...)
+      @issue = Issue.find_or_initialize_by :vendor_id => params[:issue][:id], :vendor => "github"
+      @issue.title = params[:issue][:title]
+      @issue.closed = params[:issue][:state] == "closed"
+      @issue.save
+      render :json => @issue
+    end
+
+    def subscribe
+      @user = User.find_or_initialize_by :email => params[:user][:email]
+      @issue = Issue.find params[:id]
+      unless @issue.users.include?(@user)
+        @issue.users << @user
+        @issue.save
+      end
+    end
+
+    private
+
+      def check_hub_signature!
+        owner, repo = params[:repository][:full_name].split("/")
+        options = GotFixed.config[:github].find(:owner => owner, :repo => repo).first
+        request.body.rewind
+        request_body = request.body.read
+
+        github_webhook = Receivers::GithubWebhook.new :secret => options[:webhook_secret]
+        github_webhook.check_hub_signature! request.headers['X-Hub-Signature'], request_body
+      end
+
+    # # POST /issues
+    # def create
+    #   @issue = Issue.new(issue_params)
+
+    #   if @issue.save
+    #     redirect_to @issue, notice: 'Issue was successfully created.'
+    #   else
+    #     respond_with @issue
+    #   end
+    # end
+
+    # # PATCH/PUT /issues/1
+    # def update
+    #   if @issue.update(issue_params)
+    #     redirect_to @issue, notice: 'Issue was successfully updated.'
+    #   else
+    #     render action: 'edit'
+    #   end
+    # end
+
+    # # DELETE /issues/1
+    # def destroy
+    #   @issue.destroy
+    #   redirect_to issues_url, notice: 'Issue was successfully destroyed.'
+    # end
+
+    # private
+    #   # Use callbacks to share common setup or constraints between actions.
+    #   def set_issue
+    #     @issue = Issue.find(params[:id])
+    #   end
+
+    #   # Only allow a trusted parameter "white list" through.
+    #   def issue_params
+    #     params.require(:issue).permit(:title, :closed)
+    #   end
+  end
+end

data/app/helpers/got_fixed/application_helper.rb

@@ -0,0 +1,4 @@
+module GotFixed
+  module ApplicationHelper
+  end
+end

data/app/helpers/got_fixed/issues_helper.rb

@@ -0,0 +1,4 @@
+module GotFixed
+  module IssuesHelper
+  end
+end

data/app/mailers/got_fixed/user_mailer.rb

@@ -0,0 +1,16 @@
+module GotFixed
+  class UserMailer < ActionMailer::Base
+    default from: GotFixed.config[:user_mailer][:from]
+
+    def issue_got_fixed_email(user, issue)
+      @user = user
+      @issue = issue
+      mail(to: @user.email, subject: subject(issue))
+    end
+
+    def subject(issue)
+      template = GotFixed.config[:user_mailer][:subject_template]
+      template % issue.attributes.symbolize_keys
+    end
+  end
+end

data/app/models/got_fixed/issue.rb

@@ -0,0 +1,36 @@
+# == Schema Information
+#
+# Table name: got_fixed_issues
+#
+#  id         :integer          not null, primary key
+#  title      :string(255)
+#  closed     :boolean
+#  created_at :datetime
+#  updated_at :datetime
+#  number     :integer
+#  vendor_id  :string(255)
+#  vendor     :string(255)
+#
+
+module GotFixed
+  class Issue < ActiveRecord::Base
+    default_scope { order("updated_at DESC") }
+    validates_uniqueness_of :vendor_id, :scope => :vendor
+
+    has_and_belongs_to_many :users
+
+    after_update :send_notifications, :if => :just_closed?
+
+    private
+
+      def just_closed?
+        !closed_was && closed
+      end
+
+      def send_notifications
+        users.each do |user|
+          user.send_notification self
+        end
+      end
+  end
+end

data/app/models/got_fixed/user.rb

@@ -0,0 +1,25 @@
+# == Schema Information
+#
+# Table name: got_fixed_users
+#
+#  id         :integer          not null, primary key
+#  email      :string(255)
+#  created_at :datetime
+#  updated_at :datetime
+#
+
+module GotFixed
+  class User < ActiveRecord::Base
+    validates_presence_of :email
+    validates_uniqueness_of :email
+    validates_format_of :email, :with => /\A([-a-z0-9!\#$%&'*+\/=?^_`{|}~]+\.)*[-a-z0-9!\#$%&'*+\/=?^_`{|}~]+@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+
+    has_and_belongs_to_many :issues
+
+    def send_notification(issue)
+      # TODO(ssaunier): async send (SMTP is slow !!)
+      mail = UserMailer.issue_got_fixed_email(self, issue)
+      mail.deliver
+    end
+  end
+end

data/app/views/got_fixed/issues/index.html.erb

@@ -0,0 +1,21 @@
+<h1>Listing issues</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th></th>
+      <th>Title</th>
+      <th>Resolved?</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @issues.each do |issue| %>
+      <tr>
+        <td>#<%= issue.number %></td>
+        <td><%= issue.title %></td>
+        <td><%= issue.closed ? "yes" : "no" %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/got_fixed/issues/subscribe.js.erb

@@ -0,0 +1 @@
+alert('<%= j @user.email %> subscribed to issue #<%= @issue.vendor_id %>');

data/app/views/got_fixed/user_mailer/issue_got_fixed_email.text.erb

@@ -0,0 +1,13 @@
+Hello,
+
+We are happy to announce you that the issue
+"<%= @issue.title %>"
+has been closed.
+
+In a few minutes, this change will be promoted to production which should fix your problem.
+
+Best regards.
+
+--
+You received this email because you subscribed to issue updates.
+You will only receive emails for issues you registered for.

data/app/views/layouts/got_fixed/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>GotFixed</title>
+  <%= stylesheet_link_tag    "got_fixed/application", :media => "all" %>
+  <%= javascript_include_tag "got_fixed/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/got_fixed.rb

@@ -0,0 +1,17 @@
+config = YAML.load(ERB.new(File.read(Rails.root.join('config', 'got_fixed.yml'))).result)
+
+# https://gist.github.com/ssaunier/3866812
+def symbolize(object)
+  if object.kind_of? Hash
+    object.keys.each do |k|
+      object[k.to_sym] = symbolize(object.delete k)
+    end
+    object
+  elsif object.kind_of? Array
+    object.map { |e| symbolize e }
+  else
+    object
+  end
+end
+
+GotFixed.config = symbolize(config)

data/config/routes.rb

@@ -0,0 +1,12 @@
+GotFixed::Engine.routes.draw do
+  resources :issues, :only => [:index] do
+    collection do
+      post :github_webhook
+    end
+    member do
+      post :subscribe
+    end
+  end
+
+  root :to => "issues#index"
+end

data/db/migrate/20130912175851_create_got_fixed_issues.rb

@@ -0,0 +1,10 @@
+class CreateGotFixedIssues < ActiveRecord::Migration
+  def change
+    create_table :got_fixed_issues do |t|
+      t.string :title
+      t.boolean :closed
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130913195152_add_number_to_got_fixed_issue.rb

@@ -0,0 +1,6 @@
+class AddNumberToGotFixedIssue < ActiveRecord::Migration
+  def change
+    add_column :got_fixed_issues, :number, :integer
+    add_column :got_fixed_issues, :vendor_id, :string
+  end
+end

data/db/migrate/20130914085003_add_vendor_to_got_fixed_issue.rb

@@ -0,0 +1,5 @@
+class AddVendorToGotFixedIssue < ActiveRecord::Migration
+  def change
+    add_column :got_fixed_issues, :vendor, :string
+  end
+end

data/db/migrate/20130924121816_create_got_fixed_users.rb

@@ -0,0 +1,9 @@
+class CreateGotFixedUsers < ActiveRecord::Migration
+  def change
+    create_table :got_fixed_users do |t|
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130924123004_has_and_belongs_to_many_issues_user.rb

@@ -0,0 +1,8 @@
+class HasAndBelongsToManyIssuesUser < ActiveRecord::Migration
+  def change
+    create_table :got_fixed_issues_users do |t|
+      t.belongs_to :user
+      t.belongs_to :issue
+    end
+  end
+end

data/db/migrate/20130929180909_unique_user_emails.rb

@@ -0,0 +1,5 @@
+class UniqueUserEmails < ActiveRecord::Migration
+  def change
+    add_index :got_fixed_users, :email, unique: true
+  end
+end

data/lib/got_fixed/adapters/github.rb

@@ -0,0 +1,78 @@
+require "httparty"
+
+module GotFixed
+  module Adapters
+    class Github
+      include HTTParty
+      base_uri "https://api.github.com"
+
+      attr_accessor :access_token, :owner, :repo
+
+      def initialize(options = {})
+        ensure_mandatory_parameters options, true
+      end
+
+      # Retrieve all issues of a given GitHub repository matching given labels
+      # Labels must be comma separated, e.g. "public,foo,bar"
+      #
+      # Doc: http://developer.github.com/v3/issues/#list-issues-for-a-repository
+      def issues(options = {})
+        ensure_mandatory_parameters options
+        labels = options[:labels]
+
+        opened = issues_with_state(labels, :open)
+        closed = issues_with_state(labels, :closed)
+        opened + closed
+      end
+
+      def hooks(options = {})
+        ensure_mandatory_parameters options
+        self.class.get "/repos/#{@owner}/#{@repo}/hooks", :headers => headers
+      end
+
+      def create_hook(options = {})
+        ensure_mandatory_parameters options
+        url = options[:url] || "http://requestb.in/xy043uxy"
+        secret = options[:secret]  # TODO(ssaunier): Raise error if secret not set.
+
+        body = {
+          :name => "web",
+          :config => {
+            :url => url,
+            :content_type => "json",
+            :secret => secret
+          },
+          :events => [ 'issues' ]
+        }
+        self.class.post "/repos/#{@owner}/#{@repo}/hooks", :body => body.to_json, :headers => headers
+      end
+
+      private
+
+      def ensure_mandatory_parameters(options, allow_empty = false)
+        [:access_token, :owner, :repo].each do |option|
+          self.send :"#{option}=", options[option] unless blank?(options[option])
+          if !allow_empty && blank?(self.send option)
+            raise ArgumentError.new "Missing mandatory :#{option} option"
+          end
+        end
+      end
+
+      def issues_with_state(labels, state)
+        query = { :labels => labels, :state => state }
+        self.class.get "/repos/#{@owner}/#{@repo}/issues", :query => query, :headers => headers
+      end
+
+      def headers
+        {
+          "Authorization" => "token #{@access_token}"
+        }
+      end
+
+      def blank?(str)
+        str.nil? || str == ""
+      end
+
+    end
+  end
+end

data/lib/got_fixed/engine.rb

@@ -0,0 +1,12 @@
+module GotFixed
+  class Engine < ::Rails::Engine
+    isolate_namespace GotFixed
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false, :view_specs => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/got_fixed/issue_factory.rb

@@ -0,0 +1,11 @@
+module GotFixed
+  class IssueFactory
+    def from_github(github_issue)
+      issue = Issue.find_or_initialize_by :vendor_id => github_issue["id"], :vendor => "github"
+      issue.title = github_issue["title"]
+      issue.closed = github_issue["state"] == "closed"
+      issue.number = github_issue["number"]
+      issue
+    end
+  end
+end

data/lib/got_fixed/receivers/github_webhook.rb

@@ -0,0 +1,21 @@
+module GotFixed
+  module Receivers
+    class GithubWebhook
+      HMAC_DIGEST = OpenSSL::Digest::Digest.new('sha1')
+      class SignatureError < StandardError; end
+
+      def initialize(options = {})
+        @secret = options[:secret]
+      end
+
+      # Incoming request:
+      # https://github.com/github/github-services/blob/14f4da01ce29bc6a02427a9fbf37b08b141e81d9/lib/services/web.rb#L48
+      def check_hub_signature!(header, body)
+        expected_signature = "sha1=#{OpenSSL::HMAC.hexdigest(HMAC_DIGEST, @secret, body)}"
+        if header != expected_signature
+          raise SignatureError.new "#{header} != #{expected_signature}"
+        end
+      end
+    end
+  end
+end

data/lib/got_fixed/version.rb

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

data/lib/got_fixed.rb

@@ -0,0 +1,10 @@
+require "got_fixed/engine"
+require "got_fixed/issue_factory"
+require "got_fixed/adapters/github"
+require "got_fixed/receivers/github_webhook"
+
+module GotFixed
+  mattr_accessor :config
+end
+
+WebMock.disable! if require "webmock"

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,34 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if(Rails.env.development?)
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults({
+      'position_in_routes'   => "before",
+      'position_in_class'    => "before",
+      'position_in_test'     => "before",
+      'position_in_fixture'  => "before",
+      'position_in_factory'  => "before",
+      'show_indexes'         => "true",
+      'simple_indexes'       => "false",
+      'model_dir'            => "app/models",
+      'include_version'      => "false",
+      'require'              => "",
+      'exclude_tests'        => "false",
+      'exclude_fixtures'     => "false",
+      'exclude_factories'    => "false",
+      'ignore_model_sub_dir' => "false",
+      'skip_on_db_migrate'   => "false",
+      'format_bare'          => "true",
+      'format_rdoc'          => "false",
+      'format_markdown'      => "false",
+      'sort'                 => "false",
+      'force'                => "false",
+      'trace'                => "false",
+    })
+  end
+
+  Annotate.load_tasks
+end