Skip to content

Commit 067c1d3

Browse files
ilemiashonakilemiashonak
authored
Phone parser (#33)
* data source links applied, type renaming * phone parser --------- Co-authored-by: ivan-lemiashonak <[email protected]>
1 parent 84081a4 commit 067c1d3

File tree

7 files changed

+94
-3
lines changed

7 files changed

+94
-3
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ func main() {
105105
- Email [(part of RFC5322)](https://tools.ietf.org/html/rfc5322) - [wiki](https://en.wikipedia.org/wiki/Email_address)
106106
- Timezone [(RFC6557 IANA timezones)](https://www.iana.org/time-zones) - [wiki](https://en.wikipedia.org/wiki/Time_zone)
107107
- Languages [(ISO 639-1)](https://www.iso.org/standard/22109.html) - [wiki](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes); [(ISO 639-2)](https://www.iso.org/standard/4767.html) - [wiki](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes), [data source](https://datahub.io/core/language-codes/r/language-codes-3b2.json)
108-
- BCP47 language tags [(wiki)](https://en.wikipedia.org/wiki/IETF_language_tag), [rfc](https://www.rfc-editor.org/info/bcp47)
109108
- Dial Codes [(E.164)](https://www.itu.int/rec/T-REC-E.164-201203-I!Sup6/en) - [wiki](https://en.wikipedia.org/wiki/E.164), [data source](https://datahub.io/core/country-codes/r/country-codes.json)
109+
- BCP47 language tags [(wiki)](https://en.wikipedia.org/wiki/IETF_language_tag), [rfc](https://www.rfc-editor.org/info/bcp47)

‎bcp47_language/swagger.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ components:
55
example: en-US
66
type: string
77
format: bcp47-language
8-
x-go-type: github.com/mikekonan/go-types/bcp47_language.Language
8+
x-go-type: github.com/mikekonan/go-types/v2/bcp47_language.Language

‎go.mod

+5
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,8 @@ require (
77
golang.org/x/text v0.9.0
88
gopkg.in/guregu/null.v4 v4.0.0
99
)
10+
11+
require (
12+
github.com/golang/protobuf v1.3.2 // indirect
13+
github.com/nyaruka/phonenumbers v1.1.7 // indirect
14+
)

‎go.sum

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d h1:Byv0BzEl3/e6D5CLfI0j/7hiIEtvGVFPCZ7Ei2oq8iQ=
22
github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
3+
github.com/golang/protobuf v1.3.2 h1:6nsPYzhq5kReh6QImI3k5qWzO4PEbvbIW2cwSfR/6xs=
4+
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
5+
github.com/nyaruka/phonenumbers v1.1.7 h1:5UUI9hE79Kk0dymSquXbMYB7IlNDNhvu2aNlJpm9et8=
6+
github.com/nyaruka/phonenumbers v1.1.7/go.mod h1:DC7jZd321FqUe+qWSNcHi10tyIyGNXGcNbfkPvdp1Vs=
37
golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
48
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
59
gopkg.in/guregu/null.v4 v4.0.0 h1:1Wm3S1WEA2I26Kq+6vcW+w0gcDo44YKYD7YIEJNHDjg=

‎phone/number.go

+39
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ import (
44
"database/sql/driver"
55
"encoding/json"
66
"fmt"
7+
"github.com/mikekonan/go-types/v2/country"
78
"strconv"
9+
10+
"github.com/nyaruka/phonenumbers"
811
)
912

1013
// Number represents a phone number type
@@ -61,3 +64,39 @@ func (number *Number) UnmarshalJSON(data []byte) error {
6164
func (number Number) String() string {
6265
return string(number)
6366
}
67+
68+
// StrictParse is Parse analogue with phone number region consistency check: fails if passed country is not matches parsed one
69+
func StrictParse(rawPhone string, country country.Alpha2Code) (DialCode, Number, error) {
70+
var parsed, err = phonenumbers.Parse(rawPhone, country.String())
71+
if err != nil {
72+
return "", "", err
73+
}
74+
75+
var valid = phonenumbers.IsValidNumber(parsed)
76+
if !valid {
77+
return "", "", fmt.Errorf(`%s phone number is not valid for %s region`, rawPhone, country.String())
78+
}
79+
80+
var dialCode = DialCode(strconv.Itoa(int(parsed.GetCountryCode())))
81+
if err = dialCode.Validate(); err != nil {
82+
return "", "", err
83+
}
84+
85+
return dialCode, Number(strconv.FormatUint(parsed.GetNationalNumber(), 10)), nil
86+
}
87+
88+
// Parse matches passed 'country' string representation to digits and searches for it at the beginning of 'rawPhone'.
89+
// If not found - consider whole passes 'rawPhone' as Number and use matched one 'country' as DialCode
90+
func Parse(rawPhone string, country country.Alpha2Code) (DialCode, Number, error) {
91+
var parsed, err = phonenumbers.Parse(rawPhone, country.String())
92+
if err != nil {
93+
return "", "", err
94+
}
95+
96+
var dialCode = DialCode(strconv.Itoa(int(parsed.GetCountryCode())))
97+
if err = dialCode.Validate(); err != nil {
98+
return "", "", err
99+
}
100+
101+
return dialCode, Number(strconv.FormatUint(parsed.GetNationalNumber(), 10)), nil
102+
}

‎phone/number_test.go

+43
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package phone
33
import (
44
"encoding/json"
55
"fmt"
6+
"github.com/mikekonan/go-types/v2/country"
67
"testing"
78
)
89

@@ -67,3 +68,45 @@ func TestNumber_Value(t *testing.T) {
6768
}
6869
}
6970
}
71+
72+
var parseTestCases = []struct {
73+
testPhoneNumber string
74+
testCountryCode country.Alpha2Code
75+
expectingError bool
76+
}{
77+
{testPhoneNumber: "", testCountryCode: country.Australia.Alpha2Code(), expectingError: true},
78+
{testPhoneNumber: "sdfge5uy2fwdf", testCountryCode: country.Australia.Alpha2Code(), expectingError: true},
79+
{testPhoneNumber: "123", testCountryCode: country.Australia.Alpha2Code(), expectingError: false},
80+
{testPhoneNumber: "375295555555", testCountryCode: country.Belgium.Alpha2Code(), expectingError: false},
81+
{testPhoneNumber: "375295555555", testCountryCode: country.Belarus.Alpha2Code(), expectingError: false},
82+
}
83+
84+
func TestParse(t *testing.T) {
85+
for _, testCase := range parseTestCases {
86+
_, _, actualErr := Parse(testCase.testPhoneNumber, testCase.testCountryCode)
87+
if (actualErr == nil) && testCase.expectingError {
88+
t.Errorf(`PhoneNumber: '%s', CountryCode: '%s'. Error is expected but the result was opposite`, testCase.testPhoneNumber, testCase.testCountryCode)
89+
}
90+
}
91+
}
92+
93+
var strictParseTestCases = []struct {
94+
testPhoneNumber string
95+
testCountryCode country.Alpha2Code
96+
expectingError bool
97+
}{
98+
{testPhoneNumber: "", testCountryCode: country.Australia.Alpha2Code(), expectingError: true},
99+
{testPhoneNumber: "asdgdhf", testCountryCode: country.Australia.Alpha2Code(), expectingError: true},
100+
{testPhoneNumber: "123", testCountryCode: country.Australia.Alpha2Code(), expectingError: true},
101+
{testPhoneNumber: "375295555555", testCountryCode: country.Belgium.Alpha2Code(), expectingError: true},
102+
{testPhoneNumber: "375295555555", testCountryCode: country.Belarus.Alpha2Code(), expectingError: false},
103+
}
104+
105+
func TestParseWithRegionCheck(t *testing.T) {
106+
for _, testCase := range strictParseTestCases {
107+
_, _, actualErr := StrictParse(testCase.testPhoneNumber, testCase.testCountryCode)
108+
if (actualErr == nil) && testCase.expectingError {
109+
t.Errorf(`PhoneNumber: '%s', CountryCode: '%s'. Error is expected but the result was opposite`, testCase.testPhoneNumber, testCase.testCountryCode)
110+
}
111+
}
112+
}

‎swagger.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ components:
55
example: en-US
66
type: string
77
format: bcp47-language
8-
x-go-type: github.com/mikekonan/go-types/bcp47_language.Language
8+
x-go-type: github.com/mikekonan/go-types/v2/bcp47_language.Language
99
CardDate:
1010
example: 01/06
1111
type: string

0 commit comments

Comments
 (0)