gwooks 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6781d02a796d53e92d4bce412fe1bd0908c4eb25
+  data.tar.gz: 3a563a41d93ae70f2c4e415a941f400dcb97dc8a
+SHA512:
+  metadata.gz: 40e37a11a10d6e24d3d28e8c50d4f1590c60d03f68cafbb12cb9c01b7eaa543abbbc7f3227e495f8d348d62dd0b9d01df4e3e34c23fe8b56d430f08a6a6c8906
+  data.tar.gz: 1f9724f655fb69e51080b8aaf28d3df73db8a9a08861ef6141c13a83abebcae9502f6c541fde03bd9c4686195634a4830d94dcf6eb0b892b627e12f663572cff

data/README.md

@@ -26,26 +26,34 @@ performed in response to a push:
 
 ```ruby
 class MyActions < Gwooks::Base
-  
+
+  # Do something when GitHub receives a push to a repository
+  # named "my_cool_project":
   repository_name "my_cool_project" do
-    # this block gets executed when GitHub receives
-    # a push to a repo named "my_cool_project"
 
-    # Here you can also access the payload sent by GitHub, parsed to a hash:
-    contributors = payload[:commits].map {|c| c[:author][:name] }.uniq
-    send_email "someone@email.com", "my_cool_project received changes by: #{ contributors.join(', ') }"
-  end
+    # You can nest matchers. The following block for example is executed
+    # when GitHub receives a push to the 'master' branch:
+    branch "master" do
+      # You have also access to the payload sent by GitHub, parsed to a hash:
+      contributors = payload[:commits].map {|c| c[:author][:email] }
+      contributors.uniq.each do |email|
+        send_email email, "Thanks for your contribution :)"
+      end
+    end
 
-  commit_message /Bump new version v(\d+\.\d+\.\d+)/ do |matches|
-    # this block gets called when GitHub receives a push
-    # with at least one commit message matching the Regexp.
-    matches.each do |match|
-      send_email("someone@email.com", "New version released: #{match[1]}")
+    # You can match with regular exceptions too. E.g. the next block gets
+    # called when GitHub receives a push with at least one commit message
+    # matching the given Regexp:
+    commit_message /Bump new version v(\d+\.\d+\.\d+)/ do |matches|
+      matches.each do |match|
+        send_email("someone@email.com", "New version released: #{match[1]}")
+      end
     end
+
   end
-  
+
   private
-  
+
   def send_email(to, msg)
     # assume we define here a method to send an email
   end
@@ -112,10 +120,11 @@ match is a MatchData object when regexp matching is used, or the matched
 pattern otherwise. The block is evaluated in the instance scope, and thus can
 access the `payload` object.
 
-Here is the full list of DSL methods: 
+Here is the full list of DSL methods:
 ```
 after
 before
+branch
 commits_added        (alias: commit_added)
 commits_author_email (alias: commit_author_email)
 commits_author_name  (alias: commit_author_name)
@@ -138,6 +147,10 @@ repository_url         (alias: repo_url)
 repository_watchers    (alias: repo_watchers)
 ```
 
+Each of them matches a corresponding field in the payload sent by GitHub,
+except `branch`, which is a shortcut to match the branch using info in the
+`ref` (e.g. `branch "master"` is a shortcut for `ref "refs/heads/master"`)
+
 
 ## Payload
 
@@ -172,6 +185,8 @@ may change frequently.
 
 ## Changelog
 
+v0.0.6 - Add possibility to nest matcher methods
+
 v0.0.5 - Add `branch` payload property and corresponding DSL method
 
 v0.0.4 - Payload with indifferent access

data/gwooks.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.add_dependency("json")
   gem.add_dependency("sinatra")
+  gem.add_development_dependency("rake")
   gem.add_development_dependency("rspec")
   gem.add_development_dependency("rack-test")
 end

data/lib/gwooks/base.rb

@@ -3,6 +3,32 @@ require File.expand_path("payload.rb", File.dirname(__FILE__))
 module Gwooks
   class Base
 
+    DSL_METHODS = %w(
+      after
+      before
+      branch
+      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
+    )
+
     class << self
       def call(payload)
         new(payload).call
@@ -17,37 +43,7 @@ module Gwooks
         @_hooks << [key, pattern, block]
       end
 
-      def ref(pattern, &block)
-        payload_matches("ref", pattern, &block)
-      end
-
-      method_names = %w(
-        after
-        before
-        branch
-        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|
+      DSL_METHODS.each do |method_name|
         key = method_name.gsub("_", ".")
 
         define_method(method_name.to_sym) do |pattern, &block|
@@ -55,7 +51,7 @@ module Gwooks
         end
       end
 
-      to_be_aliased = method_names.select do |n|
+      to_be_aliased = DSL_METHODS.select do |n|
         n.start_with? "commits_", "repository_"
       end
 
@@ -75,28 +71,54 @@ module Gwooks
     attr_reader :payload
 
     def initialize(payload)
-      @payload = Gwooks::Payload.new(payload) 
+      @payload = Gwooks::Payload.new(payload)
     end
 
     def call
       self.class.hooks.each do |hook|
         key, pattern, block = *hook
-        target = payload.resolve(key)
-        if target.is_a? Array 
-          match = target.map do |t|
-            match_pattern(t, pattern)
-          end.compact
-          matching = match.compact.size > 0
+        exec_if_matching( key, pattern, &block )
+      end
+      nil
+    end
+
+    DSL_METHODS.each do |method_name|
+      key = method_name.gsub("_", ".")
+
+      define_method(method_name.to_sym) do |pattern, &block|
+        exec_if_matching(key, pattern, &block)
+      end
+    end
+
+    to_be_aliased = DSL_METHODS.select do |n|
+      n.start_with? "commits_", "repository_"
+    end
+
+    to_be_aliased.each do |method_name|
+      alias_name = method_name.gsub /^(commits|repository)_/ do
+        if $1 == "commits"
+          "commit_"
         else
-          match = match_pattern(target, pattern)
-          matching = !match.nil? 
+          "repo_"
         end
-        instance_exec(match, &block) if matching
       end
-      nil
+      alias_method alias_name, method_name
     end
 
-    private 
+    private
+
+    def exec_if_matching(key, pattern, &block)
+      target = payload.resolve(key)
+      if target.is_a? Array
+        match = target.map do |t|
+          match_pattern(t, pattern)
+        end.compact
+        match = nil if match.size == 0
+      else
+        match = match_pattern(target, pattern)
+      end
+      instance_exec(match, &block) if match
+    end
 
     def match_pattern(target, pattern)
       if pattern.is_a? Regexp

data/lib/gwooks/version.rb

@@ -1,3 +1,3 @@
 module Gwooks
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/gwooks/base_spec.rb

@@ -3,6 +3,32 @@ require File.expand_path("../../lib/gwooks/base.rb", File.dirname(__FILE__))
 
 describe "subclass of Gwooks::Base" do
 
+  dsl_methods = %w(
+    after
+    before
+    branch
+    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
+  )
+
   before(:each) do
     Object.send(:remove_const, "GwooksBaseSub") if Object.const_defined?("GwooksBaseSub")
     GwooksBaseSub = Class.new(Gwooks::Base)
@@ -32,33 +58,7 @@ describe "subclass of Gwooks::Base" do
     end
   end
 
-  method_names = %w(
-    after
-    before
-    branch
-    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|
+  dsl_methods.each do |method_name|
     key = method_name.gsub("_", ".")
 
     describe method_name do
@@ -70,7 +70,7 @@ describe "subclass of Gwooks::Base" do
     end
   end
 
-  to_be_aliased = method_names.select do |n|
+  to_be_aliased = dsl_methods.select do |n|
     n.start_with? "commits_", "repository_"
   end
 
@@ -208,6 +208,36 @@ describe "subclass of Gwooks::Base" do
       end
     end 
 
+    dsl_methods.each do |method_name|
+      key = method_name.gsub("_", ".")
+
+      describe method_name do
+        it "executes block if '#{key}' matches value" do
+          called = false
+          gwooks = GwooksBaseSub.new(
+            "repository" => {
+              "url" => "foo/bar"
+            }
+          )
+          gwooks.payload.should_receive(:resolve).with(key).and_return "foo"
+          gwooks.send method_name.to_sym, "foo", &(Proc.new { called = true })
+          called.should be_true
+        end
+
+        it "does not executes block if '#{key}' does not match value" do
+          called = false
+          gwooks = GwooksBaseSub.new(
+            "repository" => {
+              "url" => "foo/bar"
+            }
+          )
+          gwooks.payload.should_receive(:resolve).with(key).and_return "bar"
+          gwooks.send method_name.to_sym, "foo", &(Proc.new { called = true })
+          called.should be_false
+        end
+      end
+    end
+
   end
 
 end

metadata

@@ -1,88 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gwooks
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Luca Ongaro
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-19 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
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   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"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rack-test
-  version_requirements: *id004
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A DSL for quickly creating endpoints for GitHub post-receive webhooks.
-email: 
+email:
 - lukeongaro@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -101,38 +105,30 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/lucaong/gwooks
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 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: 
+specification_version: 4
+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/gwooks/payload_spec.rb