post_commit 0.1.0 → 0.1.1

data/README.rdoc

@@ -7,6 +7,7 @@ Post commit allows you to notify several services with simple and elegant DSL. I
 * FriendFeed
 * LightHouse
 * Twitter
+* URL
 
 = Usage
 
@@ -75,6 +76,21 @@ The Twitter hook supports public and direct messages.
   post "Mary, check this out! http://example.com", :type => :direct_message, :screen_name => "marydoe"
   post "Mary, check this out! http://example.com", :type => :direct_message, :user_id => 12345
 
+== URL
+
+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
+
+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
+
 = Creating new hooks
 
 To create a new hook, you can extend the <tt>PostCommit::Hooks::Base</tt> class, to bootstrap your own class.
@@ -87,7 +103,8 @@ To create a new hook, you can extend the <tt>PostCommit::Hooks::Base</tt> class,
     end
   end
 
-To register this new hook, you just have to call the <tt>PostCommit::Hooks.register</tt> method.
+Your new hook will be register automatically. By downcasing the class name. So, <tt>LightHouse</tt> will be registered as <tt>:lighthouse</tt>.
+To register this hook will other name, you just have to call the <tt>PostCommit::Hooks.register</tt> method.
 
   PostCommit::Hooks.register :email, Email
 
@@ -104,11 +121,27 @@ 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
 
 = Maintainer
 
 * Nando Vieira - http://simplesideias.com.br
 
+= Contributing
+
+Once you've made your great commits:
+
+1.  Fork[http://help.github.com/forking/] the project at http://github.com/fnando/post_commit
+2. Create a topic branch - <tt>git checkout -b my_branch</tt>
+3. Push to your branch - <tt>git push origin my_branch</tt>
+4. Create an Issue[http://github.com/fnando/post_commit/issues] with a link to your branch
+5. That's it!
+
+Please respect the indentation rules. And always use 2 spaces.
+
 = License
 
 (The MIT License)

data/lib/post_commit/hooks/base.rb

@@ -17,6 +17,10 @@ module PostCommit
         @credentials = {}
       end
 
+      def self.inherited(base)
+        PostCommit::Hooks.register base.name.split("::").last.downcase.to_sym, base
+      end
+
       # Set up the authorization for the current notifier.
       # Each notifier can have its own authorization options.
       def authorize(options = {})

data/lib/post_commit/hooks/url.rb

@@ -0,0 +1,39 @@
+module PostCommit
+  module Hooks
+    # To send an URL post commit, you have to set up your URL and, optionally, username and password.
+    #
+    #   post_commit :url do
+    #     post "http://example.com", :message => "Post commit"
+    #   end
+    #
+    # If you need to authorize your request with basic auth, you can set your username and password.
+    #
+    #   post_commit :url do
+    #     authorize :username => "johndoe", :password => "mypass"
+    #     post "http://example.com", :message => "Post commit"
+    #   end
+    class URL < Base
+      # Post data to an arbitrary URL. The data should a one-depth hash.
+      #
+      #   post "http://example.com", :message => "Post commit", :service => "yourapp"
+      def post(url, params = {})
+        @uri = URI.parse(url)
+        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
+
+        @response = http.request(@request)
+
+        if response.code =~ /^2\d+/
+          true
+        else
+          false
+        end
+      rescue Exception
+        false
+      end
+    end
+  end
+end

data/lib/post_commit/version.rb

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

data/lib/post_commit.rb

@@ -11,14 +11,9 @@ require "post_commit/hooks/campfire"
 require "post_commit/hooks/friend_feed"
 require "post_commit/hooks/light_house"
 require "post_commit/hooks/twitter"
+require "post_commit/hooks/url"
 require "post_commit/version"
 
-PostCommit::Hooks.register :basecamp, PostCommit::Hooks::Basecamp
-PostCommit::Hooks.register :campfire, PostCommit::Hooks::Campfire
-PostCommit::Hooks.register :friendfeed, PostCommit::Hooks::FriendFeed
-PostCommit::Hooks.register :lighthouse, PostCommit::Hooks::LightHouse
-PostCommit::Hooks.register :twitter, PostCommit::Hooks::Twitter
-
 # Send a notification to the specified service. This method is just
 # a shorcut to the PostCommit::Hooks module.
 #

data/spec/post_commit/url_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe PostCommit::Hooks::URL do
+  before do
+    @url = "http://example.com/some/url"
+  end
+
+  it "should instantiate hook" do
+    hook = post_commit(:url) {}
+    hook.should be_an_instance_of(PostCommit::Hooks::URL)
+  end
+
+  it "should recover from unknown exceptions" do
+    Net::HTTP.should_receive(:new).and_raise(Exception)
+    subject.post(@url, :message => "Some message").should be_false
+  end
+
+  it "should set authorization headers" do
+    @url = "http://johndoe:mypass@example.com/some/url"
+    FakeWeb.register_uri(:post, @url, :status => ["200", "OK"])
+
+    subject.authorize :username => "johndoe", :password => "mypass"
+    subject.post(@url, :message => "Some message")
+
+    subject.request["authorization"].should == subject.request.send(:basic_encode, "johndoe", "mypass")
+  end
+
+  it "should be posted" do
+    FakeWeb.register_uri(:post, @url, :status => ["200", "OK"])
+    subject.post(@url, :message => "Some message")
+    FakeWeb.should have_requested(:post, @url)
+  end
+
+  it "should be successful with any success status" do
+    FakeWeb.register_uri(:post, @url, [
+      {:status => ["200", "OK"]},
+      {:status => ["201", "Created"]}
+    ])
+
+    subject.post(@url, :message => "Some message").should be_true
+    subject.post(@url, :message => "Some message").should be_true
+  end
+
+  it "should set post data" do
+    subject.post(@url, :message => "Some message", :id => 1234)
+    body = CGI.parse(subject.request.body)
+
+    body["message"].to_s.should == "Some message"
+    body["id"].to_s.should == "1234"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: post_commit
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -42,6 +42,7 @@ files:
 - lib/post_commit/hooks/friend_feed.rb
 - lib/post_commit/hooks/light_house.rb
 - lib/post_commit/hooks/twitter.rb
+- lib/post_commit/hooks/url.rb
 - lib/post_commit/version.rb
 - spec/post_commit/base_spec.rb
 - spec/post_commit/basecamp_spec.rb
@@ -49,6 +50,7 @@ files:
 - spec/post_commit/friend_feed_spec.rb
 - spec/post_commit/light_house_spec.rb
 - spec/post_commit/twitter_spec.rb
+- spec/post_commit/url_spec.rb
 - spec/resources/controllers.rb
 - spec/resources/responses/campfire.json
 - spec/resources/responses/friendfeed.json
@@ -90,5 +92,6 @@ test_files:
 - spec/post_commit/friend_feed_spec.rb
 - spec/post_commit/light_house_spec.rb
 - spec/post_commit/twitter_spec.rb
+- spec/post_commit/url_spec.rb
 - spec/resources/controllers.rb
 - spec/spec_helper.rb