external_id 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8daf1349bdbc49e832de6c584e66e582d8eea993725e831f8c550c698dcad153
-  data.tar.gz: 003bd6b70857cf9457b1a45513b73682d7939e18aa03dbbc9b91e96bbddd35cb
+  metadata.gz: 1b9df2ebbd5ffd553c97841c5d7b4b66f5a4c5ad03e6c6514ce81d05f8fcc476
+  data.tar.gz: f591813e0d6ac93edb75491131543fd52ea0ccf10e71e95bc46ddec6cfe5fcc6
 SHA512:
-  metadata.gz: 52c9fef8215b01a7741c0b559d0f034d314acc85056a4d4882697c445a29ed801edcfb53ad31fc2f4115a184f78b1faef68503bebf5c0b1b607f82ca908268b4
-  data.tar.gz: 35bed9ab8dad13ee768cc270767396171049526226be2889ea854d23c139f26e77e8a913755fb34b9d56627c64ae47d65ed1222408e03ed945d95ea446fbb756
+  metadata.gz: 39983d6348cecc46842550d55a688b85dc32adc865c2e946b0d0eb4a2a1f71fa3db8cdaf637963be9e1dcd805ea167aa493bce0184c000440b3ff97e19ea812e
+  data.tar.gz: a043ce4201d839ad871040314eab48517426a8931cbc2d046faddef1dbe85be57d6987f2aeb6ef96d0b412d42a3ab8fdcfe58b9c7571f27eaca9b40082ce3731

data/README.md

@@ -63,6 +63,11 @@ ExternalId.configure do |config|
 
   # Optional: Use UUID for primary keys (default: true)
   # config.use_uuid = true
+
+  # Optional: Enable auditing with the audited gem (if loaded)
+  # Default: true
+  # Set to false if you don't want ExternalId records to be audited
+  # config.enable_auditing = true
 end
 ```
 
@@ -132,7 +137,7 @@ customer_without_eid.external_id.blank?  # => true
 customer = Customer.find(123)
 
 # Access the external_id record directly
-customer.eid  # => ExternalId::ExternalId instance or nil
+customer.eid  # => ExternalId::Record instance or nil
 
 # The association is dependent: :destroy
 # Deleting the customer will also delete the external_id
@@ -203,13 +208,13 @@ class ApplicationRecord < ActiveRecord::Base
 end
 
 # Add custom scopes
-class ExternalId::ExternalId
+class ExternalId::Record
   scope :raynet, -> { where(provider: 'raynet') }
   scope :customers, -> { where(resource_type: 'Customer') }
 end
 
 # Use them
-ExternalId::ExternalId.raynet.customers
+ExternalId::Record.raynet.customers
 ```
 
 ### Handling multiple providers
@@ -228,6 +233,47 @@ customer.add_external_id(provider: 'raynet', id: 'R-99999')  # => ActiveRecord::
 # Note: Currently limited to one external_id per resource
 ```
 
+### Auditing with the audited gem
+
+If you have the `audited` gem loaded in your application, the `ExternalId` model will automatically track all changes to external ID records. This includes tracking changes to:
+- `provider` attribute
+- `external_id` attribute
+- `resource` polymorphic association
+
+Auditing is enabled by default when the audited gem is present. You can disable it in your initializer:
+
+```ruby
+ExternalId.configure do |config|
+  config.enable_auditing = false
+end
+```
+
+To access the audit history of an external ID record:
+
+```ruby
+external_id_record = ExternalId::Record.find(some_id)
+
+# Get all audits for this record
+external_id_record.audits
+
+# Get the last audit
+external_id_record.audits.last
+
+# Access audit details
+audit = external_id_record.audits.last
+audit.action        # => "create", "update", or "destroy"
+audit.audited_changes # => Hash of changed attributes
+audit.created_at    # => When the change occurred
+audit.user          # => The user who made the change (if set)
+```
+
+Note: Make sure you've run the audited gem's generator to create the `audits` table:
+
+```bash
+rails generate audited:install
+rails db:migrate
+```
+
 ## 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.

data/lib/external_id/concerns/with_external_id.rb

@@ -5,7 +5,7 @@ module ExternalId
     extend ActiveSupport::Concern
 
     included do
-      has_one :eid, class_name: 'ExternalId::ExternalId', as: :resource, dependent: :destroy
+      has_one :eid, class_name: 'ExternalId::Record', as: :resource, dependent: :destroy
     end
 
     class_methods do
@@ -16,7 +16,7 @@ module ExternalId
                 "Provider must be one of #{providers.keys}, was '#{provider}'"
         end
 
-        ::ExternalId::ExternalId.find_by(provider: provider, external_id: external_id, resource_type: name)&.resource
+        ::ExternalId::Record.find_by(provider: provider, external_id: external_id, resource_type: name)&.resource
       end
     end
 
@@ -27,7 +27,7 @@ module ExternalId
 
       eid = external_id_object.is_a?(::ExternalId::Value) ? external_id_object : ::ExternalId::Value.new(provider: provider, id: id)
 
-      ::ExternalId::ExternalId.find_or_create_by!(provider: eid.provider, external_id: eid.id, resource: self)
+      ::ExternalId::Record.find_or_create_by!(provider: eid.provider, external_id: eid.id, resource: self)
     end
 
     def external_id

data/lib/external_id/configuration.rb

@@ -2,12 +2,13 @@
 
 module ExternalId
   class Configuration
-    attr_accessor :providers, :base_class, :use_uuid
+    attr_accessor :providers, :base_class, :use_uuid, :enable_auditing
 
     def initialize
       @providers = {}
       @base_class = 'ActiveRecord::Base'
       @use_uuid = true
+      @enable_auditing = true
     end
 
     def providers=(value)

data/lib/external_id/models/{external_id.rb → record.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ExternalId
-  class ExternalId < ActiveRecord::Base
+  class Record < ActiveRecord::Base
     self.table_name = 'external_ids'
 
     belongs_to :resource, polymorphic: true
@@ -36,10 +36,10 @@ module ExternalId
     # Call setup when the class is loaded
     def self.inherited(subclass)
       super
-      subclass.setup_enum! if subclass == ExternalId::ExternalId
+      subclass.setup_enum! if subclass == ExternalId::Record
     end
   end
 end
 
 # Setup enum after configuration
-ExternalId::ExternalId.setup_enum! if defined?(Rails) && Rails.application
+ExternalId::Record.setup_enum! if defined?(Rails) && Rails.application

data/lib/external_id/railtie.rb

@@ -6,6 +6,12 @@ module ExternalId
       ActiveSupport.on_load(:active_record) do
         # Make the concern available to all ActiveRecord models
         # Users will still need to explicitly include it
+
+        # Enable auditing if the audited gem is loaded and configured
+        # This runs after initializers so user configuration is available
+        if defined?(Audited) && ::ExternalId.configuration.enable_auditing
+          ::ExternalId::Record.audited
+        end
       end
     end
   end

data/lib/external_id/version.rb

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

data/lib/external_id.rb

@@ -6,7 +6,7 @@ require 'active_support'
 require_relative 'external_id/version'
 require_relative 'external_id/configuration'
 require_relative 'external_id/models/value'
-require_relative 'external_id/models/external_id'
+require_relative 'external_id/models/record'
 require_relative 'external_id/concerns/with_external_id'
 
 module ExternalId

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :external_id, class: 'ExternalId::ExternalId' do
+  factory :external_id, class: 'ExternalId::Record' do
     provider { 'default_provider' }
     sequence(:external_id) { |n| "ext-#{n}" }
     # association :resource, factory: :your_model

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

@@ -20,4 +20,9 @@ ExternalId.configure do |config|
   # Use UUID for primary keys (recommended for distributed systems)
   # Default: true
   # config.use_uuid = true
+
+  # Enable auditing with the audited gem (if loaded)
+  # Default: true
+  # Set to false if you don't want ExternalId records to be audited
+  # config.enable_auditing = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: external_id
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tomáš Landovský
@@ -143,7 +143,7 @@ files:
 - 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/record.rb
 - lib/external_id/models/value.rb
 - lib/external_id/railtie.rb
 - lib/external_id/version.rb