Class: CFoundry::V2::Client

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

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.



85
86
87
88
89
90
91
 
# File 'lib/cfoundry/v2/client.rb', line 85

def current_user
  if guid = @base.token_data[:user_id]
    user = user(guid)
    user.emails = [{ :value => @base.token_data[:email] }]
    user
  end
end

#info ⇒ Object

Cloud metadata



94
95
96
 
# File 'lib/cfoundry/v2/client.rb', line 94

def info
  @base.info
end

#log ⇒ Object

The current log. See log=.



70
71
72
 
# File 'lib/cfoundry/v2/client.rb', line 70

def log
  @base.log
end

#log=(mode) ⇒ Object

Set the logging mode. Mode can be one of:

String

Name of a file to log the last 10 requests to.

Array

Array to append with log data (a Hash).

IO

An IO object to write to.

false

No logging.



80
81
82
 
# File 'lib/cfoundry/v2/client.rb', line 80

def log=(mode)
  @base.log = mode
end

#logged_in? ⇒ Boolean

Is an authentication token set on the client?

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/cfoundry/v2/client.rb', line 136

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`.



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cfoundry/v2/client.rb', line 116

def (credentials)
  @current_organization = nil
  @current_space = nil

  @base.token =
    if @base.uaa
      @base.uaa.authorize(credentials)
    else
      @base.create_token(
        { :password => credentials[:password] },
        credentials[:username])[:token]
    end
end

#login_prompts ⇒ Object

Login prompts



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

def 
  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.



131
132
133
 
# File 'lib/cfoundry/v2/client.rb', line 131

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