trackguard 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1372d974514748b7cb553b4299b14de6345339c00947e24102be03ec7ac0be0d
-  data.tar.gz: 142f9a999003624989fa47ad7a422a5bc76c504dbb8666a8e676d49970490775
+  metadata.gz: 49c01824d558ae2b9416ed2451b7ecc9fd864a93979afb91ea1bdce297c198b2
+  data.tar.gz: 429ff2b09df7c9d9571ac7a863e3200a80b6ee4a50028284af0132d18b4b2b79
 SHA512:
-  metadata.gz: e3f01bd73d5701b53f8e7a3ef37ab3c3a43b016dc72e9388c8b8f9db225412380889b8fd13ae1df8783231fcdb6fde828f7f6807854c6ef9fa0ee6a4924dc774
-  data.tar.gz: 9ff260dc894d2cbc70e69062bb878d394be1913faf4edd61dad5b9c10c41db2e68805985832ba8f4b7762af6a6483e0b6a0d9690447993d0c3f5ea542d8eb98c
+  metadata.gz: 7da72f474a80e8b89b5549de51a3ebefa6cba99da4b9b1045b7d860b2628f10ac9950efcd7acdec94d438e1f72544e7c5189335285025c5c872a64b6e8d616ea
+  data.tar.gz: 7ce7519b8998ce10beab775c922e7c965cb017bfa4852a843173cbc586e0c8c3af95cf6df397a12b270869b6de04411c81c958fa53966f8185b75d47d5821a89

data/app/controllers/concerns/trackguard/page_tracker.rb

@@ -19,6 +19,7 @@ module Trackguard
     end
 
     def track_page_view
+      return unless Trackguard.tracking_enabled?
       return unless request.get? || request.head?
       return unless request.format.html?
 

data/app/helpers/trackguard/application_helper.rb

@@ -1,6 +1,8 @@
 module Trackguard
   module ApplicationHelper
     def trackguard_header_tags
+      return "".html_safe unless Trackguard.tracking_enabled?
+
       tags = [ tag.meta(name: "trace-id", content: @trace_id) ]
 
       case Trackguard.adapter

data/app/jobs/trackguard/detect_suspicious_visitors_job.rb

@@ -40,7 +40,7 @@ module Trackguard
     def analyze_visitor(visitor, views)
       count = views.size
       return if count.zero?
-      return if visitor.whitelisted_ip&.active?
+      return if whitelisted?(visitor)
 
       name = name_from_ua(visitor.user_agent)
 
@@ -183,6 +183,19 @@ module Trackguard
       )
     end
 
+    protected
+
+    def whitelisted?(visitor)
+      wl = visitor.whitelisted_ip
+      unless wl
+        wl = WhitelistedIp.active.find_by(ip: visitor.ip)
+        wl&.update!(visitor: visitor)
+      end
+      wl&.active?
+    end
+
+    private
+
     def name_from_ua(user_agent)
       BlockedUserAgent.matching_pattern(user_agent)
     end

data/config/routes.rb

@@ -1,4 +1,6 @@
 Trackguard::Engine.routes.draw do
+  next if Trackguard.adapter.is_a?(Trackguard::Adapters::Hub)
+
   post "/page_views", to: "page_views#create"
 
   scope "/admin", module: "admin" do

data/lib/trackguard/adapters/base.rb

@@ -3,6 +3,8 @@
 module Trackguard
   module Adapters
     class Base
+      def validate! = nil
+
       def blocked_user_agent?(user_agent) = raise NotImplementedError, "#{self.class}#blocked_user_agent?"
       def blocked_path?(path)             = raise NotImplementedError, "#{self.class}#blocked_path?"
       def whitelisted_ip?(ip)             = raise NotImplementedError, "#{self.class}#whitelisted_ip?"
@@ -10,6 +12,7 @@ module Trackguard
 
       def track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:, tracking_layer:,
                           http_method:, prefetch: false)
+        return unless Trackguard.tracking_enabled?
         return if blocked_user_agent?(user_agent)
         return if blocked_path?(path)
         return if path.blank? || path.start_with?(Trackguard.admin_path)
@@ -22,7 +25,10 @@ module Trackguard
       end
 
       def track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
-        raise NotImplementedError, "#{self.class}#track_blocked_request"
+        return unless Trackguard.tracking_enabled?
+
+        perform_track_blocked_request(ip: ip, user_agent: user_agent, path: path,
+                                      http_method: http_method, block_reason: block_reason)
       end
 
       protected
@@ -31,6 +37,10 @@ module Trackguard
                                   tracking_layer:, http_method:, prefetch: false)
         raise NotImplementedError, "#{self.class}#perform_track_page_view"
       end
+
+      def perform_track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
+        raise NotImplementedError, "#{self.class}#perform_track_blocked_request"
+      end
     end
   end
 end

data/lib/trackguard/adapters/hub.rb

@@ -10,6 +10,33 @@ module Trackguard
       STALE_KEY = "trackguard/hub_rules/stale"
       ETAG_KEY  = "trackguard/hub_rules/etag"
 
+      def validate!
+        return unless Trackguard.tracking_enabled?
+
+        missing = []
+        missing << "hub_api_key"    if Trackguard.hub_api_key.blank?
+        missing << "hub_secret_key" if Trackguard.hub_secret_key.blank?
+        return if missing.empty?
+
+        raise Trackguard::ConfigurationError, <<~MSG.strip
+          Trackguard Hub adapter is missing required credentials: #{missing.join(', ')}.
+
+          Set them in your initializer:
+
+              Trackguard.configure do |c|
+                c.adapter        = :hub
+                c.hub_api_key    = ENV["TRACKGUARD_API_KEY"]
+                c.hub_secret_key = ENV["TRACKGUARD_SECRET_KEY"]
+              end
+
+          Sign up at https://trackguard.dev to create a project and generate credentials.
+
+          To use local tracking instead (no external service needed):
+
+              Trackguard.configure { |c| c.adapter = :local }
+        MSG
+      end
+
       def blocked_user_agent?(user_agent)
         rules.fetch(:blocked_user_agents, []).any? do |p|
           user_agent.to_s.downcase.include?(p.downcase)
@@ -30,14 +57,14 @@ module Trackguard
         rules.fetch(:flagged_ips, []).include?(ip)
       end
 
-      def track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
+      protected
+
+      def perform_track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
         Trackguard::Hub::SubmitBlockedRequestJob.perform_later(
           ip: ip, user_agent: user_agent, path: path, http_method: http_method, block_reason: block_reason
         )
       end
 
-      protected
-
       def perform_track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:,
                                   tracking_layer:, http_method:, prefetch: false)
         return if prefetch

data/lib/trackguard/adapters/local.rb

@@ -19,7 +19,9 @@ module Trackguard
         Visitor.flagged?(ip)
       end
 
-      def track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
+      protected
+
+      def perform_track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
         TrackBlockedRequestJob.perform_later(
           ip: ip,
           user_agent: user_agent,
@@ -29,8 +31,6 @@ module Trackguard
         )
       end
 
-      protected
-
       def perform_track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:,
                                   tracking_layer:, http_method:, prefetch: false)
         TrackPageViewJob.perform_later(

data/lib/trackguard/engine.rb

@@ -21,6 +21,7 @@ module Trackguard
     end
 
     config.after_initialize do
+      Trackguard.adapter.validate!
       Trackguard::RackAttack.configure
     end
   end

data/lib/trackguard/rack_attack.rb

@@ -4,28 +4,25 @@ require "rack/attack"
 
 module Trackguard
   module RackAttack
-    # rubocop:disable Metrics/MethodLength
     def self.configure
-      adapter = Trackguard.adapter
-
       ::Rack::Attack.safelist("trackguard/allow local") do |req|
         [ "127.0.0.1", "::1" ].include?(req.ip)
       end
 
       ::Rack::Attack.safelist("trackguard/allow whitelisted ips") do |req|
-        adapter.whitelisted_ip?(req.ip)
+        Trackguard.adapter.whitelisted_ip?(req.ip)
       end
 
       ::Rack::Attack.blocklist("trackguard/block known scanners") do |req|
-        adapter.blocked_user_agent?(req.user_agent)
+        Trackguard.adapter.blocked_user_agent?(req.user_agent)
       end
 
       ::Rack::Attack.blocklist("trackguard/block known paths") do |req|
-        adapter.blocked_path?(req.path)
+        Trackguard.adapter.blocked_path?(req.path)
       end
 
       ::Rack::Attack.blocklist("trackguard/flagged visitors") do |req|
-        adapter.flagged_visitor?(req.ip)
+        Trackguard.adapter.flagged_visitor?(req.ip)
       end
 
       ::Rack::Attack.throttle(
@@ -34,16 +31,15 @@ module Trackguard
         period: Trackguard.throttle_period, &:ip
       )
 
-      subscribe_to_blocked_requests(adapter)
+      subscribe_to_blocked_requests
     end
-    # rubocop:enable Metrics/MethodLength
 
-    def self.subscribe_to_blocked_requests(adapter)
+    def self.subscribe_to_blocked_requests
       @subscribe_to_blocked_requests ||= ActiveSupport::Notifications.subscribe("rack.attack") do |*, payload|
         req = payload[:request]
         next unless req.env["rack.attack.match_type"] == :blocklist
 
-        adapter.track_blocked_request(
+        Trackguard.adapter.track_blocked_request(
           ip: req.ip,
           user_agent: req.user_agent.to_s,
           path: req.path,

data/lib/trackguard/version.rb

@@ -1,3 +1,3 @@
 module Trackguard
-  VERSION = "0.29.0".freeze
+  VERSION = "0.30.0".freeze
 end

data/lib/trackguard.rb

@@ -9,10 +9,84 @@ require "trackguard/adapters/local"
 require "trackguard/adapters/hub"
 
 module Trackguard
+  class ConfigurationError < StandardError; end
+
   class << self
-    attr_writer :authenticate_admin_with, :admin_layout, :admin_path, :back_label, :local_api_token, :throttle_limit,
-                :throttle_period, :hub_secret_key, :hub_api_key, :hub_rules_ttl
-    attr_accessor :hub_url
+    def configure
+      @_configuring = true
+      yield self
+    ensure
+      @_configuring = false
+    end
+
+    # Setters — use configure block; direct assignment is deprecated.
+
+    def authenticate_admin_with=(value)
+      deprecated_direct_setter(:authenticate_admin_with)
+      @authenticate_admin_with = value
+    end
+
+    def admin_layout=(value)
+      deprecated_direct_setter(:admin_layout)
+      @admin_layout = value
+    end
+
+    def admin_path=(value)
+      deprecated_direct_setter(:admin_path)
+      @admin_path = value
+    end
+
+    def back_label=(value)
+      deprecated_direct_setter(:back_label)
+      @back_label = value
+    end
+
+    def local_api_token=(value)
+      deprecated_direct_setter(:local_api_token)
+      @local_api_token = value
+    end
+
+    def throttle_limit=(value)
+      deprecated_direct_setter(:throttle_limit)
+      @throttle_limit = value
+    end
+
+    def throttle_period=(value)
+      deprecated_direct_setter(:throttle_period)
+      @throttle_period = value
+    end
+
+    def hub_url=(value)
+      deprecated_direct_setter(:hub_url)
+      @hub_url = value
+    end
+
+    def hub_secret_key=(value)
+      deprecated_direct_setter(:hub_secret_key)
+      @hub_secret_key = value
+    end
+
+    def hub_api_key=(value)
+      deprecated_direct_setter(:hub_api_key)
+      @hub_api_key = value
+    end
+
+    def hub_rules_ttl=(value)
+      deprecated_direct_setter(:hub_rules_ttl)
+      @hub_rules_ttl = value
+    end
+
+    def adapter=(value)
+      deprecated_direct_setter(:adapter)
+      @adapter = resolve_adapter(value)
+    end
+
+    def disable_on_development=(value)
+      deprecated_direct_setter(:disable_on_development)
+      @disable_on_development = value
+    end
+
+    # Readers
 
     def authenticate_admin_with
       @authenticate_admin_with ||= proc {}
@@ -42,20 +116,36 @@ module Trackguard
       @throttle_period ||= 60
     end
 
+    def hub_url
+      @hub_url ||= "https://app.trackguard.dev"
+    end
+
     def hub_secret_key = @hub_secret_key.to_s
     def hub_api_key    = @hub_api_key.to_s
-    def hub_rules_ttl = @hub_rules_ttl ||= 5.minutes
+    def hub_rules_ttl  = @hub_rules_ttl ||= 5.minutes
 
     def adapter
       @adapter ||= Trackguard::Adapters::Local.new
     end
 
-    def adapter=(value)
-      @adapter = resolve_adapter(value)
+    def disable_on_development
+      @disable_on_development.nil? || @disable_on_development
+    end
+
+    def tracking_enabled?
+      !disable_on_development || !Rails.env.development?
     end
 
     private
 
+    def deprecated_direct_setter(attr)
+      return if @_configuring
+
+      warn "[DEPRECATED] Trackguard.#{attr}= called directly. " \
+           "Use `Trackguard.configure { |c| c.#{attr} = ... }` instead. " \
+           "Direct assignment will be removed in a future version."
+    end
+
     def resolve_adapter(value)
       case value
       when Symbol then Trackguard::Adapters.const_get(value.to_s.camelize).new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackguard
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Krzysztof Rygielski