ref

Author: sshaplygin

bik/bik.go

@@ -1,40 +1,75 @@
 package bik
 
 import (
-	"strconv"
+	"fmt"
 
 	"github.com/sshaplygin/docs-code/models"
 	"github.com/sshaplygin/docs-code/utils"
 )
 
-// Validate check to valid BIK format
-// example valid format is 044525225
-func Validate(bik string) (bool, error) {
-	if len(bik) != 9 {
-		return false, &models.CommonError{
+const codeLength = 9
+
+type BIKStruct struct {
+	country       CountryCode
+	territoryCode TerritoryCode
+	unitNumber    UnitConditionalNumber
+	lastNumber    LastAccountNumbers
+}
+
+func NewBik(bik string) (*BIKStruct, error) {
+	if len(bik) != codeLength {
+		return nil, &models.CommonError{
 			Method: packageName,
 			Err:    models.ErrInvalidLength,
 		}
 	}
 
 	bikArr, err := utils.StrToArr(bik)
 	if err != nil {
-		return false, err
+		return nil, fmt.Errorf("cound't parse raw bik: %w", err)
 	}
 
-	if bikArr[0] != 0 || bikArr[1] != 4 {
+	return &BIKStruct{
+		country:       CountryCode(utils.SliceToInt(bikArr[0:2])),
+		territoryCode: TerritoryCode(utils.SliceToInt(bikArr[2:4])),
+		unitNumber:    UnitConditionalNumber(utils.SliceToInt(bikArr[4:6])),
+		lastNumber:    LastAccountNumbers(utils.SliceToInt(bikArr[6:])),
+	}, nil
+}
+
+func (bs *BIKStruct) IsValid() (bool, error) {
+	if bs == nil {
+		return false, ErrNilBik
+	}
+
+	if !bs.country.IsValid() {
 		return false, ErrInvalidCountryCode
 	}
 
-	// special code
-	if bikArr[6] == 0 && bikArr[7] == 1 && bikArr[8] == 2 {
-		return true, nil
+	if !bs.territoryCode.IsValid() {
+		return false, ErrInvalidTerritoryCode
 	}
 
-	latestTriadStr := bik[6:]
-	code, _ := strconv.Atoi(latestTriadStr)
+	if !bs.unitNumber.IsValid() {
+		return false, ErrInvalidUnitConditionalNumber
+	}
+
+	if !bs.lastNumber.IsValid() {
+		return false, ErrInvalidLastAccountNumbers
+	}
+
+	return true, nil
+}
+
+// Validate check to valid BIK format.
+// Example valid format is 044525225
+func Validate(bik string) (bool, error) {
+	bikData, err := NewBik(bik)
+	if err != nil {
+		return false, fmt.Errorf("create bik model: %w", err)
+	}
 
-	return code >= 50 && code < 1000, nil
+	return bikData.IsValid()
 }
 
 func Generate() string {

bik/errros.go

@@ -3,6 +3,18 @@ package bik
 import "errors"
 
 var (
+	// ErrNilBik try call methods for nil bik struct
+	ErrNilBik = errors.New("nil bik struct")
+
 	// ErrInvalidCountryCode invalid bik code country
 	ErrInvalidCountryCode = errors.New("invalid bik country code")
+
+	// ErrInvalidTerritoryCode invalid okato territorial code of the subject
+	ErrInvalidTerritoryCode = errors.New("invalid okato city code")
+
+	// ErrInvalidUnitConditionalNumber invalid unit conditional number
+	ErrInvalidUnitConditionalNumber = errors.New("invalid unit conditional number")
+
+	// ErrInvalidLastAccountNumbers invalid okato territorial code of the subject
+	ErrInvalidLastAccountNumbers = errors.New("invalid last account number")
 )

bik/models.go

@@ -1,3 +1,77 @@
 package bik
 
 const packageName = "bik"
+
+const (
+	maxCountryCodeLength     = 100
+	maxTerritoryCodeLength   = 100
+	maxInitConditionalNumber = 100
+	minLastAccountNumbers    = 50
+	maxLastAccountNumbers    = 1000
+)
+
+var (
+	// directParticipationCounty - участник платежной системы с прямым участием
+	directParticipationCounty CountryCode = 0
+
+	// indirectParticipationCounty - участник платежной системы с косвенным участием
+	indirectParticipationCounty CountryCode = 1
+
+	// notMemberClientCBRF - клиент Банка России, не являющийся участником платежной системы
+	notMemberClientCBRF CountryCode = 2
+
+	russiaCountryCode CountryCode = 4
+)
+
+var supportedCountryCodes = map[CountryCode]string{
+	directParticipationCounty:   "Участник платежной системы с прямым участием",
+	indirectParticipationCounty: "Участник платежной системы с косвенным участием",
+	notMemberClientCBRF:         "Клиент Банка России, не являющийся участником платежной системы",
+	russiaCountryCode:           "Код Российской Федерации",
+}
+
+type (
+	// CountryCode Required length 2.
+	CountryCode int
+
+	// TerritoryCode OKATO code. Required length 2.
+	TerritoryCode int
+
+	// UnitConditionalNumber required length 2.
+	// The conditional number of the Bank of Russia settlement network division,
+	// unique within the territorial institution of the Bank of Russia,
+	// in which this division of the Bank of Russia settlement network operates,
+	// or the conditional number of the structural division of the Bank of Russia.
+	UnitConditionalNumber int
+
+	// LastAccountNumbers required length 3. It is last correspondent account of the bank. Possible values 050 до 999
+	LastAccountNumbers int
+)
+
+func (cc CountryCode) IsValid() bool {
+	if cc > maxCountryCodeLength {
+		return false
+	}
+
+	_, ok := supportedCountryCodes[cc]
+
+	return ok
+}
+
+func (tc TerritoryCode) IsValid() bool {
+	return tc < maxTerritoryCodeLength
+}
+
+func (ucn UnitConditionalNumber) IsValid() bool {
+	return ucn < maxInitConditionalNumber
+}
+
+const specialCode = 12
+
+func (lan LastAccountNumbers) IsValid() bool {
+	if lan == specialCode {
+		return true
+	}
+
+	return lan >= minLastAccountNumbers && lan < maxLastAccountNumbers
+}

utils/helpers.go

@@ -32,3 +32,11 @@ func StrToArr(str string) ([]int, error) {
 	}
 	return arr, nil
 }
+
+func SliceToInt(data []int) int {
+	var res int
+	for _, num := range data {
+		res = res*10 + num
+	}
+	return res
+}

utils/helpers_test.go

@@ -0,0 +1,40 @@
+package utils
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_SliceToInt(t *testing.T) {
+	type testCase struct {
+		name string
+		in   []int
+		want int
+	}
+
+	tests := []testCase{
+		{
+			"nil",
+			nil,
+			0,
+		},
+		{
+			"102",
+			[]int{1, 0, 2},
+			102,
+		},
+		{
+			"with zero prefix 02",
+			[]int{0, 2},
+			2,
+		},
+	}
+
+	for _, tc := range tests {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			assert.Equal(t, tc.want, SliceToInt(tc.in))
+		})
+	}
+}