complicode 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7ea01c2b4b68843962e6b00d12ef8429fb906760f8f8248a94ac16d00d9bef0
-  data.tar.gz: 9b7380b749c9086893fa6416687dcfb934a7ea4eded354aa2656f8d1df90e64b
+  metadata.gz: a12ea0604947b47e7077ce14b8d703361d18615d0ef28ebde58ecdd65a5782f5
+  data.tar.gz: 3362ee7edb677550cf553eb188f7d4cb5e25c8841d86f0a963813d2abd51adf9
 SHA512:
-  metadata.gz: d66589838ad40670c5391578977e0498aaf4d520ded16a1d75001253c734a7176e24283b5b3942b5b9eb90e5e6a668c8f3042c47e9680f43c07249f6d6edf3fe
-  data.tar.gz: dd4afb08004bf361ead2758be51c85e8aeb80928ca2aa26863ed53d5c5f75feaacd2f008b9295b8ec871ded050d4e7db7e9b8fbad4a283d2fe1e66e4f52b287d
+  metadata.gz: 20fdc2bca8fe7493291cd5fe2360ddeb9060718b5b2e1640a23efa093709e3294c9224a909056c35fa8271216dd272e7b35e968173195ac2fea3e6e9cf598c44
+  data.tar.gz: bbc7e21969a45a3ce0e82bed02c78ebe2354bb7c19ecfa90db3d528117acf5f2e223cc312410f4662462f1aae6b7401c835712262a33efa16ace879480541fd0

data/README.md

@@ -1,17 +1,18 @@
 # 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)
+[![Depfu](https://badges.depfu.com/badges/6f2f73672eae4d603d6ae923164435e2/overview.svg)](https://depfu.com/github/pablocrivella/statics?project=Bundler)
+[![Inline docs](http://inch-ci.org/github/pablocrivella/complicode.svg?branch=master&style=shields)](http://inch-ci.org/github/pablocrivella/complicode)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d874a9673862541f247b/maintainability)](https://codeclimate.com/github/pablocrivella/complicode/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d874a9673862541f247b/test_coverage)](https://codeclimate.com/github/pablocrivella/complicode/test_coverage)
 
-Control code generator for invoices inside the Bolivian national tax service..
+Control code generator for invoices inside the Bolivian national tax service.
 
 Links:
 
-  - [API Docs](https://www.rubydoc.info/gems/complicode)
-  - [Contributing](https://github.com/pablocrivella/complicode/blob/master/CONTRIBUTING.md)
-  - [Code of Conduct](https://github.com/pablocrivella/complicode/blob/master/CODE_OF_CONDUCT.md)
+- [API Docs](https://www.rubydoc.info/gems/complicode)
+- [Contributing](https://github.com/pablocrivella/complicode/blob/master/CONTRIBUTING.md)
+- [Code of Conduct](https://github.com/pablocrivella/complicode/blob/master/CODE_OF_CONDUCT.md)
 
 ## Requirements
 
@@ -38,18 +39,17 @@ 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")
+invoice = Complicode::Invoice.new(number: 1503, nit: 4189179011, issue_date: Date.new(2007, 7, 2), amount: 2500.0)
+generator = Complicode::Generator.new
+generator.call(authorization_code: authorization_code, key: key, invoice: invoice)
 # => "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:
 
-```
+```shell
 bundle exec rspec spec/
 ```
 
@@ -63,5 +63,5 @@ Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
 
 ## License
 
-Copyright 2018 [Pablo Crivella](https://pablocrivella.me).
-Read [LICENSE](LICENSE.md) for details.
+Copyright 2020 [Pablo Crivella](https://pablocrivella.me).
+Read [LICENSE](LICENSE) for details.

data/lib/complicode.rb

@@ -6,10 +6,5 @@ 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/generator"
 require "complicode/version"

data/lib/complicode/generator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Complicode
+  class Generator
+    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 authorization_code [String]
+    # @param key [String]
+    # @param invoice [Complicode::Invoice]
+    # @return [String]
+    def call(authorization_code:, key:, invoice:)
+      key.freeze
+
+      seeds = [
+        invoice.number.to_s,
+        invoice.nit.to_s,
+        invoice.issue_date.strftime("%Y%m%d"),
+        invoice.amount.round.to_s,
+      ]
+
+      seeds = append_verification_digits(seeds, 2)
+      digits = generate_verification_digits(seeds)
+      partial_keys = generate_partial_keys(key.dup, digits)
+
+      seeds.unshift(authorization_code)
+      seeds = append_partial_keys(seeds, partial_keys)
+
+      encryption_key = key + digits
+      encrypted_data = encrypt(seeds.join, encryption_key)
+
+      ascii_sums = generate_ascii_sums(encrypted_data, partial_keys.count)
+      base64_data = generate_base64_data(ascii_sums, partial_keys)
+
+      format(encrypt(base64_data, encryption_key))
+    end
+
+    def append_verification_digits(seed, count)
+      case seed
+      when Array
+        seed.map { |seed| append_verification_digits(seed, count) }
+      else
+        count.times do
+          seed = seed.to_s + Verhoeff.checksum_digit_of(seed).to_s
+        end
+
+        seed
+      end
+    end
+
+    # @param invoice [Array<String>]
+    # @return [String]
+    def generate_verification_digits(seeds)
+      sum = seeds.map(&:to_i).sum
+      sum = append_verification_digits(sum, 5)
+      sum.to_s[-5..-1]
+    end
+
+    # @param key [String]
+    # @param digits [String]
+    # @return [Array<Complicode::PartialKey>]
+    def generate_partial_keys(key, digits)
+      partial_key_sizes = digits.split("").map { |digit| digit.to_i + 1 }
+      partial_key_sizes.map { |index| PartialKey.new(value: key.slice!(0...index)) }
+    end
+
+    def append_partial_keys(seeds, partial_keys)
+      seeds.map.with_index { |seed, index| seed + partial_keys[index].value }
+    end
+
+    # @param encrypted_data [String]
+    # @param partials_count [Integer]
+    # @return [Struct]
+    def generate_ascii_sums(data, partials_count)
+      Struct.new(:total, :partials).new(0, Array.new(partials_count, 0)).tap do |sums|
+        data.each_byte.with_index do |byte, index|
+          sums.total += byte
+          sums.partials[index % partials_count] += byte
+        end
+      end
+    end
+
+    # @param ascii_sums [Struct]
+    # @param partial_keys [Array<String>]
+    # @return [String]
+    def generate_base64_data(ascii_sums, partial_keys)
+      ascii_sums.partials.each_with_index.inject(0) { |sum, (partial_sum, index)|
+        sum + ascii_sums.total * partial_sum / partial_keys[index].size
+      }.b(10).to_s(BASE64)
+    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/invoice.rb

@@ -2,39 +2,17 @@
 
 module Complicode
   class Invoice
-    attr_accessor :nit, :amount, :issue_date, :number
+    attr_reader :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(:+)
+    # @param [Integer] :nit
+    # @param [Integer] :number
+    # @param [Float] :amount
+    # @param [Date] :issue_date
+    def initialize(nit:, number:, issue_date:, amount:)
+      @amount = Float(amount)
+      @nit = Integer(nit)
+      @number = Integer(number)
+      @issue_date = Date.parse(issue_date.to_s)
     end
   end
 end

data/lib/complicode/partial_key.rb

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

data/lib/complicode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: complicode
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Pablo Crivella
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: radix
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,61 +137,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: smarter_csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: smarter_csv
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.1'
 description: Control code generator for invoices inside the Bolivian national tax
   service.
 email:
@@ -205,12 +205,7 @@ 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/generator.rb
 - lib/complicode/invoice.rb
 - lib/complicode/partial_key.rb
 - lib/complicode/version.rb
@@ -236,8 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Complicode! A needlessly complicated code generator!

data/lib/complicode/generate.rb

@@ -1,58 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# 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