package Pithub::Issues::Comments;
{
$Pithub::Issues::Comments::VERSION = '0.01015';
}
# ABSTRACT: Github v3 Issue Comments API
use Moo;
use Carp qw(croak);
extends 'Pithub::Base';
sub create {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: issue_id' unless $args{issue_id};
croak 'Missing key in parameters: data (hashref)' unless ref $args{data} eq 'HASH';
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'POST',
path => sprintf( '/repos/%s/%s/issues/%s/comments', delete $args{user}, delete $args{repo}, delete $args{issue_id} ),
%args,
);
}
sub delete {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: comment_id' unless $args{comment_id};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'DELETE',
path => sprintf( '/repos/%s/%s/issues/comments/%s', delete $args{user}, delete $args{repo}, delete $args{comment_id} ),
%args,
);
}
sub get {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: comment_id' unless $args{comment_id};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/issues/comments/%s', delete $args{user}, delete $args{repo}, delete $args{comment_id} ),
%args,
);
}
sub list {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: issue_id' unless $args{issue_id};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/issues/%s/comments', delete $args{user}, delete $args{repo}, delete $args{issue_id} ),
%args,
);
}
sub update {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: comment_id' unless $args{comment_id};
croak 'Missing key in parameters: data (hashref)' unless ref $args{data} eq 'HASH';
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'PATCH',
path => sprintf( '/repos/%s/%s/issues/comments/%s', delete $args{user}, delete $args{repo}, delete $args{comment_id} ),
%args,
);
}
1;
__END__
=pod
=head1 NAME
Pithub::Issues::Comments - Github v3 Issue Comments API
=head1 VERSION
version 0.01015
=head1 METHODS
=head2 create
=over
=item *
Create a comment
POST /repos/:user/:repo/issues/:id/comments
Examples:
my $c = Pithub::Issues::Comments->new;
my $result = $c->create(
repo => 'Pithub',
user => 'plu',
issue_id => 1,
data => { body => 'some comment' }
);
=back
=head2 delete
=over
=item *
Delete a comment
DELETE /repos/:user/:repo/issues/comments/:id
Examples:
my $c = Pithub::Issues::Comments->new;
my $result = $c->delete(
repo => 'Pithub',
user => 'plu',
comment_id => 1,
);
=back
=head2 get
=over
=item *
Get a single comment
GET /repos/:user/:repo/issues/comments/:id
Examples:
my $c = Pithub::Issues::Comments->new;
my $result = $c->get(
repo => 'Pithub',
user => 'plu',
comment_id => 1,
);
=back
=head2 list
=over
=item *
List comments on an issue
GET /repos/:user/:repo/issues/:id/comments
Examples:
my $c = Pithub::Issues::Comments->new;
my $result = $c->list(
repo => 'Pithub',
user => 'plu',
issue_id => 1,
);
=back
=head2 update
=over
=item *
Edit a comment
PATCH /repos/:user/:repo/issues/comments/:id
Examples:
my $c = Pithub::Issues::Comments->new;
my $result = $c->update(
repo => 'Pithub',
user => 'plu',
comment_id => 1,
data => { body => 'some comment' },
);
=back
=head1 AUTHOR
Johannes Plunien <plu@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Johannes Plunien.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut