czech_bank_account 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c38c48865d97356e32dc0a64570781b4b00025d63107cfa6ac596ef6df012c7
-  data.tar.gz: 70aba6374a3ed569a7877eab247747b1b40653f8378bda374f145580c191ba5e
+  metadata.gz: afa1b5d1a560d14d6796cd23d4dfce263ab899454d361924392961f14b5eb617
+  data.tar.gz: 93a1ccf26074b734f8ac125be099e966f01847c41dbc0ed4aa879554e1f23889
 SHA512:
-  metadata.gz: c9792b21bd4efc892dbdedf15902cedb9f11d4b6ad14ee8124741c54dc0913901d7a14f26dac1d2d2a15f1fed3ca2bef90be830d630850941bd649350939255c
-  data.tar.gz: 60583111a448444cb5b4d6126cffb90dea039bbc4131e42a9495e829922ee0a243126b430271232d05b379192c77818216322a104d7aa52b6551e72dcfe242aa
+  metadata.gz: b0e473c20496399627495b20cab1e2173581f6b4512e9615786aa0108a7190cf6e6f8f3b834477a381fe8ea3deb5ba1d7b5eeedf6744777acef91cb6df9d7638
+  data.tar.gz: e9c4710e01dfdb0e6cc7cd4319262a2657ffbe94d7e4e127ca2ecf47e074a9cce6bdd07bc52e4f1a7b5ee6fb68338ec025a47a1bdeaf5b89a2d821141b6fda6a

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4

data/README.md

@@ -1,8 +1,7 @@
-# CzechBankAccount
+# CzechBankAccount [![Build Status](https://www.travis-ci.org/Masa331/czech_bank_account.svg?branch=master)](https://www.travis-ci.org/Masa331/czech_bank_account)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/czech_bank_account`. To experiment with that code, run `bin/console` for an interactive prompt.
+Czech bank accounts validations with official Czech National Bank algorithm.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,20 +19,77 @@ Or install it yourself as:
 
     $ gem install czech_bank_account
 
+
 ## Usage
 
-TODO: Write usage instructions here
+Initialize `CzechBankAccount::Account` and call `validate` on it:
+```
+number = '36-6420840257' # bank account number with optional prefix but without bank code
+bank_code = '0301' # separate bank code
+account = CzechBankAccount::Account.new(number, bank_code)
+
+account.validate # returns array with error symbols
+#=> [:prefix_doesnt_pass_checksum, :unknown_bank_code]
+```
+
+Or use a shortcut which returns errors directly:
+```
+CzechBankAccount.validate('35-6420840257', '9999') # returns array with error symbols
+#=> [:unknown_bank_code]
+```
+
+
+### Possible error symbols
+
+1. `:number_is_empty`
+2. `:bank_code_is_empty`
+3. `:number_includes_not_allowed_characters`
+4. `:number_prefix_is_over_length_limit`
+5. `:number_is_over_or_under_length_limit`
+6. `:prefix_doesnt_pass_checksum`
+7. `:number_doesnt_pass_checksum`
+8. `:unknown_bank_code`
+
+
+### Usage in Rails
 
-## Development
+Prepare your own custom validation as per [Rails guide](https://guides.rubyonrails.org/active_record_validations.html#performing-custom-validations)
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For example ActiveModel::Validator could look like following:
+```
+# app/validators/czech_bank_account_validator.rb
+class CzechBankAccountValidator < ActiveModel::Validator
+  def validate(record)
+    errors = CzechBankAccount.validate(record.account_number, record.bank_code)
+    errors.each { |e| record.errors.add(:base, e) }
+  end
+end
+```
+
+Then in model:
+```
+class Invoice < ApplicationRecord
+  validates_with CzechBankAccountValidator
+end
+```
+
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/czech_bank_account.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Masa331/czech_bank_account.
+
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Links
+
+
+### Official docs for account validation algorithm
+
+* http://www.cnb.cz/miranda2/export/sites/www.cnb.cz/cs/platebni_styk/pravni_predpisy/download/vyhl_169_2011.pdf
+* http://www.cnb.cz/miranda2/export/sites/www.cnb.cz/cs/platebni_styk/ucty_kody_bank/download/kody_bank_CR.pdf
+* http://www.cnb.cz/cs/platebni_styk/ucty_kody_bank/index.html

data/czech_bank_account.gemspec

@@ -3,11 +3,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'czech_bank_account'
-  spec.version       = '0.1.1'
+  spec.version       = '1.0.0'
   spec.authors       = ['Premysl Donat']
   spec.email         = ['pdonat@seznam.cz']
 
-  spec.summary       = 'Library for working with czech bank account numbers'
+  spec.summary       = 'Library for validation of czech bank account numbers'
   spec.description   = spec.description
   spec.homepage      = 'https://github.com/Masa331/czech_bank_account'
   spec.license       = 'MIT'
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activemodel'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
 end

data/lib/czech_bank_account.rb

@@ -1,79 +1,10 @@
-require 'active_model/validator'
+require 'czech_bank_account/account'
 
 module CzechBankAccount
-  class BankAccountValidator < ActiveModel::Validator
-    # http://www.cnb.cz/miranda2/export/sites/www.cnb.cz/cs/platebni_styk/pravni_predpisy/download/vyhl_169_2011.pdf
-    # http://www.cnb.cz/miranda2/export/sites/www.cnb.cz/cs/platebni_styk/ucty_kody_bank/download/kody_bank_CR.pdf
-    # http://www.cnb.cz/cs/platebni_styk/ucty_kody_bank/index.html
+  KNOWN_BANK_CODES = ['0100', '0300', '0600', '0710', '0800', '2010', '2020', '2030', '2060', '2070', '2100', '2200', '2220', '2240', '2250', '2260', '2275', '2600', '2700', '3030', '3050', '3060', '3500', '4000', '4300', '5500', '5800', '6000', '6100', '6200', '6210', '6300', '6700', '6800', '7910', '7940', '7950', '7960', '7970', '7980', '7990', '8030', '8040', '8060', '8090', '8150', '8200', '8215', '8220', '8225', '8230', '8240', '8250', '8260', '8265', '8270', '8280', '8290', '8291', '8292', '8293', '8294']
 
-    WEIGHTS = [6, 3, 7, 9, 10, 5, 8, 4, 2, 1]
-    KNOWN_CODES = ["0100", "0300", "0600", "0710", "0800", "2010", "2020", "2030", "2060", "2070", "2100", "2200", "2220", "2240", "2250", "2260", "2275", "2600", "2700", "3030", "3050", "3060", "3500", "4000", "4300", "5500", "5800", "6000", "6100", "6200", "6210", "6300", "6700", "6800", "7910", "7940", "7950", "7960", "7970", "7980", "7990", "8030", "8040", "8060", "8090", "8150", "8200", "8215", "8220", "8225", "8230", "8240", "8250", "8260", "8265", "8270", "8280", "8290", "8291", "8292", "8293", "8294"]
-
-    def validate(record)
-      if record.number.blank?
-        record.errors.add(:base, :number_is_blank)
-      end
-
-      if record.bank_code.blank?
-        record.errors.add(:base, :bank_code_is_blank)
-      end
-
-      validate_allowed_chars(record)
-      validate_number(record)
-      validate_bank_code(record)
-    end
-
-    private
-
-    def validate_allowed_chars(record)
-      return if record.number.blank?
-
-      unless record.number.match?(/\A[0-9-]*\z/)
-        record.errors.add :base, :number_includes_not_allowed_characters
-      end
-    end
-
-    def validate_number(record)
-      return if record.number.blank?
-      return if record.number.count('-') > 1
-
-      if record.number.include? '-'
-        prefix, number = record.number.split '-'
-      else
-        prefix = nil
-        number = record.number
-      end
-
-      if prefix && prefix.length > 6
-        record.errors.add :base, :number_prefix_is_over_length_limit
-        return
-      end
-
-      if number && (number.length < 2 || number.length > 10)
-        record.errors.add :base, :number_is_over_or_under_length_limit
-        return
-      end
-
-      if prefix && weighted_sum(prefix) % 11 != 0
-        record.errors.add :base, :prefix_doesnt_pass_checksum
-      end
-
-      if number && weighted_sum(number) % 11 != 0
-        record.errors.add :base, :number_doesnt_pass_checksum
-      end
-    end
-
-    def validate_bank_code(record)
-      unless KNOWN_CODES.include? record.bank_code
-        record.errors.add :base, :unknown_bank_code
-      end
-    end
-
-    def weighted_sum(number)
-      normalized = number.rjust(10, '0')
-      chars = normalized.chars.map(&:to_i)
-      zipped = chars.zip WEIGHTS
-      zipped.inject(0) { |acc, pair| acc + pair.first * pair.last }
-    end
+  def self.validate(number, bank_code)
+    account = Account.new(number, bank_code)
+    account.validate
   end
 end

data/lib/czech_bank_account/account.rb

@@ -0,0 +1,80 @@
+module CzechBankAccount
+  class Account
+    WEIGHTS = [6, 3, 7, 9, 10, 5, 8, 4, 2, 1]
+
+    attr_reader :number, :bank_code
+
+    def initialize(number = nil, bank_code = nil)
+      @number, @bank_code = number.to_s, bank_code.to_s
+    end
+
+    def validate
+      errors = []
+
+      if number.empty?
+        errors << :number_is_empty
+      end
+
+      if bank_code.empty?
+        errors << :bank_code_is_empty
+      end
+
+      validate_allowed_chars(errors)
+      validate_number(errors)
+      validate_bank_code(errors)
+
+      errors
+    end
+
+    private
+
+    def validate_allowed_chars(errors)
+      unless number.match?(/\A[0-9-]*\z/)
+        errors << :number_includes_not_allowed_characters
+      end
+    end
+
+    def validate_number(errors)
+      return if number.empty?
+      return if number.count('-') > 1
+
+      if number.include? '-'
+        prefix, base = number.split '-'
+      else
+        prefix = nil
+        base = number
+      end
+
+      if prefix && prefix.length > 6
+        errors << :number_prefix_is_over_length_limit
+        return
+      end
+
+      if base && (base.length < 2 || base.length > 10)
+        errors << :number_is_over_or_under_length_limit
+        return
+      end
+
+      if prefix && weighted_sum(prefix) % 11 != 0
+        errors << :prefix_doesnt_pass_checksum
+      end
+
+      if number && weighted_sum(base) % 11 != 0
+        errors << :number_doesnt_pass_checksum
+      end
+    end
+
+    def validate_bank_code(errors)
+      unless CzechBankAccount::KNOWN_BANK_CODES.include? bank_code
+        errors << :unknown_bank_code
+      end
+    end
+
+    def weighted_sum(number)
+      normalized = number.rjust(10, '0')
+      chars = normalized.chars.map(&:to_i)
+      zipped = chars.zip WEIGHTS
+      zipped.inject(0) { |acc, pair| acc + pair.first * pair.last }
+    end
+  end
+end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: czech_bank_account
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Premysl Donat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -46,11 +60,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - czech_bank_account.gemspec
 - lib/czech_bank_account.rb
+- lib/czech_bank_account/account.rb
 homepage: https://github.com/Masa331/czech_bank_account
 licenses:
 - MIT
@@ -70,9 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
-summary: Library for working with czech bank account numbers
+summary: Library for validation of czech bank account numbers
 test_files: []