Mastodon-Client/lib/Mastodon/Role/UserAgent.pm
package Mastodon::Role::UserAgent;
use strict;
use warnings;
our $VERSION = '0.017';
use v5.10.0;
use Moo::Role;
use Log::Any;
my $log = Log::Any->get_logger( category => 'Mastodon' );
use URI::QueryParam;
use List::Util qw( any );
use Types::Standard qw(
ArrayRef
Dict
HashRef
Maybe
Num
Optional
Str
Undef
slurpy
);
use Mastodon::Types qw(
HTTPResponse
Instance
URI
UserAgent
to_Entity
);
use Type::Params qw( compile );
use Carp;
has instance => (
is => 'rw',
isa => Instance,
default => 'https://mastodon.social',
coerce => 1,
);
has api_version => (
is => 'ro',
isa => Num,
default => 1,
);
has redirect_uri => (
is => 'ro',
isa => Str,
lazy => 1,
default => 'urn:ietf:wg:oauth:2.0:oob',
);
has user_agent => (
is => 'ro',
isa => UserAgent,
default => sub {
require HTTP::Thin;
HTTP::Thin->new;
},
);
has latest_response => (
is => 'ro',
isa => Maybe[HTTPResponse],
init_args => undef,
);
sub authorization_url {
my $self = shift;
unless ($self->client_id and $self->client_secret) {
croak $log->fatal(
'Cannot get authorization URL without client_id and client_secret'
);
}
state $check = compile( slurpy Dict [ access_code => Optional [Instance] ] );
my ($params) = $check->(@_);
$params->{instance} //= $self->instance;
my $uri = URI->new('/oauth/authorize')->abs($params->{instance}->uri);
$uri->query_param(redirect_uri => $self->redirect_uri);
$uri->query_param(response_type => 'code');
$uri->query_param(client_id => $self->client_id);
$uri->query_param(scope => join q{ }, sort(@{$self->scopes}));
return $uri;
}
sub post { shift->_request( post => shift, data => shift, @_ ) }
sub patch { shift->_request( patch => shift, data => shift, @_ ) }
sub get { shift->_request( get => shift, params => shift, @_ ) }
sub delete { shift->_request( delete => shift, params => shift, @_ ) }
sub _request {
my $self = shift;
my $method = shift;
my $url = shift;
my $args = { @_ };
my $headers = $args->{headers} // {};
my $data = $self->_prepare_data($args->{data});
$url = $self->_prepare_params($url, $args->{params});
$method = uc($method);
if ($self->can('access_token') and $self->access_token) {
$headers = {
Authorization => 'Bearer ' . $self->access_token,
%{$headers},
};
}
if ($log->is_trace) {
require Data::Dumper;
$log->debugf('Method: %s', $method);
$log->debugf('URL: %s', $url);
$log->debugf('Headers: %s', Data::Dumper::Dumper( $headers ));
$log->debugf('Data: %s', Data::Dumper::Dumper( $data ));
}
use Try::Tiny;
return try {
my @args = $url;
push @args, [%{$data}] unless $method eq 'GET';
@args = (@args, %{$headers});
require HTTP::Request::Common;
my $type = ($method eq 'PATCH') ? 'POST' : $method;
my $request = HTTP::Request::Common->can($type)->( @args );
$request->method($method);
my $response = $self->user_agent->request( $request );
use JSON::MaybeXS qw( decode_json );
use Encode qw( encode );
# We want to be able to set it, but do not want the user to do so
$self->{latest_response} = $response;
die $response->status_line unless $response->is_success;
my $payload = decode_json encode('utf8', $response->decoded_content);
# Some API calls return empty objects, which cannot be coerced
if ($response->decoded_content ne '{}') {
if ($url !~ /(?:apps|oauth)/ and $self->coerce_entities) {
$payload = (ref $payload eq 'ARRAY')
? [ map { to_Entity({ %{$_}, _client => $self }) } @{$payload} ]
: to_Entity({ %{$payload}, _client => $self });
}
}
if (ref $payload eq 'ARRAY') {
die $payload->{error} if any { defined $_->{error} } @{$payload};
}
elsif (ref $payload eq 'HASH') {
die $payload->{error} if defined $payload->{error};
}
return $payload;
}
catch {
my $msg = sprintf 'Could not complete request: %s', $_;
$log->fatal($msg);
croak $msg;
};
}
sub _prepare_data {
my ($self, $data) = @_;
$data //= {};
foreach my $key (keys %{$data}) {
# Array parameters to the API need keys that are marked with []
# However, HTTP::Request::Common expects an arrayref to encode files
# for transfer, even though the API does not expect that to be an array
# So we need to manually skip it, unless we come up with another solution.
next if $key eq 'file';
my $val = $data->{$key};
$data->{$key . '[]'} = delete($data->{$key}) if ref $val eq 'ARRAY';
}
return $data;
}
sub _prepare_params {
my ($self, $url, $params) = @_;
$params //= {};
croak 'Cannot make a request without a URL' unless $url;
unless (ref $url eq 'URI') {
my $base = $url =~ m{^/oauth/} ? '/' : '/api/v' . $self->api_version . '/';
$url = URI->new( $self->instance->uri . $base . $url );
}
# Adjust query param format to be Ruby-compliant
foreach my $key (keys %{$params}) {
my $val = $params->{$key};
if (ref $val eq 'ARRAY') { $url->query_param($key . '[]' => @{$val}) }
else { $url->query_param($key => $val) }
}
return $url;
}
1;