blib/lib/SmsAero.pm untested

filter: Statementstmt 0.0% 0 / 223 Branchbran 0.0% 0 / 106 Conditioncond 0.0% 0 / 43 MC/DCmcdc 0.0% 0 / 24 Subroutinesub 0.0% 0 / 57 Podpod 0.0% 0 / 43 totaltotal 0.0% 0 / 496 CC 54 SCAR 27.1
CC
54
Cov
0%
send_sms
56.0
_init_validate
30.0
_validate_phone_number
30.0
CRAP 15.1
1 package SmsAero;
2  
3 use strict;
4 use warnings;
5 use JSON;
6 use LWP::UserAgent;
7 use HTTP::Request;
8 use URI::Escape;
9 use Email::Valid;
10 use Time::Piece;
11 use Log::Log4perl qw(:easy);
12 use MIME::Base64;
13  
14 our $VERSION = '3.2.0';
15  
16 use constant {
17 GATE_URLS => [
18 '@gate.smsaero.ru/v2/',
19 '@gate.smsaero.org/v2/',
20 '@gate.smsaero.net/v2/'
21 ],
22 SIGNATURE => 'Sms Aero'
23 };
24  
25 {
26 package SmsAeroException;
27 use base qw(Exception::Class::Base);
28 }
29  
30 {
31 package SmsAeroConnectionException;
32 use base qw(SmsAeroException);
33 }
34  
35 {
36 package SmsAeroNoMoneyException;
37 use base qw(SmsAeroException);
38 }
39  
40 my $logger = Log::Log4perl->get_logger();
41  
42 sub new {
43 my ($class, %args) = @_;
44  
45 my $self = {
46 _email => $args{email},
47 _api_key => $args{api_key},
48 _signature => $args{signature} || SIGNATURE,
49 _timeout => $args{timeout} || 15,
50 _allow_phone_validation => defined $args{allow_phone_validation} ? $args{allow_phone_validation} : 1,
51 _gate => $args{url_gate},
52 _test_mode => $args{test_mode} || 0,
53 _ua => LWP::UserAgent->new(
54 timeout => $args{timeout} || 15,
55 agent => 'SAPerlClient/3.0.0'
56 )
57 };
58  
59 bless $self, $class;
60  
61 $self->_init_validate();
62 $self->_check_and_format_user_gate();
63  
64 return $self;
65 }
66  
67 sub _init_validate {
68 my ($self) = @_;
69  
70 unless (Email::Valid->address($self->{_email})) {
71 die "Invalid email address";
72 }
73  
74 unless ($self->{_api_key} && length($self->{_api_key}) >= 16 && length($self->{_api_key}) <= 32) {
75 die "API key length must be between 16 and 32 characters";
76 }
77  
78 unless ($self->{_signature} && length($self->{_signature}) >= 2) {
79 die "Signature length must be at least 2 characters";
80 }
81  
82 unless ($self->{_timeout} > 2) {
83 die "Timeout must be greater than 2";
84 }
85 }
86  
87 sub _check_and_format_user_gate {
88 my ($self) = @_;
89  
90 return unless $self->{_gate};
91  
92 my $gate = $self->{_gate};
93  
94 $gate = '@' . $gate unless $gate =~ /^@/;
95  
96 $gate .= '/v2/' unless $gate =~ /\/v2\/$/;
97  
98 $self->{_gate} = $gate;
99 }
100  
101 sub _request {
102 my ($self, $selector, $data, $page) = @_;
103  
104 foreach my $gate (@{$self->_get_gate_urls()}) {
105 my $url = $self->_build_url('https', $selector, $gate, $page);
106  
107 $logger->debug("Sending request to $url with data ", encode_json($data));
108  
109 my $req = HTTP::Request->new(
110 'POST',
111 $url,
112 [
113 'Content-Type' => 'application/json',
114 'Authorization' => 'Basic ' . encode_base64($self->{_email} . ':' . $self->{_api_key})
115 ],
116 encode_json($data || {})
117 );
118  
119 my $res = $self->{_ua}->request($req);
120  
121 if ($res->is_success) {
122 my $content = decode_json($res->content);
123 $logger->debug("Received response: ", encode_json($content));
124  
125 return $self->_check_response($content);
126 }
127  
128 $logger->debug("Request failed: " . $res->status_line);
129 }
130  
131 die SmsAeroConnectionException->new("Failed to connect to any gateway");
132 }
133  
134 sub _get_gate_urls {
135 my ($self) = @_;
136 return $self->{_gate} ? [$self->{_gate}] : GATE_URLS;
137 }
138  
139 sub _build_url {
140 my ($self, $proto, $selector, $gate, $page) = @_;
141  
142 $gate =~ s/^@//;
143  
144 my $url = sprintf("%s://%s%s",
145 $proto,
146 $gate,
147 $selector
148 );
149  
150 $url .= "?page=$page" if $page;
151 return $url;
152 }
153  
154 sub _check_response {
155 my ($self, $content) = @_;
156  
157 if ($content->{result} && $content->{result} eq 'no credits') {
158 die SmsAeroNoMoneyException->new($content->{result});
159 }
160 if ($content->{result} && $content->{result} eq 'reject') {
161 die SmsAeroException->new($content->{reason});
162 }
163 unless ($content->{success}) {
164 die SmsAeroException->new($content->{message} || "Unknown error");
165 }
166  
167 return $content->{data};
168 }
169  
170 sub _validate_phone_number {
171 my ($self, $number) = @_;
172  
173 return unless $self->{_allow_phone_validation};
174  
175 my @numbers = ref $number eq 'ARRAY' ? @$number : ($number);
176 foreach my $num (@numbers) {
177 unless ($num =~ /^\d{7,15}$/) {
178 die "Invalid phone number length";
179 }
180  
181 unless ($num =~ /^[1-9]\d{6,14}$/) {
182 die "Invalid phone number format";
183 }
184 }
185 }
186  
187 sub enable_test_mode {
188 my ($self) = @_;
189 $self->{_test_mode} = 1;
190 }
191  
192 sub disable_test_mode {
193 my ($self) = @_;
194 $self->{_test_mode} = 0;
195 }
196  
197 sub is_test_mode_active {
198 my ($self) = @_;
199 return $self->{_test_mode};
200 }
201  
202 sub is_authorized {
203 my ($self) = @_;
204 return $self->_request('auth') ? 0 : 1;
205 }
206  
207 sub send_sms {
208 my ($self, %args) = @_;
209  
210 $self->_validate_phone_number($args{number});
211 die "Text must be between 2 and 640 characters"
212 unless length($args{text}) >= 2 && length($args{text}) <= 640;
213  
214 my $data = {
215 text => $args{text},
216 sign => $args{sign} || $self->{_signature}
217 };
218  
219 if (ref $args{number} eq 'ARRAY') {
220 $data->{numbers} = $args{number};
221 } else {
222 $data->{number} = $args{number};
223 }
224  
225 if ($args{date_to_send}) {
226 if (ref $args{date_to_send} eq 'Time::Piece') {
227 $data->{dateSend} = $args{date_to_send}->epoch;
228 } else {
229 die "date_to_send must be a Time::Piece object";
230 }
231 }
232  
233 $data->{callbackUrl} = $args{callback_url} if $args{callback_url};
234  
235 return $self->_request(
236 $self->{_test_mode} ? 'sms/testsend' : 'sms/send',
237 $data
238 );
239 }
240  
241 sub sms_status {
242 my ($self, $sms_id) = @_;
243  
244 return $self->_request(
245 $self->{_test_mode} ? 'sms/teststatus' : 'sms/status',
246 { id => int($sms_id) }
247 );
248 }
249  
250 sub send_telegram {
251 my ($self, %args) = @_;
252  
253 $self->_validate_phone_number($args{number});
254 die "Code must be a 4 to 8 digit integer"
255 unless defined $args{code} && $args{code} =~ /^\d{4,8}$/;
256  
257 my $data = {
258 code => int($args{code}),
259 };
260  
261 if (ref $args{number} eq 'ARRAY') {
262 $data->{numbers} = $args{number};
263 } else {
264 $data->{number} = $args{number};
265 }
266  
267 $data->{sign} = $args{sign} if defined $args{sign};
268 $data->{text} = $args{text} if defined $args{text};
269  
270 return $self->_request(
271 'telegram/send',
272 $data
273 );
274 }
275  
276 sub telegram_status {
277 my ($self, $telegram_id) = @_;
278  
279 return $self->_request(
280 'telegram/status',
281 { id => int($telegram_id) }
282 );
283 }
284  
285 sub send_mobile_id {
286 my ($self, %args) = @_;
287  
288 die "number is required" unless defined $args{number};
289 die "sign is required" unless defined $args{sign};
290 die "callback_url is required" unless defined $args{callback_url};
291  
292 $self->_validate_phone_number($args{number});
293  
294 return $self->_request(
295 'mobile-id/send',
296 {
297 number => $args{number},
298 sign => $args{sign},
299 callbackUrl => $args{callback_url},
300 }
301 );
302 }
303  
304 sub mobile_id_status {
305 my ($self, $req_id) = @_;
306  
307 return $self->_request(
308 'mobile-id/status',
309 { id => int($req_id) }
310 );
311 }
312  
313 sub verify_mobile_id {
314 my ($self, %args) = @_;
315  
316 die "req_id is required" unless defined $args{req_id};
317 die "code is required" unless defined $args{code};
318 die "sign is required" unless defined $args{sign};
319  
320 return $self->_request(
321 'mobile-id/verify',
322 {
323 id => int($args{req_id}),
324 code => $args{code},
325 sign => $args{sign},
326 }
327 );
328 }
329  
330 sub sms_list {
331 my ($self, %args) = @_;
332  
333 my $data = {};
334 if ($args{number}) {
335 if (ref $args{number} eq 'ARRAY') {
336 $data->{numbers} = $args{number};
337 } else {
338 $data->{number} = $args{number};
339 }
340 }
341 $data->{text} = $args{text} if $args{text};
342  
343 return $self->_request(
344 $self->{_test_mode} ? 'sms/testlist' : 'sms/list',
345 $data,
346 $args{page}
347 );
348 }
349  
350 sub balance {
351 my ($self) = @_;
352 return $self->_request('balance');
353 }
354  
355 sub balance_add {
356 my ($self, $amount, $card_id) = @_;
357 return $self->_request('balance/add', {
358 sum => $amount + 0,
359 cardId => int($card_id)
360 });
361 }
362  
363 sub cards {
364 my ($self) = @_;
365 return $self->_request('cards');
366 }
367  
368 sub tariffs {
369 my ($self) = @_;
370 return $self->_request('tariffs');
371 }
372  
373 sub sign_list {
374 my ($self, $page) = @_;
375 return $self->_request('sign/list', undef, $page);
376 }
377  
378 sub group_add {
379 my ($self, $name) = @_;
380 return $self->_request('group/add', { name => $name });
381 }
382  
383 sub group_delete {
384 my ($self, $group_id) = @_;
385 return $self->_request('group/delete', { id => int($group_id) }) ? 0 : 1;
386 }
387  
388 sub group_delete_all {
389 my ($self) = @_;
390 return $self->_request('group/delete-all') ? 0 : 1;
391 }
392  
393 sub group_list {
394 my ($self, $page) = @_;
395 return $self->_request('group/list', undef, $page);
396 }
397  
398 sub contact_add {
399 my ($self, %args) = @_;
400  
401 my $data = {
402 number => $args{number},
403 groupId => $args{group_id} && int($args{group_id}),
404 birthday => $args{birthday},
405 sex => $args{sex},
406 lname => $args{last_name},
407 fname => $args{first_name},
408 sname => $args{surname},
409 param1 => $args{param1},
410 param2 => $args{param2},
411 param3 => $args{param3}
412 };
413  
414 return $self->_request('contact/add', $data);
415 }
416  
417 sub contact_delete {
418 my ($self, $contact_id) = @_;
419 return $self->_request('contact/delete', { id => int($contact_id) }) ? 0 : 1;
420 }
421  
422 sub contact_delete_all {
423 my ($self) = @_;
424 return $self->_request('contact/delete-all') ? 0 : 1;
425 }
426  
427 sub contact_list {
428 my ($self, %args) = @_;
429  
430 my $data = {
431 number => $args{number},
432 groupId => $args{group_id} && int($args{group_id}),
433 birthday => $args{birthday},
434 sex => $args{sex},
435 operator => $args{operator},
436 lname => $args{last_name},
437 fname => $args{first_name},
438 sname => $args{surname}
439 };
440  
441 return $self->_request('contact/list', $data, $args{page});
442 }
443  
444 sub blacklist_add {
445 my ($self, $number) = @_;
446  
447 my $data = ref $number eq 'ARRAY' ?
448 { numbers => $number } :
449 { number => $number };
450  
451 return $self->_request('blacklist/add', $data);
452 }
453  
454 sub blacklist_list {
455 my ($self, %args) = @_;
456  
457 my $data;
458 if ($args{number}) {
459 $data = ref $args{number} eq 'ARRAY' ?
460 { numbers => $args{number} } :
461 { number => $args{number} };
462 }
463  
464 return $self->_request('blacklist/list', $data, $args{page});
465 }
466  
467 sub blacklist_delete {
468 my ($self, $blacklist_id) = @_;
469 return $self->_request('blacklist/delete', { id => int($blacklist_id) }) ? 0 : 1;
470 }
471  
472 sub hlr_check {
473 my ($self, $number) = @_;
474  
475 my $data = ref $number eq 'ARRAY' ?
476 { numbers => $number } :
477 { number => $number };
478  
479 return $self->_request('hlr/check', $data);
480 }
481  
482 sub hlr_status {
483 my ($self, $hlr_id) = @_;
484 return $self->_request('hlr/status', { id => int($hlr_id) });
485 }
486  
487 sub number_operator {
488 my ($self, $number) = @_;
489  
490 my $data = ref $number eq 'ARRAY' ?
491 { numbers => $number } :
492 { number => $number };
493  
494 return $self->_request('number/operator', $data);
495 }
496  
497 sub viber_send {
498 my ($self, %args) = @_;
499  
500 my $data = {
501 sign => $args{sign},
502 channel => $args{channel},
503 text => $args{text},
504 imageSource => $args{image_source},
505 textButton => $args{text_button},
506 linkButton => $args{link_button},
507 dateSend => $args{date_send},
508 signSms => $args{sign_sms},
509 channelSms => $args{channel_sms},
510 textSms => $args{text_sms},
511 priceSms => $args{price_sms}
512 };
513  
514 if ($args{number}) {
515 if (ref $args{number} eq 'ARRAY') {
516 $data->{numbers} = $args{number};
517 } else {
518 $data->{number} = $args{number};
519 }
520 }
521 $data->{groupId} = int($args{group_id}) if $args{group_id};
522  
523 return $self->_request('viber/send', $data);
524 }
525  
526 sub viber_sign_list {
527 my ($self) = @_;
528 return $self->_request('viber/sign/list');
529 }
530  
531 sub viber_list {
532 my ($self, $page) = @_;
533 return $self->_request('viber/list', undef, $page);
534 }
535  
536 sub viber_statistics {
537 my ($self, $sending_id, $page) = @_;
538 return $self->_request('viber/statistic',
539 { sendingId => int($sending_id) },
540 $page
541 );
542 }
543  
544 1;