viitelaskuri 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc/**
+pkg/**
+doc/**

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2010-05-28
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,58 @@
+Viitelaskuri
+    by Toni Tuominen
+    http://github.com/tjtuom/viitelaskuri
+
+== DESCRIPTION:
+
+A collection of methods for calculating finnish bank references.
+
+== FEATURES/PROBLEMS:
+
+* Calculate the check number for different numbers
+* Format the reference number
+* Check for validity of existing references
+* Generate (almost certainly) unique references
+
+== SYNOPSIS:
+
+To calculate a valid reference from an invoice id for instance use something along these lines.
+
+require 'viitelaskuri'
+Viitelaskuri.calculate(100) # => 1009
+
+See the documentation for other uses.
+
+== REQUIREMENTS:
+
+None.
+
+Tested on ruby 1.8.7 but should work on other versions as well.
+
+== INSTALL:
+
+sudo gem install viitelaskuri
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Toni Tuominen
+
+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/Rakefile

@@ -0,0 +1,19 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'spec:run'
+task 'gem:release' => 'spec:run'
+
+Bones {
+  name  'viitelaskuri'
+  authors  'Toni Tuominen'
+  email    'toni@piranhadigital.fi'
+  url      'http://github.com/tjtuom/viitelaskuri'
+  ignore_file  '.gitignore'
+  depend_on 'rspec', :development => true
+}
+

data/lib/viitelaskuri.rb

@@ -0,0 +1,106 @@
+# A collection of methods for calculating
+# bank references for finnish invoices.
+module Viitelaskuri
+  autoload :Version, 'viitelaskuri/version'
+
+  extend self
+
+  # Calculates the bank reference for a given number
+  #
+  # @param [Number, String] seed The number to calculate the check number for. For instance in invoice number.
+  # @return [Integer] The bank reference calculated.
+  # @raise [ArgumentError] Raises an error if the seed is less than 3 or more than 19 digits.
+  def calculate(seed)
+    str = seed.to_s
+
+    if str.length < 3
+      raise ArgumentError.new('The seed must be at least 3 digits.')
+    end
+
+    if str.length > 19
+      raise ArgumentError.new('The seed must not be more than 19 digits.')
+    end
+
+    reversed = str.reverse
+    sum = 0
+    coefficients = [7, 3, 1]
+    i = 0
+    reversed.each_char do |c|
+      n = c.to_i
+      sum += n * coefficients[i % 3]
+      i += 1
+    end
+    # sum -> nearest full ten - sum
+    check = sum % 10 == 0 ? 0 : ((sum / 10).to_i + 1) * 10 - sum
+    str = str + check.to_s
+    str.to_i
+  end
+
+  # Formats a given number into five digit groups starting from the right
+  #
+  # @param [Number, String] ref The number to format.
+  # @return [String] The formatted string.
+  # @raise [ArgumentError] Raises an error if the ref is less than 4 or more than 20 digits.
+  def format(ref)
+    str = ref.to_s
+
+    if str.length < 4
+      raise ArgumentError.new('The seed must be at least 4 digits.')
+    end
+
+    if str.length > 20
+      raise ArgumentError.new('The seed must not be more than 20 digits.')
+    end
+
+     # organize in five letter groups starting from the right
+    in_groups_of(str.reverse.split(''), 5, false).map { |e| e.join('')  }.join(' ').reverse
+  end
+
+  # Checks if a given number is a valid bank reference
+  #
+  # @param [Number, String] ref The number to check.
+  # @return [Boolean] True if the ref is valid, false if not.
+  def valid?(ref)
+    if ref.to_s.length < 4 || ref.to_s.length > 20
+      return false
+    end
+
+    str = ref.to_s[0...-1]
+    calculate(str) == ref.to_i
+  end
+
+  # Generates an almost certainly unique bank reference.
+  # Uses a timestamp (10 digits) and a random number (9 digits)
+  # and adds the check number.
+  #
+  # @return [Integer] the generated bank reference.
+  def generate
+    time = Time.now.utc.to_i
+    random = 9.times.map { rand(10) }
+    calculate(time.to_s + random.to_s)
+  end
+
+  private
+
+  # borrowed from rails
+  def in_groups_of(array, number, fill_with = nil)
+    if fill_with == false
+      collection = array
+    else
+      # size % number gives how many extra we have;
+      # subtracting from number gives how many to add;
+      # modulo number ensures we don't add group of just fill.
+      padding = (number - array.size % number) % number
+      collection = array.dup.concat([fill_with] * padding)
+    end
+
+    if block_given?
+      collection.each_slice(number) { |slice| yield(slice) }
+    else
+      groups = []
+      collection.each_slice(number) { |group| groups << group }
+      groups
+    end
+  end
+
+end

data/lib/viitelaskuri/version.rb

@@ -0,0 +1,3 @@
+module Viitelaskuri
+  Version = '0.1.0'
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib viitelaskuri]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/spec/viitelaskuri_spec.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Viitelaskuri do
+
+  context "#calculate" do
+
+    it "calculates bank references" do
+      seeds = [100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 403, 693, 193626, 5926038623]
+      refs = [1009, 1012, 1025, 1038, 1041, 1054, 1067, 1070, 1083, 1096, 4035, 6936, 1936267, 59260386230]
+      seeds.each_with_index do |seed, i|
+        Viitelaskuri.calculate(seed).should == refs[i]
+      end
+    end
+
+    it 'raises an error if given a number less than 3 digits long' do
+      lambda { Viitelaskuri.calculate(10) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises an error if given a number more than 19 digits long' do
+      lambda { Viitelaskuri.calculate(12345678901234567890) }.should raise_error(ArgumentError)
+    end
+
+  end
+
+  context "#format" do
+
+    it 'formats bank references' do
+      refs = [[1009, '1009'], [1936267, '19 36267'], [59260386230, '5 92603 86230']]
+      refs.each do |ref|
+        Viitelaskuri.format(ref.first).should == ref.last
+      end
+    end
+
+    it 'raises an error if given a number less than 4 digits long' do
+      lambda { Viitelaskuri.format(100) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises an error if given a number more than 20 digits long' do
+      lambda { Viitelaskuri.format(123456789012345678901) }.should raise_error(ArgumentError)
+    end
+
+
+  end
+
+  context "#valid?" do
+
+    it 'validates references' do
+      refs = [[1009, true], [1008, false], ['19 36267', true], [100, false], [123456789012345678901, false]]
+      refs.each do |ref|
+        Viitelaskuri.valid?(ref.first).should == ref.last
+      end
+    end
+
+  end
+
+  context "#generate" do
+
+    it 'generates a random reference with almost certain uniqueness' do
+      ref = Viitelaskuri.generate
+      Viitelaskuri.valid?(ref).should be_true
+      ref.to_s.length.should == 20
+    end
+
+  end
+
+end

data/version.txt

@@ -0,0 +1 @@
+0.1.0

data/viitelaskuri.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{viitelaskuri}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toni Tuominen"]
+  s.date = %q{2010-05-30}
+  s.description = %q{A collection of methods for calculating finnish bank references.}
+  s.email = %q{toni@piranhadigital.fi}
+  s.extra_rdoc_files = ["History.txt", "README.txt", "version.txt"]
+  s.files = [".gitignore", "History.txt", "README.txt", "Rakefile", "lib/viitelaskuri.rb", "lib/viitelaskuri/version.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/viitelaskuri_spec.rb", "version.txt", "viitelaskuri.gemspec"]
+  s.homepage = %q{http://github.com/tjtuom/viitelaskuri}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{viitelaskuri}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A collection of methods for calculating finnish bank references}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<bones>, [">= 3.4.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<bones>, [">= 3.4.3"])
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: viitelaskuri
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Toni Tuominen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-30 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 4
+        - 3
+        version: 3.4.3
+  type: :development
+  version_requirements: *id002
+description: A collection of methods for calculating finnish bank references.
+email: toni@piranhadigital.fi
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+- version.txt
+files: 
+- .gitignore
+- History.txt
+- README.txt
+- Rakefile
+- lib/viitelaskuri.rb
+- lib/viitelaskuri/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/viitelaskuri_spec.rb
+- version.txt
+- viitelaskuri.gemspec
+has_rdoc: true
+homepage: http://github.com/tjtuom/viitelaskuri
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: viitelaskuri
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A collection of methods for calculating finnish bank references
+test_files: []
+