github-hooker 0.1.1 → 0.1.2

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0-gc

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# CHANGELOG
+
+## not released yet
+
+* `github-hooker campfire` now accepts an optional `--token` that overwrites the `campfire_token` that's usually defined in your `~/.github-hooker.yml`.
+
+## 0.1.1
+
+* `github-hooker delete` now doesn't raise an JSON parse exception.
+
+## 0.1.0
+
+* creates campfire and web hooks
+* lists hooks
+* deletes hooks
+* first public release!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github-hooker (0.1.1)
+    github-hooker (0.1.2)
       activesupport (~> 3.0)
       rest-client (~> 1.6.7)
       thor (~> 0.14.6)

data/README.md

@@ -1,8 +1,8 @@
 # github-hooker
 
-This is an internal gem at PlataformaTec (<http://plataformatec.com.br>).
+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).
+We use it to create and delete hooks in our github repositories (like campfire notifications for push and pull_request and CI integration with web push hooks).
 
 ## Configuration
 
@@ -12,14 +12,16 @@ First, create `~/.github-hooker.yml` with
 user: github_username
 password: github_password
 campfire_token: campfire_api_token
+#optional api_url, default https://api.github.com
+#api_url: https://mygithubenterprise/api/v3
 ```
 
+Then you can use the command `github-hooker` to list, create email, web and campfire hooks or delete them. Other hooks are not yet implemented (pull requests are appreciated!).
+
 ### 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.
@@ -31,6 +33,7 @@ $ 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 email user/repo events --address=ADDRESS                     # Add an email hook in the given repository. Events must be separated by commas.
   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
@@ -42,10 +45,16 @@ Tasks:
 github-hooker list plataformatec/devise 
 ```
 
+### Create a new email hook
+
+```
+github-hooker email plataformatec/devise "push" --address=email@mydomain.com
+```
+
 ### Create a new web hook
 
 ```
-github-hooker web plataformatec/devise "pull_requests, push" --url=http://mycallback.com/callback
+github-hooker web plataformatec/devise "pull_request, 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. 
@@ -53,7 +62,7 @@ This creates a new web hook that calls the url specified by `--url`. The events
 ### Create a new campfire hook
 
 ```
-github-hooker campfire plataformatec/devise pull_requests,push,issue_comment --room="My Room" --subdomain="My Subdomain"
+github-hooker campfire plataformatec/devise pull_request,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).
@@ -70,21 +79,30 @@ Deletes the hook 1010 from the given repository. You can get the hook id from th
 
 The available events that github gives us are:
 
+Email events:
+- push
+
 Campfire events:
 
 - push
-- pull_requests
+- pull_request
 - issues
 
 Web events:
 
 - push
-- pull_requests
+- pull_request
 - 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.
 
+## Naming
+
+This gem is named after the famous [Hooker Telescope](http://en.wikipedia.org/wiki/Hooker_Telescope), in operation in the Mount Wilson Observatory. Edwin Hubble used this telescope to discover the expansion of the universe.
+
+![Hooker Telescope](http://upload.wikimedia.org/wikipedia/commons/thumb/a/ac/100inchHooker.jpg/250px-100inchHooker.jpg)
+
 ## License
 
-MIT License. Copyright 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br
+MIT License. Copyright 2012 Plataformatec. http://plataformatec.com.br

data/lib/github-hooker.rb

@@ -1,38 +1,37 @@
 require "github-hooker/version"
+require "github-hooker/config"
 require 'net/http'
 require 'json'
-require 'yaml'
 require 'restclient'
 require 'active_support/core_ext/hash/reverse_merge'
 
 module Github
   module Hooker
     def self.hooks(repo)
-      url = "https://api.github.com/repos/#{repo}/hooks"
-      github_api(:get, url)
+      path = "/repos/#{repo}/hooks"
+      github_api(:get, path)
     end
 
     def self.add_hook(repo, payload={})
-      url = "https://api.github.com/repos/#{repo}/hooks"
+      path = "/repos/#{repo}/hooks"
       payload = payload.reverse_merge(:active => true)
-      github_api(:post, url, :payload => payload.to_json)
+      github_api(:post, path, :payload => payload.to_json)
     end
 
     def self.delete_hook(repo, hook)
-      url = "https://api.github.com/repos/#{repo}/hooks/#{hook}"
-      github_api(:delete, url)
+      path = "/repos/#{repo}/hooks/#{hook}"
+      github_api(:delete, path)
     end
 
-    def self.config
-      @config ||= YAML.load_file(File.expand_path(config_filename))
-    end
+    def self.github_api(method, path, options={})
+      github_url = Github::Hooker::Config.config.fetch("api_url", "https://api.github.com")
+      url = github_url + path
 
-    def self.github_api(method, url, options={})
       options.reverse_merge!(
-        :method => method,
-        :url => url,
-        :user => config["user"],
-        :password => config["password"]
+        :method   => method,
+        :url      => url,
+        :user     => Github::Hooker::Config.config["user"],
+        :password => Github::Hooker::Config.config["password"]
       )
       response = RestClient::Request.execute(options)
       case response.code
@@ -42,9 +41,5 @@ module Github
         response
       end
     end
-
-    def self.config_filename
-      "~/.github-hooker.yml"
-    end
   end
 end

data/lib/github-hooker/cli.rb

@@ -8,9 +8,12 @@ module Github
           hooks = Github::Hooker.hooks(repo)
           hooks.each do |hook|
             puts "#{hook['url']}"
-            puts "> name:   #{hook['name']}"
-            puts "> events: #{hook['events'].join(", ")}"
-            puts "> config: #{hook['config']}"
+            puts "> name:       #{hook['name']}"
+            puts "> updated_at: #{hook['updated_at']}"
+            puts "> created_at: #{hook['created_at']}"
+            puts "> events:     #{hook['events'].join(", ")}"
+            puts "> active:     #{hook['active']}"
+            puts "> config:     #{hook['config']}"
             puts
           end unless hooks.nil?
         end
@@ -19,16 +22,30 @@ module Github
       desc "campfire user/repo events", "Add a campfire hook in the given repository. Events must be separated by commas."
       method_option :room,       :required => true
       method_option :subdomain,  :required => true
+      method_option :token,      :required => false
       def campfire(repo, events)
         handle_404 do
           check_config!
           events = split_events(events)
-          Github::Hooker.add_hook(repo, :name => "campfire", :events => events, :config => options)
+          Github::Hooker.add_hook(repo, :name => "campfire", :events => events, :config => options.reverse_merge("token" => Github::Hooker::Config.config['campfire_token']))
+        end
+      end
+
+      desc "email user/repo events", "Add an email hook in the given repository. Events must be separated by commas."
+      method_option :address, :required => true
+      method_option :secret
+      method_option :send_from_author, :default => "1"
+      def email(repo, events)
+        handle_404 do
+          check_config!
+          events = split_events(events)
+          Github::Hooker.add_hook(repo, :name => "email", :events => events, :config => options)
         end
       end
 
       desc "web user/repo events", "Add a web hook in the given repository. Events must be separated by commas."
       method_option :url, :required => true
+      method_option :secret
       def web(repo, events)
         handle_404 do
           check_config!
@@ -57,7 +74,7 @@ module Github
       end
 
       def check_config!
-        error("~/.github-hooker.yml is not present. Please set 'user', 'password' and 'campfire_token'.") unless File.exist?(File.expand_path(Github::Hooker.config_filename))
+        error("~/.github-hooker.yml is not present. Please set 'user', 'password' and 'campfire_token'.") unless File.exist?(File.expand_path(Github::Hooker::Config.filename))
       end
 
       def resource_not_found_message!

data/lib/github-hooker/config.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+
+module Github
+  module Hooker
+    module Config
+      def self.filename
+        "~/.github-hooker.yml"
+      end
+
+      def self.config
+        @config ||= YAML.load_file(File.expand_path(filename))
+      end
+    end
+  end
+end

data/lib/github-hooker/version.rb

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

data/spec/fixtures/list_hooks.json

@@ -43,5 +43,26 @@
         "id": 157271,
         "url": "https://api.github.com/repos/user/repo/hooks/157271",
         "active": true
+    },
+    {
+        "updated_at": "2012-11-22T07:36:52Z",
+        "last_response": {
+            "status": "unused",
+            "message": null,
+            "code": null
+         },
+        "created_at": "2012-11-22T07:36:52Z",
+        "events": [
+            "push"
+        ],
+        "name": "email",
+        "config": {
+            "address": "user@example.com",
+            "send_from_author": "1",
+            "secret": "X-Test-github-hooker"
+        },
+        "id": 561345,
+        "url": "https://api.github.com/repos/user/repo/hooks/561345",
+        "active": true
     }
 ]

data/spec/github-hooker/cli_spec.rb

@@ -5,11 +5,9 @@ require 'github-hooker'
 require 'github-hooker/cli'
 
 describe "github-hooker" do
-  subject { Github::Hooker::CLI.new }
-
   before do
-    Github::Hooker.stub(:config_filename).and_return("/tmp/.github-hooker.yml")
-    FileUtils.touch(Github::Hooker.config_filename)
+    Github::Hooker::Config.stub(:config_filename).and_return("/tmp/.github-hooker.yml")
+    FileUtils.touch(Github::Hooker::Config.config_filename)
     stub_config!
   end
 
@@ -26,7 +24,7 @@ describe "github-hooker" do
         }
       ]
       Github::Hooker.stub(:hooks).with("user/repo").and_return(hooks)
-      subject.list("user/repo")
+      cli("list user/repo")
     end
 
     it "handles 404 errors in github API" do
@@ -34,28 +32,44 @@ describe "github-hooker" do
         to_return(:status => 404, :body => "NotFound", :headers => {})
 
       $stdout.should_receive(:puts).with("Resource Not Found (404): This repository may not exist or you may not have access to it.")
-      expect { subject.list("user/non-existent-repo") }.to raise_error(SystemExit)
+      expect { cli("list user/non-existent-repo") }.to raise_error(SystemExit)
     end
   end
 
   describe "campfire" do
     it "calls Github::Hooker with the correct arguments" do
-      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "campfire", :events => ["pull_requests", "issue"], :config => {}})
-      subject.campfire("user/repo", "pull_requests, issue")
+      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "campfire", :events => ["pull_request", "issue"], :config=> {"token"=>"token", "room"=>"RROM", "subdomain"=>"SUBDOMAIN"}})
+      cli("campfire user/repo pull_request,issue --room=RROM --subdomain=SUBDOMAIN")
+    end
+
+    it "ignores campfire_token if --token is passed" do
+      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "campfire", :events => ["pull_request", "issue"], :config => {"token"=>"cli_token", "room"=>"ROOM", "subdomain"=>"SUBDOMAIN"}})
+      cli("campfire user/repo pull_request,issue --room=ROOM --subdomain=SUBDOMAIN --token=cli_token")
+    end
+  end
+
+  describe "email" do
+    it "calls Github::Hooker with the correct arguments" do
+      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "email", :events => ["push"], :config=> {"address"=>"user@example.com", "secret"=>"X-Test-github-hooker", "send_from_author" => "1"}})
+      cli("email user/repo push --address=user@example.com --secret=X-Test-github-hooker --send-from-author=1")
     end
   end
 
   describe "web" do
     it "calls Github::Hooker with the correct arguments" do
-      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "web", :events => ["pull_requests", "issue"], :config => {}})
-      subject.web("user/repo", "pull_requests, issue")
+      Github::Hooker.stub(:add_hook).with("user/repo", {:name => "web", :events => ["pull_request", "issue"], :config=> {"url"=>"http://example.com/callback"}})
+      cli("web user/repo pull_request,issue --url=http://example.com/callback")
     end
   end
 
   describe "delete" do
     it "calls Github::Hooker with the correct arguments" do
-      Github::Hooker.stub(:delete_hook).with("user/repo", 1010)
-      subject.delete("user/repo", 1010)
+      Github::Hooker.stub(:delete_hook).with("user/repo", "1010")
+      cli("delete user/repo 1010")
     end
   end
+
+  def cli(string)
+    Github::Hooker::CLI.start(string.split(" "))
+  end
 end

data/spec/github-hooker_spec.rb

@@ -36,6 +36,23 @@ describe Github::Hooker do
       subject.add_hook("user/repo", hook_options)
     end
 
+    it "adds a email 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\":\"email\",\"events\":[\"push\"],\"config\":{\"address\":\"user@example.com\",\"send_from_author\":\"1\"}}").
+        to_return(:status => 201, :body => "{}", :headers => {})
+
+      hook_options = {
+        :name => "email",
+        :events => ["push"],
+        :active => "true",
+        :config => {
+          :address => "user@example.com",
+          :send_from_author => "1"
+        }
+      }
+      subject.add_hook("user/repo", hook_options)
+    end
+
     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\"}}").

data/spec/support/config_stub.rb

@@ -1,3 +1,3 @@
 def stub_config!
-  Github::Hooker.stub(:config).and_return({ "user" => "user", "password" => "password", "campfire_token" => "token" })
+  Github::Hooker::Config.stub(:config).and_return({ "user" => "user", "password" => "password", "campfire_token" => "token" })
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-hooker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-08 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70291867146740 !ruby/object:Gem::Requirement
+  requirement: &70196237187800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70291867146740
+  version_requirements: *70196237187800
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70291867146020 !ruby/object:Gem::Requirement
+  requirement: &70196237186940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70291867146020
+  version_requirements: *70196237186940
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70291867145520 !ruby/object:Gem::Requirement
+  requirement: &70196237186460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70291867145520
+  version_requirements: *70196237186460
 description: ! ' github-hooker creates and deletes hooks in your github repository '
 email:
 - george@plataformatec.com.br
@@ -53,7 +53,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rbenv-version
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -63,6 +65,7 @@ files:
 - github-hooker.gemspec
 - lib/github-hooker.rb
 - lib/github-hooker/cli.rb
+- lib/github-hooker/config.rb
 - lib/github-hooker/version.rb
 - spec/fixtures/list_hooks.json
 - spec/github-hooker/cli_spec.rb
@@ -83,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2168196875312501794
+      hash: -2266126513958876058
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2168196875312501794
+      hash: -2266126513958876058
 requirements: []
 rubyforge_project: github-hooker
 rubygems_version: 1.8.11