[valued-rails] start listening to controller events

Author: rkh

valued-rails/README.md

@@ -0,0 +1,3 @@
+* Notification based – allows you to keep Valued logic outside of your business logic
+* Automatic user detection when using [Devise](https://github.com/heartcombo/devise) or [Warden](https://github.com/wardencommunity/warden)
+* Automatic customer detection when using [Acts As Tenant](https://github.com/ErwinM/acts_as_tenant) or for common one-to-many relations between users and customers.

valued-rails/lib/valued/rails.rb

@@ -0,0 +1,7 @@
+require "rails"
+require "valued"
+
+module Valued::Rails
+  require "valued/rails/process_action"
+  require "valued/rails/railtie"
+end

valued-rails/lib/valued/rails/process_action.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Valued::Rails
+  class ProcessAction
+    # Called by ActiveSupport::Notifications when a process_action.action_controller event is published.
+    # @api private
+    def self.call(name, start, finish, id, payload)
+      return unless name == "process_action.action_controller"
+      Valued::Rails.process_action(new(start: start, finish: finish, **payload))
+    end
+
+    # @return [Time] the time the controller action started
+    attr_reader :start
+
+    # @return [Time] the time the controller action finished
+    attr_reader :finish
+
+    # @return [String] the controller class name
+    attr_reader :controller
+
+    # @return [String] the controller action name
+    attr_reader :action
+
+    # @return [Hash] the controller action parameters without any filtered parameter
+    attr_reader :params
+
+    # @return [ActionDispatch::Http::Headers] the request headers
+    attr_reader :headers
+
+    # @return [Symbol] the response format (:html, :json, :xml, etc.)
+    attr_reader :format
+
+    # @return [String] the controller action method ("GET", "POST", etc.)
+    attr_reader :method
+
+    # @return [String] the controller action path
+    attr_reader :path
+
+    # @return [ActionDispatch::Request] the request object
+    attr_reader :request
+
+    # @return [ActionDispatch::Response] the response object
+    attr_reader :response
+
+    # @return [Integer] the response status code
+    attr_reader :status
+
+    # @api private
+    def initialize(start:, finish:, controller:, action:, params:, headers:, format:, method:, path:, request:, response:, status:)
+      @start      = start
+      @finish     = finish
+      @controller = controller
+      @action     = action
+      @params     = params
+      @headers    = headers
+      @format     = format
+      @method     = method
+      @path       = path
+      @request    = request
+      @response   = response
+      @status     = status
+    end
+
+    # @return [ActionDispatch::Session::AbstractSecureStore] the session object
+    def session = request.session
+
+    # @return [Warden::Proxy, nil] the warden object if Warden/Devise is set up
+    def warden = request.env['warden']
+
+    # @return [Object, nil] the current user if Warden/Devise is set up and the user is authenticated
+    # @todo Needs to be overridable with custom logic.
+    def user = @user ||= find_user
+
+    # @return [true, false] whether {#user} is set
+    def user? = !!user
+
+    # @return [Object, nil] Currently active customer if available.
+    # @todo Needs to be overridable with custom logic.
+    def customer = @customer ||= find_customer
+  
+    private
+
+    def find_user
+      return unless warden
+      warden.user(:user) || warden.user
+    end
+  
+    def find_customer
+      return ActsAsTenant.current_tenant if defined? ActsAsTenant and ActsAsTenant.current_tenant
+      return unless user
+      return user.customer     if user.respond_to? :customer
+      return user.organization if user.respond_to? :organization
+      return user.account      if user.respond_to? :account
+    end
+  end
+end

valued-rails/lib/valued/rails/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Valued::Rails
+  class Railtie < ::Rails::Railtie
+    initializer "valued.initialize" do
+      ActiveSupport::Notifications.subscribe "process_action.action_controller", ProcessAction
+    end
+  end
+end

valued-rails/valued-rails.gemspec

@@ -2,4 +2,5 @@ require_relative "../lib/gemspec"
 
 Gemspec.new do |spec|
   spec.summary = "Rails plugin for event tracking with Valued"
+  spec.add_dependency "rails", "~> 7.0"
 end