Class: Github::Client::Issues::Comments

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

Constant Summary collapse

VALID_ISSUE_COMMENT_PARAM_NAME =
%w[
  body
  resource
  mime_type
].freeze

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!, #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, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

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.issues.comments.create 'user-name', 'repo-name', 'number',
   body: 'a new comment'
github.issues.comments.create
  user: 'owner-name',
  repo: 'repo-name',
  number: 'comment-number',
  body: 'a new comment body'

Parameters:

  • params (Hash)
  • [String] (Hash)

    a customizable set of options


87
88
89
90
91
92
93
94
95
# File 'lib/github_api/client/issues/comments.rb', line 87

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

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

#delete(*args) ⇒ Object

Delete a comment

Examples

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

Examples:

github.issues.comments.delete
  user: 'owner-name',
  repo: 'repo-name',
  id: 'comment-id',

138
139
140
141
142
# File 'lib/github_api/client/issues/comments.rb', line 138

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

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

#edit(*args) ⇒ Object

Edit a comment

Examples:

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

Parameters:


116
117
118
119
120
121
122
123
# File 'lib/github_api/client/issues/comments.rb', line 116

def edit(*args)
  arguments(args, required: [:user, :repo, :id]) do
    permit VALID_ISSUE_COMMENT_PARAM_NAME
    assert_required %w[ body ]
  end

  patch_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", arguments.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', 'id'
github.issues.comments.find owner: 'user-name', repo: 'repo-name', id: 'id'

60
61
62
63
64
65
# File 'lib/github_api/client/issues/comments.rb', line 60

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

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

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

List comments on an issue

List comments in a repository

Examples:

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

Parameters:


37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/github_api/client/issues/comments.rb', line 37

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

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