rastreioz 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796879e6c97c04645bf89e9dd3b3d6e75214103c8d57dcbcb73cddc002467c5c
-  data.tar.gz: fbded9f7d85184500404fd2ceb75c8e2573e519901b31f5de0c9edab9e9b40f4
+  metadata.gz: e09e701d07a19608cb5110b075adec290d5f40c28f0bd2ec34b66dbfe7a91ede
+  data.tar.gz: 18f030e906cef37369a89b4e073ec6da443a602eed24b684b83c449bae623f3c
 SHA512:
-  metadata.gz: 7abeea7fcb8f48da138f0c04954c3c6098448ea25e3ddd582216b8f041472889c0eb67cd9f84ea3d36606bc14185b10a447fa8b9ab74238d0fa5772039127421
-  data.tar.gz: 566a5ae76e4253cb11f6ca4c1b7c4e8d3b4feb4d1310dcef2f107fedeaecd8efee9200ac721fe67cc3a6c879a464ee050b85f864f6919c79f0d59064a074c4ff
+  metadata.gz: '09984ce5dabaf2fe364caf4afee6eca6a81a8c78efd9b54a8e91e5d3d61e24fdfa3597658b71d789f4ee4d2f3cac802bbd29a96d8b6aef6e8036486d07b7effe'
+  data.tar.gz: 5871f80d98f62501314351869f5b1f693ba40fd52ca6b07573f643f750adeda064430f9d5d3c3aeb46fdc9820f22b8e619cb58f4f63962bb5e219abebe07cd52

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+data/pstore
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,43 +1,104 @@
 # Rastreioz
 
-VERSÃO ALFA DE TESTE!
+Esta Gem pertence ao serviço Rastreioz, que permite consultar o serviço de calculo de preços e prazos, rastreamento de encomenda e consulta de endereços diretamente dos Correios, com resultado armazenado em cache de algumas horas para aumentar a velocidade e disponibilidade da consulta.
 
-Rastreioz::Prazo.calcular([:e_sedex, :sedex_10, :pac_com_contrato, :sedex_com_contrato_1], {cep_origem: 22041030, cep_destino: 22041030, peso: 1, formato: :caixa_pacote, comprimento: 20, altura: 4, largura: 11, diametro: 20, valor_declarado: 25.00})
+O Rastreioz fornece os resultados dessa consulta através de uma API autenticada que está sendo disponibilizada
+sem custo adicional, porém, é possível que no futuro ocorra a a cobrança de uma taxa anual somente para a manutenção e hospedagem dos serviços. Ainda assim, se esse serviço for útil para você ou seu site, aceitamos sua doação para ajudar a pagar o café :)
 
-## Installation
+A implementação da API utiliza a linguagem Ruby no serviço Lambda da AWS e essa Gem faz a interface com os recursos, além da autenticação por JWT.
 
-Add this line to your application's Gemfile:
+VERSÃO BETA: Atenção, essa API e a Gem são utilizadas por uma loja virtual em produção e já recebeu mais de 4.8k requisições desde que foi iniciado a utilização em 19/12/18 até o período de 20/01/19. A utilização em produção, apesar do bom resultado, é por sua conta e risco. O Rastreioz não se responsabiliza por eventuais interrupções do serviço ou mudança da API no período Beta.
+
+## Instalação
+
+Inclua essa linha ao arquivo Gemfile da sua aplicação:
 
 ```ruby
 gem 'rastreioz'
 ```
 
-And then execute:
+E então execute o comando:
 
     $ bundle
 
-Or install it yourself as:
+Ou instale separadamente dessa forma:
 
     $ gem install rastreioz
 
-## Usage
+## Uso
+
+1) Primeiro você deve criar uma conta para ter acesso a api_key e a api_password gerados automáticamente no cadastro. Obs: Possíveis abusos serão excluídos sem aviso.
+
+    $ curl -H "Content-Type: application/x-www-form-urlencoded" -X POST https://api.rastreioz.com/users/signup -d 'email=usuario@dominio.com.br&full_name=Seu Nome&password=12345678&password_confirmation=12345678'
+
+```
+{"message":"Account created successfully","auth_token":"eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZmFkM2MyMzItYzZjNy00MjI2LWI1N2ItNDc2Y2ZlM2JlNzQzIiwiZXhwIjoxNTQ3NTEwODA1fQ.W0ftZ_LX_j14ybNwZ1b1G6LeMQA8C--_JQirXdkXRUU","api_key":"ak_5c5743369a774b78993966d8c2d8a1f5","api_password":"d7f259ac4812bde6dfc67523304a1244"}
+```
+
+2) Após receber a api_key e a api_password, você deve guardar com segurança essa informações, pois não podem ser regeradas 
+neste momento e a api_password não será exibida novamente.
+
+```ruby
+Rastreioz.api_key = "ak_5c5743369a774b78993966d8c2d8a1f5"
+Rastreioz.api_password = "d7f259ac4812bde6dfc67523304a1244"
+```
+
+3) Após a configuração da gem com a api_key e a api_password recebida, é possível calcular o custo e o prazo da entrega dos serviços sem um contrato com o Correios:
+
+Serviços disponíveis:
+
+```ruby
+AVAILABLE_SERVICES = {
+  "4510"  => { :type => :pac,                         :name => "PAC",            :description => "PAC sem contrato"                  },
+  "41068" => { :type => :pac_com_contrato,            :name => "PAC",            :description => "PAC com contrato"                  },
+  "4669"  => { :type => :pac_com_contrato_2,          :name => "PAC",            :description => "PAC com contrato"                  },
+  "41300" => { :type => :pac_gf,                      :name => "PAC GF",         :description => "PAC para grandes formatos"         },
+  "4014"  => { :type => :sedex,                       :name => "SEDEX",          :description => "SEDEX sem contrato"                },
+  "40045" => { :type => :sedex_a_cobrar,              :name => "SEDEX a Cobrar", :description => "SEDEX a Cobrar, sem contrato"      },
+  "40126" => { :type => :sedex_a_cobrar_com_contrato, :name => "SEDEX a Cobrar", :description => "SEDEX a Cobrar, com contrato"      },
+  "40215" => { :type => :sedex_10,                    :name => "SEDEX 10",       :description => "SEDEX 10, sem contrato"            },
+  "40290" => { :type => :sedex_hoje,                  :name => "SEDEX Hoje",     :description => "SEDEX Hoje, sem contrato"          },
+  "40096" => { :type => :sedex_com_contrato_1,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "40436" => { :type => :sedex_com_contrato_2,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "40444" => { :type => :sedex_com_contrato_3,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "40568" => { :type => :sedex_com_contrato_4,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "40606" => { :type => :sedex_com_contrato_5,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "4162"  => { :type => :sedex_com_contrato_6,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+  "81019" => { :type => :e_sedex,                     :name => "e-SEDEX",        :description => "e-SEDEX, com contrato"             },
+  "81027" => { :type => :e_sedex_prioritario,         :name => "e-SEDEX",        :description => "e-SEDEX Prioritário, com contrato" },
+  "81035" => { :type => :e_sedex_express,             :name => "e-SEDEX",        :description => "e-SEDEX Express, com contrato"     },
+  "81868" => { :type => :e_sedex_grupo_1,             :name => "e-SEDEX",        :description => "(Grupo 1) e-SEDEX, com contrato"   },
+  "81833" => { :type => :e_sedex_grupo_2,             :name => "e-SEDEX",        :description => "(Grupo 2) e-SEDEX, com contrato"   },
+  "81850" => { :type => :e_sedex_grupo_3,             :name => "e-SEDEX",        :description => "(Grupo 3) e-SEDEX, com contrato"   }
+}
+```
+Calcular valor do Frete:
 
-TODO: Write usage instructions here
+```ruby
+Rastreioz::Frete.calcular([:pac, :sedex, :sedex_10], {cep_origem: '01154-010', cep_destino: '06351-140', peso: 2, formato: :caixa_pacote, comprimento: 20, altura: 20, largura: 20, diametro: 20, valor_declarado: 115.00})
+```
+
+Caso você tenha um contrato com o correio, pode informar o seu código_empresa e a senha. Essas informações não são armazenadas pelo Rastreioz.
+
+```ruby
+Rastreioz::Frete.calcular([:e_sedex, :sedex_10, :pac_com_contrato, :sedex_com_contrato_1], {cep_origem: '01154-010', cep_destino: '06351-140', peso: 2, formato: :caixa_pacote, comprimento: 20, altura: 20, largura: 20, diametro: 20, valor_declarado: 115.00, codigo_empresa: 11111111, senha: 11111111})
+```
+4) A próxima estapa será mostrar o rastreamento dos correios. Ainda em construção.
 
-## Development
+## Desenvolvimento
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+## Contribuição
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/base16soft/rastreioz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Avisos de erros e pull requests são bem vindos nesse repositório https://github.com/base16soft/rastreioz. O projeto destina-se a ser um espaço seguro e acolhedor para colaboração, e espera-se que os colaboradores sigam o código de conduta do [Pacto do Colaborador](http://contributor-covenant.org)
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+O código fonte dessa gem está disponível sob os termos da [licença MIT](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## Código de Conduta
 
-Everyone interacting in the Rastreioz project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rastreioz/blob/master/CODE_OF_CONDUCT.md).
+Qualquer interação o código base dessa gem, dúvidas, avisos de erros (issues) ou troca de mensagens deve seguir o seguinte [código de conduta](https://github.com/base16soft/rastreioz/blob/master/CODE_OF_CONDUCT.md).

data/lib/rastreioz.rb

@@ -7,6 +7,7 @@ require 'uri'
 require "rastreioz/version"
 require "rastreioz/log"
 require "rastreioz/http"
+require "rastreioz/auth"
 require "rastreioz/servico"
 require "rastreioz/rastreamento"
 require "rastreioz/frete"
@@ -27,12 +28,23 @@ module Rastreioz
   extend Timeout
 
   class << self
-    def auth=(credentials)
-      @credentials = credentials
+
+    def default_url
+      "https://api.rastreioz.com"
     end
 
-    def auth
-      @credentials
+    def api_key=(api_key)
+      @api_key = api_key
+    end
+    def api_key
+      @api_key
+    end
+
+    def api_password=(api_password)
+      @api_password = api_password
+    end
+    def api_password
+      @api_password
     end
   end
 

data/lib/rastreioz/auth.rb

@@ -0,0 +1,38 @@
+require 'pstore'
+require 'tmpdir'
+
+module Rastreioz
+  class Auth
+
+    def token(use_ssl = true)
+
+      auth_token = nil
+      if !Rastreioz.api_key.nil? && !Rastreioz.api_password.nil?
+        temp_dir = Rails.root.join('tmp') rescue Dir.tmpdir()
+        store = PStore.new("#{temp_dir}/pstore.data")
+
+        auth_token = store.transaction { store[:auth_token] }
+        expires_in = store.transaction { store[:expires_in] }
+        
+        if auth_token.nil? || Time.now.to_i > expires_in.to_i
+          uri = URI.parse("#{Rastreioz.default_url}/users/login")
+          http = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: use_ssl, verify_mode: OpenSSL::SSL::VERIFY_NONE)
+          request = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/x-www-form-urlencoded'})
+          request.body = {api_key: Rastreioz.api_key, api_password: Rastreioz.api_password}.to_json
+          response = Rastreioz::Log.new.with_log {
+            http.request(request)
+          }
+          response_body = JSON.parse(response.body)
+          auth_token = response_body["auth_token"]
+          store.transaction do
+            store[:auth_token] = auth_token
+            store[:expires_in] = Time.now + 23*60*60
+          end
+        end
+        auth_token
+      end
+
+    end
+
+  end
+end

data/lib/rastreioz/cep.rb

@@ -3,8 +3,6 @@ module Rastreioz
 
     attr_accessor :bairro, :cep, :localidade, :logradouro, :uf
 
-    URL = "https://api.rastreioz.com/cep"
-
     def initialize(options = {})
     end
 

data/lib/rastreioz/frete.rb

@@ -17,7 +17,6 @@ module Rastreioz
       :valor_declarado => 0.0
     }
 
-    URL = "https://api.rastreioz.com/frete/prazo"
     FORMATS = { :caixa_pacote => 1, :rolo_prisma => 2, :envelope => 3 }
     CONDITIONS = { true => "S", false => "N" }
 
@@ -29,16 +28,12 @@ module Rastreioz
 
     def calcular(service_types)
       servicos = {}
-      begin
-        url = "#{URL}?#{params_for(service_types)}"
-        response = Rastreioz::Log.new.with_log {Rastreioz::Http.new.http_request(url)}
-        response_body = JSON.parse(response.body)
-        response_body.each do |element|
-          servico = Rastreioz::Servico.new.parse(element)
-          servicos[servico.tipo] = servico
-        end
-      rescue
-        raise "Falha na Consulta ao Correio"
+      url = "#{Rastreioz.default_url}/frete/prazo?#{params_for(service_types)}"
+      response = Rastreioz::Log.new.with_log {Rastreioz::Http.new.http_request(url)}
+      response_body = JSON.parse(response.body)
+      response_body.each do |element|
+        servico = Rastreioz::Servico.new.parse(element)
+        servicos[servico.tipo] = servico
       end
       servicos
     end
@@ -50,20 +45,20 @@ module Rastreioz
     private
 
     def params_for(service_types)
-      res = "sCepOrigem=#{self.cep_origem}&" +
-            "sCepDestino=#{self.cep_destino}&" +
-            "nVlPeso=#{self.peso}&" +
-            "nVlComprimento=#{format_decimal(self.comprimento)}&" +
-            "nVlLargura=#{format_decimal(self.largura)}&" +
-            "nVlAltura=#{format_decimal(self.altura)}&" +
-            "nVlDiametro=#{format_decimal(self.diametro)}&" +
-            "nCdFormato=#{FORMATS[self.formato]}&" +
-            "sCdMaoPropria=#{CONDITIONS[self.mao_propria]}&" +
-            "sCdAvisoRecebimento=#{CONDITIONS[self.aviso_recebimento]}&" +
-            "nVlValorDeclarado=#{format_decimal(format("%.2f" % self.valor_declarado))}&" +
-            "nCdServico=#{service_codes_for(service_types)}"
+      res = "cep_origem=#{self.cep_origem}&" +
+        "cep_destino=#{self.cep_destino}&" +
+        "peso=#{self.peso}&" +
+        "comprimento=#{format_decimal(self.comprimento)}&" +
+        "largura=#{format_decimal(self.largura)}&" +
+        "altura=#{format_decimal(self.altura)}&" +
+        "diametro=#{format_decimal(self.diametro)}&" +
+        "formato=#{FORMATS[self.formato]}&" +
+        "mao_propria=#{CONDITIONS[self.mao_propria]}&" +
+        "aviso_recebimento=#{CONDITIONS[self.aviso_recebimento]}&" +
+        "valor_declarado=#{format_decimal(format("%.2f" % self.valor_declarado))}&" +
+        "servicos=#{service_codes_for(service_types)}"
 
-      res = "#{res}&nCdEmpresa=#{self.codigo_empresa}&sDsSenha=#{self.senha}" if self.codigo_empresa && self.senha
+      res = "#{res}&codigo_empresa=#{self.codigo_empresa}&senha=#{self.senha}" if self.codigo_empresa && self.senha
       res
     end
 
@@ -75,8 +70,6 @@ module Rastreioz
       service_codes = service_types.is_a?(Array) ? 
         service_types.map { |type| Rastreioz::Servico.code_from_type(type) }.join(",") :
         Rastreioz::Servico.code_from_type(service_types)
-      
-      puts service_codes
       service_codes
     end
 

data/lib/rastreioz/http.rb

@@ -1,28 +1,19 @@
 module Rastreioz
   class Http
 
-    def http_request(request_url)
+    def http_request(request_url, use_ssl = true)
       @uri = URI.parse(request_url)
-      @http = build_http
-
+      @http = build_http(use_ssl)
       request = Net::HTTP::Get.new(@uri)
+      request['Authorization'] = Rastreioz::Auth.new.token(use_ssl)
       http.open_timeout = Rastreioz.request_timeout
       http.request(request)
     end
 
     private 
 
-    def build_http
-      Net::HTTP.start(
-        uri.host,
-        uri.port,
-        nil,
-        nil,
-        nil,
-        nil,
-        use_ssl: true,
-        verify_mode: OpenSSL::SSL::VERIFY_NONE
-      )
+    def build_http(use_ssl)
+      Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: use_ssl, verify_mode: OpenSSL::SSL::VERIFY_NONE)
     end      
 
     attr_reader :uri, :url, :http

data/lib/rastreioz/log.rb

@@ -10,7 +10,7 @@ module Rastreioz
 
     def format_request_message(response)
       message =  with_line_break { "RastreioZ Request:" }
-      message << with_line_break { "GET #{response.uri}" }
+      message << with_line_break { "#{response.uri}" }
     end
 
     def format_response_message(response)

data/lib/rastreioz/rastreamento.rb

@@ -3,8 +3,6 @@ module Rastreioz
 
     attr_accessor :bairro, :cep, :localidade, :logradouro, :uf
 
-    URL = "https://api.rastreioz.com/cep"
-
     def initialize(options = {})
     end
 

data/lib/rastreioz/version.rb

@@ -1,3 +1,3 @@
 module Rastreioz
-  VERSION = "0.1.3"
+  VERSION = "0.1.7"
 end

data/rastreioz.gemspec

@@ -8,9 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Rastreioz::VERSION
   spec.authors       = ["Augusto Cesar S. Martins"]
   spec.email         = ["augusto@base16.com.br"]
-
-  spec.summary       = "Calculo de frete dos Correios utilizando a Rastreioz Api."
-  spec.description   = "[Alfa Version] Calculo de frete utilizando o Web Service Rastreioz.\nOs servicos de frete suportados sao PAC, SEDEX, SEDEX a Cobrar, SEDEX 10, SEDEX Hoje e e-SEDEX."
+  spec.summary       = "Consulta aos Correios utilizando a Rastreioz Api."
+  spec.description   = "Esta Gem pertence ao serviço Rastreioz, que permite consultar o serviço de calculo de preços e prazos, rastreamento de encomenda e consulta de endereços diretamente dos Correios, com resultado armazenado em cache de algumas horas para aumentar a velocidade e disponibilidade da consulta."
   spec.homepage      = "https://github.com/base16soft/rastreioz"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rastreioz
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.7
 platform: ruby
 authors:
 - Augusto Cesar S. Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log-me
@@ -66,9 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |-
-  [Alfa Version] Calculo de frete utilizando o Web Service Rastreioz.
-  Os servicos de frete suportados sao PAC, SEDEX, SEDEX a Cobrar, SEDEX 10, SEDEX Hoje e e-SEDEX.
+description: Esta Gem pertence ao serviço Rastreioz, que permite consultar o serviço
+  de calculo de preços e prazos, rastreamento de encomenda e consulta de endereços
+  diretamente dos Correios, com resultado armazenado em cache de algumas horas para
+  aumentar a velocidade e disponibilidade da consulta.
 email:
 - augusto@base16.com.br
 executables: []
@@ -85,7 +86,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- data/.keep
 - lib/rastreioz.rb
+- lib/rastreioz/auth.rb
 - lib/rastreioz/cep.rb
 - lib/rastreioz/frete.rb
 - lib/rastreioz/http.rb
@@ -117,5 +120,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Calculo de frete dos Correios utilizando a Rastreioz Api.
+summary: Consulta aos Correios utilizando a Rastreioz Api.
 test_files: []