Eulerian/EDW/Peer.pm untested

filter: Statementstmt 0.0% 0 / 90 Branchbran 0.0% 0 / 40 Conditioncond 0.0% 0 / 11 MC/DCmcdc 0.0% 0 / 7 Subroutinesub 0.0% 0 / 19 Podpod 0.0% 0 / 17 totaltotal 0.0% 0 / 184 CC 21 SCAR 24.5
CC
21
Cov
0%
dump
42.0
_bearer
12.0
kind
6.0
CRAP 11.6
1 #/usr/bin/env perl
2 ###############################################################################
3 #
4 # @file Peer.pm
5 #
6 # @brief Eulerian Data Warehouse Peer Base class Module definition.
7 #
8 # @author Thorillon Xavier:x.thorillon@eulerian.com
9 #
10 # @date 26/11/2021
11 #
12 # @version 1.0
13 #
14 ###############################################################################
15 package API::Eulerian::EDW::Peer;
16  
17 use strict;
18  
19 use API::Eulerian::EDW::Status();
20  
21 #
22 # @brief Allocate a new Eulerian Data Warehouse Peer.
23 #
24 # @param $class - Eulerian Data Warehouse Peer Class.
25 # @param $setup - Setup attributes.
26 #
27 # @return Eulerian Data Warehouse Peer instance.
28 #
29 sub new
30 {
31 my $proto = shift();
32 my $class = ref($proto) || $proto;
33 my $setup = shift() || {};
34 return bless({
35 _CLASS => $class,
36 _KIND => 'access',
37 _PLATFORM => 'fr',
38 _PLATFORM_AUTH => 'fr',
39 _BEARER => undef,
40 _HOOKS => undef,
41 _TOKEN => undef,
42 _GRID => undef,
43 _HOST => undef,
44 _PORTS => [ 80, 443 ],
45 _SECURE => 1,
46 _IP => undef
47 });
48 }
49  
50 #
51 # @brief Class attribute getter.
52 #
53 # @param $self - Eulerian Data Warehouse Peer.
54 #
55 # @return Eulerian Data Warehouse Peer Class name.
56 #
57 sub class
58 {
59 return shift->{ _CLASS };
60 }
61 # @brief Token Kind attribute accessors.
62 #
63 # @param $self - Eulerian Data Warehouse Peer.
64 # @param $kind - Token kind.
65 #
66 # @return Token Kind.
67 #
68 sub kind
69 {
70 my ( $self, $kind ) = @_;
71 $self->{ _KIND } = $kind if defined( $kind );
72 return $self->{ _KIND };
73 }
74 #
75 # @brief Host attribute accessors.
76 #
77 # @param $self - Eulerian Data Warehouse Peer.
78 # @param $host - Eulerian Data Warehouse Host name.
79 #
80 # @return Eulerian Data Warehouse Host Name.
81 #
82 sub host
83 {
84 my ( $self, $host ) = @_;
85 $self->{ _HOST } = $host if defined( $host );
86 return $self->{ _HOST };
87 }
88 #
89 # @brief Ports attribute accessors.
90 #
91 # @param $self - Eulerian Data Warehouse Peer.
92 # @param $ports - Eulerian Data Warehouse Host Ports.
93 #
94 # @return Eulerian Data Warehouse Host Ports.
95 #
96 sub ports
97 {
98 my ( $self, $ports ) = @_;
99 $self->{ _PORTS } = $ports if defined( $ports );
100 return $self->{ _PORTS };
101 }
102 #
103 # @brief Platform attribute accessors.
104 #
105 # @param $self - Eulerian Data Warehouse Peer.
106 # @param $platform - Eulerian Data Warehouse Platform.
107 #
108 # @return Eulerian Data Warehouse Platform.
109 #
110 sub platform
111 {
112 my ( $self, $platform ) = @_;
113 $self->{ _PLATFORM } = $platform if defined( $platform );
114 return $self->{ _PLATFORM };
115 }
116  
117 #
118 # @brief Platform Auth attribute accessors. In the case we want
119 # to fetch data on a CA platform but auth is to be done on FR,
120 # if not defined, defaults to platform
121 #
122 # @param $self - Eulerian Data Warehouse Peer.
123 # @param $platform_auth - Eulerian Data Warehouse Platform.
124 #
125 # @return Eulerian Data Warehouse Platform.
126 #
127 sub platform_auth
128 {
129 my ( $self, $platform_auth ) = @_;
130 $self->{ _PLATFORM_AUTH } = $platform_auth if defined( $platform_auth );
131 return $self->{ _PLATFORM_AUTH } || $self->{ _PLATFORM };
132 }
133  
134 #
135 # @brief Hook attribute accessors.
136 #
137 # @param $self - Eulerian Data Warehouse Peer.
138 # @param $hook - Eulerian Data Warehouse Peer Hook.
139 #
140 # @return Eulerian Data Warehouse Peer Hook.
141 #
142 sub hook
143 {
144 my ( $self, $hook ) = @_;
145 $self->{ _HOOKS } = $hook if defined( $hook );
146 return $self->{ _HOOKS };
147 }
148 #
149 # @brief Grid attribute accessors.
150 #
151 # @param $self - Eulerian Data Warehouse Peer.
152 # @param $grid - Eulerian Data Warehouse Grid.
153 #
154 # @return Eulerian Data Warehouse Grid.
155 #
156 sub grid
157 {
158 my ( $self, $grid ) = @_;
159 $self->{ _GRID } = $grid if defined( $grid );
160 return $self->{ _GRID };
161 }
162 #
163 # @brief Secure attribute accessors.
164 #
165 # @param $self - Eulerian Data Warehouse Peer.
166 # @param $secure - Secure mode flag.
167 #
168 # @return Secure mode flag.
169 #
170 sub secure
171 {
172 my ( $self, $secure ) = @_;
173 $self->{ _SECURE } = $secure if defined( $secure );
174 return $self->{ _SECURE };
175 }
176 #
177 # @brief IP attribute accessors.
178 #
179 # @param $self - Eulerian Data Warehouse Peer.
180 # @param $ip - Eulerian Data Warehouse Peer IP.
181 #
182 # @return Secure mode flag.
183 #
184 sub ip
185 {
186 my ( $self, $ip ) = @_;
187 $self->{ _IP } = $ip if defined( $ip );
188 return $self->{ _IP };
189 }
190 #
191 # @brief Token attribute accessors.
192 #
193 # @param $self - Eulerian Data Warehouse Peer.
194 # @param $token - Eulerian Token.
195 #
196 # @return Eulerian Token.
197 #
198 sub token
199 {
200 my ( $self, $token ) = @_;
201 $self->{ _TOKEN } = $token if defined( $token );
202 return $self->{ _TOKEN };
203 }
204 #
205 # @brief Bearer attribute accessors.
206 #
207 # @param $self - Eulerian Data Warehouse Peer.
208 # @param $bearer - Eulerian EDW Bearer Session Token.
209 #
210 # @return Eulerian Bearer.
211 #
212 sub bearer
213 {
214 my ( $self, $bearer ) = @_;
215 $self->{ _BEARER } = 'Bearer '.$bearer if defined( $bearer );
216 return $self->{ _BEARER };
217 }
218 #
219 # @brief Setup Eulerian Data Warehouse Peer.
220 #
221 # @param $self - Eulerian Data Warehouse Peer.
222 # @param $setup - Setup entries.
223 #
224 sub setup
225 {
226 my ( $self, $setup ) = @_;
227  
228 foreach my $param ( qw/
229 kind platform platform_auth hook secure token grid ip host ports bearer / ) {
230 if ( $self->can($param) && exists $setup->{ $param } ) {
231 $self->$param( $setup->{$param} );
232 }
233 }
234  
235 return $self;
236 }
237  
238 #
239 # @brief Dump Eulerian Data Warehouse Peer settings.
240 #
241 # @param $self - Eulerian Data Warehouse Peer.
242 #
243 sub dump
244 {
245 my ( $self ) = @_;
246 my $hook = $self->hook() ? 'Set' : 'Unset';
247 my $secure = $self->secure() ? 'True' : 'False';
248 my $ports = $self->ports();
249 my $dump = "\n";
250  
251 $ports = $ports ? $ports->[ 0 ] . ',' . $ports->[ 1 ] : undef;
252 $dump .= 'Host : ' . $self->host() . "\n" if $self->host();
253 $dump .= 'Ports : ' . $ports . "\n" if $ports;
254 $dump .= 'Class : ' . $self->class() . "\n";
255 $dump .= 'Kind : ' . $self->kind() . "\n";
256 $dump .= 'Platform : ' . $self->platform() . "\n";
257 $dump .= 'Platform Auth : ' . $self->platform_auth() . "\n";
258 $dump .= 'Hook : ' . $hook . "\n";
259 $dump .= 'Token : ' . $self->token() . "\n";
260 $dump .= 'Bearer : ' . $self->bearer() . "\n";
261 $dump .= 'Grid : ' . $self->grid() . "\n";
262 $dump .= 'Secure : ' . $secure . "\n";
263 $dump .= 'Ip : ' . $self->ip() . "\n";
264  
265 print( $dump );
266 return $self;
267 }
268 #
269 # @brief Get Authorization bearer value from Eulerian Authority Services.
270 #
271 # @param $self - Eulerian Data Warehouse Peer.
272 #
273 # @return API::Eulerian::EDW::Status. On success a new entry 'bearer' is inserted into
274 # the Status.
275 #
276 sub _bearer
277 {
278 my $self = shift;
279 my $bearer = $self->{ _BEARER };
280 my $status;
281  
282 if( ! defined( $bearer ) ) {
283 # Request Authority Services for a valid bearer
284 $status = API::Eulerian::EDW::Authority->bearer(
285 $self->kind(), $self->platform(), $self->platform_auth(),
286 $self->grid(), $self->ip(),
287 $self->token()
288 );
289  
290 # Cache bearer value for next use
291 $self->{ _BEARER } = $status->{ bearer } if ! $status->error();
292 } else {
293 # Return Cached bearer value
294 $status = API::Eulerian::EDW::Status->new();
295 $status->{ bearer } = $bearer;
296 }
297  
298 return $status;
299 }
300 #
301 # @brief Create HTTP Request Headers.
302 #
303 # @param $self - Eulerian Data Warehouse Peer.
304 #
305 # @return API::Eulerian::EDW::Status. On success a new entry 'headers' is inserted into
306 # the status.
307 #
308 sub headers
309 {
310 my $self = shift;
311 my $status = $self->_bearer();
312 my $headers;
313  
314 if( ! $status->error() ) {
315 # Create a new Object Headers
316 $headers = API::Eulerian::EDW::Request->headers();
317 # Setup Authorization Header value
318 $headers->push_header( 'Authorization', $status->{ bearer } );
319 # Setup reply context
320 $status->{ headers } = $headers;
321 # Remove bearer
322 delete $status->{ bearer };
323 }
324  
325 return $status;
326 }
327  
328 1;
329  
330 __END__