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

FASTLY / WebService-Fastly-9.01 / lib / WebService / Fastly / Configuration.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
168
169
170
171
172
173
174
175

              
=begin comment
Fastly API
Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
The version of the API Spec document: 1.0.0
Contact: oss@fastly.com
=end comment
=cut
#
# NOTE: This class is auto generated.
# Do not edit the class manually.
#
package WebService::Fastly::Configuration;
use strict;
use warnings;
use utf8;
use Log::Any qw($log);
use Carp;
use constant VERSION => '9.01';
=head1 Name
        WebService::Fastly::Configuration - holds the configuration for all WebService::Fastly Modules
=head1 new(%parameters)
=over 4
=item http_timeout: (optional)
Integer. timeout for HTTP requests in seconds
default: 180
=item http_user_agent: (optional)
String. custom UserAgent header
default: fastly-perl/9.01
=item api_key: (optional)
Hashref. Keyed on the name of each key (there can be multiple tokens).
    api_key => {
        secretKey => 'aaaabbbbccccdddd',
        anotherKey => '1111222233334444',
    };
=item api_key_prefix: (optional)
Hashref. Keyed on the name of each key (there can be multiple tokens). Note not all api keys require a prefix.
    api_key_prefix => {
        secretKey => 'string',
        anotherKey => 'same or some other string',
    };
=item api_key_in: (optional)
=item username: (optional)
String. The username for basic auth.
=item password: (optional)
String. The password for basic auth.
=item access_token: (optional)
String. The OAuth access token.
=item base_url: (optional)
String. The base URL of the API
default: https://api.fastly.com
=back
=cut
sub new {
    my ($self, %p) = (shift,@_);
    # class/static variables
    $p{http_timeout} //= 180;
    $p{http_user_agent} //= 'fastly-perl/9.01';
    # authentication setting
    $p{api_key} //= {};
    $p{api_key_prefix} //= {};
    $p{api_key_in} //= {};
    # username and password for HTTP basic authentication
    $p{username} //= '';
    $p{password} //= '';
    # access token for OAuth
    $p{access_token} //= '';
    # base_url
    $p{base_url} //= 'https://api.fastly.com';
    # The last observed value of http header Fastly-RateLimit-Remaining
    # https://www.fastly.com/documentation/reference/api/#rate-limiting
    $p{rate_limit_remaining} //= 1000;
    # The last observed value of http header Fastly-RateLimit-Reset
    $p{rate_limit_remaining} //= undef;
    return bless \%p => $self;
}
sub get_tokens {
    my $self = shift;
    my $tokens = {};
    $tokens->{username} = $self->{username} if $self->{username};
    $tokens->{password} = $self->{password} if $self->{password};
    $tokens->{access_token} = $self->{access_token} if $self->{access_token};
    foreach my $token_name (keys %{ $self->{api_key} }) {
        $tokens->{$token_name}->{token} = $self->{api_key}{$token_name};
        $tokens->{$token_name}->{prefix} = $self->{api_key_prefix}{$token_name};
        $tokens->{$token_name}->{in} = $self->{api_key_in}{$token_name};
    }
    return $tokens;
}
sub clear_tokens {
    my $self = shift;
    my %tokens = %{$self->get_tokens}; # copy
    $self->{username} = '';
    $self->{password} = '';
    $self->{access_token} = '';
    $self->{api_key} = {};
    $self->{api_key_prefix} = {};
    $self->{api_key_in} = {};
    return \%tokens;
}
sub accept_tokens {
    my ($self, $tokens) = @_;
    foreach my $known_name (qw(username password access_token)) {
        next unless $tokens->{$known_name};
        $self->{$known_name} = delete $tokens->{$known_name};
    }
    foreach my $token_name (keys %$tokens) {
        $self->{api_key}{$token_name} = $tokens->{$token_name}{token};
        if ($tokens->{$token_name}{prefix}) {
            $self->{api_key_prefix}{$token_name} = $tokens->{$token_name}{prefix};
        }
        my $in = $tokens->{$token_name}->{in} || 'head';
        croak "Tokens can only go in 'head' or 'query' (not in '$in')" unless $in =~ /^(?:head|query)$/;
        $self->{api_key_in}{$token_name} = $in;
    }
}
1;