ik5 / phonegeocode

Phone number geocoding library for Go (#golang)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Phone Geocode

Build Status

Internationalised phone number geocoding by country for Go.

I built this because I needed to turn phone numbers into countries, and that's really all I needed. If libphonenumber existed for Go, I would probably just use that. AFAIK it doesn't.

This is based on work in github.com/relops/prefixes, however it has a different implementation, using a Trie data structure - specifically github.com/tchap/go-patricia.

The way it works is that we have a list of prefixes that identify a country, and we simply match the most specific prefix to find the country code. This deals with Canada where the country code is +1 and shared with US.

All the data lives in a CSV and can be used via codegen to create our Trie.

cat data/prefixes.csv | go run data/codegen.go > ./data.go && go fmt

Usage

// cc = GB, err = nil
cc, err := phonegeocode.New().Country("+447999111222")

// cc = "", err = phonegeocode.ErrCountryNotFound
cc, err := phonegeocode.New().Country("+999999999998")

License

The MIT License (MIT)

Copyright (c) 2016 Dave Gardner

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.

About

Phone number geocoding library for Go (#golang)


Languages

Language:Go 100.0%