github_api 0.1.1 → 0.1.2

data/lib/github_api/repos/hooks.rb

@@ -2,64 +2,165 @@
 
 module Github
   class Repos
+    # The Repository Hooks API manages the post-receive web and service hooks for a repository.
     module Hooks
 
-      REQUIRED_PARAMS = %w[ name config ]
+      VALID_HOOK_PARAM_NAMES = %w[
+        name
+        config
+        active
+        events
+        add_events
+        remove_events
+      ].freeze
+
+      # Active hooks can be configured to trigger for one or more events. The default event is push.
+      # The available events are:
+      VALID_HOOK_PARAM_VALUES = {
+        'events' => %w[
+          push
+          issues
+          issue_comment
+          commit_comment
+          pull_request
+          gollum
+          watch
+          download
+          fork
+          fork_apply
+          member
+          public
+        ]
+      }.freeze
+
+      REQUIRED_PARAMS = %w[ name config ].freeze
 
       # List repository hooks
-      # 
-      # GET /repos/:user/:repo/hooks
       #
-      def hooks(user, repo)
-        get("/repos/#{user}/#{repo}/hooks")
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.hooks 'user-name', 'repo-name'
+      #  @github.repos.hooks 'user-name', 'repo-name' { |hook| ... }
+      #
+      def hooks(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/hooks", params)
+        return response unless block_given?
+        response.each { |el| yield el }
       end
 
-      # Get a single hook 
+      # Get a single hook
       #
-      # GET /repos/:user/:repo/hooks/:id
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.hook 'user-name', 'repo-name'
       #
-      def get_hook(user, repo, hook_id)
-        get("/repos/#{user}/#{repo}/hooks/#{hook_id}")
+      def hook(user_name, repo_name, hook_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of hook_id
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
       end
 
       # Create a hook
       #
-      # POST /repos/:user/:repo/hooks
+      # = Inputs
+      # * <tt>:name</tt> - Required string - the name of the service that is being called.
+      # * <tt>:config</tt> - Required hash - A Hash containing key/value pairs to provide settings for this hook.
+      # * <tt>:events</tt> - Optional array - Determines what events the hook is triggered for. Default: ["push"]
+      # * <tt>:active</tt> - Optional boolean - Determines whether the hook is actually triggered on pushes.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.create_hook 'user-name', 'repo-name',
+      #    "name" =>  "web",
+      #    "active" => true,
+      #    "config" => {
+      #      "url" => "http://something.com/webhook"
+      #      }
+      #    }
       #
-      def create_hook(user, repo, params)
+      def create_hook(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+
         _normalize_params_keys(params)
-        _filter_params_keys(%w[ name config active ], params)
-        raise ArgumentError, "Required parameters are: #{REQUIRED_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_PARAMS, params)
+        _filter_params_keys(VALID_HOOK_PARAM_NAMES, params)
+
+        raise ArgumentError, "Required parameters are: name, config" unless _validate_inputs(REQUIRED_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/hooks", params)
       end
 
       # Edit a hook
       #
-      # PATCH /repos/:user/:repo/hooks/:id
-      # 
-      def edit_hook(user, repo, hook_id, params)
+      # = Inputs
+      # * <tt>:name</tt> - Required string - the name of the service that is being called.
+      # * <tt>:config</tt> - Required hash - A Hash containing key/value pairs to provide settings for this hook.
+      # * <tt>:events</tt> - Optional array - Determines what events the hook is triggered for. This replaces the entire array of events. Default: ["push"].
+      # * <tt>:add_events</tt> - Optional array - Determines a list of events to be added to the list of events that the Hook triggers for.
+      # * <tt>:remove_events</tt> - Optional array - Determines a list of events to be removed from the list of events that the Hook triggers for.
+      # * <tt>:active</tt> - Optional boolean - Determines whether the hook is actually triggered on pushes.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.edit_hook 'user-name', 'repo-name',
+      #    "name" => "campfire",
+      #    "active" =>  true,
+      #    "config" =>  {
+      #      "subdomain" => "github",
+      #      "room" =>  "Commits",
+      #      "token" => "abc123"
+      #    }
+      #
+      def edit_hook(user_name, repo_name, hook_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of hook_id
+
         _normalize_params_keys(params)
-        _filter_params_keys(%w[ name config active ], params)
-        raise ArgumentError, "Required parameters are: #{REQUIRED_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_PARAMS, params)
+        _filter_params_keys(VALID_HOOK_PARAM_NAMES, params)
 
-        patch("/repos/#{user}/#{repo}/hooks/#{hook_id}")
+        raise ArgumentError, "Required parameters are: name, config" unless _validate_inputs(REQUIRED_PARAMS, params)
+
+        patch("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
       end
 
       # Test a hook
       #
-      # POST /repos/:user/:repo/hooks/:id/test
+      # This will trigger the hook with the latest push to the current repository.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.test_hook 'user-name', 'repo-name', 'hook-id'
       #
-      def test_hook(user, repo, hook_id)
-        post("/repos/#{user}/#{repo}/hooks/#{hook_id}/test")
+      def test_hook(user_name, repo_name, hook_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of hook_id
+        _normalize_params_keys(params)
+
+        post("/repos/#{user}/#{repo}/hooks/#{hook_id}/test", params)
       end
 
       # Delete a hook
       #
-      # DELETE /repos/:user/:repo/hooks/:id
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.delete_hook 'user-name', 'repo-name', 'hook-id'
       #
-      def delete_hook(user, repo, hook_id)
-        delete("/repos/#{user}/#{repo}/hooks/#{hook_id}")
+      def delete_hook(user_name, repo_name, hook_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of hook_id
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
       end
 
     end # Hooks

data/lib/github_api/repos/keys.rb

@@ -35,7 +35,7 @@ module Github
         _validate_presence_of key_id
         _normalize_params_keys(params)
 
-        get("/repos/#{user}/#{repo}/keys/#{key_id}")
+        get("/repos/#{user}/#{repo}/keys/#{key_id}", params)
       end
 
       # Create a key
@@ -81,7 +81,7 @@ module Github
         _normalize_params_keys(params)
         _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
 
-        patch("/repos/#{user}/#{repo}/keys/#{key_id}")
+        patch("/repos/#{user}/#{repo}/keys/#{key_id}", params)
       end
 
       # Delete key
@@ -96,7 +96,7 @@ module Github
         _validate_presence_of key_id
         _normalize_params_keys(params)
 
-        delete("/repos/#{user}/#{repo}/keys/#{key_id}")
+        delete("/repos/#{user}/#{repo}/keys/#{key_id}", params)
       end
 
     end # Keys

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github
+  class Repos
+    module PubSubHubbub
+      
+      def subscribe(topic, callback)
+        post("/hub")
+      end
+    end # PubSubHubbub
+  end # Repos
+end # Github

data/lib/github_api/request/basic_auth.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'base64'
+
+module Github
+  module Request
+    class BasicAuth < Faraday::Middleware
+      dependency 'base64'
+
+      def call(env)
+        # puts "BASIC: #{@auth}"
+        env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+
+        @app.call env
+      end
+
+      def initialize(app, *args)
+        @app = app
+        login, password = args.shift, args.shift
+        @auth = Base64.encode64("#{login}:#{password}")
+        @auth.gsub!("\n", "")
+      end
+    end # BasicAuth
+  end # Request
+end # Github

data/lib/github_api/request/oauth2.rb

@@ -28,6 +28,6 @@ module Github
         @app = app
         @token = args.shift
       end
-    end
-  end
+    end # OAuth2
+  end # Request
 end # Github

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 1
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/repos/branches.json

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "master",
+    "commit": {
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "url": "https://api.github.com/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+    }
+  }
+]

data/spec/fixtures/repos/contributors.json

@@ -0,0 +1,8 @@
+[
+  {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  }
+]

data/spec/fixtures/repos/hook.json

@@ -0,0 +1,15 @@
+{
+  "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1",
+  "updated_at": "2011-09-06T20:39:23Z",
+  "created_at": "2011-09-06T17:26:27Z",
+  "name": "web",
+  "events": [
+    "push"
+  ],
+  "active": true,
+  "config": {
+    "url": "http://example.com",
+    "content_type": "json"
+  },
+  "id": 1
+}

data/spec/fixtures/repos/hooks.json

@@ -0,0 +1,10 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World/hooks/1",
+    "updated_at": "2011-09-06T20:39:23Z",
+    "created_at": "2011-09-06T17:26:27Z",
+    "name": "web",
+    "active": true,
+    "id": 1
+  }
+]

data/spec/fixtures/repos/languages.json

@@ -0,0 +1,4 @@
+{
+  "Ruby": 78769,
+  "Python": 7769
+}

data/spec/fixtures/repos/repo.json

@@ -0,0 +1,90 @@
+{
+  "url": "https://api.github.com/repos/octocat/Hello-World",
+  "html_url": "https://github.com/octocat/Hello-World",
+  "clone_url": "https://github.com/octocat/Hello-World.git",
+  "git_url": "git://github.com/octocat/Hello-World.git",
+  "ssh_url": "git@github.com:octocat/Hello-World.git",
+  "svn_url": "https://svn.github.com/octocat/Hello-World",
+  "owner": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  },
+  "name": "Hello-World",
+  "description": "This your first repo!",
+  "homepage": "https://github.com",
+  "language": null,
+  "private": false,
+  "fork": false,
+  "forks": 9,
+  "watchers": 80,
+  "size": 108,
+  "master_branch": "master",
+  "open_issues": 0,
+  "pushed_at": "2011-01-26T19:06:43Z",
+  "created_at": "2011-01-26T19:01:12Z",
+  "organization": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat",
+    "type": "Organization"
+  },
+  "parent": {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "owner": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "name": "Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z"
+  },
+  "source": {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "ssh_url": "git@github.com:octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "owner": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "name": "Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z"
+  },
+  "has_issues": true,
+  "has_wiki": true,
+  "has_downloads": true
+}

data/spec/fixtures/repos/repos.json

@@ -0,0 +1,29 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "ssh_url": "git@github.com:octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "owner": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "name": "Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z"
+  }
+]