/usr/share/perl5/Pithub/Repos/Contents.pm is in libpithub-perl 0.01033-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | package Pithub::Repos::Contents;
$Pithub::Repos::Contents::VERSION = '0.01033';
our $AUTHORITY = 'cpan:PLU';
# ABSTRACT: Github v3 Repo Contents API
use Moo;
use Carp qw(croak);
extends 'Pithub::Base';
sub archive {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: archive_format' unless $args{archive_format};
croak 'Invalid archive_format. Valid formats: tarball, zipball' unless grep $args{archive_format} eq $_, qw(tarball zipball);
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/%s/%s', delete $args{user}, delete $args{repo}, delete $args{archive_format}, delete $args{ref} || '' ),
%args,
);
}
sub get {
my ( $self, %args ) = @_;
$self->_validate_user_repo_args( \%args );
if ( my $path = delete $args{path} ) {
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/contents/%s', delete $args{user}, delete $args{repo}, $path ),
%args,
);
}
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/contents', delete $args{user}, delete $args{repo} ),
%args,
);
}
sub readme {
my ( $self, %args ) = @_;
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf( '/repos/%s/%s/readme', delete $args{user}, delete $args{repo} ),
%args,
);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Pithub::Repos::Contents - Github v3 Repo Contents API
=head1 VERSION
version 0.01033
=head1 METHODS
=head2 archive
=over
=item *
This method will return a C<< 302 >> to a URL to download a tarball
or zipball archive for a repository.
Note: For private repositories, these links are temporary and expire
quickly.
GET /repos/:user/:repo/:archive_format/:ref
The C<< ref >> parameter is optional and will default to
C<< master >>.
Examples:
use Path::Tiny;
my $c = Pithub::Repos::Contents->new(
repo => 'Pithub',
user => 'plu'
);
my $result = $c->archive( archive_format => 'tarball' );
if ( $result->success ) {
path('Pithub-master.tgz')->spew($result->raw_content);
}
$result = $c->archive( archive_format => 'tarball', ref => 'other_branch' );
if ( $result->success ) {
path('Pithub-other_branch.tgz')->spew($result->raw_content);
}
=back
=head2 get
=over
=item *
This method returns the contents of any file or directory in a
repository.
GET /repos/:user/:repo/contents/:path
Optional Parameters:
=over
=item *
B<ref>: Optional string - The String name of the
Commit/Branch/Tag. Defaults to C<< master >>.
=back
Examples:
my $c = Pithub::Repos::Contents->new(
repo => 'Pithub',
user => 'plu'
);
# List all files/directories in the repo root
my $result = $c->get;
if ( $result->success ) {
say $_->{name} for @{ $result->content };
}
# Get the Pithub.pm file
$result = $c->get( path => 'lib/Pithub.pm' );
print Dumper $result->content if $result->success;
=back
=head2 readme
=over
=item *
This method returns the preferred README for a repository.
GET /repos/:user/:repo/readme
Optional Parameters:
=over
=item *
B<ref>: Optional string - The String name of the
Commit/Branch/Tag. Defaults to C<< master >>.
=back
Examples:
my $c = Pithub::Repos::Contents->new(
repo => 'dotfiles',
user => 'plu'
);
my $result = $c->readme;
if ( $result->success ) {
print Dumper $result->content;
}
# Get the readme of branch 'other_branch'
$result = $c->readme( params => { ref => 'other_branch' } );
print Dumper $result->content if $result->success;
=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
|