RubyGems - post_commit - Versions diffs - 0.1.1 → 0.1.2 - Mend

post_commit 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/CHANGELOG.rdoc +7 -0
data/README.rdoc +27 -9
data/lib/post_commit/hooks/base.rb +36 -1
data/lib/post_commit/hooks/url.rb +31 -3
data/lib/post_commit/version.rb +1 -1
data/spec/post_commit/base_spec.rb +27 -0
data/spec/post_commit/url_spec.rb +43 -0
data/spec/spec_helper.rb +1 -0
metadata +2 -2

data/CHANGELOG.rdoc CHANGED

@@ -3,3 +3,10 @@
 == March 1 2010
 * Released 0.1.0 version
+* Released 0.1.1 version
+== March 2 2010
+* Hooks are registered automatically
+* The URL hook can send JSON and XML
+* Released 0.1.2 version

data/README.rdoc CHANGED

@@ -1,6 +1,6 @@
 = Introduction
-Post commit allows you to notify several services with simple and elegant DSL. It currently supports 5 services:
+Post commit allows you to notify several services with a simple and elegant DSL. It currently supports 5 services:
 * Basecamp
 * Campfire
@@ -80,16 +80,34 @@ The Twitter hook supports public and direct messages.
 To send a message to an arbitrary URL, use the <tt>:url</tt>.
-    post_commit :url do
-      post "http://example.com", :status => "pending", :id => 1234, :service => "yourapp"
-    end
+  post_commit :url do
+    post "http://example.com", :status => "pending", :id => 1234, :service => "yourapp"
+  end
 If you need a basic authorization, just inform the <tt>username</tt> and <tt>password</tt>.
-    post_commit :url do
-      authorize :username => "johndoe", :password => "mypass"
-      post "http://example.com", :status => "running", :id => 1234, :service => "yourapp"
-    end
+  post_commit :url do
+    authorize :username => "johndoe", :password => "mypass"
+    post "http://example.com", :status => "running", :id => 1234, :service => "yourapp"
+  end
+You can post data encoded as JSON or XML. Just set the <tt>:data_type</tt> option.
+  post_commit :url do
+    set :data_type, :json
+    set :data_type, :xml
+  end
+To post a XML, your params hash need to be a multi-level hash. For instance, the hash
+<tt>{:message => { :title => "Some title", :body => "Some message" }}</tt> will be converted to
+  <message>
+    <title>Some title</title>
+    <body>Some message</body>
+  </message>
+<b>Gotcha:</b> to send a normal POST, you have to specify a flat hash.
+So <tt>{:a => 1}</tt> is ok, but <tt>{:a => {:b => 1}}</tt> will fail.
 = Creating new hooks
@@ -121,10 +139,10 @@ You can use the <tt>credentials</tt> attribute to retrieve these settings.
 = To-Do
 * Receive post commits
-* URL hook must post JSON and XML data
 * Create IRC hook
 * Create Jabber hook
 * Create email hook
+* All hooks should use the <tt>:url</tt> hook
 = Maintainer

data/lib/post_commit/hooks/base.rb CHANGED

@@ -2,7 +2,7 @@ module PostCommit
   module Hooks
     class Base
       # Hold the authorization options.
-      attr_accessor :credentials
+      attr_reader :credentials
       # Hold the latest response
       attr_reader :response
@@ -13,8 +13,12 @@ module PostCommit
       # Hold the latest uri object
       attr_reader :uri
+      # Hold options defined throught the PostCommit::Hooks::Base#set method
+      attr_reader :options
       def initialize
         @credentials = {}
+        @options = {}
       end
       def self.inherited(base)
@@ -27,9 +31,40 @@ module PostCommit
         @credentials = options
       end
+      # Set an option for the current hook.
+      # The available options may vary from hook to hook and may not be available at all.
+      #
+      #   set :data_type, :json
+      def set(name, value)
+        @options[name.to_sym] = value
+      end
       def post(options = {}) # :nodoc:
         raise PostCommit::AbstractMethodError
       end
+      def convert_to_xml(hash) # :nodoc:
+        xml_node = Proc.new do |name, value, buffer|
+          buffer ||= ""
+          if value.kind_of?(Hash)
+            buffer << "<#{name}>"
+            value.each {|n, v| buffer << xml_node[n, v] }
+            buffer << "</#{name}>"
+          else
+            buffer << "<#{name}><![CDATA[#{value}]]></#{name}>"
+          end
+          buffer
+        end
+        root = hash.keys.first
+        xml_node[root, hash[root]]
+      end
+      def convert_to_params(hash) # :nodoc:
+        hash
+      end
     end
   end
 end

data/lib/post_commit/hooks/url.rb CHANGED

@@ -12,8 +12,26 @@ module PostCommit
     #     authorize :username => "johndoe", :password => "mypass"
     #     post "http://example.com", :message => "Post commit"
     #   end
+    #
+    # You can post data encoded as JSON or XML. Just set the <tt>:data_type</tt> option.
+    #
+    #   post_commit :url do
+    #     set :data_type, :json
+    #     set :data_type, :xml
+    #   end
+    #
+    # To post a XML, your params hash need to be a multi-level hash. For instance, the hash
+    # <tt>{:message => { :title => "Some title", :body => "Some message" }}</tt> will be converted to
+    #
+    #   <message>
+    #     <title>Some title</title>
+    #     <body>Some message</body>
+    #   </message>
+    #
+    # <b>Gotcha:</b> to send a normal POST, you have to specify a flat hash. So <tt>{:a => 1}</tt> is ok,
+    # but <tt>{:a => {:b => 1}}</tt> will fail.
     class URL < Base
-      # Post data to an arbitrary URL. The data should a one-depth hash.
+      # Post data to an arbitrary URL.
       #
       #   post "http://example.com", :message => "Post commit", :service => "yourapp"
       def post(url, params = {})
@@ -21,9 +39,19 @@ module PostCommit
         http = Net::HTTP.new(uri.host, uri.port)
         @request = Net::HTTP::Post.new(uri.path)
-        @request.basic_auth credentials[:username], credentials[:password] if credentials[:username]
-        @request.form_data = params
+        case options[:data_type]
+        when :json then
+          @request.content_type = "application/json"
+          @request.body = params.to_json
+        when :xml then
+          @request.content_type = "application/xml"
+          @request.body = convert_to_xml(params)
+        else
+          @request.form_data = convert_to_params(params)
+        end
+        @request.basic_auth credentials[:username], credentials[:password] if credentials[:username]
         @response = http.request(@request)
         if response.code =~ /^2\d+/

data/lib/post_commit/version.rb CHANGED

@@ -2,7 +2,7 @@ module PostCommit
   module Version
     MAJOR = "0"
     MINOR = "1"
-    PATCH = "1"
+    PATCH = "2"
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/post_commit/base_spec.rb CHANGED

@@ -4,4 +4,31 @@ describe PostCommit::Hooks::Base do
   it "should raise when trying to call abstract method" do
     doing { subject.post }.should raise_error(PostCommit::AbstractMethodError)
   end
+  context "convert to params" do
+    it "should convert flat hash"
+    it "should convert multi-level hash"
+  end
+  context "convert to xml" do
+    it "should convert flat hash" do
+      data = {:chars => {:a => 1, :b => 2}}
+      xml = Nokogiri::XML(subject.convert_to_xml(data))
+      xml.at("chars > a").inner_text.should == "1"
+      xml.at("chars > b").inner_text.should == "2"
+    end
+    it "should convert multi-level hash" do
+      data = {
+        :chars => {
+          :a => {:lowercase => "a", :uppercase => "A"}
+        }
+      }
+      xml = Nokogiri::XML(subject.convert_to_xml(data))
+      xml.at("chars > a > lowercase").inner_text.should == "a"
+      xml.at("chars > a > uppercase").inner_text.should == "A"
+    end
+  end
 end

data/spec/post_commit/url_spec.rb CHANGED

@@ -41,6 +41,12 @@ describe PostCommit::Hooks::URL do
     subject.post(@url, :message => "Some message").should be_true
   end
+  it "should return false with any status other than 2xx" do
+    FakeWeb.register_uri(:post, @url, :status => ["401", "Unauthorized"])
+    subject.post(@url, :message => "Some message").should be_false
+  end
   it "should set post data" do
     subject.post(@url, :message => "Some message", :id => 1234)
     body = CGI.parse(subject.request.body)
@@ -48,4 +54,41 @@ describe PostCommit::Hooks::URL do
     body["message"].to_s.should == "Some message"
     body["id"].to_s.should == "1234"
   end
+  context "data type" do
+    context "JSON string" do
+      before do
+        subject.set :data_type, :json
+        subject.post(@url, :message => {:title => "Some title", :body => "Some message"})
+      end
+      it "should encode body" do
+        body = JSON.parse(subject.request.body)
+        body["message"]["title"].should == "Some title"
+        body["message"]["body"].should == "Some message"
+      end
+      it "should set headers" do
+        subject.request.content_type.should == "application/json"
+      end
+    end
+    context "XML string" do
+      before do
+        subject.set :data_type, :xml
+        subject.post(@url, :message => {:title => "Some title", :body => "Some message"})
+      end
+      it "should encode body" do
+        xml = Nokogiri::XML(subject.request.body)
+        xml.at("message > title").inner_text.should == "Some title"
+        xml.at("message > body").inner_text.should == "Some message"
+      end
+      it "should set headers" do
+        subject.request.content_type.should == "application/xml"
+      end
+    end
+  end
 end

data/spec/spec_helper.rb CHANGED

@@ -6,6 +6,7 @@ require "post_commit"
 require "spec"
 require "fakeweb"
 require "fakeweb_matcher"
+require "nokogiri"
 FakeWeb.allow_net_connect = false

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: post_commit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nando Vieira
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-03-01 00:00:00 -03:00
+date: 2010-03-02 00:00:00 -03:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency