Class: Github::Client::Repos::Branches::Protections

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/repos/branches/protections.rb

Overview

The Branch Protections API

Constant Summary collapse

VALID_PROTECTION_PARAM_NAMES =
%w[
  required_status_checks
  required_pull_request_reviews
  enforce_admins
  restrictions
  accept
].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!, #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

Methods included from Request::Verbs

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

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

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

#delete(*args) ⇒ Object Also known as: remove

Delete a branch protection

Examples:

github = Github.new
github.repos.branches.protections.delete 'user', 'repo', 'branch'

68
69
70
71
72
# File 'lib/github_api/client/repos/branches/protections.rb', line 68

def delete(*args)
  arguments(args, required: [:user, :repo, :branch])

  delete_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
end

#edit(*args) ⇒ Object Also known as: update

Edit a branch protection

Users with push access to the repository can edit a branch protection.

Look to the branch protection API to see how to use these developer.github.com/v3/repos/branches/#update-branch-protection

Examples:

github = Github.new
github.repos.branches.protections.edit 'user', 'repo', 'branch',
  required_pull_request_reviews: {dismiss_stale_reviews: false}

Parameters:


52
53
54
55
56
57
58
# File 'lib/github_api/client/repos/branches/protections.rb', line 52

def edit(*args)
  arguments(args, required: [:user, :repo, :branch]) do
    permit VALID_PROTECTION_PARAM_NAMES
  end

  put_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
end

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

Get a single branch's protection

Examples:

github = Github.new
github.repos.branches.protections.get 'user', 'repo', 'branch'

23
24
25
26
27
# File 'lib/github_api/client/repos/branches/protections.rb', line 23

def get(*args)
  arguments(args, required: [:user, :repo, :branch])

  get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
end