banktools-de 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b78faf6270b41240ca4265c79c4bc628353a7d30
-  data.tar.gz: 33a87d445276e51cbef63049034cbc49eb2bad70
+  metadata.gz: 010b6ad5764da47d0eee569b99a8494b4ea73d52
+  data.tar.gz: e02e69d013380a473866a788a04013831d8d775a
 SHA512:
-  metadata.gz: be1e8813bbb8b0cfb0cccf337563ea000a693ad12e5a94a29c3bb2b2b0920956d2afd4cc753e5c4c284843035d28810e43342e30bf0fd4f395fb8dd1bb8f782c
-  data.tar.gz: 6032a660b7646be3b186d0eeeba23f383d52d2a4a86b633645fc1ca621d6d2a1a2a2ad0827ed61559d1d6b89da7b47f2ee2062a0202242b19ba44aaa1d2f8b8d
+  metadata.gz: 76cac880128d73863d1d75a8d3eecb4db6f1121f06268b34a298504b3b8974312214334b9e4ef8b67be3cf0404f92c85927fabe8bf9b847fa133d10c0f3367dd
+  data.tar.gz: 9d9fc8c51b69eac2fcadf788caf721eaf39f65cc37156366c084d33bf5101518a44cd0c442c48420af0696002d24f909f5db6cbdd4fb41cc462b6e0316f320c5

data/README.md

@@ -1,46 +1,62 @@
 # German bank tools
 
-Ruby gem to validate, normalize/prettify and to some extent interpret German Bankleitzahl (BLZ) and bank account numbers.
+Ruby gem to validate, normalize/prettify and interpret German Bankleitzahl (BLZ) and bank account numbers.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'banktools-de'
-
-And then execute:
-
-    $ bundle
+When in doubt, this library aims to err on the side of allowing too much.
 
-Or install it yourself as:
+If we got anything wrong, please file an issue or contribute a fix yourself.
 
-    $ gem install banktools-de
 
 ## Usage
 
 (Very much in progress. Expect this list to change rapidly.)
 
+    # BLZ
+
     blz = BankTools::DE::BLZ.new("10070024")
     blz.normalize  # => "100 700 24"
+    blz.valid?  # => true
+    blz.errors  # => []
+
+    bad_blz = BankTools::DE::BLZ.new("1X")
+    bad_blz.valid?  # => false
+    bad_blz.errors  # => [ :too_short, :invalid_characters ]
+    bad_account.normalize  # => "1X"
+
 
 ## Tests
 
     rspec
     # or: rake
 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'banktools-de'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banktools-de
+
+
 ## Also see
 
 * [BankTools::SE (Swedish)](https://github.com/barsoom/banktools-se)
 * [iban-tools](https://github.com/iulianu/iban-tools)
 
+
 ## Credits and license
 
 By [Henrik Nyh](http://henrik.nyh.se) for [Barsoom](http://barsoom.se) under the MIT license:
 
 Copyright (c) 2014 Barsoom AB
 
-MIT License
-
 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

data/lib/bank_tools/de/blz.rb

@@ -1,8 +1,11 @@
 require "attr_extras"
+require "bank_tools/de/errors"
 
 module BankTools
   module DE
     class BLZ
+      LENGTH = 8
+
       pattr_initialize :original_value
 
       def normalize
@@ -13,6 +16,18 @@ module BankTools
         end
       end
 
+      def valid?
+        errors.empty?
+      end
+
+      def errors
+        errors = []
+        errors << Errors::TOO_SHORT if compacted_value.length < LENGTH
+        errors << Errors::TOO_LONG if compacted_value.length > LENGTH
+        errors << Errors::INVALID_CHARACTERS if compacted_value.match(/\D/)
+        errors
+      end
+
       private
 
       def compacted_value

data/lib/bank_tools/de/errors.rb

@@ -0,0 +1,9 @@
+module BankTools
+  module DE
+    module Errors
+      TOO_SHORT = :too_short
+      TOO_LONG = :too_long
+      INVALID_CHARACTERS = :invalid_characters
+    end
+  end
+end

data/lib/bank_tools/de/version.rb

@@ -1,5 +1,5 @@
 module BankTools
   module DE
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/blz_spec.rb

@@ -16,3 +16,33 @@ describe BankTools::DE::BLZ, "#normalize" do
     expect(BankTools::DE::BLZ.new(from).normalize).to eq unto
   end
 end
+
+describe BankTools::DE::BLZ, "#valid?" do
+  it "is true with no errors" do
+    expect(BankTools::DE::BLZ.new("123 456 78").valid?).to be_true
+  end
+
+  it "is false with errors" do
+    expect(BankTools::DE::BLZ.new("1").valid?).to be_false
+  end
+end
+
+describe BankTools::DE::BLZ, "#errors" do
+  Errors = BankTools::DE::Errors
+
+  it "is empty with no errors" do
+    expect(BankTools::DE::BLZ.new("123 456 78").errors).to eq []
+  end
+
+  it "includes TOO_SHORT if below 8 characters" do
+    expect(BankTools::DE::BLZ.new("1234567").errors).to include(Errors::TOO_SHORT)
+  end
+
+  it "includes TOO_LONG if above 8 characters" do
+    expect(BankTools::DE::BLZ.new("123456789").errors).to include(Errors::TOO_LONG)
+  end
+
+  it "includes INVALID_CHARACTERS if there are non-digits" do
+    expect(BankTools::DE::BLZ.new("1X").errors).to include(Errors::INVALID_CHARACTERS)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banktools-de
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Henrik Nyh
@@ -80,6 +80,7 @@ files:
 - banktools-de.gemspec
 - lib/bank_tools/de.rb
 - lib/bank_tools/de/blz.rb
+- lib/bank_tools/de/errors.rb
 - lib/bank_tools/de/version.rb
 - spec/blz_spec.rb
 - spec/spec_helper.rb