File Coverage

blib/lib/OAuth/Cmdline.pm

Criterion	Covered	Total	%
statement	33	124	26.6
branch	0	28	0.0
condition	0	3	0.0
subroutine	11	26	42.3
pod	3	15	20.0
total	47	196	23.9

###########################################
package OAuth::Cmdline;
###########################################
use strict;
use warnings;
use URI;
use YAML qw( DumpFile LoadFile );
use HTTP::Request::Common;
use URI;
use LWP::UserAgent;
use Log::Log4perl qw(:easy);
use JSON qw( from_json );
use MIME::Base64;
use Moo;

our $VERSION = "0.06";

has client_id     => ( is => "rw" );
has client_secret => ( is => "rw" );
has local_uri      => (
  is      => "rw",
  default => "http://localhost:8082",
);
has homedir => (
  is      => "ro",
  default => glob '~',
);
has base_uri    => ( is => "rw" );
has login_uri   => ( is => "rw" );
has site        => ( is => "rw" );
has scope       => ( is => "rw" );
has token_uri   => ( is => "rw" );
has redir_uri   => ( is => "rw" );
has access_type => ( is => "rw" );
has raise_error => ( is => "rw" );

###########################################
sub redirect_uri {
###########################################
    my( $self ) = @_;

    return $self->local_uri . "/callback";
}

###########################################
sub cache_file_path {
###########################################
    my( $self ) = @_;

      # creds saved  ~/.[site].yml
    return $self->homedir . "/." .
           $self->site . ".yml";
}

###########################################
sub full_login_uri {
###########################################
    my( $self ) = @_;

    my $full_login_uri = URI->new( $self->login_uri );

    $full_login_uri->query_form (
      client_id     => $self->client_id(),
      response_type => "code",
      (defined $self->redirect_uri() ?
        ( redirect_uri  => $self->redirect_uri() ) :
        ()
      ),
      scope         => $self->scope(),
      ($self->access_type() ?
          (access_type => $self->access_type()) : ()),
    );

    DEBUG "full login uri: $full_login_uri";
    return $full_login_uri;
}

###########################################
sub access_token {
###########################################
    my( $self ) = @_;

    if( $self->token_expired() ) {
        $self->token_refresh() or LOGDIE "Token refresh failed";
    }

    my $cache = $self->cache_read();
    return $cache->{ access_token };
}

###########################################
sub authorization_headers {
###########################################
    my( $self ) = @_;

    return (
        'Authorization' =>
            'Bearer ' . $self->access_token
    );
}

###########################################
sub token_refresh_authorization_header {
###########################################
    my( $self ) = @_;

    return ();
}

###########################################
sub token_refresh {
###########################################
    my( $self ) = @_;

    DEBUG "Refreshing access token";

    my $cache = $self->cache_read();

    $self->token_uri( $cache->{ token_uri } );

    my $req = &HTTP::Request::Common::POST(
        $self->token_uri,
        {
            refresh_token => $cache->{ refresh_token },
            client_id     => $cache->{ client_id },
            client_secret => $cache->{ client_secret },
            grant_type    => 'refresh_token',
        },
        $self->token_refresh_authorization_header(),
    );

    my $ua = LWP::UserAgent->new();
    my $resp = $ua->request($req);

    if( $resp->is_success() ) {
        my $data =
        from_json( $resp->content() );

        DEBUG "Token refreshed, will expire in $data->{ expires_in } seconds";

        $cache->{ access_token } = $data->{ access_token };
        $cache->{ expires }      = $data->{ expires_in } + time();

        $self->cache_write( $cache );
        return 1;
    }

    ERROR "Token refresh failed: ", $resp->status_line();
    return undef;
}

###########################################
sub token_expired {
###########################################
    my( $self ) = @_;

    my $cache = $self->cache_read();

    my $time_remaining = $cache->{ expires } - time();

    if( $time_remaining < 300 ) {
        if( $time_remaining < 0 ) {
            DEBUG "Token expired ", -$time_remaining, " seconds ago";
        } else {
            DEBUG "Token will expire in $time_remaining seconds";
        }

        DEBUG "Token needs to be refreshed.";
        return 1;
    }

    return 0;
}

###########################################
sub token_expire {
###########################################
    my( $self ) = @_;

    my $cache = $self->cache_read();

    $cache->{ expires } = time() - 1;
    $self->cache_write( $cache );
}

###########################################
sub cache_read {
###########################################
    my( $self ) = @_;

    if( ! -f $self->cache_file_path ) {
        LOGDIE "Cache file ", $self->cache_file_path, " not found. ",
          "See GETTING STARTED in the docs for how to get started.";
    }

    return LoadFile $self->cache_file_path;
}

###########################################
sub cache_write {
###########################################
    my( $self, $cache ) = @_;

    my $old_umask = umask 0177;

    DumpFile $self->cache_file_path, $cache;

    umask $old_umask;
    return 1;
}

###########################################
sub tokens_get {
###########################################
    my( $self, $code ) = @_;

    my $req = &HTTP::Request::Common::POST(
        $self->token_uri,
        [
            code          => $code,
            client_id     => $self->client_id,
            client_secret => $self->client_secret,
            redirect_uri  => $self->redirect_uri,
            grant_type    => 'authorization_code',
        ]
    );

    my $ua = LWP::UserAgent->new();
    my $resp = $ua->request($req);

    if( $resp->is_success() ) {
        my $json = $resp->content();
        DEBUG "Received: [$json]",
        my $data = from_json( $json );

        return ( $data->{ access_token },
            $data->{ refresh_token },
            $data->{ expires_in } );
    }

    LOGDIE $resp->status_line();
    return undef;
}

###########################################
sub tokens_collect {
###########################################
    my( $self, $code ) = @_;

    my( $access_token, $refresh_token,
        $expires_in ) = $self->tokens_get( $code );

    my $cache = {
        access_token  => $access_token,
        refresh_token => $refresh_token,
        client_id     => $self->client_id,
        client_secret => $self->client_secret,
        expires       => time() + $expires_in,
        token_uri     => $self->token_uri,
    };

    $self->cache_write( $cache );
}

###########################################
sub http_get {
###########################################
    my( $self, $url, $query ) = @_;

    my $ua = LWP::UserAgent->new();

    my $uri = URI->new( $url );
    $uri->query_form( @$query ) if defined $query;

    DEBUG "Fetching $uri";

    my $resp = $ua->get( $uri,
        $self->authorization_headers, @$query );

    if( $resp->is_error ) {
        if( $self->raise_error ) {
            die $resp->message;
        }
        return undef;
    }

    return $resp->decoded_content;
}

###########################################
sub client_init_conf_check {
###########################################
    my( $self, $url ) = @_;

    my $conf = { };
    if( -f $self->cache_file_path ) {
        $conf = $self->cache_read();
    }

    if( !exists $conf->{ client_id } or
        !exists $conf->{ client_secret } ) {
        die "You need to register your application on " .
          "$url and add the client_id and " .
          "client_secret entries to " . $self->cache_file_path . "\n";
    }

    $self->client_id( $conf->{ client_id } );
    $self->client_secret( $conf->{ client_secret } );

    return 1;
}

1;

__END__