Class: Trackguard::Adapters::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/trackguard/adapters/base.rb

Direct Known Subclasses

Hub, Local

Instance Method Summary collapse

Instance Method Details

#blocked_path?(path) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


9
 
# File 'lib/trackguard/adapters/base.rb', line 9

def blocked_path?(path)             = raise NotImplementedError, "#{self.class}#blocked_path?"

#blocked_user_agent?(user_agent) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


8
 
# File 'lib/trackguard/adapters/base.rb', line 8

def blocked_user_agent?(user_agent) = raise NotImplementedError, "#{self.class}#blocked_user_agent?"

#flagged_visitor?(ip) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


11
 
# File 'lib/trackguard/adapters/base.rb', line 11

def flagged_visitor?(ip)            = raise NotImplementedError, "#{self.class}#flagged_visitor?"

#track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/trackguard/adapters/base.rb', line 27

def track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
  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

#track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:, tracking_layer:, http_method:, prefetch: false) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/trackguard/adapters/base.rb', line 13

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)

  perform_track_page_view(
    path: path, ip: ip, user_agent: user_agent, referer: referer,
    session_id: session_id, trace_id: trace_id, source: source,
    tracking_layer: tracking_layer, http_method: http_method, prefetch: prefetch
  )
end

#validate! ⇒ Object 



6
 
# File 'lib/trackguard/adapters/base.rb', line 6

def validate! = nil

#whitelisted_ip?(ip) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


10
 
# File 'lib/trackguard/adapters/base.rb', line 10

def whitelisted_ip?(ip)             = raise NotImplementedError, "#{self.class}#whitelisted_ip?"