Class: Github::Client::Repos::Pages
- Defined in:
- lib/github_api2/client/repos/pages.rb
Overview
The Pages API retrieves information about your GitHub Pages configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public.
Constant Summary
Constants included from MimeType
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
Instance Method Summary collapse
-
#get(*args) ⇒ Object
(also: #find)
Get information about a Pages site.
-
#list(*args) ⇒ Object
(also: #all)
List Pages builds.
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
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
#get(*args) ⇒ Object Also known as: find
Get information about a Pages site
41 42 43 44 45 |
# File 'lib/github_api2/client/repos/pages.rb', line 41 def get(*args) arguments(args, required: [:owner, :repo]) get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages", arguments.params) end |
#list(*args) ⇒ Object Also known as: all
List Pages builds
21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/github_api2/client/repos/pages.rb', line 21 def list(*args) arguments(args, required: [:owner, :repo]) response = if args.map(&:to_s).include?('latest') get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages/builds/latest", arguments.params) else get_request("/repos/#{arguments.owner}/#{arguments.repo}/pages/builds", arguments.params) end return response unless block_given? response.each { |el| yield el } end |