gwooks 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
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luca Ongaro
+
+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,91 @@
+# Gwooks
+
+A DSL for quickly creating endpoints for [GitHub post-receive webhooks](https://help.github.com/articles/post-receive-hooks).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gwooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gwooks
+
+## Usage
+
+Extend the `Gwooks::Base` class and use the dsl to create you hooks:
+
+```ruby
+class MyHooks < Gwooks::Base
+  
+  repository_name "gwooks" do
+    # this block gets called when a post-receive webhook
+    # notifies a push to a repo named "gwooks"
+  end
+
+  commits_message /Bump new version v(\d+\.\d+\.\d+)/ do |matches|
+    # this block gets called when a post-receive webhook
+    # notifies a push with at least one commit message
+    # matching the Regexp. The block gets passed an array of
+    # MatchData objects, one for every match.
+    matches.each do |match|
+      # assuming a publish_tweet method was defined somewhere
+      # we can tweet about the new version released:
+      publish_tweet("New version released: #{match[1]}")
+    end
+  end
+
+end
+```
+
+Then set up an application providing an endpoint for the post-receive webhooks and make use of the class you created:
+
+```ruby
+require "sinatra"
+
+post "/webhook" do
+  MyHooks.call(params[:payload])
+end
+```
+
+Alternatively, you can use the sinatra application provided by the class `Gwooks::App`:
+
+```ruby
+# In your config.ru
+
+Gwooks::App.use_webhook MyHooks
+use Gwooks::App
+```
+
+### Matcher methods
+
+The full list of matcher methods is the following:
+```
+after
+before
+commits_added
+commits_author_email
+commits_author_name
+commits_id
+commits_message
+commits_modified
+commits_removed
+commits_timestamp
+commits_url
+ref
+repository_description
+repository_forks
+repository_homepage
+repository_name
+repository_owner_email
+repository_owner_name
+repository_pledgie
+repository_private
+repository_url
+repository_watchers
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gwooks.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gwooks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gwooks"
+  gem.version       = Gwooks::VERSION
+  gem.authors       = ["Luca Ongaro"]
+  gem.email         = ["lukeongaro@gmail.com"]
+  gem.description   = "A DSL for quickly creating endpoints for GitHub post-receive webhooks."
+  gem.summary       = "A DSL for quickly creating endpoints for GitHub post-receive webhooks. It provides methods for executing blocks of code when GitHub posts a payload matching some conditions in response to a code push."
+  gem.homepage      = "https://github.com/lucaong/gwooks"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency("json")
+  gem.add_dependency("sinatra")
+  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("rack-test")
+end

data/lib/gwooks/app.rb

@@ -0,0 +1,16 @@
+require "sinatra/base"
+
+module Gwooks
+  class App < Sinatra::Base
+
+    post "/" do
+      raise "No webhook specified." if settings.webhook.nil?
+      settings.webhook.call(params[:payload])
+    end
+
+    def self.use_webhook(hook)
+      set :webhook, hook
+    end
+
+  end
+end

data/lib/gwooks/base.rb

@@ -0,0 +1,112 @@
+require "json"
+
+module Gwooks
+  class Base
+
+    class << self
+      def call(payload)
+        new(payload).call
+      end
+
+      def hooks
+        @_hooks ||= []
+      end
+
+      def payload_matches(key, pattern, &block)
+        @_hooks ||= []
+        @_hooks << [key, pattern, block]
+      end
+
+      def ref(pattern, &block)
+        payload_matches("ref", pattern, &block)
+      end
+
+      method_names = %w(
+        after
+        before
+        commits_added
+        commits_author_email
+        commits_author_name
+        commits_id
+        commits_message
+        commits_modified
+        commits_removed
+        commits_timestamp
+        commits_url
+        ref
+        repository_description
+        repository_forks
+        repository_homepage
+        repository_name
+        repository_owner_email
+        repository_owner_name
+        repository_pledgie
+        repository_private
+        repository_url
+        repository_watchers
+      )
+
+      method_names.each do |method_name|
+        key = method_name.gsub("_", ".")
+
+        define_method(method_name.to_sym) do |pattern, &block|
+          payload_matches(key, pattern, &block)
+        end
+      end
+
+    end
+
+    attr_reader :payload
+    private :payload
+
+    def initialize(payload)
+      if payload.is_a? String
+        @payload = JSON.parse(payload)
+      else
+        @payload = payload
+      end
+    end
+
+    def call
+      self.class.hooks.each do |hook|
+        key, pattern, block = *hook
+        target = resolve_key(key)
+        if target.is_a? Array 
+          match = target.map do |t|
+            match_pattern(t, pattern)
+          end.compact
+          matching = match.compact.size > 0
+        else
+          match = match_pattern(target, pattern)
+          matching = !match.nil? 
+        end
+        instance_exec(match, &block) if matching
+      end
+      nil
+    end
+
+    private
+
+    def resolve_key(key)
+      key.split(".").inject(payload) do |obj, segment|
+        break nil if obj.nil?
+        if obj.is_a? Array
+          obj.map do |item|
+            item[segment] 
+          end.flatten
+        else
+          obj[segment]
+        end
+      end
+    end
+
+    def match_pattern(target, pattern)
+      if pattern.is_a? Regexp
+        pattern.match(target)
+      else
+        target if target == pattern
+      end
+    end
+
+  end
+end

data/lib/gwooks/version.rb

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

data/lib/gwooks.rb

@@ -0,0 +1,3 @@
+require "gwooks/version"
+require "gwooks/base"
+require "gwooks/app"

data/spec/gwooks/app_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+require File.expand_path("../../lib/gwooks/app.rb", File.dirname(__FILE__))
+require "rack/test"
+
+Gwooks::App.instance_eval do
+  set :environment, :test
+end
+
+describe Gwooks::App do
+
+  include Rack::Test::Methods
+
+  def app
+    Gwooks::App
+  end
+
+  describe :use_webhook do
+    it "sets settings.webhook" do 
+      Gwooks::App.should_receive(:set).with(:webhook, "foo")
+      Gwooks::App.use_webhook("foo")
+    end
+  end
+
+  describe "POST /" do
+    it "raises if settings.webhook is not set" do
+      Gwooks::App.stub(:webhook).and_return(nil) 
+      expect {
+        post "/"
+      }.to raise_error(StandardError, /No webhook specified/)
+    end
+
+    it "invokes webhook.call() passing payload" do
+      webhook = Proc.new {}
+      Gwooks::App.stub(:webhook).and_return(webhook)
+      payload = "\{\}"
+      webhook.should_receive(:call).with(payload)
+      post "/", :payload => payload
+    end
+  end
+
+end

data/spec/gwooks/base_spec.rb

@@ -0,0 +1,254 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+require File.expand_path("../../lib/gwooks/base.rb", File.dirname(__FILE__))
+
+describe "subclass of Gwooks::Base" do
+
+  before(:each) do
+    Object.send(:remove_const, "GwooksBaseSub") if Object.const_defined?("GwooksBaseSub")
+    GwooksBaseSub = Class.new(Gwooks::Base)
+  end
+
+  describe :call do
+    it "creates a new instance passing payload and then invokes call()" do
+      gwooks = double GwooksBaseSub.new("{}")
+      GwooksBaseSub.should_receive(:new).with("{}").and_return(gwooks)
+      gwooks.should_receive(:call)
+      GwooksBaseSub.call("{}")
+    end
+  end
+
+  describe :payload_matches do
+    it "adds a new hook storing key, pattern and block" do
+      block = Proc.new {}
+      GwooksBaseSub.payload_matches "foo", "bar", &block
+      GwooksBaseSub.hooks.last.should == ["foo", "bar", block]
+    end
+  end
+
+  method_names = %w(
+    after
+    before
+    commits_added
+    commits_author_email
+    commits_author_name
+    commits_id
+    commits_message
+    commits_modified
+    commits_removed
+    commits_timestamp
+    commits_url
+    ref
+    repository_description
+    repository_forks
+    repository_homepage
+    repository_name
+    repository_owner_email
+    repository_owner_name
+    repository_pledgie
+    repository_private
+    repository_url
+    repository_watchers
+  )
+  
+  method_names.each do |method_name|
+    key = method_name.gsub("_", ".")
+
+    describe method_name do
+      it "adds a new hook with key '#{key}'" do
+        block = Proc.new {}
+        GwooksBaseSub.send method_name.to_sym, "bar", &block
+        GwooksBaseSub.hooks.last.should == [key, "bar", block]
+      end
+    end
+  end
+ 
+  describe "instance" do
+
+    describe :new do
+      it "initializes payload parsing the argument as JSON if it is a string" do
+        gwooks = GwooksBaseSub.new("{\"foo\": \"bar\"}")
+        gwooks.send(:payload).should == {"foo" => "bar"}
+      end
+
+      it "initializes payload using the argument if it is not a string" do
+        gwooks = GwooksBaseSub.new({"foo" => "bar"})
+        gwooks.send(:payload).should == {"foo" => "bar"}
+      end
+    end
+
+    describe :call do
+      it "executes all matching hooks" do
+        probe = []
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", "foo/bar", Proc.new { probe << "baz" }],
+          ["repository.url", "foo/bar", Proc.new { probe << "qux" }]
+        ])
+        GwooksBaseSub.new(
+          "repository" => {
+            "url" => "foo/bar"
+          }
+        ).call()
+        probe.should include("baz", "qux")
+      end
+
+      it "does not execute non-matching hooks" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", "foo/bar", Proc.new { probe = "baz" }]
+        ])
+        GwooksBaseSub.new(
+          "repository" => {
+            "url" => "qux/quux"
+          }
+        ).call()
+        probe.should be_nil
+      end
+
+      it "execute hook if target is an array and any element matches" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["commits.message", "foo", Proc.new { probe = "baz" }]
+        ])
+        GwooksBaseSub.new(
+          "commits" => [
+            { "message" => "foo" },
+            { "message" => "bar" }
+          ]
+        ).call()
+        probe.should == "baz"
+      end
+
+     it "supports regexp matching" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", /\b.oo/, Proc.new { probe = "baz" }]
+        ])
+        GwooksBaseSub.new(
+          "repository" => {
+            "url" => "foo/bar"
+          }
+        ).call()
+        probe.should == "baz"
+      end
+
+      it "executes block in the instance scope" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", /\b.oo/, Proc.new { probe = self }]
+        ])
+        gwooks = GwooksBaseSub.new(
+          "repository" => {
+            "url" => "foo/bar"
+          }
+        )
+        gwooks.call()
+        probe.should == gwooks
+      end
+
+      it "passes the matched string as argument to the block if string matching is used" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", "foo/bar", Proc.new {|url| probe = url }]
+        ])
+        GwooksBaseSub.new(
+          "repository" => {
+            "url" => "foo/bar"
+          }
+        ).call()
+        probe.should == "foo/bar"
+      end
+
+      it "passes the matchdata as argument to the block if regexp matching is used" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["repository.url", /(\w+)\/(\w+)/, Proc.new {|match|
+            probe = "#{match[1]}#{match[2]}"
+          }]
+        ])
+        GwooksBaseSub.new(
+          "repository" => {
+            "url" => "foo/bar"
+          }
+        ).call()
+        probe.should == "foobar"
+      end
+
+      it "passes array of matches if target is an array and any element matches" do
+        probe = nil
+        GwooksBaseSub.stub(:hooks).and_return([
+          ["commits.message", /foo.*/, Proc.new {|matches|
+            probe = matches.map {|m| m[0] }
+          }]
+        ])
+        GwooksBaseSub.new(
+          "commits" => [
+            { "message" => "foo" },
+            { "message" => "bar" },
+            { "message" => "fooey" }
+          ]
+        ).call()
+        probe.should include("foo", "fooey")
+      end
+    end 
+
+    describe :resolve_key do
+      it "returns nested object according to the key" do
+        GwooksBaseSub.new(
+          "foo" => {
+            "bar" => {
+              "baz" => "qux"
+            }
+          }
+        ).send(:resolve_key, "foo.bar.baz").should == "qux"
+      end
+      
+      it "returns nil if nested object does not exist" do
+        GwooksBaseSub.new(
+          "foo" => {
+            "bar" => {}
+          }
+        ).send(:resolve_key, "foo.bar.baz").should == nil
+      end
+
+      it "returns nil if parent object does not exist" do
+        GwooksBaseSub.new(
+          "foo" => {}
+        ).send(:resolve_key, "foo.bar.baz").should == nil
+      end
+
+      it "returns all items in array when item is an array" do
+        GwooksBaseSub.new(
+          "foo" => ["a", "b", "c"]
+        ).send(:resolve_key, "foo").should == ["a", "b", "c"]
+      end
+
+      it "resolve key in array" do
+        GwooksBaseSub.new(
+          "foo" => [
+            { "bar" => 123 },
+            { "bar" => 321 }
+          ]
+        ).send(:resolve_key, "foo.bar").should == [123, 321]
+      end
+
+      it "resolve key in nested arrays" do
+        GwooksBaseSub.new(
+          "foo" => [
+            { "bar" => [
+              {"baz" => 123},
+              {"baz" => 321}
+            ]},
+            { "bar" => [
+              {"baz" => 312},
+              {"baz" => 132}
+            ]}
+          ]
+        ).send(:resolve_key, "foo.bar.baz").should == [123, 321, 312, 132]
+      end
+
+
+    end
+
+  end
+
+end

data/spec/integration/integration_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+require File.expand_path("../../lib/gwooks/base.rb", File.dirname(__FILE__))
+require File.expand_path("../../lib/gwooks/app.rb", File.dirname(__FILE__))
+require "rack/test"
+
+class IntegrationTestWebhook < Gwooks::Base
+  class << self
+    attr_accessor :probe
+  end
+
+  def initialize(payload)
+    self.class.probe = []
+    super payload
+  end
+
+  repository_url "foo/bar" do |url|
+    self.class.probe << "repository_url #{url}"
+  end
+
+  repository_owner_email "foo@bar.com" do |email|
+    self.class.probe << "repository_owner_email #{email}"
+  end
+
+  commits_message /\bv\d+\.\d+.\d+\b/ do |matches|
+    matches.each do |m|
+      self.class.probe << m[0]
+    end
+  end
+
+  repository_owner_name "qux" do |name|
+    self.class.probe << name
+  end
+end
+
+Gwooks::App.instance_eval do
+  set :environment, :test
+  use_webhook IntegrationTestWebhook
+end
+
+describe Gwooks::App do
+
+  include Rack::Test::Methods
+
+  def app
+    Gwooks::App
+  end
+
+  describe "when receiving a post-receive hook" do
+    let(:payload) do
+      <<-eos
+        {
+          "repository": {
+            "url": "foo/bar",
+            "owner": {
+              "name": "foo",
+              "email": "foo@bar.com"
+            }
+          },
+          "commits": [
+            { "message": "done some things" },
+            { "message": "v1.2.3"}
+          ]
+        }
+      eos
+    end
+
+    it "executes all matching hooks" do
+      post "/", :payload => payload 
+      IntegrationTestWebhook.probe.should include(
+        "repository_url foo/bar",
+        "repository_owner_email foo@bar.com",
+        "v1.2.3"
+      )
+    end
+ 
+    it "does not execute non-matching hooks" do
+      post "/", :payload => payload 
+      IntegrationTestWebhook.probe.should_not include("qux")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rspec"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: gwooks
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luca Ongaro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  name: sinatra
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  name: rack-test
+  version_requirements: *id004
+description: A DSL for quickly creating endpoints for GitHub post-receive webhooks.
+email: 
+- lukeongaro@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gwooks.gemspec
+- lib/gwooks.rb
+- lib/gwooks/app.rb
+- lib/gwooks/base.rb
+- lib/gwooks/version.rb
+- spec/gwooks/app_spec.rb
+- spec/gwooks/base_spec.rb
+- spec/integration/integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lucaong/gwooks
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A DSL for quickly creating endpoints for GitHub post-receive webhooks. It provides methods for executing blocks of code when GitHub posts a payload matching some conditions in response to a code push.
+test_files: 
+- spec/gwooks/app_spec.rb
+- spec/gwooks/base_spec.rb
+- spec/integration/integration_spec.rb
+- spec/spec_helper.rb