rps_paulistana 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39ca7a120c30f5659fade5174a6ec6384441787f
-  data.tar.gz: b6670f349b3db0d0e4eeffa5af1bfe8b3c1564d0
+  metadata.gz: 7f409e1953d515e209cd2299aadd76739f8548da
+  data.tar.gz: 2a5bf1ba7153b977c2603473d9075eebbd880b5a
 SHA512:
-  metadata.gz: 10e9856fd348efd9a3e95e280250cad4bed5f5fff9dfe66d4228a27489225cd55fa1a351ae958868a20915127f71a0e6360526a6573483eec49b6b018986475e
-  data.tar.gz: ef3796bbe4d49d78fb7405ca2bbaae43ccc0c9f8f081877ffb81735fd3d6ece5fbe3e2bbe920286b57b942415b664ad919809fd643f72c7298257fb86c5b2691
+  metadata.gz: c45abce2c25a2f3e48108b5c8fb0d83b3a45cfc9a0ae4cc4741feec2442802554d1c14e4243ea5d69eb5ae22ab77b54b1febedc2dd35b15247d1002df8794a34
+  data.tar.gz: c5a68745ba2074a92d2302775388bfb03ff43db83a94ee0063c2d99dd07e7c9986a3207dea452640044a168fd120628db1d731f3da8dcaa105d919a36f72cb85

data/lib/detail.rb

@@ -0,0 +1,90 @@
+module NFE
+    class Detail < Register
+        REQUIRED_FIELDS = [
+            :rps_type,
+            :rps_number,
+            :issuing_date,
+            :rps_status,
+            :amount,
+            :tax_amount,
+            :service_code,
+            :aliquot,
+            :iss_by,
+            :taker_type,
+            :taker_document,
+            :service_description
+        ]
+
+        VALID_FIELDS = [
+            :rps_type,
+            :rps_serial,
+            :rps_number,
+            :issuing_date,
+            :rps_status,
+            :amount,
+            :tax_amount,
+            :service_code,
+            :aliquot,
+            :iss_by,
+            :taker_type,
+            :taker_document,
+            :taker_ccm,
+            :state_registration,
+            :taker_name,
+            :address_type,
+            :address,
+            :address_number,
+            :complement,
+            :district,
+            :city,
+            #:uf,
+            :zip_code,
+            :taker_email,
+            :pis_pasep,
+            :cofins,
+            :inss,
+            :ir,
+            :cssl,
+            :total_tax_amount,
+            :tributary_percentage,
+            :tributary_source,
+            :cei,
+            :matriculation,
+            :city_ibge_code,
+            :private_blank_field,
+            :service_description
+        ]
+
+        DEFAULTS = {
+            rps_type: "RPS",
+            issuing_date: Time.now.to_date.strftime("%Y%m%d")
+        }
+
+        def initialize
+            super 6
+        end
+
+        def valid?
+            fields_hash = self.to_hash
+            if fields_hash[:taker_type].eql? "2"
+               @required_fields.concat([
+                   :taker_name,
+                   :taker_email,
+                   :address_type,
+                   :address,
+                   :address_number,
+                   :district,
+                   :city,
+                   #:uf,
+                   :zip_code
+               ])
+           end
+
+           if ["F", "B", "N", "V"].include?(fields_hash[:rps_status])
+               @required_fields << :city_ibge_code
+           end
+
+           super
+        end
+    end
+end

data/lib/errors/errors.rb

@@ -0,0 +1,16 @@
+module NFE
+    module Errors
+        class RPSRegisterTypeError < StandardError; end
+        class InvalidParamError    < StandardError; end
+        class LayoutVersionError   < StandardError; end
+        class RPSTypeError         < StandardError; end
+        class RPSStatusError       < StandardError; end
+        class ISSByError           < StandardError; end
+        class TakerTypeError       < StandardError; end
+        class NonExistentFieldError< StandardError; end
+        class InvalidFieldError    < StandardError; end
+        class InvalidDetailError   < StandardError; end
+        class InvalidHeaderError   < StandardError; end
+        class InvalidRPSError      < StandardError; end
+    end
+end

data/lib/footer.rb

@@ -0,0 +1,19 @@
+module NFE
+    class Footer < Register
+        REQUIRED_FIELDS = [
+            :total_detail_lines,
+            :total_amount,
+            :total_tax_amount
+        ]
+
+        VALID_FIELDS = REQUIRED_FIELDS
+
+        DEFAULTS = {
+            total_detail_lines: "0"
+        }
+
+        def initialize
+            super 9
+        end
+    end
+end

data/lib/header.rb

@@ -0,0 +1,22 @@
+module NFE
+    class Header < Register
+        REQUIRED_FIELDS = [
+            :layout_version,
+            :municipal_registration,
+            :start_date,
+            :end_date
+        ]
+
+        VALID_FIELDS = REQUIRED_FIELDS
+
+        DEFAULTS = {
+            layout_version: "002",
+            start_date: Time.now.to_date.strftime("%Y%m%d"),
+            end_date:   Time.now.to_date.strftime("%Y%m%d")
+        }
+
+        def initialize
+            super 1
+        end
+    end
+end

data/lib/register.rb

@@ -0,0 +1,90 @@
+module NFE
+    class Register
+        VALID_TYPES     = [1, 6, 9]
+        REQUIRED_FIELDS = []
+        VALID_FIELDS    = []
+        DEFAULTS  = {}
+
+        attr_reader   :fields, :type, :required_fields
+
+        def validate!
+            if !@type.is_a? String and !@type.is_a? Integer
+                raise Errors::InvalidParamError,      /Parameter type must be String or Integer/
+            end
+
+            if !VALID_TYPES.include?(@type.to_i)
+                raise Errors::RPSRegisterTypeError, /Invalid RPS Register type/
+            end
+        end
+
+        def initialize type
+            @type            = type
+            @fields          = Array.new
+            @required_fields = Array.new(self.class::REQUIRED_FIELDS)
+            validate!
+        end
+
+        def valid?
+            set_non_filled
+            return (@required_fields - self.to_hash.keys).empty?
+        end
+
+        def valid_register_field? name
+            return (self.class::VALID_FIELDS).include?(name)
+        end
+
+        def << fields
+            raise Errors::InvalidParamError, /Expecting Hash parameter/ if !fields.is_a? Hash
+            fields = self.class::DEFAULTS.merge(fields)
+
+            fields.each do |name, value|
+                if valid_register_field?(name)
+                    field = RPSField.new name, value
+
+                    if field.valid?
+                        field.check_value
+                        @fields << field
+                    else
+                        raise Errors::InvalidFieldError, /The field #{field.name}; Value: #{field.value} is invalid. Check its value/
+                    end
+                else
+                    raise Errors::NonExistentFieldError, /Register: #{self.class}; Name: #{name}; Value: #{value}/
+                end
+            end
+
+            return @fields
+        end
+
+        private def set_non_filled
+            non_filled = (self.class::VALID_FIELDS - @required_fields) - self.to_hash.keys
+
+            non_filled.each do |field_name|
+                field = RPSField.new field_name
+                if field.valid?
+                    field.check_value
+                    @fields << field
+                else
+                    raise Errors::InvalidFieldError, /The field #{field.name}; Value: #{field.value} is invalid. Check its value/
+                end
+            end
+        end
+
+        def to_hash
+            fields_hash = Hash.new
+            @fields.each do |field|
+                fields_hash[field.name] = field.value
+            end
+
+            return fields_hash
+        end
+
+        def to_s
+            string = @type.to_s
+            self.class::VALID_FIELDS.each do |field_name|
+                string += self.to_hash[field_name]
+            end
+
+            return "#{string}\n"
+        end
+    end
+end

data/lib/rps.rb

@@ -0,0 +1,65 @@
+module NFE
+    class RPS
+        attr_reader :header, :details, :footer
+
+        def initialize
+            @header  = Header.new
+            @footer  = Footer.new
+            @details = Array.new
+        end
+
+        def add_header fields
+            @header << fields
+            raise Errors::InvalidHeaderError, /Invalid Header: #{@header.to_hash}/      if !@header.valid?
+            return @header.fields
+        end
+
+        def add_detail fields
+            detail = Detail.new
+            detail << fields
+            if detail.valid?
+                @details << detail
+            else
+                raise Errors::InvalidDetailError, /Invalid Detail: #{detail.to_hash}/
+            end
+        end
+
+        def set_footer
+            total_amount     = 0
+            total_tax_amount = 0
+            @details.each do |detail|
+                total_amount     += detail.to_hash[:amount].to_i
+                total_tax_amount += detail.to_hash[:tax_amount].to_i
+            end
+
+            @footer << {total_detail_lines: @details.count.to_s, total_amount: total_amount.to_s, total_tax_amount: total_tax_amount.to_s}
+        end
+
+        def valid?
+            return (@header.valid? and @details.count and @footer.valid?)
+        end
+
+        def to_s
+            if self.valid?
+                string = @header.to_s
+                @details.each do |detail|
+                    string += detail.to_s
+                end
+                string += @footer.to_s
+
+                return string
+            else
+                raise Errors::InvalidRPSError
+            end
+        end
+
+        def save_to_file path = "./"
+            filename = "#{path}/RPS_#{@details.first.to_hash[:issuing_date]}.txt"
+            file = File.new(filename, "w")
+            saved = file.write(self.to_s)
+            file.close
+
+            return filename if saved
+        end
+    end
+end

data/lib/rps_field.rb

@@ -0,0 +1,192 @@
+module NFE
+    class RPSField
+        attr_reader :name, :value, :type, :size, :auto_fill
+
+        module Type
+            ALPHA = "ALPHA"
+            NUM   = "NUM"
+            EMAIL = "EMAIL"
+        end
+
+        def validate!
+            raise Errors::InvalidParamError, /Parameter name must be String or Symbol/  if !@name .is_a? String and !@name.is_a? Symbol
+            raise Errors::InvalidParamError, /Parameter value must be String/           if !@value.is_a? String
+            raise Errors::InvalidParamError                                             if  @name.empty?
+        end
+
+        def initialize name, value = ""
+            @name      = name
+            @value     = value
+            @auto_fill = true
+            validate!
+            @name = @name.to_sym
+            @value.upcase!
+            set_configs
+        end
+
+        def set_configs
+            case @name
+            when :taker_email
+                @size = 75
+                @type = Type::EMAIL
+            when :aliquot
+                @size = 4
+                @type = Type::NUM
+            when :total_detail_lines
+                @size = 7
+                @type = Type::NUM
+            when :taker_document
+                @size = 14
+                @type = Type::NUM
+            when :amount, :tax_amount, :total_amount, :total_tax_amount, :pis_pasep, :cofins, :inss, :ir, :cssl
+                @size = 15
+                @type = Type::NUM
+            when :rps_number, :matriculation
+                @size = 12
+                @type = Type::NUM
+            when :taker_ccm
+                @size = 8
+                @type = Type::NUM
+            when :private_blank_field
+                @size = 200
+                @type = Type::ALPHA
+            when :taker_name
+                @size = 75
+                @type = Type::ALPHA
+            when :address_type
+                @size = 3
+                @type = Type::ALPHA
+            when :address, :city
+                @size = 50
+                @type = Type::ALPHA
+            when :address_number, :tributary_source
+                @size = 10
+                @type = Type::ALPHA
+            when :complement, :district
+                @size = 30
+                @type = Type::ALPHA
+            when :service_description
+                @size = @value.length
+                @type = Type::ALPHA
+            when :rps_type, :rps_serial
+                @size = 5
+                @type = Type::ALPHA
+            when :layout_version
+                @size = 3
+                @type = Type::NUM
+                @auto_fill = false
+            when :start_date, :end_date, :issuing_date, :municipal_registration
+                @size = 8
+                @type = Type::NUM
+                @auto_fill = false
+            when :zip_code
+                @size = 8
+                @type = Type::NUM
+            when :state_registration, :cei
+                @size = 12
+                @type = Type::NUM
+            when :service_code
+                @size = 5
+                @type = Type::NUM
+                @auto_fill = false
+            when :tributary_percentage
+                @size = 5
+                @type = Type::NUM
+            when :iss_by, :taker_type
+                @size = 1
+                @type = Type::NUM
+                @auto_fill = false
+            when :city_ibge_code
+                @size = 7
+                @type = Type::NUM
+            when :rps_status
+                @size = 1
+                @type = Type::ALPHA
+                @auto_fill = false
+            when :uf
+                @size = 2
+                @type = Type::ALPHA
+            end
+        end
+
+        def default_char
+            case @type
+                when Type::NUM
+                    return "0"
+                else
+                    return " "
+            end
+        end
+
+        def valid?
+            if @value.empty?
+                valid = true
+            else
+                case @type
+                when Type::ALPHA
+                    valid = self.alphanumeric?
+                when Type::EMAIL
+                    valid = self.email?
+                when Type::NUM
+                    valid = self.numeric?
+                end
+            end
+
+            self.fill! if @auto_fill == true
+            return (valid and self.length == @size)
+        end
+
+        def check_value
+            case @name
+            when :layout_version
+                if !["001", "002"].include? @value
+                    raise Errors::LayoutVersionError, /Only 001 and 002 versions supported/
+                end
+            when :rps_type
+                if !@value.strip.eql?("RPS") and !@value.strip.eql?("RPS-M")
+                    raise Errors::RPSTypeError, /RPS types allowed: RPS and RPS-M/
+                end
+            when :rps_status
+                if !["T", "F", "A", "B", "M", "N", "X", "V", "P", "C"].include? @value
+                    raise Errors::RPSStatusError, /Invalid RPS situation\/status. Please, check the manual (section 4.3.6)/
+                end
+            when :iss_by
+                if !["1", "2", "3"].include? @value
+                    raise Errors::ISSByError, /Invalid ISS. Please, check the manual (section 4.3.11)/
+                end
+            when :taker_type
+                if !["1", "2", "3"].include? @value
+                    raise Errors::TakerTypeError, /Invalid Taker type. Please, check the manual (section 4.3.12)/
+                end
+            when :start_date, :end_date, :issuing_date
+                Date.strptime(@value, "%Y%m%d")
+            end
+        end
+
+        def alphanumeric?
+            return @value.match(/^[[:alnum:]\s]+$/) != nil
+        end
+
+        def numeric?
+            return @value.match(/^[0-9]+$/) != nil
+        end
+
+        def email?
+            return @value.match(/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i) != nil
+        end
+
+        def length
+            return @value.length
+        end
+
+        def fill!
+            while self.length < @size do
+                if self.default_char.eql? "0"
+                    @value = self.default_char + @value
+                else
+                    @value << self.default_char
+                end
+            end
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rps_paulistana
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Júlia M. Birkett
@@ -32,6 +32,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/detail.rb
+- lib/errors/errors.rb
+- lib/footer.rb
+- lib/header.rb
+- lib/register.rb
+- lib/rps.rb
+- lib/rps_field.rb
 - lib/rps_paulistana.rb
 homepage: http://rubygems.org/gems/rps_paulistana
 licenses: []