gwooks 0.0.3 → 0.0.4

data/README.md

@@ -24,14 +24,14 @@ Or install it yourself as:
 First extend the `Gwooks::Base` class and use the DSL to create actions to be performed in response to a push:
 
 ```ruby
-class MyHookHandler < Gwooks::Base
+class MyActions < Gwooks::Base
   
   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:
-    contributors = payload["commits"].map { |c| c["author"]["name"] }
+    # Here you can also access the payload sent by GitHub, parsed to a hash:
+    contributors = payload[:commits].map {|c| c[:author][:name] }
     send_email "someone@email.com", "my_cool_project received changes by: #{ contributors.join(', ') }"
   end
 
@@ -59,7 +59,7 @@ class you created:
 require "sinatra"
 
 post "/webhook" do
-  MyHookHandler.call(params[:payload])
+  MyActions.call(params[:payload])
 end
 ```
 
@@ -70,7 +70,7 @@ Alternatively, you can use the sinatra application provided by the class `Gwooks
 require "gwooks"
 
 # Tell Gwooks::App to use your class
-Gwooks::App.use_webhook MyHookHandler
+Gwooks::App.use_webhook MyActions
 
 # Gwooks::App sets up an endpoint on POST /"
 run Gwooks::App

data/lib/gwooks/base.rb

@@ -1,4 +1,4 @@
-require "json"
+require File.expand_path("payload.rb", File.dirname(__FILE__))
 
 module Gwooks
   class Base
@@ -72,20 +72,15 @@ module Gwooks
     end
 
     attr_reader :payload
-    private :payload
 
     def initialize(payload)
-      if payload.is_a? String
-        @payload = JSON.parse(payload)
-      else
-        @payload = payload
-      end
+      @payload = Gwooks::Payload.new(payload) 
     end
 
     def call
       self.class.hooks.each do |hook|
         key, pattern, block = *hook
-        target = resolve_key(key)
+        target = payload.resolve(key)
         if target.is_a? Array 
           match = target.map do |t|
             match_pattern(t, pattern)
@@ -100,20 +95,7 @@ module Gwooks
       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
+    private 
 
     def match_pattern(target, pattern)
       if pattern.is_a? Regexp

data/lib/gwooks/payload.rb

@@ -0,0 +1,57 @@
+require "json"
+
+module Gwooks
+  class Payload < Hash
+
+    class << self
+      alias_method :new_without_indifferent_access, :new
+
+      def new(payload)
+        new_hash = new_without_indifferent_access do |hash, key|
+          hash[key.to_s] if key.is_a? Symbol
+        end
+        payload = JSON.parse(payload) if payload.is_a? String
+        new_hash.update(payload)
+      end
+    end
+
+    def resolve(key)
+      key.split(".").inject(self) 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
+
+    alias_method :update_without_indifferent_access, :update
+    def update(hash)
+      hash.each do |key, obj|
+        self[key] = make_indifferent(obj)
+      end
+      self
+    end
+
+    private
+
+    def make_indifferent(obj)
+      case obj
+      when Hash
+        new_hash = Hash.new(&self.default_proc)
+        obj.each do |key, val|
+          new_hash[key] = make_indifferent(val)
+        end
+        new_hash
+      when Array
+        obj.map {|item| make_indifferent(item)}
+      else
+        obj
+      end
+    end
+
+  end
+end

data/lib/gwooks/version.rb

@@ -1,3 +1,3 @@
 module Gwooks
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/gwooks/base_spec.rb

@@ -8,6 +8,13 @@ describe "subclass of Gwooks::Base" do
     GwooksBaseSub = Class.new(Gwooks::Base)
   end
 
+  describe :new do
+    it "creates and store a new instance of Gwooks::Payload" do
+      gwooks = GwooksBaseSub.new({"foo" => "bar"})
+      gwooks.payload.should == {"foo" => "bar"}
+    end
+  end
+
   describe :call do
     it "creates a new instance passing payload and then invokes call()" do
       gwooks = double GwooksBaseSub.new("{}")
@@ -83,19 +90,7 @@ describe "subclass of Gwooks::Base" do
     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 "instance" do 
 
     describe :call do
       it "executes all matching hooks" do
@@ -212,64 +207,6 @@ describe "subclass of Gwooks::Base" do
       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/gwooks/payload_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+require File.expand_path("../../lib/gwooks/payload.rb", File.dirname(__FILE__))
+
+describe Gwooks::Payload do
+  describe "class methods" do
+    describe :new do
+      it "initializes parsing the argument as JSON if it is a string" do
+        payload = Gwooks::Payload.new("{\"foo\": \"bar\"}")
+        payload.should == {"foo" => "bar"}
+      end
+
+      it "initializes using the argument if it is not a string" do
+        payload = Gwooks::Payload.new({"foo" => "bar"})
+        payload.should == {"foo" => "bar"}
+      end
+    end
+  end
+
+  describe :[] do
+    it "provides indifferent access" do
+      payload = Gwooks::Payload.new("foo" => {"bar" => "baz"})
+      payload[:foo][:bar].should == "baz"
+      payload["foo"]["bar"].should == "baz"
+    end
+  end
+
+  describe :resolve do
+    it "returns nested object according to the key" do
+      Gwooks::Payload.new(
+        "foo" => {
+          "bar" => {
+            "baz" => "qux"
+          }
+        }
+      ).resolve("foo.bar.baz").should == "qux"
+    end
+ 
+    it "returns nil if nested property does not exist" do
+      Gwooks::Payload.new(
+        "foo" => {
+          "bar" => {}
+        }
+      ).resolve("foo.bar.baz").should == nil
+    end
+
+    it "returns nil if parent property does not exist" do
+      Gwooks::Payload.new(
+        "foo" => {}
+      ).resolve("foo.bar.baz").should == nil
+    end
+
+    it "returns all items in array when property is an array" do
+      Gwooks::Payload.new(
+        "foo" => ["a", "b", "c"]
+      ).resolve("foo").should == ["a", "b", "c"]
+    end
+
+    it "resolve key nested in an array" do
+      Gwooks::Payload.new(
+        "foo" => [
+          { "bar" => 123 },
+          { "bar" => 321 }
+        ]
+      ).resolve("foo.bar").should == [123, 321]
+    end
+
+    it "resolve key nested in multiple arrays" do
+      Gwooks::Payload.new(
+        "foo" => [
+          { "bar" => [
+            {"baz" => 123},
+            {"baz" => 321}
+          ]},
+          { "bar" => [
+            {"baz" => 312},
+            {"baz" => 132}
+          ]}
+        ]
+      ).resolve("foo.bar.baz").should == [123, 321, 312, 132]
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gwooks
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Luca Ongaro
@@ -93,9 +93,11 @@ files:
 - lib/gwooks.rb
 - lib/gwooks/app.rb
 - lib/gwooks/base.rb
+- lib/gwooks/payload.rb
 - lib/gwooks/version.rb
 - spec/gwooks/app_spec.rb
 - spec/gwooks/base_spec.rb
+- spec/gwooks/payload_spec.rb
 - spec/integration/integration_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -135,5 +137,6 @@ summary: A DSL for quickly creating endpoints for GitHub post-receive webhooks.
 test_files: 
 - spec/gwooks/app_spec.rb
 - spec/gwooks/base_spec.rb
+- spec/gwooks/payload_spec.rb
 - spec/integration/integration_spec.rb
 - spec/spec_helper.rb