From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

WATERKIP / WebService-ValidSign-0.004 / lib / WebService / ValidSign / API.pm 

            

              
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

              
package WebService::ValidSign::API;
our $VERSION = '0.004';
use Moo::Role;
use namespace::autoclean;
with 'WebService::ValidSign::API::Constructor';
# ABSTRACT: A REST API client for ValidSign
use Carp qw(croak);
use HTTP::Request;
use JSON qw(decode_json);
use URI;
use WebService::ValidSign::Types qw(
    WebServiceValidSignURI
    WebServiceValidSignAuthModule
);
requires qw(action_endpoint);
has json => (
    is      => 'ro',
    builder => 1,
    lazy    => 1,
);
sub _build_json {
    require JSON::XS;
    return JSON::XS->new->convert_blessed;
}
has auth => (
    is       => 'ro',
    required => 1,
    isa      => WebServiceValidSignAuthModule,
);
sub get_endpoint {
    my ($self, @misc) = @_;
    my $uri = $self->endpoint->clone;
    my @path = $uri->path_segments;
    @path = grep { defined $_ && length $_ } @path, @misc;
    $uri->path_segments(@path);
    return $uri;
}
sub download_file {
    my ($self, $uri) = @_;
    my $fh = File::Temp->new();
    my $request = HTTP::Request->new(
        GET => $uri,
        [
            'Content-Type' => 'application/json',
        ]
    );
    $self->call_api_download(
        $request,
        sub {
            my ($chunk, $res, $proto) = @_;
            print $fh $chunk;
        }
    );
    $fh->seek(0,0);
    return $fh;
}
sub call_api_download {
    my ($self, $req, @opts) = @_;
    my $res = $self->lwp->request($req, @opts);
    if (!$res->is_success) {
        my $msg = join("$/", "", $req->as_string, $res->as_string);
        my $apikey = $self->secret;
        $msg =~ s/$apikey/APIKEYHIDDEN/g;
        croak("ValidSign error: $msg");
    }
    my $headers = $res->headers;
    foreach (qw(x-died client-aborted)) {
        if (my $header = $headers->header($_)) {
            my $msg = join("$/", "", $req->as_string, $res->as_string);
            my $apikey = $self->secret;
            $msg =~ s/$apikey/APIKEYHIDDEN/g;
            die sprintf("%s: Unable to complete file download", $_);
        }
    }
    return 1;
}
sub call_api {
    my ($self, $req, %options) = @_;
    if ($options{with_token} && $self->can('auth')) {
        $req->header("Authentication", $self->auth->token);
    }
    my $res = $self->lwp->request($req);
    return decode_json($res->decoded_content) if $res->is_success;
    my $msg = join("$/", "", $req->as_string, $res->as_string);
    my $apikey = $self->secret;
    $msg =~ s/$apikey/APIKEYHIDDEN/g;
    croak("ValidSign error: $msg");
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
WebService::ValidSign::API - A REST API client for ValidSign
=head1 VERSION
version 0.004
=head1 SYNOPSIS
    use WebService::ValidSign;
    my $client = WebService::ValidSign->new(
        endpoint => 'https://hostname.validsign.nl/api'
    );
    $client->
=head1 ATTRIBUTES
=over
=item endpoint
The API URI endpoint as described in the Acceplication Integrator's Guide
=item lwp
An LWP::UserAgent object. If you extend this module you can use your own
builder or just inject something that respects the LWP::UserAgent API.
=back
=head1 METHODS
=head1 AUTHOR
Wesley Schwengle <waterkip@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2019 by Wesley Schwengle.
This is free software, licensed under:
  The (three-clause) BSD License
=cut