bicvalidator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c4948e91746bcb124c9d33372fda62cbbc8a50
+  data.tar.gz: 3f3c9a92e6ddbc64f51f083173c93d0698c8e864
+SHA512:
+  metadata.gz: 6d8faf6aec2ea70def953d1cce0690c95624b25308a48c44dcf70a011e96d71aedc0fbb4a3653bf066f3479f4f9c8a88ed80411af44660b714468f26eb2bd959
+  data.tar.gz: ac67c7a192dd9a59cb068651c6339c0ba6146dd2300f8791c75946abf35498607a042a50fbb051ea674017d0f07093b4539dc2dff091258d5f8d63770bb18f7e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+#git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bicvalidator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,98 @@
+# Bicvalidator
+Mit dem BicValidator kann man eine Validitäsprüfung und Korrektur (Leerzeichen, Groß/Kleinschreibung) von übergebenen BIC werten durchführen um diese zu prüfen bevor man diese weiterverarbeitet.
+Neben der Länge des Codes und den möglichen Ländercodes kann man auch überprüfen ob das Land der BIC (4+5 Stelle) am SepaSchema teilnimmt. 
+Optional kann man den Check auch ausstellen.
+
+
+## Installation
+
+Das muss ins Gemfile:
+
+```ruby
+gem 'bicvalidator',:git => 'https://github.com/olafkaderka/bicvalidator.git', :branch => 'master'
+```
+
+Und dann ausführen:
+
+    $ bundle
+
+## Usage
+
+### Sepa-Ländercodesänderung (falls gewünscht)
+Man kann die standardmäßig vorgegebenen Ländercodes die zum Separaum gehören überschreiben z.b. in einem Rails initializer.
+Zur Zeit wird dieser Wert standardmäßig gesetzt auf alle Länder gemäß [dieser Liste](https://wiki.xmldation.com/Support/EPC/List_of_SEPA_countries).
+
+In den Bics sind mehr Länder als in den IBANS, denn die französischen und englischen Kolonien haben gemaess BIC einen eigenen Ländercode , in der IBAN aber nicht. 
+* ["GF","GP","GG","IM","JE","MQ","YT","RE","BL","MF","PM", "PF", "TF", "NC","WF"] sind die Ländercodes der Kolonien.
+
+* **Bicvalidator.sepa_bic_countries = []**
+
+### Instanz Initialisierung
+**Bicvalidator::Validate.new(options={})**
+
+Das Objekt erwartet nur einen Parameter options als hash in dem man die möglichen vorhanden Wert übergeben kann
+* **:bic_code** String mit dem BicCode
+* **:bic_bankcode** String lokale BLZ des Landes, (Land muss dann auch kommen)
+* **:bic_country** String ISO 3166-1 alpha-2 (2 Stellig)
+* **:sepa_country_check** true/false soll direkt überprüft werden ob das land im Separaum ist. **default => true**
+
+Alle übergeben Werte werden automatsich korrigiert falls möglich (Gross/Klein, Leerzeichen entfernt)
+Das Object hat dann folgende Attribute auf die man zugreifen kann:
+* **:errorcode, :bic_bankcode, :bic_code, :bic_country, :sepa_country**
+
+### Beipiele
+**bv = Bicvalidator::Validate.new({:bic_code  => " GENODEM 1A HL "})**
+  * bv.bic_code => "GENODEM1AHL"
+  * bv.bic_country => "DE"
+  * bv.errorcode => nil
+  * bv.sepa_country => true
+
+**bv = Bicvalidator::Validate.new({:bic_code  => "GENNAEXS"})**
+  * bv.bic_code => "GENNAEXS"
+  * bv.bic_country => "AE"
+  * bv.errorcode => "BV0026" (Kein SEPA Land)
+  * bv.sepa_country => false
+
+**bv = Bicvalidator::Validate.new({:bic_code  => "GENNAEXS", :sepa_country_check => false})**
+  * bv.bic_code => "GENNAEXS"
+  * bv.bic_country => "AE"
+  * bv.errorcode => nil
+  * bv.sepa_country => false
+
+
+
+### Errorcodes
+
+* "BV0000": BicValidator keine Werte zum überprüfen
+* "BV0010": BIC ungültige Zeichen
+* "BV0011": BIC ungültige Länge
+* "BV0020": BIC Land ungültige Zeichen
+* "BV0021": BIC Land ungültige Länge
+* "BV0025": BIC Land unbekannt
+* "BV0026": BIC Land Kein SEPA Land
+* "BV0030": BIC Bankcode ohne Land
+* "BV0032": BIC Bankcode undgültige Zeichen (allgemein)
+* "BV0040": BIC Bankcode ungültig (länderspezfisch)
+
+
+
+### Tests per Rspec
+bundle exec rspec spec
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/olafkaderka/bicvalidator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bicvalidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/olafkaderka/bicvalidator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bicvalidator.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bicvalidator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bicvalidator"
+  spec.version       = Bicvalidator::VERSION
+  spec.authors       = ["Olaf Kaderka"]
+  spec.email         = ["okaderka@yahoo.de"]
+
+  spec.summary       = %q{Klasse um BICS auf Konsistenz zur validieren}
+  spec.description   = %q{prüft den Ländercode und die Zugehörigkeit zum SepaSchema}
+  spec.homepage      = "https://github.com/olafkaderka/bicvalidator/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+
+  #for mattr_accessor, reverse_merge
+  spec.add_dependency "activesupport", '~> 4.0'
+  
+  #laender 
+  #Countries is a collection of all sorts of useful information for every country in the ISO 3166 standard. 
+  #It contains info for the following standards ISO3166-1 (countries),
+  #ISO3166-2 (states/subdivisions), ISO4217 (currency) and E.164 (phone numbers)
+  #https://github.com/hexorx/countries
+  spec.add_dependency "countries", '~> 2.1'
+
+
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bicvalidator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bicvalidator.rb

@@ -0,0 +1,159 @@
+require "bicvalidator/version"
+require 'active_support'
+require 'active_support/core_ext'
+#brauch ich fuer laendercodes ISO3166::Country
+require 'countries'
+
+module Bicvalidator
+  #mattr_accessor kommt aus active_support/core_ext'
+  mattr_accessor :sepa_bic_countries
+
+  ##https://wiki.xmldation.com/Support/EPC/List_of_SEPA_countries
+  #kann ich somit in einem initailizer wieder ueberschreiben
+  Bicvalidator.sepa_bic_countries = ["AT", "BE", "BG", "CH", "CY", "CZ", "DE", "DK", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IT", "LI", "LT", "LU", "LV", "MC", "MT", "NL", "NO", "PL", "PT", "RO", "SE", "SI", "SK", "SM", "GI", "GF", "GP", "GG", "IS", "IM", "JE", "MQ", "YT", "RE", "BL", "MF", "PM"]
+
+
+    class Validate
+      attr_accessor :errorcode, :bic_bankcode, :bic_code, :bic_country, :sepa_country
+
+      def initialize(options={})  
+          default_options = {
+            :bic_code => nil,
+            :bic_bankcode => nil,
+            :bic_country => nil, 
+            :sepa_country_check => true,
+          }
+          @options = options.reverse_merge(default_options)
+          @errorcode = nil
+          @sepa_country = false
+          self.start_validation
+      end
+
+      def start_validation
+          #hier muss auch = "" abgefangen werden, daher check mit blank?
+          @bic_code = @options[:bic_code].blank? ? nil :  @options[:bic_code]
+          @bic_bankcode = @options[:bic_bankcode].blank? ? nil : @options[:bic_bankcode]
+          @bic_country = @options[:bic_country].blank? ? nil :  @options[:bic_country]     
+         
+
+          if [@bic_code,@bic_bankcode,@bic_country].all? {|x| x.nil?}
+            @errorcode = "BV0000"
+            return
+          end
+
+          @sepa_country_check = @options[:sepa_country_check]
+
+          if @bic_code
+            #strip reicht nicht denn strip entfernt nur leerzeichen vorne und hinten
+            @bic_code = self.canonicalize_str(@bic_code)
+
+                          #invalid character     
+            if (@bic_code =~ /^[A-Z0-9]+$/).nil?
+              @bic_code = nil
+              @errorcode = "BV0010"
+              return 
+            end
+
+            #muss 8 oder 11 stellen haben
+            case @bic_code.length
+            when 8
+              #wir furllen immer mit XXX auf 11 Stellen auf 
+              @bic_code = "#{@bic_code}XXX"
+            when 11
+              
+            else
+              @bic_code = nil
+              @errorcode = "BV0011"
+              return
+            end
+            #wir setzen bic_country auf die 4+5 Stelle des der BIC
+            @bic_country = @bic_code[4..5]
+
+          end    
+
+          #egal ob durch biccode gesetzt oder das land ubergeben wurde immer st checkn ob da was geht
+          if @bic_country
+            #strip reicht nicht denn strip entfernt nur leerzeichen vorne und hinten
+            @bic_country = self.canonicalize_str(@bic_country)
+
+            if @bic_country.length != 2
+              @bic_country = nil
+              @errorcode = "BV0020" 
+              return
+            end
+            if (@bic_country =~ /^[A-Z]+$/).nil?
+              @bic_country = nil
+              @errorcode = "BV0021"
+              return 
+            end
+
+            #gibts das land uberhaupt zb wenn ZZ kommt
+            if ISO3166::Country.new("#{@bic_country}").nil?
+              @bic_country = nil
+              @errorcode = "BV0025" 
+              return
+            end
+
+            if Bicvalidator.sepa_bic_countries.include? @bic_country
+              @sepa_country = true
+            end
+
+            if @sepa_country_check and !@sepa_country
+              @errorcode = "BV0026"
+              return 
+            end
+
+          end
+
+          if @bic_bankcode
+            
+            if !@bic_country 
+              #bankcode ohne land geht nicht
+              @errorcode = "BV0030" 
+              return
+            end
+           
+            #strip reicht nicht denn strip entfernt nur leerzeichen vorne und hinten
+            @bic_bankcode = self.canonicalize_str(@bic_bankcode)
+
+            #es duerfen nur A-Z und 0-9 kommne, keine Sonderzeichen
+            if (@bic_bankcode =~ /^[A-Z0-9]+$/).nil?
+              @bic_bankcode = nil
+              @errorcode = "BV0032"
+              return 
+            end
+
+            return if !["DE","AT","ES","CH"].include? @bic_country
+            
+            #kontonummer in DE 8 stellig
+            case @bic_country
+            when "AT","CH"
+              #kontonummer in AT 5 stellig Zahlen
+              rule = '^[0-9]{5}$'
+            when "DE","ES"
+              #kontonummer in DE 8 stellig Zahlen
+              rule = '^[0-9]{8}$'
+            end
+
+            if regexp = Regexp.new(rule).match(@bic_bankcode)
+              #hat er gefunden
+            else
+              @bic_bankcode = nil
+              @errorcode = "BV0040"
+              return
+            end
+          
+          end   
+
+
+      end
+
+
+
+      def canonicalize_str(str)
+        str.strip.gsub(/\s+/, '').upcase
+      end
+
+    end
+
+end

data/lib/bicvalidator/version.rb

@@ -0,0 +1,3 @@
+module Bicvalidator
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: bicvalidator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Olaf Kaderka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: countries
+  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'
+description: prüft den Ländercode und die Zugehörigkeit zum SepaSchema
+email:
+- okaderka@yahoo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bicvalidator.gemspec
+- bin/console
+- bin/setup
+- lib/bicvalidator.rb
+- lib/bicvalidator/version.rb
+homepage: https://github.com/olafkaderka/bicvalidator/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Klasse um BICS auf Konsistenz zur validieren
+test_files: []