Class: Github::Repos::Pages

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/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 Github::Request

Github::Request::METHODS, Github::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

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

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

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

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

Get information about a Pages site

Examples:

github = Github.new
github.repos.pages.get owner: 'owner-name', repo: 'repo-name'


41
42
43
44
45
 
# File 'lib/github_api/repos/pages.rb', line 41

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

  get_request("/repos/#{owner}/#{repo}/pages", arguments.params)
end

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

List Pages builds

Examples:

github = Github.new
github.repos.pages.list owner: 'owner-name', repo: 'repo-name'

github = Github.new
github.repos.pages.list :latest, owner: 'owner-name', repo: 'repo-name'


20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/github_api/repos/pages.rb', line 20

def list(*args)
  arguments(args, required: [:owner, :repo])
  params = arguments.params

  response = if args.map(&:to_s).include?('latest')
    get_request("/repos/#{owner}/#{repo}/pages/builds/latest", params)
  else
    get_request("/repos/#{owner}/#{repo}/pages/builds", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end