Merge pull request #29 from ivanaugustobd/master

Suporte à timeout nas requisições ⏰

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{php,phtml,json}]
+indent_size = 4

.gitignore

@@ -1 +1,2 @@
+.php_cs.cache
 /vendor

.php_cs

@@ -0,0 +1,54 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'combine_consecutive_unsets' => true,
+        'method_separation' => true,
+        'no_multiline_whitespace_before_semicolons' => true,
+        'single_quote' => true,
+        'binary_operator_spaces' => [
+            'align_double_arrow' => false,
+            'align_equals' => false,
+        ],
+        'blank_line_before_return' => true,
+        'braces' => [
+            'allow_single_line_closure' => true,
+        ],
+        'concat_space' => [
+            'spacing' => 'one'
+        ],
+        'declare_equal_normalize' => true,
+        'function_typehint_space' => true,
+        'hash_to_slash_comment' => true,
+        'include' => true,
+        'lowercase_cast' => true,
+        'no_blank_lines_after_class_opening' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_extra_consecutive_blank_lines' => [
+            'curly_brace_block',
+            'extra',
+            'parenthesis_brace_block',
+            'square_brace_block',
+            'throw',
+            'use',
+        ],
+        'no_multiline_whitespace_around_double_arrow' => true,
+        'no_singleline_whitespace_before_semicolons' => true,
+        'no_spaces_around_offset' => true,
+        'no_unneeded_control_parentheses' => true,
+        'no_unused_imports' => true,
+        'no_whitespace_before_comma_in_array' => true,
+        'no_whitespace_in_blank_line' => true,
+        'object_operator_without_whitespace' => true,
+        'phpdoc_align' => true,
+        'phpdoc_indent' => true,
+        'phpdoc_no_useless_inheritdoc' => true,
+        'phpdoc_trim' => true,
+        'single_blank_line_before_namespace' => true,
+        'ternary_operator_spaces' => true,
+        'trim_array_spaces' => true,
+        'unary_operator_spaces' => true,
+        'whitespace_after_comma_in_array' => true,
+    ]);

README.md

@@ -34,7 +34,7 @@ Se um veículo com a placa especificada for encontrado, o servidor irá retornar
 - *chassi*: chassi do veículo
 - *dataAtualizacaoCaracteristicasVeiculo*: data atualização das características do veículo
 - *dataAtualizacaoRouboFurto*: data atualização de informações sobre roubo ou furto
-- *dataAtualizacaoAlarme*: 
+- *dataAtualizacaoAlarme*:
 
 Essas informações estarão disponíveis por meio de um `array associativo` ou como `atributo` do objeto.
 
@@ -110,6 +110,21 @@ $veiculo->buscar('GWW-6471', ['ip' => '177.54.144.208', 'porta' => '80']); // a
 print_r($veiculo->dados());
 ```
 
+## Timeout
+Uma vez que o SINESP não mata sua requisição após bloqueio, é provável que você acabe se deparando com erro(s) 504. A fim de evitar transtorno, foi disponibilizado o método `timeout` para definir um tempo máximo de resposta:
+
+```php
+$veiculo->timeout(5); // tempo em segundos
+```
+
+*Dica:* Em combinação com o [proxy](#proxy) (fazendo múltiplas tentativas com diferentes proxies), isso poderá aumentar consideravelmente suas chances de sucesso para múltiplas requisições
+
+![Múltiplos erros 504 com diferentes proxies, mas sem timeout](images/without_proxy_and_timeout.png)
+*Com diferentes proxies, mas sem timeout*
+
+![Maior parte dos 504 contornados usando proxy + timeout](images/with_proxy_and_timeout.png)
+*Com diferentes proxies e timeout*
+
 # Sinesp Python API Client
 
 Uma implementação em linguagem `Python` encontra-se disponível no seguinte repositório: https://github.com/victor-torres/sinesp-client/

src/Sinesp.php

@@ -12,6 +12,12 @@ class Sinesp
     private $response = '';
     private $dados = [];
 
+    /**
+     * Time (in seconds) to wait for a response
+     * @var int
+     */
+    private $timeout = null;
+
     public function buscar($placa, array $proxy = [])
     {
         if ($proxy) {
@@ -20,6 +26,8 @@ public function buscar($placa, array $proxy = [])
 
         $this->setUp($placa);
         $this->exec();
+
+        return $this;
     }
 
     public function dados()
@@ -32,6 +40,18 @@ public function proxy($ip, $porta)
         $this->proxy = $ip . ':' . $porta;
     }
 
+    /**
+     * Set a timeout for request(s) that will be made
+     * @param  int  $seconds How much seconds to wait
+     * @return self
+     */
+    public function timeout($seconds)
+    {
+        $this->timeout = $seconds;
+
+        return $this;
+    }
+
     public function __get($name)
     {
         return array_key_exists($name, $this->dados) ? $this->dados[$name] : '';
@@ -53,13 +73,13 @@ private function obterResposta()
     {
         $xml = $this->xml();
 
-        $headers = array(
-            "Content-type: text/xml;charset=\"utf-8\"",
-            "Accept: text/xml",
-            "Cache-Control: no-cache",
-            "Pragma: no-cache",
-            "Content-length: ".strlen($xml),
-        );
+        $headers = [
+            'Content-type: text/xml;charset="utf-8"',
+            'Accept: text/xml',
+            'Cache-Control: no-cache',
+            'Pragma: no-cache',
+            'Content-length: ' . strlen($xml),
+        ];
 
         $ch = curl_init();
         curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
@@ -69,6 +89,11 @@ private function obterResposta()
             curl_setopt($ch, CURLOPT_PROXY, $this->proxy);
         }
 
+        if ($this->timeout) {
+            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->timeout);
+            curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
+        }
+
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
@@ -80,7 +105,7 @@ private function obterResposta()
 
     private function tratarResposta()
     {
-        if (! $this->response) {
+        if (!$this->response) {
             throw new \Exception('O servidor retornou nenhuma resposta!');
         }
 
@@ -91,11 +116,11 @@ private function tratarResposta()
 
     private function verificarRequisitos()
     {
-        if (! function_exists('curl_init')) {
+        if (!function_exists('curl_init')) {
             throw new \Exception('Incapaz de processar. PHP requer biblioteca cURL');
         }
 
-        if (! function_exists('simplexml_load_string')) {
+        if (!function_exists('simplexml_load_string')) {
             throw new \Exception('Incapaz de processar. PHP requer biblioteca libxml');
         }
 
@@ -106,7 +131,7 @@ private function setUp($placa)
     {
         $placa = $this->ajustar($placa);
 
-        if (! $this->validar($placa)) {
+        if (!$this->validar($placa)) {
             throw new \Exception('Placa do veiculo nao especificada ou em formato invalido!');
         }
 
@@ -120,7 +145,7 @@ private function token()
 
     private function xml()
     {
-        $xml=<<<EOX
+        $xml = <<<EOX
 <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
 <v:Envelope xmlns:v="http://schemas.xmlsoap.org/soap/envelope/">
 <v:Header>
@@ -143,6 +168,7 @@ private function xml()
 </v:Body>
 </v:Envelope>
 EOX;
+
         return sprintf($xml, $this->latitude(), $this->token(), $this->longitude(), strftime('%Y-%m-%d %H:%M:%S'), $this->placa);
     }