Class: Github::Client::Gists::Comments

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/gists/comments.rb

Constant Summary

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

#create(*args) ⇒ Object

Create a comment

Examples:

github = Github.new
github.gists.comments.create 'gist-id'

Parameters:

See Also:



58
59
60
61
62
 
# File 'lib/github_api/client/gists/comments.rb', line 58

def create(*args)
  arguments(args, required: [:gist_id])

  post_request("/gists/#{arguments.gist_id}/comments", arguments.params)
end

#delete(*args) ⇒ Object

Delete a comment

Examples:

github = Github.new
github.gists.comments.delete 'gist-id', 'comment-id'

See Also:



93
94
95
96
97
98
 
# File 'lib/github_api/client/gists/comments.rb', line 93

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

  delete_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
                 arguments.params)
end

#edit(*args) ⇒ Object

Edit a comment

Examples:

github = Github.new
github.gists.comments.edit 'gist-id', 'comment-id'

Parameters:

See Also:



77
78
79
80
81
82
 
# File 'lib/github_api/client/gists/comments.rb', line 77

def edit(*args)
  arguments(args, required: [:gist_id, :id])

  patch_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
                arguments.params)
end

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

Get a single comment

Examples:

github = Github.new
github.gists.comments.get 'gist-id', 'comment-id'

See Also:



37
38
39
40
41
42
 
# File 'lib/github_api/client/gists/comments.rb', line 37

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

  get_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
              arguments.params)
end

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

List comments on a gist

Examples:

github = Github.new
github.gists.comments.list 'gist-id'

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/github_api/client/gists/comments.rb', line 18

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

  response = get_request("/gists/#{arguments.gist_id}/comments",
                         arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end