class BitBucket::Issues::Comments

Constants

VALID_ISSUE_COMMENT_PARAM_NAME

Public Class Methods

new(options = {}) click to toggle source

Creates new Issues::Comments API

Calls superclass method BitBucket::API::new
# File lib/bitbucket_rest_api/issues/comments.rb, line 9
def initialize(options = {})
  super(options)
end

Public Instance Methods

all(user_name, repo_name, issue_id, params = {})
Alias for: list
create(user_name, repo_name, issue_id, params = {}) click to toggle source

Create a comment

Inputs

<tt>:content</tt> Required string

Examples

bitbucket = BitBucket.new
bitbucket.issues.comments.create 'user-name', 'repo-name', 'issue-id',
   "content" => 'a new comment'
# File lib/bitbucket_rest_api/issues/comments.rb, line 63
def create(user_name, repo_name, issue_id, params = {})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of issue_id

  normalize! params
  # _merge_mime_type(:issue_comment, params)
  filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
  assert_required_keys(%w[content], params)

  post_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/comments/", params)
end
delete(user_name, repo_name, comment_id, params = {}) click to toggle source

Delete a comment

Examples

bitbucket = BitBucket.new
bitbucket.issues.comments.delete 'user-name', 'repo-name', 'comment-id'
# File lib/bitbucket_rest_api/issues/comments.rb, line 105
def delete(user_name, repo_name, comment_id, params = {})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of comment_id

  normalize! params
  # _merge_mime_type(:issue_comment, params)

  delete_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
end
edit(user_name, repo_name, comment_id, params = {}) click to toggle source

Edit a comment

Inputs

<tt>:content</tt> Required string

Examples

bitbucket = BitBucket.new
bitbucket.issues.comments.edit 'user-name', 'repo-name', 'comment-id',
   "content" => 'a new comment'
# File lib/bitbucket_rest_api/issues/comments.rb, line 86
def edit(user_name, repo_name, comment_id, params = {})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of comment_id

  normalize! params
  # _merge_mime_type(:issue_comment, params)
  filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
  assert_required_keys(%w[content], params)

  put_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
end
find(user_name, repo_name, comment_id, params = {})
Alias for: get
get(user_name, repo_name, comment_id, params = {}) click to toggle source

Get a single comment

Examples

bitbucket = BitBucket.new
bitbucket.issues.comments.find 'user-name', 'repo-name', 'comment-id'
# File lib/bitbucket_rest_api/issues/comments.rb, line 41
def get(user_name, repo_name, comment_id, params = {})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of comment_id

  normalize! params
  # _merge_mime_type(:issue_comment, params)

  get_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
end
Also aliased as: find
list(user_name, repo_name, issue_id, params = {}) { |el| ... } click to toggle source

List comments on an issue

Examples

bitbucket = BitBucket.new
bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id'
bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
# File lib/bitbucket_rest_api/issues/comments.rb, line 20
def list(user_name, repo_name, issue_id, params = {})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of issue_id

  normalize! params
  # _merge_mime_type(:issue_comment, params)

  response = get_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/comments/", params)
  return response unless block_given?

  response.each { |el| yield el }
end
Also aliased as: all