1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
package Pithub::Repos::Collaborators;
our $AUTHORITY = 'cpan:PLU';
our $VERSION = '0.01036';
# ABSTRACT: Github v3 Repo Collaborators API
use Moo;
use Carp qw( croak );
extends 'Pithub::Base';
sub add {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: collaborator' unless $args{collaborator};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'PUT',
path => sprintf( '/repos/%s/%s/collaborators/%s', delete $args{user}, delete $args{repo}, delete $args{collaborator} ),
%args,
);
}
sub is_collaborator {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: collaborator' unless $args{collaborator};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/collaborators/%s', delete $args{user}, delete $args{repo}, delete $args{collaborator} ),
%args,
);
}
sub list {
my ( $self, %args ) = @_;
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/collaborators', delete $args{user}, delete $args{repo} ),
%args,
);
}
sub remove {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: collaborator' unless $args{collaborator};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'DELETE',
path => sprintf( '/repos/%s/%s/collaborators/%s', delete $args{user}, delete $args{repo}, delete $args{collaborator} ),
%args
);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Pithub::Repos::Collaborators - Github v3 Repo Collaborators API
=head1 VERSION
version 0.01036
=head1 METHODS
=head2 add
=over
=item *
Add collaborator
PUT /repos/:user/:repo/collaborators/:user
Examples:
my $c = Pithub::Repos::Collaborators->new;
my $result = $c->add(
user => 'plu',
repo => 'Pithub',
collaborator => 'rbo',
);
=back
=head2 is_collaborator
=over
=item *
Get
GET /repos/:user/:repo/collaborators/:user
Examples:
my $c = Pithub::Repos::Collaborators->new;
my $result = $c->is_collaborator(
user => 'plu',
repo => 'Pithub',
collaborator => 'rbo',
);
if ( $result->is_success ) {
print "rbo is added as collaborator to Pithub\n";
}
elsif ( $result->code == 404 ) {
print "rbo is not added as collaborator to Pithub\n";
}
=back
=head2 list
=over
=item *
List
GET /repos/:user/:repo/collaborators
Examples:
my $c = Pithub::Repos::Collaborators->new;
my $result = $c->list(
user => 'plu',
repo => 'Pithub',
);
=back
=head2 remove
=over
=item *
Remove collaborator
DELETE /repos/:user/:repo/collaborators/:user
Examples:
my $c = Pithub::Repos::Collaborators->new;
my $result = $c->remove(
user => 'plu',
repo => 'Pithub',
collaborator => 'rbo',
);
=back
=head1 AUTHOR
Johannes Plunien <plu@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011-2019 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
|