activerecord-obscuredid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58cb4a44828f83c6cd63d839571e3ffaa3156c374134ce603549249cec831fa9
+  data.tar.gz: 0b6e070feb74a02a18ba57824135da6731661c69deaaef31d08a9013ada24fe7
+SHA512:
+  metadata.gz: 8a6f7862c0bad759bd8eaaad59abb7ab49d9b5fce9fedd7bde820043f2f1cfd4003641ee0ee96d640fb9ea220060885fedd14c3711ca78cfc6ac91f648099651
+  data.tar.gz: bcc53d8e8183357611b235df67c9819146e10ed0623ae1def5532ab7ef3f30b28cfbc8b5d6a242c744d16f8d8eeb4d3a92c02062d38d2e6459e7e6b1448923b2

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - lib/activerecord-obscuredid.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 darthrighteous
+
+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,115 @@
+# ActiveRecord::ObscuredId
+
+`activerecord-obscuredid` is a gem that provides a way to encode and decode model IDs into Base32-obscured strings, making it easy to obscure the model IDs when exposing them in URLs or emails, for example.
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add PLACEHOLDER_GEM_NAME
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+$ gem install PLACEHOLDER_GEM_NAME
+```
+
+## Configuration
+
+By default, the gem uses example.com as the domain for generating obscured email addresses. You can configure this to use a custom domain:
+
+```ruby
+# config/initializers/obscured_id.rb
+ActiveRecord::ObscuredId.configure do |config|
+  config.domain = 'yourdomain.com'
+end
+```
+
+## Usage
+
+For Rails users, the ActiveRecord::ObscuredId module is already included in ActiveRecord::Base by default, so there’s no need to include it again manually. The gem automatically extends ActiveRecord models with the obscured ID functionality.
+
+```ruby
+class User < ApplicationRecord
+  # The module is already included, so you can use obscured_id related methods directly.
+end
+```
+
+### Using with Non-Rails Models
+
+If you’re not using Rails, or if your models don’t extend from ActiveRecord::Base, you can still use the ActiveRecord::ObscuredId module. To do so, include the module in your model and ensure your model has the following methods:
+  - An id attribute or method.
+  - A find method that accepts an id as an argument.
+  - A find_by method that accepts an id: keyword argument.
+
+Here’s an example of a model that satisfies these requirements:
+
+```ruby
+class User
+  include ActiveRecord::ObscuredId
+
+  attr_accessor :id
+
+  # Method to find a record by its ID
+  def self.find(id)
+    # Implementation to find a record by its ID
+  end
+
+  # Method to find a record using an ID keyword argument
+  def self.find_by(id:)
+    # Implementation to find a record using a keyword argument
+  end
+end
+```
+
+The gem provides a way to encode the ID of a record into a Base32-obscured string, as well as decode it back:
+
+```ruby
+# Generating an Obscured ID
+user = User.find(7371)
+user.obscured_id # => "g4ztomi" (an example Base32-encoded version of the ID)
+
+# Find by Obscured ID
+User.find_obscured('g4ztomi') # => <User id: 7371, ...>
+User.find_obscured!('g4ztomi') # Raises ActiveRecord::RecordNotFound if no user is found.
+
+# Generate an Obscured Email Address
+user.obscured_email_address # => "g4ztomi@users.yourdomain.com"
+
+# Find by Obscured Email Address
+User.from_obscured_email_address("g4ztomi@users.yourdomain.com") # => <User id: 7371, ...>
+```
+
+## Development
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Make your changes, add tests for them.
+4. Ensure the tests and linter pass
+5. Open a pull request with a detailed description of your changes.
+
+### Setting up
+
+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.
+
+### Running the tests and linter
+
+Minitest is used for unit tests. Rubocop is used to enforce the ruby style.
+
+To run the complete set of tests and linter run the following:
+
+```bash
+$ bundle install
+$ bundle exec rake test
+$ bundle exec rubocop
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/darthrighteous/activerecord-obscuredid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/darthrighteous/activerecord-obscuredid/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/activerecord-obscuredid/base32.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ObscuredId
+    # Implementation of Base32 encoding and decoding
+    module Base32
+      module_function
+
+      BASE32_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
+
+      def encode(input)
+        # Convert input to a binary string
+        binary = input.unpack1('B*')
+
+        # Break the binary string into 5-bit chunks and map them to Base32 characters
+        binary.scan(/.{1,5}/).map do |chunk|
+          # Pad the chunk with zeroes to make it 5 bits long if needed
+          chunk = chunk.ljust(5, '0')
+          BASE32_ALPHABET[chunk.to_i(2)]
+        end.join
+      end
+
+      def decode(base32_str)
+        # Convert Base32 string to binary representation
+        binary_str = base32_str.chars.map do |char|
+          # Convert each character to its 5-bit binary equivalent
+          index = BASE32_ALPHABET.index(char.upcase)
+          raise ArgumentError, "Invalid Base32 character: #{char}" if index.nil?
+
+          index.to_s(2).rjust(5, '0')
+        end.join
+
+        # Convert binary string back to its original form, ignoring extra zeroes
+        decoded_str = [binary_str].pack('B*')
+
+        # Strip out any null characters (trailing zero bits that resulted from padding)
+        decoded_str.delete("\x00")
+      end
+    end
+  end
+end

data/lib/activerecord-obscuredid/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  # = Active Record Obscured Id
+  module ObscuredId
+    # Holds configuration options for obscured id
+    class Configuration
+      attr_accessor :domain
+
+      def initialize
+        @domain = 'example.com'
+      end
+    end
+
+    class << self
+      attr_writer :config
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield(config)
+      end
+    end
+  end
+end

data/lib/activerecord-obscuredid/extensions/email_address.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/string/inflections' # for #pluralize, #underscore, #dasherize
+require 'active_support/core_ext/string/filters' # for #remove
+
+module ActiveRecord
+  module ObscuredId
+    module Extensions
+      # Extension using obscured ID to generate email addresses that can be used
+      # to find the record.
+      module EmailAddress
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def from_obscured_email_address(obscured_email_address)
+            domain = obscured_id_email_domain
+            subdomain = obscured_id_email_subdomain
+
+            return nil unless obscured_email_address.match?(/@#{subdomain}.#{domain}\z/)
+
+            find_obscured(obscured_email_address.remove(/@.*\z/))
+          end
+
+          private
+
+          def obscured_id_email_domain = ActiveRecord::ObscuredId.config.domain
+          def obscured_id_email_subdomain = name.pluralize.underscore.dasherize.downcase
+        end
+
+        def obscured_email_address
+          domain = self.class.send(:obscured_id_email_domain)
+          subdomain = self.class.send(:obscured_id_email_subdomain)
+
+          "#{obscured_id}@#{subdomain}.#{domain}"
+        end
+      end
+    end
+  end
+end
+
+if Object.const_defined?('ActiveRecord::Base')
+  ActiveRecord::Base.include ActiveRecord::ObscuredId::Extensions::EmailAddress
+end

data/lib/activerecord-obscuredid/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ObscuredId
+    VERSION = '0.1.0'
+  end
+end

data/lib/activerecord-obscuredid.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'activerecord-obscuredid/base32'
+require 'activerecord-obscuredid/configuration'
+require 'activerecord-obscuredid/extensions/email_address'
+
+require 'active_support/concern'
+
+module ActiveRecord
+  # = Active Record Obscured Id
+  module ObscuredId
+    extend ActiveSupport::Concern
+
+    # Class methods
+    module ClassMethods
+      # Finds a record by its obscured ID.
+      #
+      # This method decodes the given obscured ID to extract the original record ID,
+      # then searches for the record using the decoded ID.
+      #
+      # @param obscured_id [String] The obscured ID that represents the original record ID.
+      # @return [ActiveRecord::Base, nil] Returns the record if found, otherwise returns `nil`.
+      #
+      # @example
+      #   user = User.find_obscured('g4ztomi') # => <User:0x0000000165a73210 id: 7371, ...>
+      #   # Returns the user with ID 7371 corresponding to the decoded value of "g4ztomi"
+      def find_obscured(obscured_id)
+        find_by(id: decode_obscured_id(obscured_id))
+      end
+
+      # Same as #find_obscured but will raise +ActiveRecord::RecordNotFound+
+      # exception if the decoded id can't find a record.
+      def find_obscured!(obscured_id)
+        find(decode_obscured_id(obscured_id))
+      end
+
+      private
+
+      def decode_obscured_id(obscured_id)
+        Base32.decode(obscured_id.upcase)
+      end
+    end
+
+    # Generates an obscured representation of the record's ID.
+    #
+    # This method encodes the ID of the current record using a Base32 encoding
+    # scheme. The resulting obscured ID is a down-cased string that does not
+    # directly reveal the actual ID, making it suitable for public references
+    # (e.g., in URLs or emails). It is case-insensitive making it ideal for use
+    # cases like constructing email addresses or URLs, where case sensitivity
+    # might be an issue.
+    #
+    # @return [String] A down-cased Base32-encoded string representing the record's ID.
+    #
+    # @example
+    #   user = User.find(7371)
+    #   user.obscured_id
+    #   # => "g4ztomi" (an example Base32 encoded version of the ID)
+    def obscured_id = Base32.encode(id.to_s).downcase
+  end
+end
+
+ActiveRecord::Base.include ActiveRecord::ObscuredId if Object.const_defined?('ActiveRecord::Base')

data/sig/activerecord-obscuredid.rbs

@@ -0,0 +1,42 @@
+module ActiveRecord
+  module ObscuredId
+    VERSION: String
+
+    class Configuration
+      attr_accessor domain: String
+
+      def initialize: () -> void
+    end
+
+    attr_writer self.config: Configuration
+
+    def self.config: (Configuration) -> Configuration
+    def self.configure: () { (Configuration) -> void } -> void
+
+    module ClassMethods
+      def find_obscured: (obscured_id: String) -> ActiveRecord::Base?
+      def find_obscured!: (obscured_id: String) -> ActiveRecord::Base
+
+      private
+
+      def decode_obscured_id: (obscured_id: String) -> String
+    end
+
+    def obscured_id: () -> String
+
+    module Base32
+      BASE32_ALPHABET: String
+
+      def encode: (input: String) -> String
+      def decode: (base32_str: String) -> String
+    end
+
+    module Extensions
+      module EmailAddress
+        def from_obscured_email_address: (obscured_email_address: String) -> ActiveRecord::Base?
+
+        def obscured_email_address: () -> String
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-obscuredid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- darthrighteous
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  This gem provides functionality to encode and decode model IDs into Base32-obscured strings,
+      making it easy to obscure model IDs when exposing them in URLs or emails.
+email:
+- ja.ogunniyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord-obscuredid.rb
+- lib/activerecord-obscuredid/base32.rb
+- lib/activerecord-obscuredid/configuration.rb
+- lib/activerecord-obscuredid/extensions/email_address.rb
+- lib/activerecord-obscuredid/version.rb
+- sig/activerecord-obscuredid.rbs
+homepage: https://github.com/darthrighteous/activerecord-obscuredid
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/darthrighteous/activerecord-obscuredid
+  source_code_uri: https://github.com/darthrighteous/activerecord-obscuredid
+  changelog_uri: https://github.com/darthrighteous/activerecord-obscuredid/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A gem to generate obscured IDs for ActiveRecord models.
+test_files: []