github-payload 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github-payload.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Corey Donohoe
+
+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,25 @@
+# Github::Payload
+
+![](http://farm3.staticflickr.com/2365/1812404502_c855c797eb_o.jpg)
+
+GitHub::Payload provides a set of helpers for formatting GitHub payloads.  Historically, [github-services](https://github.com/github/github-services) is built on a bunch of scripts that massage GitHub events and sends them off to third parties.  New services [need to accept the unmodifier payload](http://developer.github.com/changes/2013-2-5-changes-to-services/) in order to be accepted.  This gem serves as a bunch of test data for people building things around these kinds of payloads.  It also offers some simple formatting ideal for receiving the payload and passing it on to another services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github-payload'
+
+## Usage
+
+```ruby
+require 'github/payload'
+
+event = GitHub::Payload.for(payload)
+event.summary_message
+event.summary_url
+```
+
+## Contributing
+
+1. Fork it, cnew Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/github-payload.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github/payload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-payload"
+  spec.version       = GitHub::Payload::VERSION
+  spec.authors       = ["Corey Donohoe"]
+  spec.email         = ["atmos@atmos.org"]
+  spec.description   = %q{Summarize GitHub Service Payloads easily}
+  spec.summary       = %q{Cargo Cult your GitHub service payload formats}
+  spec.homepage      = "https://github.com/atmos/github-payload"
+  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 "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "yajl-ruby"
+end

data/lib/github/payload.rb

@@ -0,0 +1,14 @@
+require "github/payload/version"
+
+require "github/payload/helpers"
+require "github/payload/formatter"
+
+require "ostruct"
+
+module GitHub
+  module Payload
+    def self.for(payload)
+      Formatter::Parser.new(payload)
+    end
+  end
+end

data/lib/github/payload/formatter.rb

@@ -0,0 +1,65 @@
+module GitHub::Payload::Formatter
+  class Parser
+    attr_accessor :payload
+    def initialize(payload)
+      @payload = payload
+    end
+    
+    def summary_message
+      summarizer.summary_message
+    end
+
+    def summary_url
+      summarizer.summary_url
+    end
+
+    def summarizer
+      @summarizer ||=
+        case payload['event']
+        when 'push'
+          PushEvent.new(payload)
+        when 'create'
+          CreateEvent.new(payload)
+        when 'delete'
+          DeleteEvent.new(payload)
+        when 'public'
+          PublicEvent.new(payload)
+        when 'issues'
+          IssuesEvent.new(payload)
+        when 'pull_request'
+          PullRequestEvent.new(payload)
+        when 'issue_comment'
+          IssueCommentEvent.new(payload)
+        when 'pull_request_review_comment'
+          warn 'unsupported payload type pull_request_review_comment'
+        else
+          puts payload['event']
+        end
+    end
+  end
+
+  class Event
+    include GitHub::Payload::Formatter
+
+    attr_accessor :payload
+    def initialize(payload)
+      @payload = payload['payload']
+    end
+
+    def self.objectify(hash)
+      struct = OpenStruct.new
+      hash.each do |key, value|
+        struct.send("#{key}=", value.is_a?(Hash) ? objectify(value) : value)
+      end
+      struct
+    end
+  end
+end
+require 'github/payload/formatter/create_event'
+require 'github/payload/formatter/delete_event'
+require 'github/payload/formatter/issue_comment_event'
+require 'github/payload/formatter/issues_event'
+require 'github/payload/formatter/public_event'
+require 'github/payload/formatter/pull_request_event'
+require 'github/payload/formatter/push_event'
+

data/lib/github/payload/formatter/create_event.rb

@@ -0,0 +1,21 @@
+module GitHub
+  module Payload
+    module Formatter
+      class CreateEvent < Event
+        include GitHub::Payload::Helpers::Push
+
+        def sender_name
+          payload['sender']['login']
+        end
+
+        def summary_url
+          payload['repository']['html_url'] + "/commits/#{payload['ref']}"
+        end
+
+        def summary_message
+          "[#{repo_name}] #{sender_name} just created #{payload['ref']}."
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/delete_event.rb

@@ -0,0 +1,21 @@
+module GitHub
+  module Payload
+    module Formatter
+      class DeleteEvent < Event
+        include GitHub::Payload::Helpers::Push
+
+        def summary_url
+          payload['repository']['html_url']
+        end
+
+        def sender_name
+          payload['sender']['login']
+        end
+
+        def summary_message
+          "[#{repo_name}] #{sender_name} just deleted #{payload['ref']}."
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/issue_comment_event.rb

@@ -0,0 +1,21 @@
+module GitHub
+  module Payload
+    module Formatter
+      class IssueCommentEvent < Event
+        include GitHub::Payload::Helpers::Push, GitHub::Payload::Helpers::Issues
+
+        def sender_name
+          payload['comment']['user']['login']
+        end
+
+        def summary_url
+          payload['comment']['url']
+        end
+
+        def summary_message
+          "[#{repo_name}] #{sender_name} just commented."
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/issues_event.rb

@@ -0,0 +1,9 @@
+module GitHub
+  module Payload
+    module Formatter
+      class IssuesEvent < Event
+        include GitHub::Payload::Helpers::Issues
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/public_event.rb

@@ -0,0 +1,21 @@
+module GitHub
+  module Payload
+    module Formatter
+      class PublicEvent < Event
+        include GitHub::Payload::Helpers::Push
+
+        def summary_url
+          payload['repository']['html_url']
+        end
+
+        def sender_name
+          payload['sender']['login']
+        end
+
+        def summary_message
+          "[#{repo_name}] #{sender_name} just made the repo public."
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/pull_request_event.rb

@@ -0,0 +1,9 @@
+module GitHub
+  module Payload
+    module Formatter
+      class PullRequestEvent < Event
+        include GitHub::Payload::Helpers::PullRequest
+      end
+    end
+  end
+end

data/lib/github/payload/formatter/push_event.rb

@@ -0,0 +1,9 @@
+module GitHub
+  module Payload
+    module Formatter
+      class PushEvent < Event
+        include GitHub::Payload::Helpers::Push
+      end
+    end
+  end
+end

data/lib/github/payload/helpers.rb

@@ -0,0 +1,10 @@
+module GitHub::Payload::Helpers
+end
+
+require "github/payload/helpers/meta"
+require "github/payload/helpers/actions"
+
+require "github/payload/helpers/push"
+require "github/payload/helpers/issues"
+require "github/payload/helpers/pull_request"
+

data/lib/github/payload/helpers/actions.rb

@@ -0,0 +1,15 @@
+module GitHub
+  module Payload
+    module Helpers
+      module Actions
+        def action
+          payload['action'].to_s
+        end
+
+        def opened?
+          action == 'opened'
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/helpers/issues.rb

@@ -0,0 +1,42 @@
+module GitHub
+  module Payload
+    module Helpers
+      module Issues
+        include GitHub::Payload::Helpers::Meta, GitHub::Payload::Helpers::Actions
+
+        def issue
+          @issue ||= self.class.objectify(payload['issue'])
+        end
+
+        def summary_url
+          issue.html_url
+        end
+
+        def summary_message
+          "[%s] %s %s issue #%d: %s." % [
+            repo.name,
+            sender.login,
+            action,
+            issue.number,
+            issue.title,
+          ]
+        rescue
+          raise_config_error "Unable to build message: #{$!.to_s}"
+        end
+
+        def self.sample_payload
+          Service::HelpersWithMeta.sample_payload.merge(
+            "action" => "opened",
+            "issue" => {
+            "number" => 5,
+            "state" => "open",
+            "title" => "booya",
+            "body"  => "boom town",
+            "user" => { "login" => "mojombo" }
+          }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/helpers/meta.rb

@@ -0,0 +1,26 @@
+module GitHub
+  module Payload
+    module Helpers
+      module Meta
+        def repo
+          @repo ||= self.class.objectify(payload['repository'])
+        end
+
+        def sender
+          @sender ||= self.class.objectify(payload['sender'])
+        end
+
+        def self.sample_payload
+          {
+            "repository" => {
+              "name"  => "grit",
+              "url"   => "http://github.com/mojombo/grit",
+              "owner" => { "login" => "mojombo" }
+            },
+            "sender" => { "login" => 'defunkt' }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/helpers/pull_request.rb

@@ -0,0 +1,52 @@
+module GitHub
+  module Payload
+    module Helpers
+      module PullRequest
+      include GitHub::Payload::Helpers::Meta, GitHub::Payload::Helpers::Actions
+
+        def pull
+          @pull ||= self.class.objectify(payload['pull_request'])
+        end
+
+        def summary_url
+          pull.html_url
+        end
+
+        def summary_message
+          base_ref = pull.base.label.split(':').last
+          head_ref = pull.head.label.split(':').last
+
+          "[%s] %s %s pull request #%d: %s (%s...%s)" % [
+            repo.name,
+            sender.login,
+            action,
+            pull.number,
+            pull.title,
+            base_ref,
+            head_ref != base_ref ? head_ref : pull.head.label]
+        end
+
+        def self.sample_payload
+          repo_owner = "mojombo"
+          repo_name = "magik"
+          pull_user = "foo"
+          pull_number = 5
+          HelpersWithMeta.sample_payload.merge(
+            "action" => "opened",
+            "pull_request" => {
+              "number" => pull_number,
+              "commits" => 1,
+              "state" => "open",
+              "title" => "booya",
+              "body"  => "boom town",
+              "user" => { "login" => "#{pull_user}" },
+              "head" => {"label" => "#{pull_user}:feature"},
+              "base" => {"label" => "#{repo_owner}:master"},
+              "html_url" => "https://github.com/#{repo_owner}/#{repo_name}/pulls/#{pull_number}"
+            }
+          )
+        end
+      end
+    end
+  end
+end