Class: Shipeasy::Configuration

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/shipeasy/config.rb', line 88

def initialize
  @base_url             = "https://api.shipeasy.ai"
  @attributes           = nil
  @init                 = true
  @poll                 = false
  @env                  = "prod"
  # nil ⇒ environment-derived default (see Engine / sdk/env.rb). An explicit
  # true/false set in the configure block always overrides.
  @is_network_enabled   = nil
  @disable_telemetry    = nil
  @disable_internal_error_reporting = false
  @telemetry_url        = nil
  @private_attributes   = nil
  @sticky_store         = nil
  @log_level            = :warn

  @profile              = "default"
  @default_chunk        = "index"
  @cdn_base_url         = "https://cdn.i18n.shipeasy.ai"
  @loader_url           = "https://cdn.i18n.shipeasy.ai/loader.js"
  @manifest_cache_ttl   = 60
  @label_file_cache_ttl = 3600
  @http_timeout         = 1
end

Instance Attribute Details

#api_key ⇒ Object

---- experimentation / SDK ----



23
24
25
 
# File 'lib/shipeasy/config.rb', line 23

def api_key
  @api_key
end

#attributes ⇒ Object

Optional transform from YOUR user object (any shape) to the Shipeasy attribute hash every flag/experiment evaluation uses. A callable (lambda/proc or anything responding to #call). Default = identity (the user object is assumed to already BE the attribute hash). Runs once, in the Shipeasy::Client constructor.

Shipeasy.configure do |c|
c.api_key    = ENV["SHIPEASY_SERVER_KEY"]
c.attributes = ->(u) { { "user_id" => u.id, "plan" => u.plan } }
end


81
82
83
 
# File 'lib/shipeasy/config.rb', line 81

def attributes
  @attributes
end

#base_url ⇒ Object

---- experimentation / SDK ----



23
24
25
 
# File 'lib/shipeasy/config.rb', line 23

def base_url
  @base_url
end

#cdn_base_url ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def cdn_base_url
  @cdn_base_url
end

#default_chunk ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def default_chunk
  @default_chunk
end

#disable_internal_error_reporting ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def disable_internal_error_reporting
  @disable_internal_error_reporting
end

#disable_telemetry ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def disable_telemetry
  @disable_telemetry
end

#env ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def env
  @env
end

#http_timeout ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def http_timeout
  @http_timeout
end

#init ⇒ Object

Fetch lifecycle for the global engine configure builds:

- init (default true): fire a one-shot fetch fire-and-forget so the first
`Shipeasy::Client.new(user).get_flag(...)` resolves against real rules
(ideal for serverless / short-lived processes).
- poll (default false): start the background poll (initial fetch +
periodic refresh) for a long-running server, so flags stay fresh
without a redeploy. Configuration owns the lifecycle — you never call
`engine.init` yourself.


69
70
71
 
# File 'lib/shipeasy/config.rb', line 69

def init
  @init
end

#is_network_enabled ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def is_network_enabled
  @is_network_enabled
end

#label_file_cache_ttl ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def label_file_cache_ttl
  @label_file_cache_ttl
end

#loader_url ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def loader_url
  @loader_url
end

#log_level ⇒ Object

SDK-wide diagnostic verbosity for the leveled logger (Shipeasy::Logging). One of :silent, :error, :warn (default), :info, :debug (strings accepted and downcased; unknown falls back to :warn). Controls the stderr output of every caught-error diagnostic the SDK emits — the public runtime reads (get_flag/get_config/…) never raise, so this only tunes how loud they are about a recovered failure. Threaded into the global Engine by configure.



59
60
61
 
# File 'lib/shipeasy/config.rb', line 59

def log_level
  @log_level
end

#manifest_cache_ttl ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def manifest_cache_ttl
  @manifest_cache_ttl
end

#poll ⇒ Object

Fetch lifecycle for the global engine configure builds:

- init (default true): fire a one-shot fetch fire-and-forget so the first
`Shipeasy::Client.new(user).get_flag(...)` resolves against real rules
(ideal for serverless / short-lived processes).
- poll (default false): start the background poll (initial fetch +
periodic refresh) for a long-running server, so flags stay fresh
without a redeploy. Configuration owns the lifecycle — you never call
`engine.init` yourself.


69
70
71
 
# File 'lib/shipeasy/config.rb', line 69

def poll
  @poll
end

#private_attributes ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def private_attributes
  @private_attributes
end

#profile ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def profile
  @profile
end

#public_key ⇒ Object

---- i18n / string manager ----



84
85
86
 
# File 'lib/shipeasy/config.rb', line 84

def public_key
  @public_key
end

#sticky_store ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def sticky_store
  @sticky_store
end

#telemetry_url ⇒ Object

Advanced configure options — threaded into the global Engine configure builds, so callers never construct an Engine themselves:

- env (default "prod"): deployment tag on see() events + usage telemetry.
- is_network_enabled (default: environment-derived): master switch for ALL
outbound requests (flag/experiment/config fetch, track, exposure logging,
see() reports, AND telemetry). Defaults ON in production and OFF in every
other environment, so a dev machine / CI run stays fully offline unless
you opt in. Explicit true/false always overrides. "Production" is decided
from SHIPEASY_ENV / RAILS_ENV / RACK_ENV / APP_ENV, then the `env` tag
(see sdk/env.rb). When off, reads answer from overrides / in-code
defaults and nothing is sent.
- disable_telemetry (default: environment-derived — off in prod, i.e.
telemetry ON in prod / OFF outside prod): opt out of per-eval usage
telemetry. Explicit true/false overrides; forced off when the network is
disabled.
- telemetry_url: override the telemetry endpoint (rarely needed).
- private_attributes: attribute keys stripped from every outbound event
before it leaves the process (they still drive targeting locally).
- sticky_store: pin a user's experiment group across re-buckets.
- disable_internal_error_reporting (default false): opt out of the
SDK's self-monitoring channel. When the SDK's last-resort guard
swallows one of its OWN internal errors it normally ships a structured
see event to Shipeasy's own project (NOT yours) so the SDK team can
track SDK bugs; set true to disable that entirely.


49
50
51
 
# File 'lib/shipeasy/config.rb', line 49

def telemetry_url
  @telemetry_url
end