Class: Shipeasy::Client

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

Overview

A lightweight, user-bound evaluation handle. Construct one per user/request via its real constructor:

flags = Shipeasy::Client.new(current_user)
flags.get_flag("new_checkout")          # NO user arg — bound at construction
flags.get_experiment("price_test", { price: 9 })

It is cheap: it delegates every evaluation to the single global engine built by Shipeasy.configure { … }. It does NOT open its own HTTP connection, fetch, or start a poll timer.

The configured attributes transform (see Shipeasy::Configuration#attributes) runs ONCE here, in the constructor, against the raw user object you pass. The resulting attribute hash is then enriched with the request-scoped anonymous_id (when you supplied neither user_id nor anonymous_id) and bound, so every getter reads the same bag.

Raises if constructed before Shipeasy.configure registered an engine.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user) ⇒ Client

Returns a new instance of Client.



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

def initialize(user)
  engine = Shipeasy.engine
  if engine.nil?
    raise Error, "Shipeasy::Client.new(user) called before Shipeasy.configure " \
                 "{ |c| c.api_key = … }. Call Shipeasy.configure once at app boot."
  end
  @engine = engine
  # Run the configured attributes transform (default identity), then apply
  # the existing anon-id merge exactly as the per-call engine path does.
  mapped = Shipeasy.attributes_transform.call(user)
  @attributes = engine.bind_attributes(mapped)
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

The resolved attribute hash this handle evaluates against.



22
23
24
 
# File 'lib/shipeasy/client.rb', line 22

def attributes
  @attributes
end

Instance Method Details

#get_config(name, decode = nil, default: nil) ⇒ Object

Configs are not user-scoped, but exposed here for one-stop ergonomics.



58
59
60
61
62
63
 
# File 'lib/shipeasy/client.rb', line 58

def get_config(name, decode = nil, default: nil)
  @engine.get_config(name, decode, default: default)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#get_config('#{name}') failed — returning default: #{e.message}"
  default
end

#get_experiment(name, default_params, decode = nil) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/shipeasy/client.rb', line 65

def get_experiment(name, default_params, decode = nil)
  @engine.get_experiment(name, @attributes, default_params, decode)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#get_experiment('#{name}') failed — returning safe default: #{e.message}"
  Shipeasy::SDK::Eval::ExperimentResult.new(in_experiment: false, group: "control", params: default_params)
end

#get_flag(name, default: false) ⇒ Object

NOTE on fail-safe reads: the engine's runtime methods already never raise (each is wrapped in Engine#safe_run). The extra defensive rescue here is a belt-and-braces guard so even an unexpected failure BEFORE the engine call (e.g. an @attributes deref) still returns the documented safe default rather than propagating into product code.



43
44
45
46
47
48
 
# File 'lib/shipeasy/client.rb', line 43

def get_flag(name, default: false)
  @engine.get_flag(name, @attributes, default: default)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#get_flag('#{name}') failed — returning default: #{e.message}"
  default
end

#get_flag_detail(name) ⇒ Object 



50
51
52
53
54
55
 
# File 'lib/shipeasy/client.rb', line 50

def get_flag_detail(name)
  @engine.get_flag_detail(name, @attributes)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#get_flag_detail('#{name}') failed — returning safe default: #{e.message}"
  Shipeasy::Engine::FlagDetail.new(value: false, reason: Shipeasy::Engine::REASON_CLIENT_NOT_READY)
end

#get_killswitch(name, switch_key = nil) ⇒ Object

Killswitches are not user-scoped; forwarded straight to the engine.



73
74
75
76
77
78
 
# File 'lib/shipeasy/client.rb', line 73

def get_killswitch(name, switch_key = nil)
  @engine.get_killswitch(name, switch_key)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#get_killswitch('#{name}') failed — returning false: #{e.message}"
  false
end

#log_exposure(experiment_name) ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/shipeasy/client.rb', line 88

def log_exposure(experiment_name)
  @engine.log_exposure(@attributes, experiment_name)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#log_exposure('#{experiment_name}') failed: #{e.message}"
  nil
end

#track(event_name, props = {}) ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/shipeasy/client.rb', line 80

def track(event_name, props = {})
  id = @attributes["user_id"] || @attributes["anonymous_id"]
  @engine.track(id, event_name, props)
rescue StandardError => e
  Shipeasy::Logging.error "[shipeasy] Client#track('#{event_name}') failed: #{e.message}"
  nil
end