Class: Github::Issues::Comments

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

Constant Summary collapse

VALID_ISSUE_COMMENT_PARAM_NAME = 
%w[
  body
  resource
  mime_type
].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

Inputs

<tt>:body</tt> Required string

Examples

github = Github.new
github.issues.comments.create 'user-name', 'repo-name', 'issue-id',
   'body': 'a new comment'



71
72
73
74
75
76
77
78
79
 
# File 'lib/github_api/issues/comments.rb', line 71

def create(*args)
  arguments(args, :required => [:user, :repo, :issue_id]) do
    sift VALID_ISSUE_COMMENT_PARAM_NAME
    assert_required %w[ body ]
  end
  params = arguments.params

  post_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
end

#delete(*args) ⇒ Object

Delete a comment

Examples

github = Github.new
github.issues.comments.delete 'user-name', 'repo-name', 'comment-id'



107
108
109
110
111
112
 
# File 'lib/github_api/issues/comments.rb', line 107

def delete(*args)
  arguments(args, :required => [:user, :repo, :comment_id])
  params = arguments.params

  delete_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
end

#edit(*args) ⇒ Object

Edit a comment

Inputs

<tt>:body</tt> Required string

Examples

github = Github.new
github.issues.comments.edit 'user-name', 'repo-name', 'comment-id',
   'body': 'a new comment'



91
92
93
94
95
96
97
98
99
 
# File 'lib/github_api/issues/comments.rb', line 91

def edit(*args)
  arguments(args, :required => [:user, :repo, :comment_id]) do
    sift VALID_ISSUE_COMMENT_PARAM_NAME
    assert_required %w[ body ]
  end
  params = arguments.params

  patch_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
end

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

Get a single comment

Examples

github = Github.new
github.issues.comments.find 'user-name', 'repo-name', 'comment-id'



53
54
55
56
57
58
 
# File 'lib/github_api/issues/comments.rb', line 53

def get(*args)
  arguments(args, :required => [:user, :repo, :comment_id])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
end

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

List comments on an issue

Examples

github = Github.new
github.issues.comments.all 'user-name', 'repo-name', issue_id: 'id'
github.issues.comments.all 'user-name', 'repo-name', issue_id: 'id' {|com| .. }

List comments in a repository

Parameters

  • :sort - Optional string, created or updated

  • :direction - Optional string, asc or desc.

    Ignored with sort parameter.

  • :since - Optional string of a timestamp in ISO 8601

    format: YYYY-MM-DDTHH:MM:SSZ

Examples

github = Github.new
github.issues.comments.all 'user-name', 'repo-name'
github.issues.comments.all 'user-name', 'repo-name' {|com| .. }



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/github_api/issues/comments.rb', line 33

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

  response = if (issue_id = params.delete('issue_id'))
    get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
  else
    get_request("/repos/#{user}/#{repo}/issues/comments", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end