File Coverage

blib/lib/Authen/Pluggable/JSON.pm

Criterion	Covered	Total	%
statement	17	37	45.9
branch	1	6	16.6
condition			n/a
subroutine	4	6	66.6
pod	1	3	33.3
total	23	52	44.2

package Authen::Pluggable::JSON;
$Authen::Pluggable::JSON::VERSION = '0.03';
use Mojo::Base -base, -signatures;
use Mojo::UserAgent;
use Mojo::URL;

has 'parent' => undef, weak => 1;

has _cfg => sub {
    return {
        url           => new Mojo::URL('http://127.0.0.1:3000/api/auth'),
        query_builder => sub {
            Mojo::URL->new(shift)->query( user => shift, pass => shift );
        },
        res_builder => sub($json) {return %$json ? $json : undef },
    };
};

sub authen ( $s, $user, $pass ) {
    my $ub = $s->_cfg->{query_builder};
    my $ut = $s->_cfg->{url};
    my $rb = $s->_cfg->{res_builder};

    my $url = $ub->( $ut, $user, $pass );

    my $ua  = Mojo::UserAgent->new;
    my $res = $ua->get($url)->result;

    return $rb->( $res->json ) if ( $res->is_success );

    return undef;
}

sub cfg ( $s, %cfg ) {
    if (%cfg) {
        while ( my ( $k, $v ) = each %cfg ) {
            $s->_cfg->{$k} = $v;
        }
    }
    return $s->parent;
}

sub log ( $s, $type, $msg ) {
    return unless $s->parent->log;
    $s->parent->log->$type($msg);
}

1;

=pod

=head1 NAME

Authen::Pluggable::JSON - Authentication via external json

=for html







=head1 VERSION

version 0.03

=head1 SYNOPSIS

  use Authen::Pluggable;

  my $auth = Authen::Pluggable->new();

  $auth->provider('JSON')->cfg({
    url           => ...,
    query_builder => ...,
    res_builder   => ...,
  });

  my $user_info = $auth->authen($username, $password) || die "Login failed";

=head1 DESCRIPTION

Authen::Pluggable::JSON is a L plugin to authenticate users
via JSON calls.
You can personalize url, query parameters and returned JSON via configuration.

=encoding UTF-8

=head1 METHODS

=head2 cfg

This method takes a hash of parameters. The following options are valid:

=over

=item url

Url to JSON service. Default: a L istance to
C

=item query_builder

A subroutine ref for appending query string to url. The sub is called like this:

  $qb->($url, $username, $password);

Default appends C to url.

=item res_builder

A subroutine ref for altering JSON structure returned by remote service to be
compliance with L structure. The sub is called like this:

  $rb->($json);

Default: return JSON structure returned by remote service as is or undef if
remote service return C<{}>.

=back

=head1 BUGS/CONTRIBUTING

Please report any bugs through the web interface at L

If you want to contribute changes or otherwise involve yourself in development, feel free to fork the Git repository from
L.

=head1 SUPPORT

You can find this documentation with the perldoc command too.

    perldoc Authen::Pluggable::JSON

=head1 AUTHOR

Emiliano Bruni

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by Emiliano Bruni.

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

__END__