external_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7f37fe1f61ae7cc606c98a516bcbf92158799383751ecfa602b3b29c32a7da2
+  data.tar.gz: 71a51fe88cebf3fe95516cd87c4a173d111925cdf1da6fcf3c5a8caddebc299e
+SHA512:
+  metadata.gz: 911f2c68eff82fc94075e67f295f6c9a49324013ea9636c845705bc4d9bf8c07282d432d7cf691ca37c579b4d256a20397a7a0ef3c69abcbb1999a28d4f5ba80
+  data.tar.gz: 24c2e9299bb4658cda2dc0a0c0d0a805036181cf0f89096074f3fb60b831251e47be98b1e74aa97cd1e8ca250e678fecb171912d691baf5a20892d8dd8100883

data/.ruby-version

@@ -0,0 +1 @@
+3.4.7

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-02
+
+- Initial release
+- Polymorphic external ID associations for Rails models
+- `ExternalId` model for database-backed storage
+- `ExternalIdValue` value object for clean data handling
+- `WithExternalId` concern for easy model integration
+- Configurable providers with enum support
+- UUID support for distributed systems
+- Install generator with migration and initializer templates
+- Comprehensive test suite with 46 passing examples
+- Full documentation and usage examples

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

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tomáš Landovský
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Tomáš Landovský
+
+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,247 @@
+# ExternalId
+
+A Rails gem that provides a clean, polymorphic way to associate external IDs from third-party systems (like CRMs, payment processors, or any external service) with your ActiveRecord models.
+
+## Features
+
+- Polymorphic associations - link external IDs to any model
+- Type-safe with Rails enums for provider validation
+- Value object pattern for clean external ID handling
+- Unique constraints ensuring one external ID per provider per resource
+- UUID support for distributed systems
+- Configurable providers
+- Full test coverage included
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'external-id'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Run the installer:
+
+```bash
+rails generate external_id:install
+```
+
+This will create:
+- An initializer at `config/initializers/external_id.rb`
+- A migration for the `external_ids` table
+
+Review the initializer and customize the providers, then run the migration:
+
+```bash
+rails db:migrate
+```
+
+## Configuration
+
+Edit `config/initializers/external_id.rb`:
+
+```ruby
+ExternalId.configure do |config|
+  # Define your external ID providers
+  config.providers = [:raynet, :salesforce, :hubspot]
+
+  # Or use a hash for custom enum values
+  # config.providers = {
+  #   raynet: 'raynet',
+  #   salesforce: 'sf',
+  #   hubspot: 'hs'
+  # }
+
+  # Optional: Configure base class (default: 'ActiveRecord::Base')
+  # config.base_class = 'ApplicationRecord'
+
+  # Optional: Use UUID for primary keys (default: true)
+  # config.use_uuid = true
+end
+```
+
+## Usage
+
+### Include the concern in your models
+
+```ruby
+class Customer < ApplicationRecord
+  include ExternalId::WithExternalId
+end
+
+class Order < ApplicationRecord
+  include ExternalId::WithExternalId
+end
+```
+
+### Add an external ID to a record
+
+```ruby
+customer = Customer.find(123)
+
+# Option 1: Using keyword arguments
+customer.add_external_id(provider: 'raynet', id: 'R-12345')
+
+# Option 2: Using an ExternalIdValue object
+external_id = ExternalId::ExternalIdValue.new(provider: 'salesforce', id: 'SF-67890')
+customer.add_external_id(external_id)
+```
+
+### Find a record by external ID
+
+```ruby
+# Find customer by their Raynet ID
+customer = Customer.find_by_external_id('raynet', 'R-12345')
+
+# Returns nil if not found
+customer = Customer.find_by_external_id('raynet', 'nonexistent')  # => nil
+
+# Raises ArgumentError for unknown providers
+Customer.find_by_external_id('unknown', '123')  # => ArgumentError
+```
+
+### Get the external ID from a record
+
+```ruby
+customer = Customer.find(123)
+
+# Returns an ExternalIdValue object
+external_id = customer.external_id
+
+if external_id.present?
+  puts external_id.provider  # => 'raynet'
+  puts external_id.id        # => 'R-12345'
+  puts external_id.to_s      # => 'raynet:R-12345'
+  puts external_id.to_hash   # => { provider: 'raynet', id: 'R-12345' }
+end
+
+# Blank when no external ID exists
+customer_without_eid = Customer.create(name: 'Test')
+customer_without_eid.external_id.blank?  # => true
+```
+
+### Access the underlying ActiveRecord model
+
+```ruby
+customer = Customer.find(123)
+
+# Access the external_id record directly
+customer.eid  # => ExternalId::ExternalId instance or nil
+
+# The association is dependent: :destroy
+# Deleting the customer will also delete the external_id
+```
+
+## Database Schema
+
+The gem creates an `external_ids` table with the following structure:
+
+```ruby
+create_table :external_ids, id: :uuid do |t|
+  t.string :provider, null: false, index: true
+  t.string :external_id, null: false
+  t.references :resource, polymorphic: true, null: false, index: true, type: :uuid
+
+  t.timestamps
+end
+
+add_index :external_ids, [:provider, :resource_type, :resource_id],
+          unique: true, name: 'index_one_external_id_per_resource'
+```
+
+This ensures that each resource can only have one external ID per provider.
+
+## ExternalIdValue
+
+The `ExternalIdValue` class is a value object that provides a clean interface for working with external IDs:
+
+```ruby
+# Create a value object
+eid = ExternalId::ExternalIdValue.new(provider: 'raynet', id: '12345')
+
+# Check presence
+eid.present?  # => true
+eid.blank?    # => false
+
+# String representation
+eid.to_s      # => 'raynet:12345'
+
+# Hash representation
+eid.to_hash   # => { provider: 'raynet', id: '12345' }
+
+# Array representation
+eid.to_a      # => ['raynet', '12345']
+
+# Create from array
+ExternalId::ExternalIdValue.from_array(['raynet', '12345'])
+
+# Create blank value
+ExternalId::ExternalIdValue.blank  # => blank instance
+
+# Comparison
+eid1 = ExternalId::ExternalIdValue.new(provider: 'raynet', id: '123')
+eid2 = ExternalId::ExternalIdValue.new(provider: 'raynet', id: '123')
+eid1 == eid2  # => true
+```
+
+## Advanced Usage
+
+### Custom scopes
+
+You can add custom scopes to query external IDs:
+
+```ruby
+# In your application
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end
+
+# Add custom scopes
+class ExternalId::ExternalId
+  scope :raynet, -> { where(provider: 'raynet') }
+  scope :customers, -> { where(resource_type: 'Customer') }
+end
+
+# Use them
+ExternalId::ExternalId.raynet.customers
+```
+
+### Handling multiple providers
+
+```ruby
+customer = Customer.find(123)
+
+# Add IDs from different providers
+customer.add_external_id(provider: 'raynet', id: 'R-12345')
+
+# This will fail due to unique constraint (one ID per provider per resource)
+customer.add_external_id(provider: 'raynet', id: 'R-99999')  # => ActiveRecord::RecordNotUnique
+
+# But you can have the same customer in different systems
+# by using a different provider (requires updating the resource)
+# Note: Currently limited to one external_id per resource
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/external-id. 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/[USERNAME]/external-id/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the External::Id project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/external-id/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/external_id/concerns/with_external_id.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ExternalId
+  module WithExternalId
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :eid, class_name: 'ExternalId::ExternalId', as: :resource, dependent: :destroy
+    end
+
+    class_methods do
+      def find_by_external_id(provider, external_id)
+        providers = ::ExternalId.configuration.providers
+        unless providers.key?(provider.to_sym)
+          raise ArgumentError,
+                "Provider must be one of #{providers.keys}, was '#{provider}'"
+        end
+
+        ::ExternalId::ExternalId.find_by(provider: provider, external_id: external_id, resource_type: name)&.resource
+      end
+    end
+
+    def add_external_id(external_id_object = nil, provider: nil, id: nil)
+      if external_id_object.blank? && provider.blank? && id.blank?
+        raise 'Either ExternalIdValue or provider and id are required'
+      end
+
+      eid = external_id_object.is_a?(::ExternalId::ExternalIdValue) ? external_id_object : ::ExternalId::ExternalIdValue.new(provider: provider, id: id)
+
+      ::ExternalId::ExternalId.find_or_create_by!(provider: eid.provider, external_id: eid.id, resource: self)
+    end
+
+    def external_id
+      ::ExternalId::ExternalIdValue.from_model(eid)
+    end
+  end
+end

data/lib/external_id/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ExternalId
+  class Configuration
+    attr_accessor :providers, :base_class, :use_uuid
+
+    def initialize
+      @providers = {}
+      @base_class = 'ActiveRecord::Base'
+      @use_uuid = true
+    end
+
+    def providers=(value)
+      if value.is_a?(Array)
+        # Convert array to hash format expected by enum
+        @providers = value.each_with_object({}) { |provider, hash| hash[provider.to_sym] = provider.to_s }
+      elsif value.is_a?(Hash)
+        @providers = value
+      else
+        raise ArgumentError, 'providers must be an Array or Hash'
+      end
+    end
+  end
+end

data/lib/external_id/models/external_id.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ExternalId
+  class ExternalId < ActiveRecord::Base
+    self.table_name = 'external_ids'
+
+    belongs_to :resource, polymorphic: true
+
+    validates :provider, presence: true
+    validates :external_id, presence: true
+
+    before_create :set_id_if_needed
+
+    private
+
+    def set_id_if_needed
+      return unless id.nil? && ::ExternalId.configuration.use_uuid
+
+      self.id = SecureRandom.uuid
+    end
+
+    public
+
+    # Define enum dynamically based on configuration
+    def self.providers
+      @providers ||= ::ExternalId.configuration.providers
+    end
+
+    # Set up enum if providers are configured
+    def self.setup_enum!
+      return if providers.empty?
+
+      enum :provider, providers, prefix: true
+    end
+
+    # Call setup when the class is loaded
+    def self.inherited(subclass)
+      super
+      subclass.setup_enum! if subclass == ExternalId::ExternalId
+    end
+  end
+end
+
+# Setup enum after configuration
+ExternalId::ExternalId.setup_enum! if defined?(Rails) && Rails.application

data/lib/external_id/models/external_id_value.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ExternalId
+  # ExternalId value object
+  class ExternalIdValue
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    attr_accessor :provider, :id
+
+    validates :provider, presence: true
+    validates :id, presence: true
+
+    def self.blank
+      new
+    end
+
+    # Create from ExternalId model
+    def self.from_model(external_id_model)
+      return blank if external_id_model.blank?
+
+      new(
+        provider: external_id_model.provider,
+        id: external_id_model.external_id
+      )
+    end
+
+    # Create from array format [provider, id]
+    def self.from_array(array)
+      return blank if array.blank? || !array.is_a?(Array) || array.size != 2
+
+      provider, id = array
+
+      new(provider: provider, id: id)
+    end
+
+    def initialize(provider: nil, id: nil)
+      @provider = provider.present? ? provider.to_s : provider
+      @id = id.present? ? id.to_s : id
+    end
+
+    def present?
+      provider.present? && id.present?
+    end
+
+    def blank?
+      !present?
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ExternalIdValue)
+
+      provider == other.provider && id == other.id
+    end
+
+    def to_s
+      return '' if blank?
+
+      "#{provider}:#{id}"
+    end
+
+    def to_hash
+      return {} if blank?
+
+      {
+        provider: provider,
+        id: id
+      }
+    end
+
+    # Alias for compatibility
+    alias_method :attributes, :to_hash
+
+    def to_a
+      return [] if blank?
+
+      [provider, id]
+    end
+  end
+end

data/lib/external_id/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ExternalId
+  class Railtie < Rails::Railtie
+    initializer 'external_id.active_record' do
+      ActiveSupport.on_load(:active_record) do
+        # Make the concern available to all ActiveRecord models
+        # Users will still need to explicitly include it
+      end
+    end
+  end
+end

data/lib/external_id/version.rb

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

data/lib/external_id.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+require_relative 'external_id/version'
+require_relative 'external_id/configuration'
+require_relative 'external_id/models/external_id_value'
+require_relative 'external_id/models/external_id'
+require_relative 'external_id/concerns/with_external_id'
+
+module ExternalId
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end
+
+require 'external_id/railtie' if defined?(Rails::Railtie)

data/lib/generators/external_id/install/templates/README

@@ -0,0 +1,34 @@
+===============================================================================
+
+ExternalId has been installed!
+
+Next steps:
+
+1. Review and customize the configuration in:
+   config/initializers/external_id.rb
+
+2. Run the migration to create the external_ids table:
+   rails db:migrate
+
+3. Include the concern in your models:
+   
+   class Customer < ApplicationRecord
+     include ExternalId::WithExternalId
+   end
+
+4. Start using external IDs in your application:
+   
+   # Add an external ID to a record
+   customer.add_external_id(provider: 'raynet', id: '12345')
+   
+   # Find a record by external ID
+   customer = Customer.find_by_external_id('raynet', '12345')
+   
+   # Get the external ID value object
+   external_id = customer.external_id
+   external_id.provider  # => 'raynet'
+   external_id.id        # => '12345'
+
+For more information, see: https://github.com/yourusername/external-id
+
+===============================================================================

data/lib/generators/external_id/install/templates/initializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+ExternalId.configure do |config|
+  # Define the external ID providers your application will use
+  # You can pass an array of symbols or a hash for enum configuration
+  config.providers = [:raynet]
+  
+  # Optionally, use a hash to customize the enum values:
+  # config.providers = {
+  #   raynet: 'raynet',
+  #   salesforce: 'salesforce',
+  #   hubspot: 'hubspot'
+  # }
+
+  # Configure the base class for the ExternalId model
+  # Default: 'ActiveRecord::Base'
+  # Change this if you have a custom base class like ApplicationRecord or ApplicationResource
+  # config.base_class = 'ApplicationRecord'
+
+  # Use UUID for primary keys (recommended for distributed systems)
+  # Default: true
+  # config.use_uuid = true
+end

data/lib/generators/external_id/install/templates/migration.rb.tt

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateExternalIds < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :external_ids<%= ', id: :uuid' if ExternalId.configuration.use_uuid %> do |t|
+      t.string :provider, null: false, index: true
+      t.string :external_id, null: false
+      t.references :resource, polymorphic: true, null: false, index: true<%= ', type: :uuid' if ExternalId.configuration.use_uuid %>
+
+      t.timestamps
+    end
+
+    # One resource can have only one external id per provider
+    add_index :external_ids, %i[provider resource_type resource_id], unique: true,
+                                                                      name: 'index_one_external_id_per_resource'
+  end
+end

data/lib/generators/external_id/install_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module ExternalId
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path('install/templates', __dir__)
+
+      desc 'Creates ExternalId initializer and migration'
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/external_id.rb'
+      end
+
+      def create_migration
+        migration_template 'migration.rb.tt', File.join(db_migrate_path, 'create_external_ids.rb')
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+
+      private
+
+      def db_migrate_path
+        if defined?(Rails.application) && Rails.application.config.paths['db/migrate']
+          Rails.application.config.paths['db/migrate'].to_a.first
+        else
+          'db/migrate'
+        end
+      end
+    end
+  end
+end

data/sig/external_id.rbs

@@ -0,0 +1,113 @@
+# Type signatures for external_id gem
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+# Stub declarations for Rails/ActiveRecord dependencies
+module ActiveModel
+  module Model
+  end
+
+  module Attributes
+  end
+end
+
+module ActiveSupport
+  module Concern
+  end
+end
+
+module ActiveRecord
+  class Base
+  end
+end
+
+module Rails
+  class Railtie
+  end
+end
+
+module ExternalId
+  VERSION: String
+
+  # Module-level configuration methods
+  def self.configuration: () -> Configuration
+  def self.configuration=: (Configuration) -> Configuration
+  def self.configure: () { (Configuration) -> void } -> void
+  def self.reset_configuration!: () -> Configuration
+
+  # Configuration class for the gem
+  class Configuration
+    attr_reader providers: Hash[Symbol, String]
+    attr_accessor base_class: String
+    attr_accessor use_uuid: bool
+
+    def initialize: () -> void
+    def providers=: (Array[String | Symbol] | Hash[Symbol, String]) -> Hash[Symbol, String]
+  end
+
+  # Value object for external IDs
+  class ExternalIdValue
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    attr_accessor provider: String?
+    attr_accessor id: String?
+
+    def self.blank: () -> ExternalIdValue
+    def self.from_model: (ExternalId?) -> ExternalIdValue
+    def self.from_array: (Array[String?]?) -> ExternalIdValue
+
+    def initialize: (?provider: String? | Symbol?, ?id: String?) -> void
+    def present?: () -> bool
+    def blank?: () -> bool
+    def ==: (untyped) -> bool
+    def to_s: () -> String
+    def to_hash: () -> Hash[Symbol, String?]
+    def attributes: () -> Hash[Symbol, String?]
+    def to_a: () -> Array[String?]
+  end
+
+  # ActiveRecord model for storing external IDs
+  class ExternalId < ActiveRecord::Base
+    # Associations
+    def resource: () -> ActiveRecord::Base?
+    def resource=: (ActiveRecord::Base?) -> ActiveRecord::Base?
+
+    # Attributes
+    def provider: () -> String?
+    def provider=: (String?) -> String?
+    def external_id: () -> String?
+    def external_id=: (String?) -> String?
+    def resource_type: () -> String?
+    def resource_type=: (String?) -> String?
+    def resource_id: () -> (String | Integer)?
+    def resource_id=: ((String | Integer)?) -> (String | Integer)?
+
+    # Class methods
+    def self.providers: () -> Hash[Symbol, String]
+    def self.setup_enum!: () -> void
+
+    private
+
+    def set_id_if_needed: () -> void
+  end
+
+  # Concern module for adding external ID support to models
+  module WithExternalId
+    extend ActiveSupport::Concern
+
+    # Instance methods available to including classes
+    def eid: () -> ExternalId?
+    def eid=: (ExternalId?) -> ExternalId?
+    def add_external_id: (?ExternalIdValue?, ?provider: String? | Symbol?, ?id: String?) -> ExternalId
+    def external_id: () -> ExternalIdValue
+
+    # Class methods added to including classes
+    module ClassMethods
+      def find_by_external_id: (String | Symbol, String) -> ActiveRecord::Base?
+    end
+  end
+
+  # Rails Railtie for integration
+  class Railtie < Rails::Railtie
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: external_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomáš Landovský
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A Rails gem that provides a clean way to associate external IDs from
+  third-party systems with your ActiveRecord models using polymorphic associations.
+email:
+- landovsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/external_id.rb
+- lib/external_id/concerns/with_external_id.rb
+- lib/external_id/configuration.rb
+- lib/external_id/models/external_id.rb
+- lib/external_id/models/external_id_value.rb
+- lib/external_id/railtie.rb
+- lib/external_id/version.rb
+- lib/generators/external_id/install/templates/README
+- lib/generators/external_id/install/templates/initializer.rb
+- lib/generators/external_id/install/templates/migration.rb.tt
+- lib/generators/external_id/install_generator.rb
+- sig/external_id.rbs
+homepage: https://github.com/landovsky/external-id-gem
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/landovsky/external-id-gem
+  changelog_uri: https://github.com/landovsky/external-id-gem/blob/main/CHANGELOG.md
+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.6.9
+specification_version: 4
+summary: Polymorphic external ID associations for Rails models
+test_files: []