Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikekonan/go-types

Library providing opanapi3 and Go types for store/validation and transfer of ISO-4217, ISO-3166, and other types.
https://github.com/mikekonan/go-types

country-codes currency-codes email go-validator iso-3166 iso-3166-2 iso-4217 openapi3 url

Last synced: 3 months ago
JSON representation

Library providing opanapi3 and Go types for store/validation and transfer of ISO-4217, ISO-3166, and other types.

Host: GitHub
URL: https://github.com/mikekonan/go-types
Owner: mikekonan
License: mit
Created: 2021-04-21T11:34:25.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-07-26T20:28:15.000Z (4 months ago)
Last Synced: 2024-07-26T22:08:26.294Z (4 months ago)
Topics: country-codes, currency-codes, email, go-validator, iso-3166, iso-3166-2, iso-4217, openapi3, url
Language: Go
Homepage:
Size: 277 KB
Stars: 18
Watchers: 3
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-go-extra - go-types - 4217, ISO-3166, and other types.|14|8|0|2021-04-21T11:34:25Z|2022-08-19T09:43:35Z| (Utilities / Fail injection)

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/mikekonan/go-types)](https://goreportcard.com/report/github.com/mikekonan/go-types) [![Build Status](https://travis-ci.com/mikekonan/go-types.svg?branch=main)](https://travis-ci.com/mikekonan/go-types) [![codecov](https://codecov.io/gh/mikekonan/go-types/branch/main/graph/badge.svg?token=83Q04OW4I1)](https://codecov.io/gh/mikekonan/go-types)

# go-types

This library has been created with the purpose to facilitate the store, validation, and transfer of Go ISO-3166/ISO-4217/timezones/emails/URL types. There is a [openapi3 spec](https://github.com/mikekonan/go-types/blob/main/swagger.yaml) of that type and make you able to include it into your spec. All types has own ozzo.Validate, json.Unmarshaler, Stringer and driver.Valuer implementations.

# Installation

```bash

go get github.com/mikekonan/go-types/v2

```

# Usage:

```go

package main

import (

	"encoding/json"

	"fmt"

	"log"

	validation "github.com/go-ozzo/ozzo-validation/v4"

	"github.com/mikekonan/go-types/v2/country"

	"github.com/mikekonan/go-types/v2/country/alpha2"

	"github.com/mikekonan/go-types/v2/country/alpha3"

	"github.com/mikekonan/go-types/v2/language"

	"github.com/mikekonan/go-types/v2/country/name"

	"github.com/mikekonan/go-types/v2/currency"

	"github.com/mikekonan/go-types/v2/currency/code"

	"github.com/mikekonan/go-types/v2/phone"

	"github.com/mikekonan/go-types/v2/postal_code"

)

// 1. use in your structs

type User struct {

	Name            string                `json:"name" db:"name"`

	Country         country.Alpha2Code    `json:"country" db:"country"`

	Currency        currency.Code         `json:"currency" db:"currency"`

	Language        language.Alpha2Code   `json:"language" db:"language"`

	Phone           phone.Number          `json:"phone" db:"phone"`

	CountryDialCode phone.DialCode        `json:"dialCode" db:"dialCode"`

	PostalCode      postalcode.PostalCode `json:"postalCode" db:"postalCode"`

}

func main() {

	// 2. use in your wire

	user := User{}

	_ = json.Unmarshal([]byte(`{"name":"name", "country": "CA", "currency": "CAD", "language": "fr", "phone": "123456789", "dialCode": "1"}`), &user)

	// 3. check is set

	user.Country.IsSet()

	user.Currency.IsSet()

	user.Language.IsSet()

	// 4. validate using ozzo-validation

	if err := validation.ValidateStruct(&user, validation.Field(&user.Country), validation.Field(&user.Currency)); err != nil {

            log.Fatal(err)

	}

	// 5. lookup by alpha2, alpha3, country name

	if userCountry, ok := country.ByAlpha2Code(user.Country); ok {

            fmt.Printf("country name - '%s', alpha-2 - '%s', alpha-3 - '%s'", userCountry.Name(), userCountry.Alpha2Code(), userCountry.Alpha3Code())

	}

	// 6. lookup by 2 and 3 char codes, language name

	if userLanguage, ok := language.ByAlpha2Code(user.Language); ok {

            fmt.Printf("language name - '%s', alpha-2 - '%s', alpha-3 - '%s'", userLanguage.Name(), userLanguage.Alpha2Code(), userLanguage.Alpha3Code())

	}

	// 7. lookup by country dial code

	if phoneCountries, ok := phone.CountriesByDialCode(user.CountryDialCode); ok {

            for _, phoneCountry := range phoneCountries {

                fmt.Printf("country by dial code - '%s'", phoneCountry)

            }

	}

	// 8. lookup by country

	if dialCode, ok := phone.DialByAlpha2Code(user.Country); ok {

            fmt.Printf("'%s' dial code is '%s'", user.Country, dialCode)

        }

	// 9. lookup by currency code

	if userCurrency, ok := currency.ByCode(user.Currency); ok {

            fmt.Printf("currency name - '%s', code - '%s', number - '%s', countries - '%s', decimal places - '%d'",

                userCurrency.Currency(), userCurrency.Code(), userCurrency.Number(), userCurrency.Countries(), userCurrency.DecimalPlaces())

	}

	// 10. store in db

	fmt.Println(user.Country.Value())  //prints 'CA'

	fmt.Println(user.Currency.Value()) //prints 'CAN'

	fmt.Println(user.Language.Value()) //prints 'fr'

	// 11. use specific country constants

	fmt.Println(country.Canada.Alpha2Code())

	fmt.Println("name:", name.Canada)

	fmt.Println("alpha-2:", alpha2.CA)

	fmt.Println("alpha-3:", alpha3.CAN)

	// 12. use specific currency codes

	fmt.Println(code.CAD)

}

```

## Links:

- Currency Codes [(ISO 4217)](https://www.currency-iso.org/en/home/tables/table-a1.html) - [wiki](https://en.wikipedia.org/wiki/ISO_4217), [data source](https://www.six-group.com/dam/download/financial-information/data-center/iso-currrency/lists/list-one.xml)

- Country Codes [(ISO 3166)](https://www.iso.org/iso-3166-country-codes.html) - [wiki](https://en.wikipedia.org/wiki/ISO_3166-2)

- URL(including HttpURL) [(standard)](https://url.spec.whatwg.org/) - [wiki](https://en.wikipedia.org/wiki/URL)

- Email [(part of RFC5322)](https://tools.ietf.org/html/rfc5322) - [wiki](https://en.wikipedia.org/wiki/Email_address)

- Timezone [(RFC6557 IANA timezones)](https://www.iana.org/time-zones) - [wiki](https://en.wikipedia.org/wiki/Time_zone)

- 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)

- 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)

- BCP47 language tags [(wiki)](https://en.wikipedia.org/wiki/IETF_language_tag), [rfc](https://www.rfc-editor.org/info/bcp47)