Class: Github::Gists::Comments

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

Constant Summary collapse

REQUIRED_GIST_COMMENT_OPTIONS = 
%w[
  body
].freeze
VALID_GIST_COMMENT_OPTIONS = 
%w[
  body
  mime_type
  resource
].freeze

Constants included from Request

Request::METHODS, 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 RateLimit

#ratelimit, #ratelimit_remaining

Methods included from 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

#create(*args) ⇒ Object

Create a comment

Examples

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



50
51
52
53
54
55
56
57
 
# File 'lib/github_api/gists/comments.rb', line 50

def create(*args)
  arguments(args, :required => [:gist_id]) do
    sift VALID_GIST_COMMENT_OPTIONS
    assert_required REQUIRED_GIST_COMMENT_OPTIONS
  end

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

#delete(*args) ⇒ Object

Delete a comment

Examples

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



80
81
82
83
84
 
# File 'lib/github_api/gists/comments.rb', line 80

def delete(*args)
  arguments(args, :required => [:gist_id, :comment_id])

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

#edit(*args) ⇒ Object

Edit a comment

Examples

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



65
66
67
68
69
70
71
72
 
# File 'lib/github_api/gists/comments.rb', line 65

def edit(*args)
  arguments(args, :required => [:gist_id, :comment_id]) do
    sift VALID_GIST_COMMENT_OPTIONS
    assert_required REQUIRED_GIST_COMMENT_OPTIONS
  end

  patch_request("/gists/#{gist_id}/comments/#{comment_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'



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

def get(*args)
  arguments(args, :required => [:gist_id, :comment_id])

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

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

List comments on a gist

Examples

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



22
23
24
25
26
27
28
 
# File 'lib/github_api/gists/comments.rb', line 22

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

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