complicode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8799896321a70ce1c4882a2ccd2c19c70fa36d55782e4c425c235f4929296be
+  data.tar.gz: 62a4064fce977a49caa7053bb155a085d9f639b3da43d112af0ecf8cf36c2689
+SHA512:
+  metadata.gz: c009cdf95befbcb3806b4c979c7cfa05fa9bfbd67c79ce0ded4026dc8cfe977e91c3c8cf767867df840b2f4623c63b654891e043f6474bb0d21c629da8bb5cea
+  data.tar.gz: 86915e36ef6fae206810371d3ba681ac899e7f53c333480cf7d7160d3fe8a417c57e09124f264de0d48733ce9fa1a33d787cc8c367792b4fadd93ebb8b3b592b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pablo Crivella.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Complicode
+
+[![Gem](https://img.shields.io/gem/v/complicode.svg?style=flat)](http://rubygems.org/gems/complicode)
+[![CircleCI](https://circleci.com/gh/pablocrivella/complicode.svg?style=svg)](https://circleci.com/gh/pablocrivella/complicode)
+[![Maintainability](https://api.codeclimate.com/v1/badges/935822c7c481aa464186/maintainability)](https://codeclimate.com/github/pablocrivella/complicode/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/935822c7c481aa464186/test_coverage)](https://codeclimate.com/github/pablocrivella/complicode/test_coverage)
+
+Control code generator for invoices inside the Bolivian national tax service..
+
+Links:
+
+  - [API Docs](https://www.rubydoc.info/gems/complicode)
+  - [Contributing](https://github.com/InspireNL/complicode/blob/master/CONTRIBUTING.md)
+  - [Code of Conduct](https://github.com/InspireNL/complicode/blob/master/CODE_OF_CONDUCT.md)
+
+## Requirements
+
+1. [Ruby 2.5.0](https://www.ruby-lang.org)
+
+## Installation
+
+To install, run:
+
+```
+gem install complicode
+```
+
+Or add the following to your Gemfile:
+
+```
+gem "complicode"
+```
+
+## Usage
+
+```ruby
+require "complicode"
+
+authorization_code = "29040011007"
+key = "9rCB7Sv4X29d)5k7N%3ab89p-3(5[A"
+Complicode::Generate.call(authorization_code, key, number: "1503", nit: "4189179011", issue_date: "20070702", amount: "2500")
+# => "6A-DC-53-05-14"
+# If ignored, "nit" defaults to "0"
+Complicode::Generate.call(authorization_code, key, number: "1503", issue_date: "20070702", amount: "2500")
+# => "9E-84-73-A4"
+```
+
+## Tests
+
+To test, run:
+
+```
+bundle exec rspec spec/
+```
+
+## Versioning
+
+Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
+
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+## License
+
+Copyright 2018 [Inspire Innovation BV](https://inspire.nl).
+Read [LICENSE](LICENSE.md) for details.

data/lib/complicode.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "radix"
+require "rc4"
+require "verhoeff"
+require "date"
+require "complicode/invoice"
+require "complicode/partial_key"
+require "complicode/generators/verification_digits"
+require "complicode/generators/partial_keys"
+require "complicode/generators/data"
+require "complicode/generators/ascii_sums"
+require "complicode/generators/base64_data"
+require "complicode/generate"
+require "complicode/version"

data/lib/complicode/generate.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Complicode
+  class Generate
+    # @return [String]
+    def self.call(*args)
+      new(*args).send(:call)
+    end
+
+    # @param authorization_code [String]
+    # @param key [String]
+    # @param [Hash] invoice_attributes of the invoice.
+    # @option invoice_attributes [String] :nit
+    # @option invoice_attributes [String] :number
+    # @option invoice_attributes [String] :amount
+    # @option invoice_attributes [String] :issue_date
+    def initialize(authorization_code, key, invoice_attributes = {})
+      @invoice = Invoice.new(invoice_attributes)
+      @authorization_code = authorization_code
+      @key = key
+    end
+
+    private
+
+    # @return [String]
+    def call
+      partial_keys = Generators::PartialKeys.call(@key.dup, verification_digits)
+      data = Generators::Data.call(@authorization_code, @invoice, partial_keys)
+      encrypted_data = encrypt(data, encryption_key)
+      ascii_sums = Generators::AsciiSums.call(encrypted_data, partial_keys.count)
+      base64_data = Generators::Base64Data.call(ascii_sums, partial_keys)
+      format(encrypt(base64_data, encryption_key))
+    end
+
+    # @return [String]
+    def encryption_key
+      @encryption_key ||= @key + verification_digits
+    end
+
+    # @return [String]
+    def verification_digits
+      @verification_digits ||= Generators::VerificationDigits.call(@invoice)
+    end
+
+    # @param data [String]
+    # @param encryption_key [String]
+    # @return [String]
+    def encrypt(data, encryption_key)
+      RC4.new(encryption_key).encrypt(data).unpack1("H*").upcase
+    end
+
+    # @param code [String]
+    # @return [String]
+    def format(code)
+      code.scan(/.{2}/).join("-")
+    end
+  end
+end

data/lib/complicode/generators/ascii_sums.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Complicode
+  module Generators
+    class AsciiSums
+      # @param encrypted_data [String]
+      # @param partials_count [Integer]
+      # @return [Struct]
+      def self.call(encrypted_data, partials_count)
+        Struct.new(:total, :partials).new(0, Array.new(partials_count, 0)).tap do |sums|
+          encrypted_data.each_byte.with_index do |byte, index|
+            sums.total += byte
+            sums.partials[index % partials_count] += byte
+          end
+        end
+      end
+    end
+  end
+end

data/lib/complicode/generators/base64_data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Complicode
+  module Generators
+    class Base64Data
+      BASE64 = %w[
+        0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V
+        W X Y Z a b c d e f g h i j k l m n o p q r s t u v w x y z + /
+      ].freeze
+
+      # @param ascii_sums [Struct]
+      # @param partial_keys [Array<String>]
+      # @return [String]
+      def self.call(ascii_sums, partial_keys)
+        ascii_sums.partials.each_with_index.inject(0) do |sum, (partial_sum, index)|
+          sum + ascii_sums.total * partial_sum / partial_keys[index].size
+        end.b(10).to_s(BASE64)
+      end
+    end
+  end
+end

data/lib/complicode/generators/data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Complicode
+  module Generators
+    class Data
+      # @param authorization_code [String]
+      # @param invoice [Complicode::Invoice]
+      # @param partial_keys [Array<String>]
+      # @return [String]
+      def self.call(authorization_code, invoice, partial_keys)
+        authorization_code += partial_keys[0].value
+
+        %i[number nit issue_date amount].each.with_index(1) do |attribute, index|
+          invoice.append_to(attribute, partial_keys[index].value)
+        end
+
+        authorization_code + invoice.concat
+      end
+    end
+  end
+end

data/lib/complicode/generators/partial_keys.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Complicode
+  module Generators
+    class PartialKeys
+      # @param key [String]
+      # @param verification_digits [String]
+      # @return [Array<String>]
+      def self.call(key, verification_digits)
+        partial_key_sizes = verification_digits.split("").map { |digit| digit.to_i + 1 }
+        partial_key_sizes.map do |index|
+          PartialKey.new(value: key.slice!(0...index))
+        end
+      end
+    end
+  end
+end

data/lib/complicode/generators/verification_digits.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Complicode
+  module Generators
+    class VerificationDigits
+      DIGITS_COUNT = 5
+      ITERATIONS = 2
+
+      # @param invoice [Complicode::Invoice]
+      # @return [String]
+      def self.call(invoice)
+        ITERATIONS.times do
+          %i[number nit issue_date amount]
+            .each { |attribute| invoice.append_checksum_digit_to(attribute) }
+        end
+
+        sum = invoice.sum
+        DIGITS_COUNT.times { sum = Verhoeff.checksum_of(sum) }
+        sum.to_s[-DIGITS_COUNT..-1]
+      end
+    end
+  end
+end

data/lib/complicode/invoice.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Complicode
+  class Invoice
+    attr_accessor :nit, :amount, :issue_date, :number
+
+    # @param [Hash] attributes of the invoice.
+    # @option attributes [String] :nit
+    # @option attributes [String] :number
+    # @option attributes [String] :amount
+    # @option attributes [String] :issue_date
+    def initialize(attributes = {})
+      @nit = attributes.fetch(:nit, "0").to_s
+      @number = attributes.fetch(:number).to_s
+      @amount = attributes.fetch(:amount).to_s.tr(",", ".").to_f.round.to_s
+      @issue_date = Date.parse(attributes.fetch(:issue_date).to_s).strftime("%Y%m%d")
+    end
+
+    # @param attribute [Symbol]
+    def append_checksum_digit_to(attribute)
+      append_to(attribute, Verhoeff.checksum_digit_of(send(attribute)).to_s)
+    end
+
+    # @param attribute [Symbol]
+    # @param value [String]
+    def append_to(attribute, value)
+      send("#{attribute}=", send(attribute) + value)
+    end
+
+    # @return [Integer]
+    def sum
+      [number, nit, issue_date, amount].map(&:to_i).inject(:+)
+    end
+
+    # @return [String]
+    def concat
+      [number, nit, issue_date, amount].inject(:+)
+    end
+  end
+end

data/lib/complicode/partial_key.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Complicode
+  PartialKey = Struct.new(:value, keyword_init: true) do
+    def size
+      value.size
+    end
+  end
+end

data/lib/complicode/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Complicode
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: complicode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pablo Crivella
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: radix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-rc4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: verhoeff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: smarter_csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Control code generator for invoices inside the Bolivian national tax
+  service.
+email:
+- pablocrivella@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/complicode.rb
+- lib/complicode/generate.rb
+- lib/complicode/generators/ascii_sums.rb
+- lib/complicode/generators/base64_data.rb
+- lib/complicode/generators/data.rb
+- lib/complicode/generators/partial_keys.rb
+- lib/complicode/generators/verification_digits.rb
+- lib/complicode/invoice.rb
+- lib/complicode/partial_key.rb
+- lib/complicode/version.rb
+homepage: https://github.com/mobile-bits/complicode-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/pablocrivella/complicode/issues
+  changelog_uri: https://github.com/pablocrivella/complicode/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/pablocrivella/complicode
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Complicode! A needlessly complicated code generator!
+test_files: []