event_logger_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f372aa5098db4fbac8a61ffb11d350226a5b0df839e38f1b75907e35407e1a73
+  data.tar.gz: 91960c8aee0f2adb82ad167c51b62207111dca9a7cbf5ec44750d3e585e0a430
+SHA512:
+  metadata.gz: e08ed66560764cf5fc761b3a74fcbee08d435f132c4e154053f3e9628c8de9b9c5806e9c4c0edbc8f76369dccffe0ea50898311bc5463a1579e947768daa0747
+  data.tar.gz: 72e6f058450d7462e6c86f80789492cfc737b6b0d6fac2e376a30c172005f378b8220490201bcbc02ab76ccb690e0aa269a5d0451fc89f145df3e983a184d687

data/README.md

@@ -0,0 +1,28 @@
+# EventLoggerRails
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "event_logger_rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install event_logger_rails
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/concerns/event_logger_rails/loggable.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EventLoggerRails
+  ##
+  # Provides event logging with relevant controller/request data.
+  module Loggable
+    extend ActiveSupport::Concern
+
+    def log_event(level, event, **data)
+      data_to_log = data_from_request.merge(data)
+      EventLoggerRails.log(level, event, **data_to_log)
+    rescue EventLogger::UnregisteredEvent => e
+      log_event :error, 'event-logger-rails.unregistered-event.failure', message: e.message
+    rescue EventLogger::InvalidLoggerLevel => e
+      log_event :error, 'event-logger-rails.logger-level.failure', message: e.message
+    end
+
+    def data_from_request
+      {
+        controller: controller_name.camelcase,
+        action: action_name,
+        method: request.method,
+        path: request.path,
+        remote_ip: request.remote_ip,
+        parameters: request.query_parameters.to_json
+      }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/EmptyBlock
+EventLoggerRails::Engine.routes.draw do
+end
+# rubocop:enable Lint/EmptyBlock

data/lib/event_logger_rails/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EventLoggerRails
+  class Engine < ::Rails::Engine
+    isolate_namespace EventLoggerRails
+  end
+end

data/lib/event_logger_rails/event_logger.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'exceptions/invalid_logger_level'
+require_relative 'exceptions/unregistered_event'
+
+module EventLoggerRails
+  ##
+  # Outputs event and related data logs.
+  class EventLogger
+    def initialize
+      @logger_levels = logger_levels_from_config
+      @registered_events = registered_events_from_config
+      @last_updated = File.ctime(config_file)
+    end
+
+    def log(*tags, **params)
+      reload_config if config_changed?
+
+      level, event = *tags
+      validate_tags(level, event)
+      logger = ActiveSupport::TaggedLogging.new(Logger.new(output_device))
+      logger.tagged("#{level.to_s.upcase} | #{DateTime.current} | #{event}") { logger.send(level, **params.as_json) }
+    end
+
+    private
+
+    attr_reader :logger_levels, :registered_events, :last_updated
+
+    def logger_levels_from_config
+      data_from_config[:logger_levels].map(&:to_sym)
+    end
+
+    def registered_events_from_config
+      data_from_config[:registered_events]
+    end
+
+    def data_from_config
+      @data_from_config ||= YAML.safe_load(File.read(config_file)).deep_symbolize_keys
+    end
+
+    def config_file
+      Rails.root.join('config/event_logger.yml')
+    end
+
+    def reload_config
+      @logger_levels = logger_levels_from_config
+      @registered_events = registered_events_from_config
+      @last_updated = File.ctime(config_file)
+    end
+
+    def config_changed?
+      return false unless Rails.env.development?
+
+      last_updated != File.ctime(config_file)
+    end
+
+    def validate_tags(level, event)
+      validate_logger_level(level) && validate_event(event)
+    end
+
+    def validate_logger_level(level)
+      return true if logger_levels.include?(level)
+
+      raise EventLoggerRails::Exceptions::InvalidLoggerLevel.new(logger_level: level)
+    end
+
+    def validate_event(event)
+      return true if registered_events.include?(event)
+
+      raise EventLoggerRails::Exceptions::UnregisteredEvent.new(unregistered_event: event)
+    end
+
+    def output_device
+      return $stdout unless Rails.env.test?
+
+      File.open(File::NULL, 'w')
+    end
+  end
+end

data/lib/event_logger_rails/exceptions/invalid_logger_level.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EventLoggerRails
+  module Exceptions
+    ##
+    # Indicates invalid log level provided.
+    class InvalidLoggerLevel < StandardError
+      attr_reader :logger_level
+
+      def initialize(logger_level:)
+        super("Invalid logger level provided: '#{logger_level}'. Valid levels: debug, info, warn, error, fatal.")
+      end
+    end
+  end
+end

data/lib/event_logger_rails/exceptions/unregistered_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EventLoggerRails
+  module Exceptions
+    ##
+    # Indicates event provided not registered.
+    class UnregisteredEvent < StandardError
+      attr_reader :unregistered_event
+
+      def initialize(unregistered_event:)
+        super("Event provided not registered: #{unregistered_event}")
+      end
+    end
+  end
+end

data/lib/event_logger_rails/version.rb

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

data/lib/event_logger_rails.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'active_support/dependencies'
+require 'event_logger_rails/version'
+require 'event_logger_rails/engine'
+require 'event_logger_rails/event_logger'
+require 'event_logger_rails/exceptions/invalid_logger_level'
+require 'event_logger_rails/exceptions/unregistered_event'
+
+##
+# Namespace for UtilityClasses gem
+module EventLoggerRails
+  autoload :EventLogger, 'event_logger_rails/event_logger'
+  autoload :InvalidLoggerLevel, 'event_logger_rails/exceptions/invalid_logger_level'
+  autoload :UnregisteredEvent, 'event_logger_rails/exceptions/unregistered_event'
+
+  def self.logger
+    @logger ||= EventLogger.new
+  end
+
+  def self.log(*tags, **params)
+    logger.log(*tags, **params)
+  end
+end

data/lib/tasks/event_logger_rails_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :event_logger_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: event_logger_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dick Davis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Rails gem that facilitates logging events for analysis.
+email:
+- dick@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/concerns/event_logger_rails/loggable.rb
+- config/routes.rb
+- lib/event_logger_rails.rb
+- lib/event_logger_rails/engine.rb
+- lib/event_logger_rails/event_logger.rb
+- lib/event_logger_rails/exceptions/invalid_logger_level.rb
+- lib/event_logger_rails/exceptions/unregistered_event.rb
+- lib/event_logger_rails/version.rb
+- lib/tasks/event_logger_rails_tasks.rake
+homepage: https://github.com/d3d1rty/event_logger_rails
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/d3d1rty/event_logger_rails
+  source_code_uri: https://github.com/d3d1rty/event_logger_rails
+  changelog_uri: https://github.com/d3d1rty/event_logger_rails/blob/main/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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Rails gem that facilitates logging events for analysis.
+test_files: []