Class: Castle::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/castle/client.rb

Overview

Castle’s client.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash) (defaults to: {}) 


15
16
17
18
19
20
 
# File 'lib/castle/client.rb', line 15

def initialize(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
  @do_not_track = options.fetch(:do_not_track, false)
  @timestamp = options.fetch(:timestamp) { Castle::Utils::GetTimestamp.call }
  @context = options.fetch(:context) { {} }
end

Instance Attribute Details

#context ⇒ Object

Returns the value of attribute context.



12
13
14
 
# File 'lib/castle/client.rb', line 12

def context
  @context
end

Class Method Details

.from_request(request, options = {}) ⇒ Object 



7
8
9
 
# File 'lib/castle/client.rb', line 7

def from_request(request, options = {})
  new(options.merge(context: Castle::Context::Prepare.call(request, options)))
end

Instance Method Details

#authenticate(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/castle/client.rb', line 23

def authenticate(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  return generate_do_not_track_response(options[:user_id]) unless tracked?

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::Authenticate.call(options.merge(context: new_context, no_symbolize: true))
end

#disable_tracking ⇒ Object 



109
110
111
 
# File 'lib/castle/client.rb', line 109

def disable_tracking
  @do_not_track = true
end

#enable_tracking ⇒ Object 



113
114
115
 
# File 'lib/castle/client.rb', line 113

def enable_tracking
  @do_not_track = false
end

#end_impersonation(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


99
100
101
102
103
104
105
106
107
 
# File 'lib/castle/client.rb', line 99

def end_impersonation(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::EndImpersonation.call(options.merge(context: new_context, no_symbolize: true))
end

#filter(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/castle/client.rb', line 49

def filter(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  return generate_do_not_track_response(options[:user][:id]) unless tracked?

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::Filter.call(options.merge(context: new_context, no_symbolize: true))
end

#log(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/castle/client.rb', line 75

def log(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  return generate_do_not_track_response(options[:user][:id]) unless tracked?

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::Log.call(options.merge(context: new_context, no_symbolize: true))
end

#risk(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/castle/client.rb', line 62

def risk(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  return generate_do_not_track_response(options[:user][:id]) unless tracked?

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::Risk.call(options.merge(context: new_context, no_symbolize: true))
end

#start_impersonation(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


88
89
90
91
92
93
94
95
96
 
# File 'lib/castle/client.rb', line 88

def start_impersonation(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::StartImpersonation.call(options.merge(context: new_context, no_symbolize: true))
end

#track(options = {}) ⇒ Object

Parameters:

  • options (Hash) (defaults to: {}) 


36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/castle/client.rb', line 36

def track(options = {})
  options = Castle::Utils::DeepSymbolizeKeys.call(options || {})

  return unless tracked?

  add_timestamp_if_necessary(options)

  new_context = Castle::Context::Merge.call(@context, options[:context])

  Castle::API::Track.call(options.merge(context: new_context, no_symbolize: true))
end

#tracked? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/castle/client.rb', line 118

def tracked?
  !@do_not_track
end