Class: CFoundry::V2::Client
- Inherits:
-
Object
- Object
- CFoundry::V2::Client
- Defined in:
- lib/cfoundry/v2/client.rb
Overview
The primary API entrypoint. Wraps a BaseClient to provide nicer return values. Initialize with the target and, optionally, an auth token. These are the only two internal states.
Instance Attribute Summary collapse
-
#base ⇒ Object
readonly
Internal BaseClient instance.
-
#current_organization ⇒ Object
- Organization
-
Currently targeted organization.
-
#current_space ⇒ Object
- Space
-
Currently targeted space.
Instance Method Summary collapse
-
#current_user ⇒ Object
The currently authenticated user.
-
#info ⇒ Object
Cloud metadata.
-
#initialize(target = "http://api.cloudfoundry.com", token = nil) ⇒ Client
constructor
Create a new Client for interfacing with the given target.
-
#logged_in? ⇒ Boolean
Is an authentication token set on the client?.
-
#login(credentials) ⇒ Object
Authenticate with the target.
-
#login_prompts ⇒ Object
Login prompts.
-
#logout ⇒ Object
Clear client token.
-
#proxy ⇒ Object
Current proxy user.
-
#proxy=(email) ⇒ Object
Set the proxy user for the client.
-
#target ⇒ Object
The current target URL of the client.
-
#trace ⇒ Object
Is the client tracing API requests?.
-
#trace=(bool) ⇒ Object
Set the tracing flag; if true, API requests and responses will be printed out.
Constructor Details
#initialize(target = "http://api.cloudfoundry.com", token = nil) ⇒ Client
Create a new Client for interfacing with the given target.
A token may also be provided to skip the login step.
38 39 40 |
# File 'lib/cfoundry/v2/client.rb', line 38 def initialize(target = "http://api.cloudfoundry.com", token = nil) @base = Base.new(target, token) end |
Instance Attribute Details
#base ⇒ Object (readonly)
Internal BaseClient instance. Normally won’t be touching this.
26 27 28 |
# File 'lib/cfoundry/v2/client.rb', line 26 def base @base end |
#current_organization ⇒ Object
- Organization
-
Currently targeted organization.
29 30 31 |
# File 'lib/cfoundry/v2/client.rb', line 29 def current_organization @current_organization end |
#current_space ⇒ Object
- Space
-
Currently targeted space.
32 33 34 |
# File 'lib/cfoundry/v2/client.rb', line 32 def current_space @current_space end |
Instance Method Details
#current_user ⇒ Object
The currently authenticated user.
70 71 72 73 74 75 76 |
# File 'lib/cfoundry/v2/client.rb', line 70 def current_user if guid = token_data[:user_id] user = user(guid) user.emails = [{ :value => token_data[:email] }] user end end |
#info ⇒ Object
Cloud metadata
79 80 81 |
# File 'lib/cfoundry/v2/client.rb', line 79 def info @base.info end |
#logged_in? ⇒ Boolean
Is an authentication token set on the client?
121 122 123 |
# File 'lib/cfoundry/v2/client.rb', line 121 def logged_in? !!@base.token end |
#login(credentials) ⇒ Object
Authenticate with the target. Sets the client token.
Credentials is a hash, typically containing :username and :password keys.
The values in the hash should mirror the prompts given by ‘login_prompts`.
101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/cfoundry/v2/client.rb', line 101 def login(credentials) @current_organization = nil @current_space = nil @base.token = if @base.uaa @base.uaa.(credentials) else @base.create_token( { :password => credentials[:password] }, credentials[:username])[:token] end end |
#login_prompts ⇒ Object
Login prompts
84 85 86 87 88 89 90 91 92 |
# File 'lib/cfoundry/v2/client.rb', line 84 def login_prompts if @base.uaa @base.uaa.prompts else { :username => ["text", "Email"], :password => ["password", "Password"] } end end |
#logout ⇒ Object
Clear client token. No requests are made for this.
116 117 118 |
# File 'lib/cfoundry/v2/client.rb', line 116 def logout @base.token = nil end |
#proxy ⇒ Object
Current proxy user. Usually nil.
48 49 50 |
# File 'lib/cfoundry/v2/client.rb', line 48 def proxy @base.proxy end |
#proxy=(email) ⇒ Object
Set the proxy user for the client. Must be authorized as an administrator for this to have any effect.
54 55 56 |
# File 'lib/cfoundry/v2/client.rb', line 54 def proxy=(email) @base.proxy = email end |
#target ⇒ Object
The current target URL of the client.
43 44 45 |
# File 'lib/cfoundry/v2/client.rb', line 43 def target @base.target end |
#trace ⇒ Object
Is the client tracing API requests?
59 60 61 |
# File 'lib/cfoundry/v2/client.rb', line 59 def trace @base.trace end |
#trace=(bool) ⇒ Object
Set the tracing flag; if true, API requests and responses will be printed out.
65 66 67 |
# File 'lib/cfoundry/v2/client.rb', line 65 def trace=(bool) @base.trace = bool end |