Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://rubydoc.info/github/piotrmurach/github/master/Github/Client/Orgs/Hooks below:

Hooks – Documentation for piotrmurach/github (master) – RubyDoc.info

Inherits:

API

• Object
• API
• Github::Client::Orgs::Hooks

show all

Defined in:

lib/github_api/client/orgs/hooks.rb

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

REQUIRED_PARAMS =

%w( name config ).freeze

MimeType::MEDIA_LOOKUP

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

#current_options

• #create(*args) ⇒ Object

  Create a hook.

• #delete(*args) ⇒ Object

  Delete a hook.

• #edit(*args) ⇒ Object

  Edit a hook.

• #get(*args) ⇒ Object (also: #find)

  Get a single hook.

• #list(*args) ⇒ Object (also: #all)

  List organization hooks.

• #ping(*args) ⇒ Object

  Ping a hook.

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #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, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval

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

#ratelimit, #ratelimit_remaining, #ratelimit_reset

#lookup_media, #parse

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

This class inherits a constructor from Github::API

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

Create a hook

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

97
98
99
100
101
102
103

# File 'lib/github_api/client/orgs/hooks.rb', line 97

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

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

175
176
177
178
179
180

# File 'lib/github_api/client/orgs/hooks.rb', line 175

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

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

139
140
141
142
143
144
145
146

# File 'lib/github_api/client/orgs/hooks.rb', line 139

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

40
41
42
43
44
45

# File 'lib/github_api/client/orgs/hooks.rb', line 40

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

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

22
23
24
25
26
27
28

# File 'lib/github_api/client/orgs/hooks.rb', line 22

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 a hook

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

159
160
161
162
163
164

# File 'lib/github_api/client/orgs/hooks.rb', line 159

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

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4