Raku Land

TinyID

github:bbkr

Shorten and obfuscate IDs in Raku language

test

SYNOPSIS

    use TinyID;
    
    my $key = ( 'a'..'z', 'A'..'Z', 0..9 ).flat.pick( * ).join;
    # example key is '2BjLhRduC6Tb8Q5cEk9oxnFaWUDpOlGAgwYzNre7tI4yqPvXm0KSV1fJs3ZiHM'
    
    my $tinyid = TinyID.new( key => $key );
    
    say $tinyid.encode( 48888851145 );  # will print '1FN7Ab'
    say $tinyid.decode( '1FN7Ab' );     # will print 48888851145

DESCRIPTION

Using real IDs in various places - such as GET links or API payload - is generally a bad idea:

With the help of this module you can shorten and obfuscate your IDs at the same time.

METHODS

new( key => 'qwerty' )

Key must consist of at least two unique unicode characters.

The longer the key - the shorter encoded ID.

Encoded ID will be made exclusively out of characters from the key. This very useful property allows to adapt your encoding to the environment. For example in SMS messages you may restrict key to US ASCII to avoid available length reduction caused by conversion to GSM 03.38 charset. Or if you want to use such ID as file/directory name in case insensitive filesystem you may want to use only lowercase letters in the key.

encode( 123 )

Encode positive integer into a string.

Note that leading 0s are not preserved, encode( 123 ) is the same as encode( 00123 ).

Used algorithm is a base to the length of the key conversion that maps to distinct permutation of characters. Do not consider it a strong encryption, but if you have secret and long and well shuffled key it is almost impossible to reverse-engineer real ID.

decode( 'rer' )

Decode string back into a positive integer.

TRICKS

If you provide sequential characters in key you can convert your numbers to some weird numeric systems, for example base18:

    TinyID.new( key => '0123456789ABCDEFGH' ).encode( 48888851145 ).say;    # '47F709HFF'

Or you can go wild just for the fun of it.

    my $key = ( '😀'..'😿' ).flat.join; # emoji subset
    TinyID.new( key => $key ).encode( 48888851145 ).say;    # '😭😢😀😊😫😉'

OTHER IMPLEMENTATIONS