ShinyID

About

ShinyID is a high-performance Go package inspired by the Instagram shortcode system. It allows you to encode and decode unique identifiers (IDs) into a human-readable and URL-safe string format called 'shiny'. This package is designed for scenarios where speed and efficiency are crucial, making it ideal for applications that need to handle large volumes of encoded IDs.

Table of Contents

• Features
• Installation
• Usage
  • Encoding (ID to Shiny)
  • Decoding (Shiny to ID)
• Example
• Benchmark Results
• Running Tests
• Running Benchmarks
• License
• Author

Features

• Efficient Encoding : ShinyID offers a highly efficient method for converting numeric IDs into shiny strings.
• Lightning-Fast Decoding : Decoding shiny strings into their original numeric IDs is optimized for speed and performance.
• URL-Safe : Shiny strings are designed to be URL-safe, making them suitable for web applications.
• Inspired by Instagram : The package draws inspiration from Instagram's shortcode system, ensuring a familiar and intuitive approach to representing IDs.

Installation

To integrate ShinyID into your Go project, you can easily install it using go get:

go get github.com/itpey/shinyid

Usage

Encoding (ID to Shiny)

You can quickly convert a numeric ID to its shiny representation using the ToShiny function:

shiny := shinyid.ToShiny(9375)

Decoding (Shiny to ID)

To decode a shiny string back into its original numeric ID, use the ToId function:

id, err := shinyid.ToId("CSf")
if err != nil {
    // Handle error
}

Example

Here's a simple example showcasing the use of ShinyID:

package main

import (
	"fmt"
	"github.com/itpey/shinyid"
)

func main() {
	// Encoding an ID to a shiny string
	shiny := shinyid.ToShiny(12345)
	fmt.Println("Shiny:", shiny)

	// Decoding a shiny string back to an ID
	id, err := shinyid.ToId(shiny)
	if err != nil {
		fmt.Println("Error:", err)
	} else {
		fmt.Println("ID:", id)
	}
}

Benchmark Results

Benchmark results on an Intel Core i7-6700HQ CPU @ 2.60GHz:

• BenchmarkShinyIDEncoding : ShinyID encoding took approximately 15.96 nanoseconds per operation.
• BenchmarkShinyIDDecoding : ShinyID decoding took approximately 28.04 nanoseconds per operation.
• BenchmarkBase64Encoding : base64 encoding took approximately 105.2 nanoseconds per operation.
• BenchmarkBase64Decoding : base64 decoding took approximately 84.01 nanoseconds per operation.

Based on these benchmark results, ShinyID significantly outperforms base64 encoding and decoding, especially in encoding operations. This performance advantage makes ShinyID an excellent choice for applications that require fast encoding and decoding of unique identifiers.

Running Tests

To run tests for ShinyID, use the following command:

go test github.com/itpey/shinyid

Running Benchmarks

To run benchmarks for ShinyID, use the following command:

go test -bench=. github.com/itpey/shinyid

License

This package is distributed under the Apache License, Version 2.0. See the LICENSE file for more details.

Author

ShinyID was created by itpey.
Experience the power and speed of ShinyID for your Go applications!