nfeplace-client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e14c965eedc1adc5cb279365755fa4c03a0bc8d
-  data.tar.gz: 8d9184ff9292deff5ddc6d1e64fb46ce20bc1c92
+  metadata.gz: 7a11db98db9c51b6506abade778098f57551c8a2
+  data.tar.gz: 6ae447dd2290fed4d967ccad5dd27bdf8dcde5bf
 SHA512:
-  metadata.gz: 10a4de5566e9b035da8e89e545fd83054aee9608dbc8f8d24bd97f73f52bea438f5c167284cdf942c0aa161270ace47e6932f9c6710aaf0c75112c56fa64391f
-  data.tar.gz: f581a8bf42eed10e7de69b46f5ef3cbb456c81be9f9918a69c20b6a5aa6aa85b33b3d68e2a75b3c05448ac61eed09ef0fede4f6407dc475e0d21ff7ffb1cfd25
+  metadata.gz: f81578a583cf195d1d58e660497d22234d4e651e1333ff49ef2d2d465c8de8a22a24990f39d3cbb4b171a5c9c56c208a907f805e5a36e466627af3f140db5b1e
+  data.tar.gz: a1ce96bbc6983ce96cef8a108601ec50a37933be472efa726d5e04080faf932e3e92fdedc9c8e67174c352f5b99f658a2a48721277fef055768bd9401a9416fb

data/README.md

@@ -1,4 +1,4 @@
-# Nfedobrasil
+# NfedoBrasil
 
 Gem to interact with NFEdoBrasil SOAP API.
 
@@ -20,7 +20,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+This gem is just a wrapper around [Savon](http://savonrb.com/) which [monkey
+patches](https://en.wikipedia.org/wiki/Monkey_patch) (yes... I know =[) both Savon and
+[HTTPI](http://httpirb.com/) so that they can work with P12 authentication
+required by NFEdoBrasil.
+
+```ruby
+require 'nfedobrasil'
+# For dev mode access:
+client = NfedoBrasil.client({ssl_plcs_file: './hml_natue.p12', ssl_plcs_password: 'y7bYntT3F'}, true)
+
+# For production access:
+client = NfedoBrasil.client({ssl_plcs_file: './hml_natue.p12', ssl_plcs_password: 'y7bYntT3F'})
+
+# Now just consume the API using Savon
+client.operations
+# => [:enviar, :analisa_n_fe, :consultar, :consulta_token, :cancelar, :carta_correcao, :inutilizar, :consultar_cadastro_sefaz, :consultar_nota_sefaz, :status_servico, :retorna_danfe, :retorna_chaves, :retorna_xmls, :insere_emissor, :insere_armazenamento, :existe_emissor, :existe_armazenamento]
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec

data/lib/nfedobrasil.rb

@@ -1,5 +1,16 @@
-require "nfedobrasil/version"
+require 'savon'
+require_relative 'nfedobrasil/monkey_patches'
+require_relative 'nfedobrasil/version'
 
-module Nfedobrasil
-  # Your code goes here...
+module NfedoBrasil
+  def self.client(config = {}, dev_mode = false)
+    config = {
+      wsdl: (dev_mode ?
+        'https://dev.sistema.nfeplace.com.br/services/emissor?wsdl' :
+        'https://sistema.nfeplace.com.br/services/emissor?wsdl'),
+      ssl_verify_mode: :none
+    }.merge config
+
+    Savon.client config
+  end
 end

data/lib/nfedobrasil/monkey_patches.rb

@@ -0,0 +1,59 @@
+# Add P12 support for savon
+# Inspiration: https://gist.github.com/phaus/3313756
+module Savon
+  class GlobalOptions
+    def ssl_plcs_file(ssl_plcs_file)
+      @options[:ssl_plcs_file] = ssl_plcs_file
+    end
+
+    def ssl_plcs_password(ssl_plcs_password)
+      @options[:ssl_plcs_password] = ssl_plcs_password
+    end
+  end
+
+  class HTTPRequest
+    def configure_ssl
+      @http_request.auth.ssl.ssl_version   = @globals[:ssl_version]       if @globals.include? :ssl_version
+      @http_request.auth.ssl.verify_mode   = @globals[:ssl_verify_mode]   if @globals.include? :ssl_verify_mode
+
+      @http_request.auth.ssl.cert_key_file = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
+      @http_request.auth.ssl.cert_key      = @globals[:ssl_cert_key]      if @globals.include? :ssl_cert_key
+      @http_request.auth.ssl.cert_file     = @globals[:ssl_cert_file]     if @globals.include? :ssl_cert_file
+      @http_request.auth.ssl.cert          = @globals[:ssl_cert]          if @globals.include? :ssl_cert
+      @http_request.auth.ssl.ca_cert_file  = @globals[:ssl_ca_cert_file]  if @globals.include? :ssl_ca_cert_file
+      @http_request.auth.ssl.ca_cert       = @globals[:ssl_ca_cert]       if @globals.include? :ssl_ca_cert
+
+      @http_request.auth.ssl.cert_key_password = @globals[:ssl_cert_key_password] if @globals.include? :ssl_cert_key_password
+
+      if (@globals.include?(:ssl_plcs_file) and @globals.include?(:ssl_plcs_password))
+        @http_request.auth.ssl.plcs_file @globals[:ssl_plcs_file], @globals[:ssl_plcs_password]
+      end
+    end
+  end
+end
+
+module HTTPI
+  module Auth
+    class SSL
+      def plcs_file(file, password)
+        @pkcs12 = OpenSSL::PKCS12.new(File.read(file), password)
+      end
+
+      def cert
+        if @pkcs12
+          @cert ||= @pkcs12.certificate
+        else
+          @cert ||= (OpenSSL::X509::Certificate.new File.read(cert_file) if cert_file)
+        end
+      end
+
+      def cert_key
+        if @pkcs12
+          @cert_key ||= @pkcs12.key
+        else
+          @cert_key ||= (OpenSSL::PKey.read(File.read(cert_key_file), cert_key_password) if cert_key_file)
+        end
+      end
+    end
+  end
+end

data/lib/nfedobrasil/version.rb

@@ -1,3 +1,3 @@
-module Nfedobrasil
-  VERSION = "0.0.1"
+module NfedoBrasil
+  VERSION = '0.1.0'
 end

data/nfedobrasil.gemspec

@@ -5,19 +5,23 @@ require 'nfedobrasil/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'nfeplace-client'
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ['Edson Lima','Paulo Gomes', 'Diogo Tozzi']
   spec.email         = ['dddwebdeveloper@gmail.com', 'pv.gomes89@gmail.com', 'diogo.tozzi@natue.com.br']
   spec.summary       = %q{Gem to interact with NFEPlace SOAP API.}
   spec.description   = %q{Gem to interact with NFEPlace SOAP API. Enables creation, consultation and import of invoices.}
   spec.homepage      = 'https://github.com/natuelabs/nfeplace-client'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'savon', '~> 2.11.1'
+
+  spec.add_development_dependency 'bundler',   '~>  1.7'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~>  3.2.0'
+  spec.add_development_dependency 'simplecov', '~>  0.10'
 end

data/spec/lib/nfedobrasil_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe NfedoBrasil do
+  describe '#client' do
+    subject { NfedoBrasil.client({ssl_plcs_file: File.dirname(__FILE__) + '/../support/certificate.p12', ssl_plcs_password: 'nughee1O'}) }
+
+    it 'returns a Savon client' do
+      expect(subject).to be_a Savon::Client
+      expect(subject.globals[:wsdl]).to match(/https:\/\/sistema/)
+    end
+
+    it 'fails because cert is invalid' do
+      expect{subject.operations}.to raise_error(HTTPI::SSLError)
+    end
+  end
+
+  describe 'dev mode' do
+    subject { NfedoBrasil.client({ssl_plcs_file: File.dirname(__FILE__) + '/../support/certificate.p12', ssl_plcs_password: 'nughee1O'}, true) }
+
+    it 'handles dev mode properly' do
+      expect(subject.globals[:wsdl]).to match(/https:\/\/dev.sistema/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec'
+end if ENV['COVERAGE']
+
+require File.expand_path('../../lib/nfedobrasil', __FILE__)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nfeplace-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Edson Lima
@@ -12,6 +12,20 @@ bindir: bin
 cert_chain: []
 date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: Gem to interact with NFEPlace SOAP API. Enables creation, consultation
   and import of invoices.
 email:
@@ -56,8 +98,12 @@ files:
 - README.md
 - Rakefile
 - lib/nfedobrasil.rb
+- lib/nfedobrasil/monkey_patches.rb
 - lib/nfedobrasil/version.rb
 - nfedobrasil.gemspec
+- spec/lib/nfedobrasil_spec.rb
+- spec/spec_helper.rb
+- spec/support/certificate.p12
 homepage: https://github.com/natuelabs/nfeplace-client
 licenses:
 - MIT
@@ -82,4 +128,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem to interact with NFEPlace SOAP API.
-test_files: []
+test_files:
+- spec/lib/nfedobrasil_spec.rb
+- spec/spec_helper.rb
+- spec/support/certificate.p12