NAME

Business::BR - base for other Business::BR modules

SYNOPSIS

use Business::BR::CPF; # no public interface on Business::BR by now
print "ok " if test_cpf('390.533.447-05'); 

# used in Business::BR::* modules (don't rely on this for the future)
use Business::BR qw(_dot);
my @digits = (1, 2, 3, 3);
my @weights = (2, 3, 2, 2);
my $dot = _dot(\@weights, \@digits); # computes 2*1+3*2+3*2+2*3

DESCRIPTION

This module is meant to provide a root for other Business::BR modules. By now, it doesn't provide any public interface, but it will.

If you want to see the action, take a look at Business::BR::CPF.

EXPORT

None by default.

You can explicitly ask for _dot() which is a sub to compute the dot product between two array refs (used for computing check digits).

TESTING CORRECTNESS

Among the functionalities to be made available in this distribution, we'll have tests for correctness of typical identification numbers and codes.

To be correct will mean here to satisfy certain easily computed rules. For example, a CPF number is correct if it is 11-digits-long and satisfy two check equations which validate the check digits.

The modules Business::BB::* will provide subroutines test_* for testing the correctness of such concepts.

To be correct does not mean that an identification number or code had been verified to stand for some real entry, like an actual Brazilian paytaxer citizen in the case of CPF. This would require access to government databases which may or may not be available in a public basis. And besides, to verify something will not be easily computed in general, implying access to databases and applying specialized rules.

Here we'll be trying to stick to a consistent terminology and 'correct' will always be used for validity against syntactical forms and shallow semantics. In turn, 'verified' will be used for telling if an entity really makes sense in the real world. This convention is purely arbitrary and for the sake of being formal in some way. Terms like 'test', 'verify', 'check', 'validate', 'correct', 'valid' are often used interchangeably in colloquial prose.

EXAMPLES

As a rule, the documentation and tests choose correct identification codes which are verified to be invalid by the time of the distribution update. That is, in Business::BR::CPF, the mentioned correct CPF number '390.533.447-05' is correct, but doesn't actually exist in government databases.

SEE ALSO

As you might have guessed, this is not the first Perl distribution to approach this kind of functionality. Take a look at

http://search.cpan.org/search?module=Brasil::Checar::CPF
http://search.cpan.org/search?module=Brasil::Checar::CGC
http://search.cpan.org/~mamawe/Algorithm-CheckDigits-0.38/CheckDigits/M11_004.pm

The namespace has been chosen based on similar modules for other countries, like Business::FR::SSN which tests the French "Numéro de Sécurité Sociale" and the Business::AU::* modules.

Please reports bugs via CPAN RT, http://rt.cpan.org/NoAuth/Bugs.html?Dist=biz-br

AUTHOR

A. R. Ferreira, <ferreira@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by A. R. Ferreira

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.