Class: Streambird
- Inherits:
-
Object
- Object
- Streambird
- Defined in:
- lib/streambird.rb,
lib/streambird/api.rb,
lib/streambird/api/otp.rb,
lib/streambird/api/user.rb,
lib/streambird/api/oauth.rb,
lib/streambird/api/errors.rb,
lib/streambird/api/wallet.rb,
lib/streambird/api/session.rb,
lib/streambird/api/magic_link.rb,
lib/streambird/api/oauth_connection.rb
Defined Under Namespace
Classes: Api
Instance Attribute Summary collapse
-
#api_key ⇒ Object
Returns the value of attribute api_key.
-
#default_request_params ⇒ Object
Returns the value of attribute default_request_params.
-
#logging ⇒ Object
Returns the value of attribute logging.
Class Method Summary collapse
Instance Method Summary collapse
- #client ⇒ Object
-
#initialize(api_key: nil, default_request_params: {}, logging: false) ⇒ Streambird
constructor
A new instance of Streambird.
- #live? ⇒ Boolean (also: #live, #live_mode?)
- #magic_links ⇒ Object
- #oauth ⇒ Object
- #oauth_connections ⇒ Object
- #otps ⇒ Object
- #sessions ⇒ Object
- #test? ⇒ Boolean (also: #test, #test_mode?)
- #users ⇒ Object
- #wallets ⇒ Object
Constructor Details
#initialize(api_key: nil, default_request_params: {}, logging: false) ⇒ Streambird
Returns a new instance of Streambird.
10 11 12 13 14 15 16 |
# File 'lib/streambird.rb', line 10 def initialize(api_key: nil, default_request_params: {}, logging: false) Streambird.validate_api_key(api_key) self.api_key = api_key self.default_request_params = default_request_params self.logging = logging end |
Instance Attribute Details
#api_key ⇒ Object
Returns the value of attribute api_key.
2 3 4 |
# File 'lib/streambird.rb', line 2 def api_key @api_key end |
#default_request_params ⇒ Object
Returns the value of attribute default_request_params.
2 3 4 |
# File 'lib/streambird.rb', line 2 def default_request_params @default_request_params end |
#logging ⇒ Object
Returns the value of attribute logging.
2 3 4 |
# File 'lib/streambird.rb', line 2 def logging @logging end |
Class Method Details
.validate_api_key(api_key) ⇒ Object
4 5 6 7 8 |
# File 'lib/streambird.rb', line 4 def self.validate_api_key(api_key) if api_key.length < 5 || !(api_key.start_with?('sk_live') || api_key.start_with?('sk_test')) raise Api::APIKeyInvalid end end |
Instance Method Details
#client ⇒ Object
26 27 28 |
# File 'lib/streambird.rb', line 26 def client @client ||= Api.new(api_key, default_request_params, logging) end |
#live? ⇒ Boolean Also known as: live, live_mode?
18 19 20 |
# File 'lib/streambird.rb', line 18 def live? api_key.start_with?('sk_live') end |
#magic_links ⇒ Object
30 31 32 |
# File 'lib/streambird.rb', line 30 def magic_links @magic_links ||= Streambird::Api::MagicLink.new(client) end |
#oauth ⇒ Object
42 43 44 |
# File 'lib/streambird.rb', line 42 def oauth @oauth ||= Streambird::Api::OAuth.new(client) end |
#oauth_connections ⇒ Object
54 55 56 |
# File 'lib/streambird.rb', line 54 def oauth_connections @oauth_connections ||= Streambird::Api::OAuthConnection.new(client) end |
#otps ⇒ Object
34 35 36 |
# File 'lib/streambird.rb', line 34 def otps @otps ||= Streambird::Api::Otp.new(client) end |
#sessions ⇒ Object
46 47 48 |
# File 'lib/streambird.rb', line 46 def sessions @sessions ||= Streambird::Api::Session.new(client) end |
#test? ⇒ Boolean Also known as: test, test_mode?
22 23 24 |
# File 'lib/streambird.rb', line 22 def test? api_key.start_with?('sk_test') end |
#users ⇒ Object
38 39 40 |
# File 'lib/streambird.rb', line 38 def users @users ||= Streambird::Api::User.new(client) end |
#wallets ⇒ Object
50 51 52 |
# File 'lib/streambird.rb', line 50 def wallets @wallets ||= Streambird::Api::Wallet.new(client) end |