Class: Github::Client::Orgs::Hooks

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/orgs/hooks.rb

Overview

The Organizations Hooks API manages the post-receive web and service hooks for an organization.

Constant Summary collapse

REQUIRED_PARAMS =

:nodoc:

%w( name config ).freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

Github::Constants::ACCEPT, Github::Constants::ACCEPTED_OAUTH_SCOPES, Github::Constants::ACCEPT_CHARSET, Github::Constants::CACHE_CONTROL, Github::Constants::CONTENT_LENGTH, Github::Constants::CONTENT_TYPE, Github::Constants::DATE, Github::Constants::ETAG, Github::Constants::HEADER_LAST, Github::Constants::HEADER_LINK, Github::Constants::HEADER_NEXT, Github::Constants::LOCATION, Github::Constants::META_FIRST, Github::Constants::META_LAST, Github::Constants::META_NEXT, Github::Constants::META_PREV, Github::Constants::META_REL, Github::Constants::OAUTH_SCOPES, Github::Constants::PARAM_PAGE, Github::Constants::PARAM_PER_PAGE, Github::Constants::PARAM_START_PAGE, Github::Constants::RATELIMIT_LIMIT, Github::Constants::RATELIMIT_REMAINING, Github::Constants::RATELIMIT_RESET, Github::Constants::SERVER, Github::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#create(*args) ⇒ Object

Create a hook

To create a webhook, the following fields are required by the config:

Examples:

github = Github.new
github.orgs.hooks.create 'org-name',
  name:  "web",
  active: true,
  config: {
    url: "http://something.com/webhook"
  }
}

Parameters:

See Also:


95
96
97
98
99
100
101
# File 'lib/github_api/client/orgs/hooks.rb', line 95

def create(*args)
  arguments(args, required: [:org_name]) do
    assert_required REQUIRED_PARAMS
  end

  post_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
end

#delete(*args) ⇒ Object

Delete a hook

Examples:

github = Github.new
github.orgs.hooks.delete 'org-name', 'hook-id'

See Also:


173
174
175
176
177
178
# File 'lib/github_api/client/orgs/hooks.rb', line 173

def delete(*args)
  arguments(args, required: [:org_name, :id])

  delete_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
                 arguments.params)
end

#edit(*args) ⇒ Object

Edit a hook

Examples:

github = Github.new
github.orgs.hooks.edit 'org-name', 'hook-id',
  "name" => "campfire",
  "active" =>  true,
  "config" =>  {
    "subdomain" => "github",
    "room" =>  "Commits",
    "token" => "abc123"
  }

Parameters:

See Also:


137
138
139
140
141
142
143
144
# File 'lib/github_api/client/orgs/hooks.rb', line 137

def edit(*args)
  arguments(args, required: [:org_name, :id]) do
    assert_required REQUIRED_PARAMS
  end

  patch_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
                arguments.params)
end

#get(*args) ⇒ Object Also known as: find

Get a single hook

Examples:

github = Github.new
github.orgs.hooks.get 'org-name', 'hook-id'

See Also:


38
39
40
41
42
43
# File 'lib/github_api/client/orgs/hooks.rb', line 38

def get(*args)
  arguments(args, required: [:org_name, :id])

  get_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}",
              arguments.params)
end

#list(*args) ⇒ Object Also known as: all

List organization hooks

Examples:

github = Github.new
github.orgs.hooks.list 'org-name'
github.orgs.hooks.list 'org-name' { |hook| ... }

See Also:


20
21
22
23
24
25
26
# File 'lib/github_api/client/orgs/hooks.rb', line 20

def list(*args)
  arguments(args, required: [:org_name])

  response = get_request("/orgs/#{arguments.org_name}/hooks", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

#ping(*args) ⇒ Object

Ping a hook

This will trigger a ping event to be sent to the hook.

Examples:

github = Github.new
github.orgs.hooks.ping 'org-name', 'hook-id'

See Also:


157
158
159
160
161
162
# File 'lib/github_api/client/orgs/hooks.rb', line 157

def ping(*args)
  arguments(args, required: [:org_name, :id])

  post_request("/orgs/#{arguments.org_name}/hooks/#{arguments.id}/pings",
               arguments.params)
end