webhook-payload 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p125@webhook-payload --create

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Allen Madsen
+
+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,98 @@
+# webhook-payload
+
+[![Build Status](http://travis-ci.org/blatyo/webhook-payload.png)](http://travis-ci.org/blatyo/webhook-payload)
+
+This gem is a convenience wrapper for [Github's webhook payload](https://help.github.com/articles/post-receive-hooks) that is triggered from a post receive hook. Feed it a hash of data and it will parse it into an object that you can use.
+
+## Setup
+
+**Gemfile**
+``` ruby
+gem 'webhook-payload'
+```
+
+**Manual**
+``` ruby
+require 'webhook/payload'
+```
+
+## Usage
+
+Say you have a hash from a post receive hook like so:
+
+``` ruby
+payload_data = {
+  "before" => "5aef35982fb2d34e9d9d4502f6ede1072793222d",
+  "repository" => {
+    "url" => "http://github.com/defunkt/github",
+    "name" => "github",
+    "description" => "You're lookin' at it.",
+    "watchers" => 5,
+    "forks" => 2,
+    "private" => 1,
+    "owner" => {
+      "email" => "chris@ozmm.org",
+      "name" => "defunkt"
+    }
+  },
+  "commits" => [
+    {
+      "id" => "41a212ee83ca127e3c8cf465891ab7216a705f59",
+      "url" => "http://github.com/defunkt/github/commit/41a212ee83ca127e3c8cf465891ab7216a705f59",
+      "author" => {
+        "email" => "chris@ozmm.org",
+        "name" => "Chris Wanstrath"
+      },
+      "message" => "okay i give in",
+      "timestamp" => "2008-02-15T14:57:17-08:00",
+      "added" => ["filepath.rb"]
+    },
+    {
+      "id" => "de8251ff97ee194a289832576287d6f8ad74e3d0",
+      "url" => "http://github.com/defunkt/github/commit/de8251ff97ee194a289832576287d6f8ad74e3d0",
+      "author" => {
+        "email" => "chris@ozmm.org",
+        "name" => "Chris Wanstrath"
+      },
+      "message" => "update pricing a tad",
+      "timestamp" => "2008-02-15T14:36:34-08:00"
+    }
+  ],
+  "after" => "de8251ff97ee194a289832576287d6f8ad74e3d0",
+  "ref" => "refs/heads/master"
+}
+```
+
+You can load that into an object with:
+
+``` ruby
+payload = Webhook::Payload.new(payload_data)
+```
+
+Then you can access the data via methods rather than through hash keys. It also does conversion of timestamps to `Time`, integer booleans to `true` or `false`, urls to `URI`, and file to `Pathname`.
+
+``` ruby
+payload.after                         #=> "de8251ff97ee194a289832576287d6f8ad74e3d0"
+payload.repository.url                #=> #<URI::HTTP:0x007ff14b0ace60 URL:http://github.com/defunkt/github>
+payload.commits.first.author.name     #=> "Chris Wanstrath"
+payload.commits.first.timestamp       #=> 2008-02-15 17:57:17 -0500
+payload.commits.first.timestamp.class #=> Time
+payload.commits.first.added.first     #=> #<Pathname:filepath.rb>
+payload.repository.private?           #=> true
+```
+
+Hopefully, everything else you can do is pretty obvious. Method names and hash key names are all the same.
+
+## Note on Reporting Issues
+
+* Try to make a failing test case
+* Tell me which version of ruby you're using
+* Tell me which OS you are using
+* Provide me with any extra files if necessary
+
+## Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/lib/webhook-payload.rb

@@ -0,0 +1,2 @@
+require "webhook/payload"
+require "webhook/payload/version"

data/lib/webhook/payload.rb

@@ -0,0 +1,81 @@
+require 'virtus'
+require 'pathname'
+require 'uri'
+
+module Virtus
+  class Coercion
+    class String < Virtus::Coercion::Object
+      def self.to_pathname(value)
+        Pathname.new(value)
+      end
+
+      def self.to_uri(value)
+        URI.parse(value)
+      end
+    end
+  end
+end
+
+module Webhook
+  class Payload
+    include Virtus
+
+    module User
+      include Virtus
+
+      attribute :email, String
+      attribute :name, String
+    end
+
+    class URI < Virtus::Attribute::Object
+      primitive String
+      coercion_method :to_uri
+    end
+
+    class Commit
+      include Virtus
+
+      class Author
+        include User
+      end
+
+      class Pathname < Virtus::Attribute::Object
+        primitive String
+        coercion_method :to_pathname
+      end
+
+      attribute :id, String
+      attribute :url, URI
+      attribute :message, String
+      attribute :timestamp, Time
+      attribute :added, Array[Pathname], :default => []
+      attribute :modified, Array[Pathname], :default => []
+      attribute :removed, Array[Pathname], :default => []
+      attribute :author, Author
+    end
+
+    class Repository
+      include Virtus
+
+      class Owner
+        include User
+      end
+
+      attribute :url, URI
+      attribute :name, String
+      attribute :homepage, String
+      attribute :pledgie, String
+      attribute :description, String
+      attribute :watchers, Integer
+      attribute :forks, Integer
+      attribute :private, Boolean
+      attribute :owner, Owner
+    end
+
+    attribute :before, String
+    attribute :after, String
+    attribute :ref, String
+    attribute :repository, Repository
+    attribute :commits, Array[Commit]
+  end
+end

data/lib/webhook/payload/version.rb

@@ -0,0 +1,5 @@
+module Webhook
+  class Payload
+    VERSION = "1.0.0"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../../lib/webhook-payload", __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/webhook/payload_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Webhook::Payload do
+  let(:payload){Webhook::Payload.new(payload_data)}
+  subject{payload}
+
+  its(:before){should == "5aef35982fb2d34e9d9d4502f6ede1072793222d"}
+  its(:after){should == "de8251ff97ee194a289832576287d6f8ad74e3d0"}
+  its(:ref){should == "refs/heads/master"}
+
+  it "should have two commits" do
+    subject.commits.size.should == 2
+  end
+
+  describe "#respository" do
+    let(:repository){payload.repository}
+    subject{repository}
+
+    its(:url){should == URI.parse("http://github.com/defunkt/github")}
+    its(:name){should == "github"}
+    its(:pledgie){should be_nil}
+    its(:homepage){should be_nil}
+    its(:description){should == "You're lookin' at it."}
+    its(:watchers){should == 5}
+    its(:forks){should == 2}
+    its(:private){should == true}
+
+    describe "#owner" do
+      subject{repository.owner}
+
+      its(:email){should == "chris@ozmm.org"}
+      its(:name){should == "defunkt"}
+    end
+  end
+
+  describe "a commit" do
+    let(:commit){payload.commits.first}
+    subject{commit}
+
+    its(:id){should == "41a212ee83ca127e3c8cf465891ab7216a705f59"}
+    its(:url){should == URI.parse("http://github.com/defunkt/github/commit/41a212ee83ca127e3c8cf465891ab7216a705f59")}
+    its(:message){should == "okay i give in"}
+    its(:timestamp){should == Time.parse("2008-02-15T14:57:17-08:00")}
+    its(:added){should == [Pathname.new("filepath.rb")]}
+    its(:removed){should == []}
+    its(:modified){should == []}
+
+    describe "#author" do
+      subject{commit.author}
+
+      its(:email){should == "chris@ozmm.org"}
+      its(:name){should == "Chris Wanstrath"}
+    end
+  end
+
+  let(:payload_data) do
+    {
+      "before" => "5aef35982fb2d34e9d9d4502f6ede1072793222d",
+      "repository" => {
+        "url" => "http://github.com/defunkt/github",
+        "name" => "github",
+        "description" => "You're lookin' at it.",
+        "watchers" => 5,
+        "forks" => 2,
+        "private" => 1,
+        "owner" => {
+          "email" => "chris@ozmm.org",
+          "name" => "defunkt"
+        }
+      },
+      "commits" => [
+        {
+          "id" => "41a212ee83ca127e3c8cf465891ab7216a705f59",
+          "url" => "http://github.com/defunkt/github/commit/41a212ee83ca127e3c8cf465891ab7216a705f59",
+          "author" => {
+            "email" => "chris@ozmm.org",
+            "name" => "Chris Wanstrath"
+          },
+          "message" => "okay i give in",
+          "timestamp" => "2008-02-15T14:57:17-08:00",
+          "added" => ["filepath.rb"]
+        },
+        {
+          "id" => "de8251ff97ee194a289832576287d6f8ad74e3d0",
+          "url" => "http://github.com/defunkt/github/commit/de8251ff97ee194a289832576287d6f8ad74e3d0",
+          "author" => {
+            "email" => "chris@ozmm.org",
+            "name" => "Chris Wanstrath"
+          },
+          "message" => "update pricing a tad",
+          "timestamp" => "2008-02-15T14:36:34-08:00"
+        }
+      ],
+      "after" => "de8251ff97ee194a289832576287d6f8ad74e3d0",
+      "ref" => "refs/heads/master"
+    }
+  end
+end

data/webhook-payload.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "webhook/payload/version"
+
+Gem::Specification.new do |s|
+  s.name        = "webhook-payload"
+  s.version     = Webhook::Payload::VERSION
+  s.authors     = ["Allen Madsen"]
+  s.email       = ["allen.c.madsen@gmail.com"]
+  s.homepage    = "https://github.com/blatyo/webhook-payload"
+  s.summary     = "This gem is a convenience wrapper for Github's webhook payload (https://help.github.com/articles/post-receive-hooks) that is triggered from a post receive hook. Feed it a hash of data and it will parse it into an object that you can use."
+  s.description = "This gem is a convenience wrapper for Github's webhook payload (https://help.github.com/articles/post-receive-hooks) that is triggered from a post receive hook. Feed it a hash of data and it will parse it into an object that you can use. It also provides conversions from basic data types into more useful types like Time, URI, Pathname, and Boolean."
+
+  s.rubyforge_project = "webhook-payload"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_runtime_dependency "virtus"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: webhook-payload
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70133146630780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133146630780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70133146630320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133146630320
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &70133146629860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70133146629860
+description: This gem is a convenience wrapper for Github's webhook payload (https://help.github.com/articles/post-receive-hooks)
+  that is triggered from a post receive hook. Feed it a hash of data and it will parse
+  it into an object that you can use. It also provides conversions from basic data
+  types into more useful types like Time, URI, Pathname, and Boolean.
+email:
+- allen.c.madsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/webhook-payload.rb
+- lib/webhook/payload.rb
+- lib/webhook/payload/version.rb
+- spec/spec_helper.rb
+- spec/webhook/payload_spec.rb
+- webhook-payload.gemspec
+homepage: https://github.com/blatyo/webhook-payload
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: webhook-payload
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: This gem is a convenience wrapper for Github's webhook payload (https://help.github.com/articles/post-receive-hooks)
+  that is triggered from a post receive hook. Feed it a hash of data and it will parse
+  it into an object that you can use.
+test_files:
+- spec/spec_helper.rb
+- spec/webhook/payload_spec.rb