Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kickinespresso/ex_gtin
Elixir GTIN & UPC Generation and Validation Library
https://github.com/kickinespresso/ex_gtin
elixir gln gs1 gsin gtin gtin-codes sscc upc
Last synced: 3 months ago
JSON representation
Elixir GTIN & UPC Generation and Validation Library
- Host: GitHub
- URL: https://github.com/kickinespresso/ex_gtin
- Owner: kickinespresso
- License: other
- Created: 2017-07-03T19:40:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T15:37:35.000Z (about 2 years ago)
- Last Synced: 2024-10-08T12:57:59.683Z (4 months ago)
- Topics: elixir, gln, gs1, gsin, gtin, gtin-codes, sscc, upc
- Language: Elixir
- Homepage:
- Size: 96.7 KB
- Stars: 14
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A validation library for GTIN codes under GS1 specification. (Validations)
- fucking-awesome-elixir - ex_gtin - A validation library for GTIN codes under GS1 specification. (Validations)
- awesome-elixir - ex_gtin - A validation library for GTIN codes under GS1 specification. (Validations)
README
# ExGtin
[](https://github.com/kickinespresso/ex_gtin/issues)
[](https://www.hex.pm/packages/ex_gtin)
[](LICENSE.md)
A [GTIN](https://www.gtin.info/) (Global Trade Item Number) & UPC (Universal Price Code) Generation and Validation Library in Elixir under the GS1 specification.
- GTIN-8 (EAN/UCC-8): this is an 8-digit number used predominately outside of North America
- GTIN-12 (UPC-A): this is a 12-digit number used primarily in North America
- GTIN-13 (EAN/UCC-13): this is a 13-digit number used predominately outside of North America - Global Location Number (GLN)
- GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number used to identify trade items at various packaging levels
## Features
- Supports GTIN-8, GTIN-12 (UPC-12), GTIN-13 (GLN), GTIN-14
- Generate GTIN
- Check GTIN validity
- Lookup GS1 country prefix
- Convert (normalize) GTIN-13 to GTIN-14
Features to Come:
- Global Shipment Identification Number (GSIN)
- Serial Shipping Container Code (SSCC)
## Installation
*WARNING `1.0.1` contains breaking changes from `1.0.0`* (I know this is a patch release but the breaking changes related to the deprecation of `check_gtin` and `generate_gtin` were noted in the changelog and docs over a year ago)
*WARNING `1.0.0` contains breaking changes from `0.4.0`*
Add `:ex_gtin` as a dependency to your project's `mix.exs`:
```elixir
def deps do
[{:ex_gtin, "~> 1.1.0"}]
end
```
and run `mix deps.get` to install the `:ex_gtin` dependency
```bash
mix deps.get
```
## Usage
- Check GTIN codes
```elixir
iex> ExGtin.validate("6291041500213")
{:ok, "GTIN-13"}
iex> ExGtin.validate("6291041500214")
{:error, "Invalid Code"}
iex> ExGtin.validate!("6291041500213")
"GTIN-13"
```
Pass GTIN numbers in as a String, Number or an Array
```elixir
iex> number = [6, 2, 9, 1, 0, 4, 1, 5, 0, 0, 2, 1,3]
iex> ExGtin.validate(number)
{:ok, "GTIN-13"}
iex> number = 6_291_041_500_213
iex> ExGtin.validate(number)
{:ok, "GTIN-13"}
```
- Generate GTIN codes
```elixir
iex> ExGtin.generate("629104150021")
{:ok, "6291041500213"}
iex> ExGtin.generate!("629104150021")
"6291041500213"
```
- Lookup GS1 Prefix
```elixir
iex> ExGtin.Validation.find_gs1_prefix_country("53523235")
{:ok, "GS1 Malta"}
```
- Convert GTIN-13 to GTIN 14
```elixir
iex> ExGtin.normalize("6291041500213")
{:ok, "06291041500213"}
```
### Using Strings, Arrays or Numbers
- String
```elixir
iex> ExGtin.validate("6291041500213")
{:ok, "GTIN-13"}
```
- Array of Integers
```elixir
iex> ExGtin.validate([6, 2, 9, 1, 0, 4, 1, 5, 0, 0, 2, 1, 3])
{:ok, "GTIN-13"}
```
- Integer
```elixir
iex> ExGtin.validate(6291041500213)
{:ok, "GTIN-13"}
```
Integers with leading zeros may not process properly
## Reference
- [GTIN](https://www.gs1.org)
- [How to calculate GTIN](https://www.gs1.org/how-calculate-check-digit-manually)
Documentation can be found at [https://hexdocs.pm/ex_gtin](https://hexdocs.pm/ex_gtin) on [HexDocs](https://hexdocs.pm).
## Tests
Run tests with
```elixir
mix test
```
Run test coverage
```elixir
MIX_ENV=test mix coveralls
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
When making pull requests, please be sure to update the [CHANGELOG.md](CHANGELOG.md) with the corresponding changes. Please make sure that all tests pass, add tests for new functionality and that the static analysis checker `credo` is run. Use `mix pull_request_checkout.task` to ensure that everything checks out.
Run static code analysis
```bash
mix credo
```
Generate Documentation
```bash
mix docs
```
Run the gambit of tests, static analysis and coverage
```bash
mix pull_request_checkout.task
```
## Sponsors
This project is sponsored by [KickinEspresso](https://kickinespresso.com/?utm_source=github&utm_medium=sponsor&utm_campaign=opensource)
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kickinespresso/ex_gtin/tags).
## Code of Conduct
Please refer to the [Code of Conduct](CODE_OF_CONDUCT.md) for details
## Security
Please refer to the [Security](SECURITY.md) for details
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Publish & Releasing
```elixir
mix hex.publish
```