ref: move logic to packages

Author: sshaplygin

README.md

@@ -1,7 +1,7 @@
 # ru-doc-codes
 [![GoDoc](https://godoc.org/github.com/mrfoe7/ru-doc-code?status.svg)](https://godoc.org/github.com/mrfoe7/ru-doc-code) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrfoe7/ru-doc-code/blob/master/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/mrfoe7/ru-doc-code)](https://goreportcard.com/report/github.com/mrfoe7/ru-doc-code)
 
-It is validator about official codes of documents from Russia in Go 
+It is validator about official of code documents from Russia in Go 
 
 ## Usage 
 
@@ -11,26 +11,29 @@ It is validator about official codes of documents from Russia in Go
 
 ```go
 
-isValid, err := ru-doc-code.IsSNILSValid("112-233-445 95")
+import (
+	"log"
+	
+	"github.com/mrfoe7/ru-doc-codes/inn"
+)
+
+...
+
+isValid, err := inn.Validate("526317984689")
 if err != nil {
     log.Fatal(err)
 }
 if isValid {
-    log.Println("SNILS is valid")
+    log.Println("INN is valid")
 }
 
 ```
 
 ## Documentation
 
-- Check to valid INN  - [ИНН](https://ru.wikipedia.org/wiki/%D0%98%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80_%D0%BD%D0%B0%D0%BB%D0%BE%D0%B3%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%89%D0%B8%D0%BA%D0%B0)
-
-- Check to valid SNILS - [СНИЛС](http://www.consultant.ru/document/cons_doc_LAW_124607/68ac3b2d1745f9cc7d4332b63c2818ca5d5d20d0/)
-
-- Check to valid OGRN - [ОГРН](https://ru.wikipedia.org/wiki/%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%BE%D0%B9_%D0%B3%D0%BE%D1%81%D1%83%D0%B4%D0%B0%D1%80%D1%81%D1%82%D0%B2%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80)
-
-- Check to valid OGRNIP - [ОГРНИП](http://www.temabiz.com/terminy/chto-takoe-ogrnip.html)
-
-- Check to valid BIK - [БИК](https://ru.wikipedia.org/wiki/%D0%91%D0%B0%D0%BD%D0%BA%D0%BE%D0%B2%D1%81%D0%BA%D0%B8%D0%B9_%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BA%D0%BE%D0%B4)
-
-- Check to valid KPP - [КПП](https://ru.wikipedia.org/wiki/%D0%98%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80_%D0%BD%D0%B0%D0%BB%D0%BE%D0%B3%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%89%D0%B8%D0%BA%D0%B0#%D0%9A%D0%BE%D0%B4_%D0%BF%D1%80%D0%B8%D1%87%D0%B8%D0%BD%D1%8B_%D0%BF%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B8_%D0%BD%D0%B0_%D1%83%D1%87%D1%91%D1%82_(%D0%9A%D0%9F%D0%9F)
+- Info about INN  - [ИНН](https://ru.wikipedia.org/wiki/%D0%98%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80_%D0%BD%D0%B0%D0%BB%D0%BE%D0%B3%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%89%D0%B8%D0%BA%D0%B0)
+- Info about SNILS - [СНИЛС](http://www.consultant.ru/document/cons_doc_LAW_124607/68ac3b2d1745f9cc7d4332b63c2818ca5d5d20d0/)
+- Info about OGRN - [ОГРН](https://ru.wikipedia.org/wiki/%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%BE%D0%B9_%D0%B3%D0%BE%D1%81%D1%83%D0%B4%D0%B0%D1%80%D1%81%D1%82%D0%B2%D0%B5%D0%BD%D0%BD%D1%8B%D0%B9_%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80)
+- Info about OGRNIP - [ОГРНИП](http://www.temabiz.com/terminy/chto-takoe-ogrnip.html)
+- Info about BIK - [БИК](https://ru.wikipedia.org/wiki/%D0%91%D0%B0%D0%BD%D0%BA%D0%BE%D0%B2%D1%81%D0%BA%D0%B8%D0%B9_%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B9_%D0%BA%D0%BE%D0%B4)
+- Info about KPP - [КПП](https://dic.academic.ru/dic.nsf/ruwiki/239834)

bik/bik.go

@@ -0,0 +1,34 @@
+package bik
+
+import (
+	"strconv"
+
+	ru_doc_code "github.com/mrfoe7/go-codes-validator"
+)
+
+// Validate check to valid BIK format
+// example valid format is 044525225
+func Validate(bik string) (bool, error) {
+	if len(bik) != 9 {
+		return false, ru_doc_code.ErrInvalidBIKLength
+	}
+
+	bikArr, err := ru_doc_code.StrToArr(bik)
+	if err != nil {
+		return false, err
+	}
+
+	if bikArr[0] != 0 || bikArr[1] != 4 {
+		return false, ru_doc_code.ErrInvalidBIKCountryCode
+	}
+
+	// special code
+	if bikArr[6] == 0 && bikArr[7] == 1 && bikArr[8] == 2 {
+		return true, nil
+	}
+
+	latestTriadStr := bik[6:]
+	code, _ := strconv.Atoi(latestTriadStr)
+
+	return code >= 50 && code < 1000, nil
+}

bik/bik_test.go

@@ -0,0 +1,84 @@
+package bik
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	ru_doc_code "github.com/mrfoe7/go-codes-validator"
+)
+
+func TestValidate(t *testing.T) {
+	t.Parallel()
+
+	t.Run("invalid bik length", func(t *testing.T) {
+		testCases := []ru_doc_code.TestCodeCase{
+			{
+				Code:    "1234567888776",
+				Error:   ru_doc_code.ErrInvalidBIKLength,
+				IsValid: false,
+			},
+			{
+				Code:    "044525",
+				Error:   ru_doc_code.ErrInvalidBIKLength,
+				IsValid: false,
+			},
+			{
+				Code:    "044525225",
+				Error:   nil,
+				IsValid: true,
+			},
+			{
+				Code:    "044525012",
+				Error:   nil,
+				IsValid: true,
+			},
+		}
+		for _, test := range testCases {
+			isValid, err := Validate(test.Code)
+			assert.Equal(t, test.IsValid, isValid, test.Code)
+			assert.Equal(t, true, errors.Is(test.Error, err), test.Code)
+		}
+	})
+
+	t.Run("invalid bik value", func(t *testing.T) {
+		testCases := []ru_doc_code.TestCodeCase{
+			{
+				Code:    "0445?5226",
+				Error:   ru_doc_code.ErrInvalidValue,
+				IsValid: false,
+			},
+			{
+				Code:    "054525225",
+				Error:   ru_doc_code.ErrInvalidBIKCountryCode,
+				IsValid: false,
+			},
+			{
+				Code:    "104525225",
+				Error:   ru_doc_code.ErrInvalidBIKCountryCode,
+				IsValid: false,
+			},
+			{
+				Code:    "044#55#25",
+				Error:   ru_doc_code.ErrInvalidValue,
+				IsValid: false,
+			},
+			{
+				Code:    "044525225",
+				Error:   nil,
+				IsValid: true,
+			},
+			{
+				Code:    "044525012",
+				Error:   nil,
+				IsValid: true,
+			},
+		}
+		for _, test := range testCases {
+			isValid, err := Validate(test.Code)
+			assert.Equal(t, test.IsValid, isValid, test.Code, test.IsValid)
+			assert.Equal(t, true, errors.Is(test.Error, err), test.Code)
+		}
+	})
+}

helpers.go

@@ -0,0 +1,32 @@
+package ru_doc_code
+
+import (
+	"crypto/rand"
+	"math/big"
+	"strconv"
+	"strings"
+)
+
+func RandomDigits(len int) int64 {
+	if len <= 0 {
+		len = 1
+	}
+	max, _ := strconv.Atoi(strings.Repeat("9", len))
+	min, _ := strconv.Atoi("1" + strings.Repeat("0", len-1))
+
+	num, _ := rand.Int(rand.Reader, big.NewInt(int64(max-min+1)))
+	return num.Int64() + int64(min)
+}
+
+func StrToArr(str string) ([]int, error) {
+	numbers := strings.Split(str, "")
+	arr := make([]int, 0, len(numbers))
+	for _, number := range numbers {
+		number, err := strconv.Atoi(number)
+		if err != nil {
+			return []int{}, ErrInvalidValue
+		}
+		arr = append(arr, number)
+	}
+	return arr, nil
+}

inn/inn.go

@@ -0,0 +1,104 @@
+package inn
+
+import (
+	"strconv"
+	"strings"
+
+	ru_doc_code "github.com/mrfoe7/go-codes-validator"
+)
+
+const (
+	lengthLegal    = 10
+	lengthPhysical = 12
+)
+
+// Validate check to valid inn from input string.
+// example: input format is 7707083893
+func Validate(inn string) (bool, error) {
+	if len(inn) != lengthLegal && len(inn) != lengthPhysical {
+		return false, ru_doc_code.ErrInvalidINNLength
+	}
+
+	innArr, err := transformInn(inn)
+	if err != nil {
+		return false, err
+	}
+	if len(inn) == 10 {
+		return hash10(innArr) == innArr[len(innArr)-1], nil
+	}
+
+	return hash11(innArr) == innArr[len(innArr)-2] && hash12(innArr) == innArr[len(innArr)-1], nil
+}
+
+// GenerateLegal generate legal type inn string value.
+func GenerateLegal() string {
+	inn := strconv.FormatInt(ru_doc_code.RandomDigits(9), 10)
+	innArr, _ := transformInn(inn)
+
+	return inn + strconv.Itoa(hash10(innArr))
+}
+
+// GeneratePhysical generate physical type inn string value.
+func GeneratePhysical() string {
+	inn := strconv.FormatInt(ru_doc_code.RandomDigits(10), 10)
+	innArr, _ := transformInn(inn)
+
+	hash1Num := hash11(innArr)
+	innArr = append(innArr, hash1Num)
+
+	return strings.Join([]string{
+		inn,
+		strconv.Itoa(hash1Num),
+		strconv.Itoa(hash12(innArr)),
+	}, "")
+}
+
+func transformInn(inn string) ([]int, error) {
+	innNumbers := strings.Split(inn, "")
+	innArr := make([]int, 0, len(inn))
+
+	for _, str := range innNumbers {
+		number, err := strconv.Atoi(str)
+		if err != nil {
+			return nil, ru_doc_code.ErrInvalidValue
+		}
+		innArr = append(innArr, number)
+	}
+
+	return innArr, nil
+}
+
+// Generate generate random type inn string value.
+func Generate() string {
+	if ru_doc_code.RandomDigits(1)%2 == 1 {
+		return GeneratePhysical()
+	}
+
+	return GenerateLegal()
+}
+
+// IsEntrepreneur check inn for Entrepreneur type
+func IsEntrepreneur(inn string) bool {
+	return len(inn) == lengthPhysical
+}
+
+// IsCompany check inn for Company type
+func IsCompany(inn string) bool {
+	return len(inn) == lengthLegal
+}
+
+func hash10(innArr []int) int {
+	return ((2*innArr[0] + 4*innArr[1] + 10*innArr[2] + 3*innArr[3] +
+		5*innArr[4] + 9*innArr[5] + 4*innArr[6] + 6*innArr[7] + 8*innArr[8]) % 11) % 10
+}
+
+func hash11(innArr []int) int {
+	return ((7*innArr[0] + 2*innArr[1] + 4*innArr[2] + 10*innArr[3] + 3*innArr[4] +
+		5*innArr[5] + 9*innArr[6] + 4*innArr[7] + 6*innArr[8] + 8*innArr[9]) % 11) % 10
+}
+
+func hash12(innArr []int) int {
+	return ((3*innArr[0] + 7*innArr[1] + 2*innArr[2] + 4*innArr[3] +
+		10*innArr[4] + 3*innArr[5] + 5*innArr[6] + 9*innArr[7] + 4*innArr[8] +
+		6*innArr[9] + 8*innArr[10]) % 11) % 10
+}