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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
|
#!perl
use strict;
use warnings;
use JSON::MaybeXS qw( JSON );
use Pithub ();
use Test::More import =>
[qw( can_ok done_testing fail is isa_ok isnt ok subtest use_ok )];
use lib 't/lib';
use Pithub::Test qw( uri_is );
use Pithub::Test::Factory ();
use Pithub::Test::UA ();
BEGIN {
use_ok('Pithub');
}
my @tree = (
{
accessor => 'events',
isa => 'Pithub::Events',
methods => [
qw(issue network org org_for_user public repos user_performed user_received)
],
subtree => [],
},
{
accessor => 'gists',
isa => 'Pithub::Gists',
methods =>
[qw(create delete fork get is_starred list star unstar update)],
subtree => [
{
accessor => 'comments',
isa => 'Pithub::Gists::Comments',
methods => [qw(create delete get list update)],
},
],
},
{
accessor => 'git_data',
isa => 'Pithub::GitData',
methods => [],
subtree => [
{
accessor => 'blobs',
isa => 'Pithub::GitData::Blobs',
methods => [qw(create get)],
},
{
accessor => 'commits',
isa => 'Pithub::GitData::Commits',
methods => [qw(create get)],
},
{
accessor => 'references',
isa => 'Pithub::GitData::References',
methods => [qw(create get list update)],
},
{
accessor => 'tags',
isa => 'Pithub::GitData::Tags',
methods => [qw(create get)],
},
{
accessor => 'trees',
isa => 'Pithub::GitData::Trees',
methods => [qw(create get)],
},
],
},
{
accessor => 'issues',
isa => 'Pithub::Issues',
methods => [qw(create get list update)],
subtree => [
{
accessor => 'assignees',
isa => 'Pithub::Issues::Assignees',
methods => [qw(check list)],
},
{
accessor => 'comments',
isa => 'Pithub::Issues::Comments',
methods => [qw(create delete get list update)],
},
{
accessor => 'events',
isa => 'Pithub::Issues::Events',
methods => [qw(get list)],
},
{
accessor => 'labels',
isa => 'Pithub::Issues::Labels',
methods =>
[qw(add create delete get list remove replace update)],
},
{
accessor => 'milestones',
isa => 'Pithub::Issues::Milestones',
methods => [qw(create delete get list update)],
},
],
},
{
accessor => 'markdown',
isa => 'Pithub::Markdown',
methods => [qw(render)],
},
{
accessor => 'orgs',
isa => 'Pithub::Orgs',
methods => [qw(get list update)],
subtree => [
{
accessor => 'members',
isa => 'Pithub::Orgs::Members',
methods => [
qw(conceal delete is_member is_public list list_public publicize)
],
},
{
accessor => 'teams',
isa => 'Pithub::Orgs::Teams',
methods => [
qw(add_member add_membership add_repo create delete get has_repo is_member list list_members list_repos remove_member remove_membership remove_repo update)
],
},
],
},
{
accessor => 'pull_requests',
isa => 'Pithub::PullRequests',
methods => [qw(commits create files get is_merged list merge update)],
subtree => [
{
accessor => 'comments',
isa => 'Pithub::PullRequests::Comments',
methods => [qw(create delete get list update)],
},
],
},
{
accessor => 'repos',
isa => 'Pithub::Repos',
methods => [
qw(branch branches rename_branch merge_branch contributors create get languages list tags teams update)
],
subtree => [
{
accessor => 'collaborators',
isa => 'Pithub::Repos::Collaborators',
methods => [qw(add is_collaborator list remove)],
},
{
accessor => 'commits',
isa => 'Pithub::Repos::Commits',
methods => [
qw(create_comment delete_comment get get_comment list list_comments update_comment)
],
},
{
accessor => 'contents',
isa => 'Pithub::Repos::Contents',
methods => [qw(archive get readme)],
},
{
accessor => 'downloads',
isa => 'Pithub::Repos::Downloads',
methods => [qw(create delete get list upload)],
},
{
accessor => 'forks',
isa => 'Pithub::Repos::Forks',
methods => [qw(create list)],
},
{
accessor => 'hooks',
isa => 'Pithub::Repos::Hooks',
methods => [qw(create delete get list update test)],
},
{
accessor => 'issues',
isa => 'Pithub::Issues',
methods => [qw(create get list update)],
},
{
accessor => 'keys',
isa => 'Pithub::Repos::Keys',
methods => [qw(create delete get list)],
},
{
accessor => 'markdown',
isa => 'Pithub::Markdown',
methods => [qw(render)],
},
{
accessor => 'pull_requests',
isa => 'Pithub::PullRequests',
methods => [
qw(commits create files get is_merged list merge update)],
},
{
accessor => 'releases',
isa => 'Pithub::Repos::Releases',
methods => [qw(list get create update delete)],
subtree => [
{
accessor => 'assets',
isa => 'Pithub::Repos::Releases::Assets',
methods => [qw(list get create update delete)],
}
],
},
{
accessor => 'starring',
isa => 'Pithub::Repos::Starring',
methods => [qw(has_starred list_repos list star unstar)],
},
{
accessor => 'stats',
isa => 'Pithub::Repos::Stats',
methods => [qw(contributors)],
},
{
accessor => 'statuses',
isa => 'Pithub::Repos::Statuses',
methods => [qw(create list)],
},
{
accessor => 'watching',
isa => 'Pithub::Repos::Watching',
methods => [
qw(is_watching list_repos list start_watching stop_watching)
],
},
],
},
{
accessor => 'users',
isa => 'Pithub::Users',
methods => [qw(get update)],
subtree => [
{
accessor => 'emails',
isa => 'Pithub::Users::Emails',
methods => [qw(add delete list)],
},
{
accessor => 'followers',
isa => 'Pithub::Users::Followers',
methods =>
[qw(follow is_following list list_following unfollow)],
},
{
accessor => 'keys',
isa => 'Pithub::Users::Keys',
methods => [qw(create delete get list)],
},
],
},
{
accessor => 'search',
isa => 'Pithub::Search',
methods => [qw(email issues repos users)],
},
{
accessor => 'search',
args => [ search_api => 'legacy' ],
isa => 'Pithub::Search',
methods => [qw(email issues repos users)],
},
{
accessor => 'search',
args => [ search_api => 'v3' ],
isa => 'Pithub::SearchV3',
methods => [qw(issues repos users)],
},
);
sub validate_tree {
my (%args) = @_;
my $obj = $args{obj};
my $tests = $args{tests};
my $tree = $args{tree};
foreach my $node (@$tree) {
my $accessor = $node->{accessor};
$tests->( $node, $obj );
validate_tree(
tree => $node->{subtree},
obj => $obj->$accessor( @{ $node->{args} || [] } ),
tests => $tests,
) if $node->{subtree};
}
}
# Make sure all attributes get curried down the objects
{
my %attributes = (
api_uri => 'http://foo.com',
auto_pagination => 1,
jsonp_callback => 'evil',
per_page => 42,
prepare_request => sub { },
repo => 'Pithub',
token => 123,
ua => Pithub::Test::UA->new,
user => 'plu',
);
local $SIG{__WARN__}
= sub { fail( $_[0] ) unless $_[0] =~ m{is deprecated} };
validate_tree(
tree => \@tree,
obj => Pithub->new(%attributes),
tests => sub {
my ( $node, $obj ) = @_;
my $accessor = $node->{accessor};
my $methods = $node->{methods};
can_ok $obj, $accessor;
my $val = $obj->$accessor( @{ $node->{args} || [] } );
isa_ok $val, $node->{isa};
can_ok $val, @$methods if @{ $methods || [] };
can_ok $val, 'rate_limit';
foreach my $attr ( keys %attributes ) {
is $obj->$attr, $attributes{$attr},
"Attribute ${attr} was curried to ${obj}";
}
# the following arguments are in no way real world arguments, it's just to
# satisfy -every- method with those arguments!
foreach my $method (@$methods) {
next
if $node->{isa} eq 'Pithub::Repos::Downloads'
and $method eq 'upload';
my $result;
my $data = {
state => 'pending', branch => 'master',
base => 'master', head => 'another_branch',
new_name => 'new_name'
};
# unfortunately the API expects arrayrefs on a very few calls
$data = []
if ( $node->{isa} eq 'Pithub::Users::Emails'
and grep $_ eq $method, qw(add delete) )
or ( $node->{isa} eq 'Pithub::Issues::Labels'
and grep $_ eq $method, qw(add replace) );
lives_ok {
$result = $val->$method(
archive_format => 'tarball',
asset_id => 1,
assignee => 'john',
base => 'master',
branch => 'master',
collaborator => 1,
comment_id => 1,
content_type => 'text/plain',
data => $data,
download_id => 1,
email => 'foo',
event_id => 1,
gist_id => 1,
head => 'branch',
hook_id => 1,
issue_id => 1,
key_id => 1,
keyword => 'foo',
label => 1,
milestone_id => 1,
name => 'foo',
new_name => 'new',
options => {
prepare_request => sub {
shift->header( 'Accept' => 'foo.bar' );
},
},
org => 1,
pull_request_id => 1,
q => 'foo',
ref => 1,
release_id => 1,
repo => 1,
sha => 1,
state => 'open',
team_id => 1,
user => 1,
);
}
"Calling $node->{isa}->$method with pseudo arguments";
is $result->request->header('Accept'), 'foo.bar',
"$node->{isa}->$method options prepare_request set";
}
}
);
validate_tree(
tree => \@tree,
obj => Pithub->new,
tests => sub {
my ( $node, $obj ) = @_;
foreach my $attr ( keys %attributes ) {
isnt $obj->$attr, $attributes{$attr},
"Attribute ${attr} was not curried to ${obj}";
}
}
);
}
{
my $p = Pithub::Test::Factory->create('Pithub');
isa_ok $p, 'Pithub';
throws_ok { $p->request } qr{Missing mandatory key in parameters: method},
'Not given any parameters';
throws_ok { $p->request( method => 'GET' ) }
qr{Missing mandatory key in parameters: path}, 'Parameter path missing';
throws_ok { $p->request( method => 'xxx', path => '/bar' ) }
qr{Invalid method: xxx}, 'Not a valid HTTP method';
lives_ok { $p->request( method => 'GET', path => 'bar' ) }
'Correct parameters do not throw an exception';
throws_ok {
$p->request( method => 'GET', path => '/bar', options => [] )
}
qr{The key options must be a hashref},
'options must be a hashref';
throws_ok {
$p->request(
method => 'GET', path => '/bar',
options => { prepare_request => 1 }
)
}
qr{The key prepare_request in the options hashref must be a coderef},
'prepare_request must be a coderef';
lives_ok { $p->request( method => 'GET', path => 'bar', options => {} ) }
'Empty options hashref';
my $result = $p->request( method => 'GET', path => '/bar' );
my $response = $result->response;
my $http_request = $response->request;
isa_ok $result, 'Pithub::Result';
isa_ok $response, 'HTTP::Response';
isa_ok $http_request, 'HTTP::Request';
is $http_request->content, q{}, 'The data hashref is undef';
is $http_request->uri->path, '/bar',
'The HTTP path was set in the HTTP::Request object';
is $http_request->header('Authorization'), undef,
'Authorization header was not set in the HTTP::Request object';
is $http_request->header('Content-Length'), 0,
'Content-Length header was set';
}
{
my $json = JSON->new;
my $p = Pithub::Test::Factory->create('Pithub');
$p->token('123');
my $request = $p->request(
method => 'POST', path => '/foo',
data => { some => 'data' }
)->request;
eq_or_diff $json->decode( $request->content ), { some => 'data' },
'The JSON content was set in the request object';
is $request->header('Authorization'), 'token 123',
'Authorization header was set in the HTTP::Request object';
ok $p->clear_token, 'Access token clearer';
is $p->token, undef, 'No token set anymore';
$request = $p->request(
method => 'POST', path => '/foo',
data => { some => 'data' }
)->request;
is $request->header('Authorization'), undef,
'Authorization header was not set in the HTTP::Request object';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('error/notfound.GET');
my $result = $p->request( method => 'GET', path => '/error/notfound' );
is $result->code, 404, 'HTTP status is 404';
is $result->success, q{}, 'Unsuccessful response';
ok $result->raw_content, 'Has raw JSON content';
is ref( $result->content ), 'HASH', 'Has decoded JSON hashref';
is $result->content->{message}, 'Not Found',
'Attribute exists in response: message';
is $result->ratelimit, 5000, 'Accessor to X-RateLimit-Limit header';
is $result->ratelimit_remaining, 4962,
'Accessor to X-RateLimit-Remaining header';
is $result->count, 0, 'Count accessor';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('users/miyagawa/followers.GET');
my $result = $p->users->followers->list( user => 'miyagawa' );
is $result->count, 30, 'Count accessor';
is $result->first_page_uri, undef, 'First page link on first page';
is $result->prev_page_uri, undef, 'First page link on first page';
is $result->next_page_uri,
'https://api.github.com/users/miyagawa/followers?page=2',
'Next page link on first page';
is $result->last_page_uri,
'https://api.github.com/users/miyagawa/followers?page=26',
'Last page link on first page';
is $result->first_page, undef, 'We are on first page already';
is $result->prev_page, undef, 'No prev page on the first page';
uri_is $result->next_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=2&per_page=100',
'Next page call';
uri_is $result->last_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=26&per_page=100',
'Last page call';
uri_is $result->get_page(42)->request->uri,
'https://api.github.com/users/miyagawa/followers?page=42&per_page=100',
'URI for get_page is generated, no matter if it exists or not';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('users/miyagawa/followers.GET');
$p->ua->add_response('users/miyagawa/followers.GET.page-3');
my $result
= $p->users->followers->list( user => 'miyagawa' )->get_page(3);
is $result->first_page_uri,
'https://api.github.com/users/miyagawa/followers?page=1',
'First page link on third page';
is $result->prev_page_uri,
'https://api.github.com/users/miyagawa/followers?page=2',
'First page link no third page';
is $result->next_page_uri,
'https://api.github.com/users/miyagawa/followers?page=4',
'Next page link no third page';
is $result->last_page_uri,
'https://api.github.com/users/miyagawa/followers?page=26',
'Last page link no third page';
uri_is $result->first_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=1&per_page=100',
'First page call';
uri_is $result->prev_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=2&per_page=100',
'Prev page call';
uri_is $result->next_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=4&per_page=100',
'Next page call';
uri_is $result->last_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=26&per_page=100',
'Last page call';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('users/miyagawa/followers.GET');
$p->ua->add_response('users/miyagawa/followers.GET.page-26');
my $result
= $p->users->followers->list( user => 'miyagawa' )->get_page(26);
uri_is $result->first_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=1&per_page=100',
'First page call';
uri_is $result->prev_page->request->uri,
'https://api.github.com/users/miyagawa/followers?page=25&per_page=100',
'Prev page call';
is $result->next_page, undef, 'No next page on the last page';
is $result->last_page, undef, 'We are on last page already';
uri_is $result->get_page(42)->request->uri,
'https://api.github.com/users/miyagawa/followers?page=42&per_page=100',
'URI for get_page is generated, no matter if it exists or not';
}
{
my $p = Pithub::Test::Factory->create( 'Pithub', per_page => 1 );
$p->ua->add_response('users/miyagawa/followers.GET.per_page-1');
my $result = $p->users->followers->list( user => 'miyagawa' );
eq_or_diff { $result->next_page->request->uri->query_form },
{ page => 2, per_page => 1 }, 'Next page call';
eq_or_diff { $result->last_page->request->uri->query_form },
{ page => 769, per_page => 1 }, 'Last page call';
is $result->prev_page, undef, 'No prev page on the first page';
is $result->first_page, undef, 'We are on first page already';
eq_or_diff { $result->get_page(42)->request->uri->query_form },
{ page => 42, per_page => 1 },
'URI for get_page is generated, no matter if it exists or not';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('users/plu.GET');
my $result = $p->users->get( user => 'plu' );
is $result->first_page, undef, 'First page call';
is $result->prev_page, undef, 'Prev page call';
is $result->next_page, undef, 'No next page on the last page';
is $result->last_page, undef, 'We are on last page already';
is $result->get_page(1), undef, 'No page 1';
is $result->count, 1, 'Count accessor';
}
{
my $p
= Pithub::Test::Factory->create( 'Pithub', jsonp_callback => 'foo' );
my $result = $p->request( method => 'GET', path => '/foo' );
eq_or_diff { $result->request->uri->query_form },
{ callback => 'foo', per_page => 100 },
'The callback parameter was set';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('orgs/CPAN-API/repos.GET');
my $result
= $p->request( method => 'GET', path => '/orgs/CPAN-API/repos' );
my @expectations = (
'https://github.com/CPAN-API/cpan-api',
'https://github.com/CPAN-API/search-metacpan-org',
'https://github.com/CPAN-API/cpanvote-server',
'https://github.com/CPAN-API/cpanvote-db',
'https://github.com/CPAN-API/metacpan-web',
);
is $result->first->{html_url}, $expectations[0],
'Accesor first on an arrayref content';
while ( my $row = $result->next ) {
is $row->{html_url}, shift(@expectations), 'Iterator next';
}
is scalar(@expectations), 0, 'Consumed all rows';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
$p->ua->add_response('users/plu.GET');
my $result = $p->request( method => 'GET', path => '/users/plu' );
my $row = $result->next;
is $row->{id}, 31597, 'Row data found';
eq_or_diff $result->first, $row, 'Accessor first on a hashref content';
is $result->next, undef, 'There is only one record';
}
{
my $p = Pithub::Test::Factory->create( 'Pithub', per_page => 15 );
$p->ua->add_response('users/plu/followers.GET.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-2.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-3.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-4.per_page-15');
my $result = $p->users->followers->list( user => 'plu' );
$result->auto_pagination(1);
my @followers = ();
while ( my $row = $result->next ) {
push @followers, $row;
}
is scalar(@followers), 54, 'Automatically paginate through four pages';
}
{
my $p = Pithub::Test::Factory->create(
'Pithub', per_page => 15,
auto_pagination => 1
);
$p->ua->add_response('users/plu/followers.GET.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-2.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-3.per_page-15');
$p->ua->add_response('users/plu/followers.GET.page-4.per_page-15');
my $result = $p->users->followers->list( user => 'plu' );
my @followers = ();
while ( my $row = $result->next ) {
push @followers, $row;
}
is scalar(@followers), 54, 'Automatically paginate through four pages';
}
{
my $p = Pithub::Test::Factory->create(
'Pithub',
prepare_request => sub {
my ($request) = @_;
$request->header( Accept => 'anything' );
}
);
my $result = $p->users->followers->list( user => 'plu' );
is $result->request->header('Accept'), 'anything',
'The request header got set using global prepare_request';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
my $result = $p->users->followers->list(
user => 'plu',
options => {
prepare_request => sub {
my ($request) = @_;
$request->header( Accept => 'foobar' );
}
}
);
is $result->request->header('Accept'), 'foobar',
'The request header got set via the method call';
}
{
my $p = Pithub::Test::Factory->create('Pithub');
throws_ok {
$p->users->get( user => 'foo', params => 5 );
}
qr{The key params must be a hashref}, 'The params key must be a hashref';
my $result
= $p->users->get( user => 'foo', params => { direction => 'asc' } );
my %query = $result->request->uri->query_form;
eq_or_diff \%query, { direction => 'asc', per_page => 100 },
'The params were set';
}
subtest '_create_instance passes attributes' => sub {
my $p = Pithub::Test::Factory->create( 'Pithub', per_page => 10 );
is $p->repos->per_page, 10;
is $p->repos( per_page => 5 )->per_page, 5;
is $p->issues->comments( per_page => 3 )->per_page, 3;
is $p->repos( per_page => undef )->per_page, undef, 'undef is allowed';
};
done_testing;
|