github-hooker 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    github-hooker (0.1.0)
-      active_support (~> 3.0.0)
+    github-hooker (0.1.1)
+      activesupport (~> 3.0)
       rest-client (~> 1.6.7)
       thor (~> 0.14.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     addressable (2.2.6)
     crack (0.3.1)
     diff-lcs (1.1.3)
@@ -24,7 +24,9 @@ GEM
       guard (>= 0.2.2)
     guard-rspec (0.6.0)
       guard (>= 0.10.0)
+    i18n (0.6.0)
     mime-types (1.17.2)
+    multi_json (1.0.4)
     rake (0.9.2.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)

data/README.md

@@ -0,0 +1,90 @@
+# github-hooker
+
+This is an internal gem at PlataformaTec (<http://plataformatec.com.br>).
+
+We use it to create and delete hooks in our github repositories (like campfire notifications for push and pull_requests and CI integration with web push hooks).
+
+## Configuration
+
+First, create `~/.github-hooker.yml` with
+
+```yml
+user: github_username
+password: github_password
+campfire_token: campfire_api_token
+```
+
+### Why I need to write my password?
+
+The hook API is only accessible by the v3 Github API. There's a Oauth2 authentication method, but in order to use that you would need to set up a new application with Github, and then collect the token by an http callback (that must be accessible on the web). For the sake of simplicity, we use the other way to authenticate (http auth basic).
+
+Then you can use the command `github-hooker` to list, create web and campfire hooks or delete them. Other hooks are not yet implemented (pull requests are appreciated!).
+
+## Usage
+
+The user specified MUST have administration rights for the repositories you want to set/delete hooks.
+
+The available commands are:
+
+```
+$ github-hooker
+Tasks:
+  github-hooker help [TASK]                                                  # Describe available tasks or one specific task
+  github-hooker list user/repo                                               # List hooks in the given repository
+  github-hooker web user/repo events --url=URL                               # Add a web hook in the given repository. Events must be separated by commas.
+  github-hooker campfire user/repo events --room=ROOM --subdomain=SUBDOMAIN  # Add a campfire hook in the given repository. Events must be separated by commas.
+  github-hooker delete user/repo hook_number                                 # Delete the hook from the given repository
+```
+
+### List hooks
+
+```
+github-hooker list plataformatec/devise 
+```
+
+### Create a new web hook
+
+```
+github-hooker web plataformatec/devise "pull_requests, push" --url=http://mycallback.com/callback
+```
+
+This creates a new web hook that calls the url specified by `--url`. The events that this hooks listens must be the third argument and they must be separeted by commas. 
+
+### Create a new campfire hook
+
+```
+github-hooker campfire plataformatec/devise pull_requests,push,issue_comment --room="My Room" --subdomain="My Subdomain"
+```
+
+Creates a new campfire hook. The token used for authentication with Campfire must be provided in your `~/.github-hooker.yml` (see Configuration above).
+
+### Delete a hook
+
+```
+github-hooker delete plataformatec/devise 1010
+```
+
+Deletes the hook 1010 from the given repository. You can get the hook id from the url listed in `github-hooker list user/repo`.
+
+## Events
+
+The available events that github gives us are:
+
+Campfire events:
+
+- push
+- pull_requests
+- issues
+
+Web events:
+
+- push
+- pull_requests
+- issues
+- issue_comment
+
+Github's documentation about hooks (http://developer.github.com/v3/repos/hooks/ and https://api.github.com/hooks) does not have all these hooks listed, but they are working with us.
+
+## License
+
+MIT License. Copyright 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/github-hooker.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["george@plataformatec.com.br"]
   s.homepage    = ""
   s.summary     = %q{ hook them all }
-  s.description = %q{ hook them all }
+  s.description = %q{ github-hooker creates and deletes hooks in your github repository }
 
   s.rubyforge_project = "github-hooker"
 
@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rest-client", "~> 1.6.7"
   s.add_dependency "thor", "~> 0.14.6"
-  s.add_dependency "active_support", "~> 3.0.0"
+  s.add_dependency "activesupport", "~> 3.0"
 end

data/lib/github-hooker.rb

@@ -34,7 +34,13 @@ module Github
         :user => config["user"],
         :password => config["password"]
       )
-      JSON.parse(RestClient::Request.execute(options))
+      response = RestClient::Request.execute(options)
+      case response.code
+      when 201, 200
+        JSON.parse(response)
+      when 204, 404, 500
+        response
+      end
     end
 
     def self.config_filename

data/lib/github-hooker/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Hooker
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/github-hooker_spec.rb

@@ -39,7 +39,7 @@ describe Github::Hooker do
     it "adds a new web hook in the given repo" do
       WebMock.stub_request(:post, "https://user:password@api.github.com/repos/user/repo/hooks").
         with(:body => "{\"active\":\"true\",\"name\":\"web\",\"events\":[\"pull_request\",\"issue\"],\"config\":{\"url\":\"http://example.com/callback\"}}").
-        to_return(:status => 200, :body => "{}", :headers => {})
+        to_return(:status => 201, :body => "{}", :headers => {})
 
       hook_options = {
         :name => "web",
@@ -54,7 +54,7 @@ describe Github::Hooker do
 
     it "deletes a hook in the given repo" do
       WebMock.stub_request(:delete, "https://user:password@api.github.com/repos/user/repo/hooks/1010").
-         to_return(:status => 200, :body => "{}", :headers => {})
+         to_return(:status => 204, :body => "", :headers => {})
 
       subject.delete_hook("user/repo", 1010)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-hooker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70239803941600 !ruby/object:Gem::Requirement
+  requirement: &70291867146740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70239803941600
+  version_requirements: *70291867146740
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70239803941060 !ruby/object:Gem::Requirement
+  requirement: &70291867146020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,19 +32,19 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70239803941060
+  version_requirements: *70291867146020
 - !ruby/object:Gem::Dependency
-  name: active_support
-  requirement: &70239803932200 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70291867145520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70239803932200
-description: ! ' hook them all '
+  version_requirements: *70291867145520
+description: ! ' github-hooker creates and deletes hooks in your github repository '
 email:
 - george@plataformatec.com.br
 executables:
@@ -57,6 +57,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- README.md
 - Rakefile
 - bin/github-hooker
 - github-hooker.gemspec
@@ -82,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 61845188583111008
+      hash: 2168196875312501794
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 61845188583111008
+      hash: 2168196875312501794
 requirements: []
 rubyforge_project: github-hooker
 rubygems_version: 1.8.11