nfse_sjc 0.1.1

data/etc/schemas/xmldsig-core-schema20020212_v03.xsd

@@ -0,0 +1,316 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Schema for XML Signatures
+    http://www.w3.org/2000/09/xmldsig#
+    $Revision: 1.7 $ on $Date: 2007/09/20 19:06:50 $ by $Author: p052373 $
+
+    Copyright 2001 The Internet Society and W3C (Massachusetts Institute
+    of Technology, Institut National de Recherche en Informatique et en
+    Automatique, Keio University). All Rights Reserved.
+    http://www.w3.org/Consortium/Legal/
+
+    This document is governed by the W3C Software License [1] as described
+    in the FAQ [2].
+
+    [1] http://www.w3.org/Consortium/Legal/copyright-software-19980720
+    [2] http://www.w3.org/Consortium/Legal/IPR-FAQ-20000620.html#DTD
+-->
+
+<!--
+
+Download em 23/02/2007
+Link: 
+	http://www.w3.org/TR/xmldsig-core/#sec-Schema
+	http://www.w3.org/TR/xmldsig-core/xmldsig-core-schema_v03.xsd
+
+-->
+
+<schema xmlns="http://www.w3.org/2001/XMLSchema"
+        xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
+        targetNamespace="http://www.w3.org/2000/09/xmldsig#"
+        version="0.1" elementFormDefault="qualified"> 
+
+<!-- Basic Types Defined for Signatures -->
+
+<simpleType name="CryptoBinary">
+  <restriction base="base64Binary">
+  </restriction>
+</simpleType>
+
+<!-- Start Signature -->
+
+<element name="Signature" type="ds:SignatureType"/>
+<complexType name="SignatureType">
+  <sequence> 
+    <element ref="ds:SignedInfo"/> 
+    <element ref="ds:SignatureValue"/> 
+    <element ref="ds:KeyInfo" minOccurs="0"/> 
+    <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/> 
+  </sequence>  
+  <attribute name="Id" type="ID" use="optional"/>
+</complexType>
+
+  <element name="SignatureValue" type="ds:SignatureValueType"/> 
+  <complexType name="SignatureValueType">
+    <simpleContent>
+      <extension base="base64Binary">
+        <attribute name="Id" type="ID" use="optional"/>
+      </extension>
+    </simpleContent>
+  </complexType>
+
+<!-- Start SignedInfo -->
+
+<element name="SignedInfo" type="ds:SignedInfoType"/>
+<complexType name="SignedInfoType">
+  <sequence> 
+    <element ref="ds:CanonicalizationMethod"/> 
+    <element ref="ds:SignatureMethod"/> 
+    <element ref="ds:Reference" maxOccurs="unbounded"/> 
+  </sequence>  
+  <attribute name="Id" type="ID" use="optional"/> 
+</complexType>
+
+  <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/> 
+  <complexType name="CanonicalizationMethodType" mixed="true">
+    <sequence>
+      <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/>
+      <!-- (0,unbounded) elements from (1,1) namespace -->
+    </sequence>
+    <attribute name="Algorithm" type="anyURI" use="required"/> 
+  </complexType>
+
+  <element name="SignatureMethod" type="ds:SignatureMethodType"/>
+  <complexType name="SignatureMethodType" mixed="true">
+    <sequence>
+      <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/>
+      <any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
+      <!-- (0,unbounded) elements from (1,1) external namespace -->
+    </sequence>
+    <attribute name="Algorithm" type="anyURI" use="required"/> 
+  </complexType>
+
+<!-- Start Reference -->
+
+<element name="Reference" type="ds:ReferenceType"/>
+<complexType name="ReferenceType">
+  <sequence> 
+    <element ref="ds:Transforms" minOccurs="0"/> 
+    <element ref="ds:DigestMethod"/> 
+    <element ref="ds:DigestValue"/> 
+  </sequence>
+  <attribute name="Id" type="ID" use="optional"/> 
+  <attribute name="URI" type="anyURI" use="optional"/> 
+  <attribute name="Type" type="anyURI" use="optional"/> 
+</complexType>
+
+  <element name="Transforms" type="ds:TransformsType"/>
+  <complexType name="TransformsType">
+    <sequence>
+      <element ref="ds:Transform" maxOccurs="unbounded"/>  
+    </sequence>
+  </complexType>
+
+  <element name="Transform" type="ds:TransformType"/>
+  <complexType name="TransformType" mixed="true">
+    <choice minOccurs="0" maxOccurs="unbounded"> 
+      <any namespace="##other" processContents="lax"/>
+      <!-- (1,1) elements from (0,unbounded) namespaces -->
+      <element name="XPath" type="string"/> 
+    </choice>
+    <attribute name="Algorithm" type="anyURI" use="required"/> 
+  </complexType>
+
+<!-- End Reference -->
+
+<element name="DigestMethod" type="ds:DigestMethodType"/>
+<complexType name="DigestMethodType" mixed="true"> 
+  <sequence>
+    <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
+  </sequence>    
+  <attribute name="Algorithm" type="anyURI" use="required"/> 
+</complexType>
+
+<element name="DigestValue" type="ds:DigestValueType"/>
+<simpleType name="DigestValueType">
+  <restriction base="base64Binary"/>
+</simpleType>
+
+<!-- End SignedInfo -->
+
+<!-- Start KeyInfo -->
+
+<element name="KeyInfo" type="ds:KeyInfoType"/> 
+<complexType name="KeyInfoType" mixed="true">
+  <choice maxOccurs="unbounded">     
+    <element ref="ds:KeyName"/> 
+    <element ref="ds:KeyValue"/> 
+    <element ref="ds:RetrievalMethod"/> 
+    <element ref="ds:X509Data"/> 
+    <element ref="ds:PGPData"/> 
+    <element ref="ds:SPKIData"/>
+    <element ref="ds:MgmtData"/>
+    <any processContents="lax" namespace="##other"/>
+    <!-- (1,1) elements from (0,unbounded) namespaces -->
+  </choice>
+  <attribute name="Id" type="ID" use="optional"/> 
+</complexType>
+
+  <element name="KeyName" type="string"/>
+  <element name="MgmtData" type="string"/>
+
+  <element name="KeyValue" type="ds:KeyValueType"/> 
+  <complexType name="KeyValueType" mixed="true">
+   <choice>
+     <element ref="ds:DSAKeyValue"/>
+     <element ref="ds:RSAKeyValue"/>
+     <any namespace="##other" processContents="lax"/>
+   </choice>
+  </complexType>
+
+  <element name="RetrievalMethod" type="ds:RetrievalMethodType"/> 
+  <complexType name="RetrievalMethodType">
+    <sequence>
+      <element ref="ds:Transforms" minOccurs="0"/> 
+    </sequence>  
+    <attribute name="URI" type="anyURI"/>
+    <attribute name="Type" type="anyURI" use="optional"/>
+  </complexType>
+
+<!-- Start X509Data -->
+
+<element name="X509Data" type="ds:X509DataType"/> 
+<complexType name="X509DataType">
+  <sequence maxOccurs="unbounded">
+    <choice>
+      <element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/>
+      <element name="X509SKI" type="base64Binary"/>
+      <element name="X509SubjectName" type="string"/>
+      <element name="X509Certificate" type="base64Binary"/>
+      <element name="X509CRL" type="base64Binary"/>
+      <any namespace="##other" processContents="lax"/>
+    </choice>
+  </sequence>
+</complexType>
+
+<complexType name="X509IssuerSerialType"> 
+  <sequence> 
+    <element name="X509IssuerName" type="string"/> 
+    <element name="X509SerialNumber" type="integer"/> 
+  </sequence>
+</complexType>
+
+<!-- End X509Data -->
+
+<!-- Begin PGPData -->
+
+<element name="PGPData" type="ds:PGPDataType"/> 
+<complexType name="PGPDataType"> 
+  <choice>
+    <sequence>
+      <element name="PGPKeyID" type="base64Binary"/> 
+      <element name="PGPKeyPacket" type="base64Binary" minOccurs="0"/> 
+      <any namespace="##other" processContents="lax" minOccurs="0"
+       maxOccurs="unbounded"/>
+    </sequence>
+    <sequence>
+      <element name="PGPKeyPacket" type="base64Binary"/> 
+      <any namespace="##other" processContents="lax" minOccurs="0"
+       maxOccurs="unbounded"/>
+    </sequence>
+  </choice>
+</complexType>
+
+<!-- End PGPData -->
+
+<!-- Begin SPKIData -->
+
+<element name="SPKIData" type="ds:SPKIDataType"/> 
+<complexType name="SPKIDataType">
+  <sequence maxOccurs="unbounded">
+    <element name="SPKISexp" type="base64Binary"/>
+    <any namespace="##other" processContents="lax" minOccurs="0"/>
+  </sequence>
+</complexType> 
+
+<!-- End SPKIData -->
+
+<!-- End KeyInfo -->
+
+<!-- Start Object (Manifest, SignatureProperty) -->
+
+<element name="Object" type="ds:ObjectType"/> 
+<complexType name="ObjectType" mixed="true">
+  <sequence minOccurs="0" maxOccurs="unbounded">
+    <any namespace="##any" processContents="lax"/>
+  </sequence>
+  <attribute name="Id" type="ID" use="optional"/> 
+  <attribute name="MimeType" type="string" use="optional"/> <!-- add a grep facet -->
+  <attribute name="Encoding" type="anyURI" use="optional"/> 
+</complexType>
+
+<element name="Manifest" type="ds:ManifestType"/> 
+<complexType name="ManifestType">
+  <sequence>
+    <element ref="ds:Reference" maxOccurs="unbounded"/> 
+  </sequence>
+  <attribute name="Id" type="ID" use="optional"/> 
+</complexType>
+
+<element name="SignatureProperties" type="ds:SignaturePropertiesType"/> 
+<complexType name="SignaturePropertiesType">
+  <sequence>
+    <element ref="ds:SignatureProperty" maxOccurs="unbounded"/> 
+  </sequence>
+  <attribute name="Id" type="ID" use="optional"/> 
+</complexType>
+
+   <element name="SignatureProperty" type="ds:SignaturePropertyType"/> 
+   <complexType name="SignaturePropertyType" mixed="true">
+     <choice maxOccurs="unbounded">
+       <any namespace="##other" processContents="lax"/>
+       <!-- (1,1) elements from (1,unbounded) namespaces -->
+     </choice>
+     <attribute name="Target" type="anyURI" use="required"/> 
+     <attribute name="Id" type="ID" use="optional"/> 
+   </complexType>
+
+<!-- End Object (Manifest, SignatureProperty) -->
+
+<!-- Start Algorithm Parameters -->
+
+<simpleType name="HMACOutputLengthType">
+  <restriction base="integer"/>
+</simpleType>
+
+<!-- Start KeyValue Element-types -->
+
+<element name="DSAKeyValue" type="ds:DSAKeyValueType"/>
+<complexType name="DSAKeyValueType">
+  <sequence>
+    <sequence minOccurs="0">
+      <element name="P" type="ds:CryptoBinary"/>
+      <element name="Q" type="ds:CryptoBinary"/>
+    </sequence>
+    <element name="G" type="ds:CryptoBinary" minOccurs="0"/>
+    <element name="Y" type="ds:CryptoBinary"/>
+    <element name="J" type="ds:CryptoBinary" minOccurs="0"/>
+    <sequence minOccurs="0">
+      <element name="Seed" type="ds:CryptoBinary"/>
+      <element name="PgenCounter" type="ds:CryptoBinary"/>
+    </sequence>
+  </sequence>
+</complexType>
+
+<element name="RSAKeyValue" type="ds:RSAKeyValueType"/>
+<complexType name="RSAKeyValueType">
+  <sequence>
+    <element name="Modulus" type="ds:CryptoBinary"/> 
+    <element name="Exponent" type="ds:CryptoBinary"/> 
+  </sequence>
+</complexType> 
+
+<!-- End KeyValue Element-types -->
+
+<!-- End Signature -->
+
+</schema>

data/lib/nfse_sjc.rb

@@ -0,0 +1,22 @@
+require 'nokogiri'
+require 'savon'
+
+require_relative 'nfse_sjc/dirs'
+require_relative 'nfse_sjc/config'
+require_relative 'nfse_sjc/schemas'
+require_relative 'nfse_sjc/errors/validation_error'
+require_relative 'nfse_sjc/response_hash'
+require_relative 'nfse_sjc/parser'
+require_relative 'nfse_sjc/document'
+require_relative 'nfse_sjc/version'
+require_relative 'nfse_sjc/client'
+
+module NfseSjc
+  def self.config(at: nil)
+    if block_given?
+      yield Config
+    else
+      Config.to_h(at: at)
+    end
+  end
+end

data/lib/nfse_sjc/client.rb

@@ -0,0 +1,49 @@
+module NfseSjc
+  class Client
+    PARAM_KEYS = [:pretty_print_xml, :log, :wsdl, :ssl_cert_file,
+      :ssl_cert_key_file, :ssl_cert_key_password].freeze
+
+    def initialize(params = {})
+      @savon  = Savon.client slice(params, *PARAM_KEYS).merge(NfseSjc.config(at: PARAM_KEYS))
+      @parser = Parser.new
+      @header = Document.new(Dirs.template('cabecalho_v3.xml.erb'), {}).to_xml.freeze
+    end
+
+    def call(method, params)
+      schema = Schemas.get_schema("#{method}.xml.erb")
+      schema_path = File.join Dirs.etc, 'schemas', schema
+      xsd = Nokogiri::XML::Schema(File.open schema_path)
+      document = Document.new(Dirs.template("#{method}.xml.erb"), params).to_signed_xml
+
+      errors = xsd.validate(Nokogiri::XML(document))
+
+      if errors.any?
+        message = errors.map do |err|
+          "* #{err}".gsub('{http://www.ginfes.com.br/tipos_v03.xsd}','').gsub('Element ', '')
+        end.join("\n")
+
+        raise NfseSjc::Errors::ValidationError.new("XML with invalid or incorrect data according to schema #{schema}, found errors:\n #{message}")
+      else
+        response = @savon.call(method, message: {
+          arg0: @header,
+          arg1: document
+        })
+
+        @parser.parse(response.body[:"#{method}_response"][:return])
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      call(name, *args, &block)
+    end
+
+    private
+
+    def slice(hash, *keys)
+      keys.each_with_object({}) do |key, red|
+        red[key] = hash[key] if hash.has_key?(key)
+      end
+    end
+  end
+end
+

data/lib/nfse_sjc/config.rb

@@ -0,0 +1,31 @@
+module NfseSjc
+  module Config
+    class << self
+      def self.default_attr(attr_name, env_path)
+        attr_writer attr_name
+        class_eval <<-RUBY
+          def #{attr_name}
+            @#{attr_name} ||= ENV['#{env_path}']
+          end
+        RUBY
+      end
+
+      default_attr :wsdl,                  'NFSE_SJC_WSDL_URI'
+      default_attr :ssl_cert_file,         'NFSE_SJC_SSL_CERT_FILE'
+      default_attr :ssl_cert_key_file,     'NFSE_SJC_SSL_CERT_KEY_FILE'
+      default_attr :ssl_cert_key_password, 'NFSE_SJC_SSL_CERT_KEY_PASSWORD'
+      default_attr :log,                   'NFSE_SJC_LOG'
+      default_attr :pretty_print_xml,      'NFSE_SJC_PRETTY_XML_LOG'
+      default_attr :xmlsec_binary_path,    'NFSE_SJC_XMLSEC_BINARY_PATH'
+
+      def to_h(at: nil)
+        %i(wsdl ssl_cert_file ssl_cert_key_file ssl_cert_key_password log pretty_print_xml xmlsec_binary_path).select do |prop|
+          at.blank? || at.include?(prop)
+        end.map do |meth|
+          val = send(meth)
+          [meth, val] if val
+        end.compact.to_h
+      end
+    end
+  end
+end

data/lib/nfse_sjc/dirs.rb

@@ -0,0 +1,23 @@
+module NfseSjc
+  module Dirs
+    def self.root
+      File.join(File.dirname(__dir__), '..')
+    end
+
+    def self.bin
+      File.join root, 'bin'
+    end
+
+    def self.lib
+      File.join root, 'lib'
+    end
+
+    def self.etc
+      File.join root, 'etc'
+    end
+
+    def self.template(filename)
+      File.join etc, 'codegen', filename
+    end
+  end
+end

data/lib/nfse_sjc/document.rb

@@ -0,0 +1,67 @@
+require 'erubis'
+require 'tempfile'
+
+module NfseSjc
+  class Document
+    def initialize(filepath, params = {})
+      @params   = params
+      @template = load_template(filepath)
+    end
+
+    def to_xml
+      @template.result(binding)
+    end
+
+    def to_signed_xml
+      unsigned_xml   = to_xml
+
+      unsigned_temp_xml = Tempfile.new('unsigned-xml')
+      signed_temp_xml   = Tempfile.new('signed-xml')
+      result            = ''
+
+      begin
+        unsigned_temp_xml.write(unsigned_xml)
+        unsigned_temp_xml.rewind
+
+        %x{#{NfseSjc.config[:xmlsec_binary_path]} --sign --privkey-pem '#{NfseSjc.config[:ssl_cert_key_file]}','#{NfseSjc.config[:ssl_cert_file]}' --output '#{signed_temp_xml.path}' --pwd '#{NfseSjc.config[:ssl_cert_key_password]}' '#{unsigned_temp_xml.path}'}
+
+        signed_temp_xml.rewind
+        result = signed_temp_xml.read
+      ensure
+        signed_temp_xml.close
+        unsigned_temp_xml.close
+
+        signed_temp_xml.unlink
+        unsigned_temp_xml.unlink
+      end
+
+      result
+    end
+
+    protected
+
+    def render(filepath, params = {}, of: ::NfseSjc::Document)
+      of.new(NfseSjc::Dirs.template(filepath), params).to_xml
+    end
+
+    def param(*path, with: @params)
+      value = with
+      path.each do |segment|
+        value = value[segment]
+        break if value.nil?
+      end
+      return value
+    end
+
+    def if_param(*path, with: @params)
+      value = param(*path, with: with)
+      yield value unless value.nil? || (value.respond_to?(:empty) && value.empty?)
+    end
+
+    private
+    def load_template(filepath)
+      cachepath = File.join(Dir.tmpdir, "#{File.basename(filepath)}.cache")
+      Erubis::FastEruby.load_file(filepath, cachename: cachepath)
+    end
+  end
+end