Parent

Class/Module Index [+]

Quicksearch

Github::Repos::Hooks

The Repository Hooks API manages the post-receive web and service hooks for a repository.

Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a hook

Inputs

  • :name - Required string - the name of the service that is being called.

  • :config - Required hash - A Hash containing key/value pairs to provide settings for this hook.

  • :events - Optional array - Determines what events the hook is triggered for. Default: ["push"]

  • :active - Optional boolean - Determines whether the hook is actually triggered on pushes.

Examples

github = Github.new
github.repos.hooks.create 'user-name', 'repo-name',
  "name" =>  "web",
  "active" => true,
  "config" => {
    "url" => "http://something.com/webhook"
    }
  }
# File lib/github_api/repos/hooks.rb, line 85
def create(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_HOOK_PARAM_NAMES, :recursive => false
    assert_required REQUIRED_PARAMS
  end

  post_request("/repos/#{user}/#{repo}/hooks", arguments.params)
end
delete(*args) click to toggle source

Delete a hook

Examples

github = Github.new
github.repos.hooks.delete 'user-name', 'repo-name', 'hook-id'
# File lib/github_api/repos/hooks.rb, line 145
def delete(*args)
  arguments(args, :required => [:user, :repo, :id])
  params = arguments.params

  delete_request("/repos/#{user}/#{repo}/hooks/#{id}", params)
end
edit(*args) click to toggle source

Edit a hook

Inputs

  • :name - Required string - the name of the service that is being called.

  • :config - Required hash - A Hash containing key/value pairs to provide settings for this hook.

  • :events - Optional array - Determines what events the hook is triggered for. This replaces the entire array of events. Default: ["push"].

  • :add_events - Optional array - Determines a list of events to be added to the list of events that the Hook triggers for.

  • :remove_events - Optional array - Determines a list of events to be removed from the list of events that the Hook triggers for.

  • :active - Optional boolean - Determines whether the hook is actually triggered on pushes.

Examples

github = Github.new
github.repos.hooks.edit 'user-name', 'repo-name', 'hook-id',
  "name" => "campfire",
  "active" =>  true,
  "config" =>  {
    "subdomain" => "github",
    "room" =>  "Commits",
    "token" => "abc123"
  }
# File lib/github_api/repos/hooks.rb, line 115
def edit(*args)
  arguments(args, :required => [:user, :repo, :id]) do
    sift VALID_HOOK_PARAM_NAMES, :recursive => false
    assert_required REQUIRED_PARAMS
  end

  patch_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
end
find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a single hook

Examples

github = Github.new
github.repos.hooks.get 'user-name', 'repo-name', 'hook-id'
# File lib/github_api/repos/hooks.rb, line 60
def get(*args)
  arguments(args, :required => [:user, :repo, :id])

  get_request("/repos/#{user}/#{repo}/hooks/#{id}", arguments.params)
end
Also aliased as: find
list(*args) click to toggle source

List repository hooks

Examples

github = Github.new
github.repos.hooks.list 'user-name', 'repo-name'
github.repos.hooks.list 'user-name', 'repo-name' { |hook| ... }
# File lib/github_api/repos/hooks.rb, line 45
def list(*args)
  arguments(args, :required => [:user, :repo])

  response = get_request("/repos/#{user}/#{repo}/hooks", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
test(*args) click to toggle source

Test a hook

This will trigger the hook with the latest push to the current repository.

Examples

github = Github.new
github.repos.hooks.test 'user-name', 'repo-name', 'hook-id'
# File lib/github_api/repos/hooks.rb, line 132
def test(*args)
  arguments(args, :required => [:user, :repo, :id])
  params = arguments.params

  post_request("/repos/#{user}/#{repo}/hooks/#{id}/test", params)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.