encoded_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87f85eb4edadbf1953f3f3343f3b4166f8bc0058593a66507f07f7dcd589d0e0
+  data.tar.gz: 03fe5a25403ad4d75279f6e7c66d5043075e1b5a42b359a117b34c83a86b269e
+SHA512:
+  metadata.gz: 9f6ad0446336da43661dd07ab253c8e80e3ded3b0fb81744c9bf662ec6ddfe3937df17bb5956f538e1b3d4e059eb074e94843e01f68e37131aaf1d7aec89bd61
+  data.tar.gz: 9a6daafde92782a631571c67557665adadd5998151319a4330d3d6700ec33bf1188e37d76e7c0341721703d7de83dc72840d60b7ea9fb57655cc9fdfc3e5c967

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-11
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in encoded_id.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Stephen Ierodiaconou
+
+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.

data/README.md

@@ -0,0 +1,90 @@
+# EncodedId
+
+Encode your numerical IDs (eg record primary keys) into obfuscated strings that can be used in URLs. 
+
+`::EncodedId::ReversibleId.new(salt: my_salt).encode(123)` => `"p5w9-z27j"`
+
+The obfuscated strings are reversible, so you can decode them back into the original numerical IDs. Also supports 
+encoding multiple IDs at once.
+
+```
+    reversibles = ::EncodedId::ReversibleId.new(salt: my_salt)
+    reversibles.encode([78, 45])  # "7aq6-0zqw"
+    reversibles.decode("7aq6-0zqw")  # [78, 45]
+```
+
+Length of the ID, the alphabet used, and the number of characters per group can be configured.
+
+The custom alphabet (at least 16 characters needed) and character group sizes is to make the IDs easier to read or share.
+Easily confused characters (eg `i` and `j`, `0` and `O`, `1` and `I` etc) are mapped to counterpart characters, to help 
+common mistakes when sharing (eg customer over phone to customer service agent).
+
+## Features
+
+Build with https://hashids.org
+
+* Hashids are reversible, no need to persist the generated Id
+* supports slugged IDs (eg 'beef-tenderloins-prime--p5w9-z27j')
+* supports multiple IDs encoded in one `EncodedId` (eg '7aq6-0zqw' decodes to `[78, 45]`)
+* uses a reduced character set (Crockford alphabet) & ids split into groups of letters, ie 'human-readability'
+
+To use with **Rails** check out the `encoded_id-rails` gem.
+
+## Compared to alternate Gems
+
+- https://github.com/excid3/prefixed_ids
+- https://github.com/namick/obfuscate_id
+- https://github.com/norman/friendly_id
+- https://github.com/SPBTV/with_uid
+
+## See also
+
+- https://hashids.org
+- https://www.crockford.com/wrmg/base32.html
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add encoded_id
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install encoded_id
+
+## Usage
+
+TODO: Write usage instructions here
+
+### Rails
+
+To use with rails try the `encoded_id-rails` gem.
+
+```ruby
+    class User < ApplicationRecord
+      include EncodedId::WithUid
+    end
+
+    User.find_by_uid("p5w9-z27j")  # => #<User id: 78>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 
+run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version 
+number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git 
+commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/encoded_id.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## keywords
+hash ID, friendly ID, obfuscate ID, rails, ActiveRecord, model, slug, vanity URL, friendly URL

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/encoded_id/reversible_id.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "hashids"
+
+# Hashid with a reduced character set Crockford alphabet and split groups
+# See: https://www.crockford.com/wrmg/base32.html
+# Build with https://hashids.org
+# Note hashIds already has a biuld in profanity limitation algorithm
+module EncodedId
+  class ReversibleId
+    ALPHABET = "0123456789abcdefghjkmnpqrstuvwxyz"
+
+    def initialize(salt:, length: 8, split_at: 4, alphabet: ALPHABET)
+      unique_alphabet = alphabet.chars.uniq
+      raise InvalidAlphabetError, "Alphabet must be at least 16 characters" if unique_alphabet.size < 16
+
+      @human_friendly_alphabet = unique_alphabet.join
+      @salt = salt
+      @length = length
+      @split_at = split_at
+    end
+
+    # Encode the input values into a hash
+    def encode(*values)
+      uid = convert_to_string(uid_generator.encode(*values))
+      uid = humanize_length(uid) unless split_at.nil?
+      uid
+    end
+
+    # Decode the hash to original array
+    def decode(str)
+      uid_generator.decode(convert_to_hash(str))
+    rescue ::Hashids::InputError => e
+      raise EncodedIdFormatError, e.message
+    end
+
+    private
+
+    attr_reader :salt, :length, :human_friendly_alphabet, :split_at
+
+    def uid_generator
+      @uid_generator ||= ::Hashids.new(salt, length, human_friendly_alphabet)
+    end
+
+    def convert_to_string(hash)
+      hash.is_a?(Array) ? hash.join : hash.to_s
+    end
+
+    def split_regex
+      @split_regex ||= /.{#{split_at}}(?=.)/
+    end
+
+    def humanize_length(hash)
+      hash.gsub(split_regex, '\0-')
+    end
+
+    def convert_to_hash(str)
+      map_crockford_set(str.delete("-").downcase)
+    end
+
+    def map_crockford_set(str)
+      # Crockford suggest i==1 , but I think i==j is more appropriate as we
+      # only use lowercase
+      str.tr("o", "0").tr("l", "1").tr("i", "j")
+    end
+  end
+end

data/lib/encoded_id/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EncodedId
+  VERSION = "0.1.0"
+end

data/lib/encoded_id.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "encoded_id/version"
+require_relative "encoded_id/reversible_id"
+
+module EncodedId
+  class EncodedIdFormatError < Hashids::InputError; end
+
+  class InvalidAlphabetError < Hashids::AlphabetError; end
+end

data/sig/encoded_id.rbs

@@ -0,0 +1,4 @@
+module EncodedId
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: encoded_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Encode your numerical IDs (eg record primary keys) into obfuscated strings
+  that can be used in URLs. The obfuscated strings are reversible, so you can decode
+  them back into the original numerical IDs. Supports encoding multiple IDs at once,
+  and generating IDs with custom alphabets and separators to make the IDs easier to
+  read or share.
+email:
+- stevegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/encoded_id.rb
+- lib/encoded_id/reversible_id.rb
+- lib/encoded_id/version.rb
+- sig/encoded_id.rbs
+homepage: https://github.com/stevegeek/encoded_id
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/encoded_id
+  source_code_uri: https://github.com/stevegeek/encoded_id
+  changelog_uri: https://github.com/stevegeek/encoded_id/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: EncodedId is a gem for creating reversible obfuscated IDs from numerical
+  IDs. It uses Hash IDs under the hood.
+test_files: []