NAME¶

VERSION¶

METHODS¶

archive¶

•

This method will return a 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 "ref" parameter is optional and will default to "master".

Examples:

    my $c = Pithub::Repos::Contents->new(
        repo => 'Pithub',
        user => 'plu'
    );
    my $result = $c->archive( archive_format => 'tarball' );
    if ( $result->success ) {
        File::Slurp::write_file('Pithub-master.tgz', $result->raw_content);
    }
    $result = $c->archive( archive_format => 'tarball', ref => 'other_branch' );
    if ( $result->success ) {
        File::Slurp::write_file('Pithub-other_branch.tgz', $result->raw_content);
    }
    

get¶

•

This method returns the contents of any file or directory in a repository.

    GET /repos/:user/:repo/contents/:path
    

Optional Parameters:

    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;

readme¶

•

This method returns the preferred README for a repository.

    GET /repos/:user/:repo/readme
    

Optional Parameters:

    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;

AUTHOR¶

COPYRIGHT AND LICENSE¶