Class: CFoundry::V1::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/cfoundry/v1/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.



18
19
20
 
# File 'lib/cfoundry/v1/client.rb', line 18

def initialize(target = "http://api.cloudfoundry.com", token = nil)
  @base = Base.new(target, token)
end

Instance Attribute Details

#base ⇒ Object (readonly)

Returns the value of attribute base.



13
14
15
 
# File 'lib/cfoundry/v1/client.rb', line 13

def base
  @base
end

Instance Method Details

#app(name = nil) ⇒ Object

Construct an App object. The return value is lazy, and no requests are made from this method alone.

This should be used for both app creation (after calling App#create!) and retrieval.



234
235
236
 
# File 'lib/cfoundry/v1/client.rb', line 234

def app(name = nil)
  App.new(name, self)
end

#app_by_name(name) ⇒ Object 



238
239
240
241
 
# File 'lib/cfoundry/v1/client.rb', line 238

def app_by_name(name)
  app = app(name)
  app if app.exists?
end

#apps(depth = 1, query = {}) ⇒ Object

Retreive all of the current user’s applications.



223
224
225
226
227
 
# File 'lib/cfoundry/v1/client.rb', line 223

def apps(depth = 1, query = {})
  @base.apps.collect do |json|
    App.new(json[:name], self, json)
  end
end

#current_organization ⇒ Object 



85
86
87
 
# File 'lib/cfoundry/v1/client.rb', line 85

def current_organization
  nil
end

#current_space ⇒ Object 



81
82
83
 
# File 'lib/cfoundry/v1/client.rb', line 81

def current_space
  nil
end

#current_user ⇒ Object

The currently authenticated user.



75
76
77
78
79
 
# File 'lib/cfoundry/v1/client.rb', line 75

def current_user
  if user = info[:user]
    user(user)
  end
end

#framework_by_name(name) ⇒ Object 



152
153
154
 
# File 'lib/cfoundry/v1/client.rb', line 152

def framework_by_name(name)
  frameworks.find { |f| f.name == name }
end

#frameworks(depth = 1, query = {}) ⇒ Object

Retrieve available frameworks.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/cfoundry/v1/client.rb', line 135

def frameworks(depth = 1, query = {})
  fs = info[:frameworks]
  return unless fs

  frameworks = []
  fs.each do |name, meta|
    runtimes = meta[:runtimes].collect do |r|
      Runtime.new(r[:name], r[:description])
    end

    frameworks <<
      Framework.new(name.to_s, nil, runtimes, meta[:detection])
  end

  frameworks
end

#info ⇒ Object

Retrieve target metadata.



91
92
93
 
# File 'lib/cfoundry/v1/client.rb', line 91

def info
  @base.info
end

#log ⇒ Object

The current log. See log=.



60
61
62
 
# File 'lib/cfoundry/v1/client.rb', line 60

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.



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

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

#logged_in? ⇒ Boolean

Is an authentication token set on the client?

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/cfoundry/v1/client.rb', line 217

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



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cfoundry/v1/client.rb', line 200

def (credentials)
  @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



183
184
185
186
187
188
189
190
191
 
# File 'lib/cfoundry/v1/client.rb', line 183

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.



212
213
214
 
# File 'lib/cfoundry/v1/client.rb', line 212

def logout
  @base.token = nil
end

#proxy ⇒ Object

Current proxy user. Usually nil.



38
39
40
 
# File 'lib/cfoundry/v1/client.rb', line 38

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.



44
45
46
 
# File 'lib/cfoundry/v1/client.rb', line 44

def proxy=(email)
  @base.proxy = email
end

#register(email, password) ⇒ Object

Create a user on the target and return a User object representing them.



177
178
179
180
 
# File 'lib/cfoundry/v1/client.rb', line 177

def register(email, password)
  @base.create_user(:email => email, :password => password)
  user(email)
end

#runtime_by_name(name) ⇒ Object 



130
131
132
 
# File 'lib/cfoundry/v1/client.rb', line 130

def runtime_by_name(name)
  runtimes.find { |r| r.name == name }
end

#runtimes(depth = 1, query = {}) ⇒ Object

Retrieve available runtimes.



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

def runtimes(depth = 1, query = {})
  runtimes = []

  @base.system_runtimes.each do |name, meta|
    runtimes <<
      Runtime.new(name.to_s, meta[:version], meta[:debug_modes])
  end

  runtimes
end

#service_instance(name = nil) ⇒ Object

Construct a Service object. The return value is lazy, and no requests are made from this method alone.

This should be used for both service creation (after calling Service#create!) and retrieval.



255
256
257
 
# File 'lib/cfoundry/v1/client.rb', line 255

def service_instance(name = nil)
  ServiceInstance.new(name, self)
end

#service_instance_by_name(name) ⇒ Object 



259
260
261
262
 
# File 'lib/cfoundry/v1/client.rb', line 259

def service_instance_by_name(name)
  service = service_instance(name)
  service if service.exists?
end

#service_instances(depth = 1, query = {}) ⇒ Object

Retrieve all of the current user’s services.



244
245
246
247
248
 
# File 'lib/cfoundry/v1/client.rb', line 244

def service_instances(depth = 1, query = {})
  @base.services.collect do |json|
    ServiceInstance.new(json[:name], self, json)
  end
end

#services(depth = 0, query = {}) ⇒ Object

Retrieve available services.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cfoundry/v1/client.rb', line 96

def services(depth = 0, query = {})
  services = []

  @base.system_services.each do |type, vendors|
    vendors.each do |vendor, providers|
      providers.each do |provider, properties|
        properties.each do |_, meta|
          meta[:supported_versions].each do |ver|
            state = meta[:version_aliases].find { |k, v| v == ver }

            services <<
              Service.new(vendor.to_s, ver.to_s, meta[:description],
                          type, provider.to_s, state && state.first)
          end
        end
      end
    end
  end

  services
end

#target ⇒ Object

The current target URL of the client.



23
24
25
 
# File 'lib/cfoundry/v1/client.rb', line 23

def target
  @base.target
end

#token ⇒ Object

Current authentication token.



28
29
30
 
# File 'lib/cfoundry/v1/client.rb', line 28

def token
  @base.token
end

#token=(token) ⇒ Object

Set the authentication token.



33
34
35
 
# File 'lib/cfoundry/v1/client.rb', line 33

def token=(token)
  @base.token = token
end

#trace ⇒ Object

Is the client tracing API requests?



49
50
51
 
# File 'lib/cfoundry/v1/client.rb', line 49

def trace
  @base.trace
end

#trace=(bool) ⇒ Object

Set the tracing flag; if true, API requests and responses will be printed out.



55
56
57
 
# File 'lib/cfoundry/v1/client.rb', line 55

def trace=(bool)
  @base.trace = bool
end

#user(email) ⇒ Object

Construct a User object. The return value is lazy, and no requests are made from this alone.

This should be used for both user creation (after calling User#create!) and retrieval.



172
173
174
 
# File 'lib/cfoundry/v1/client.rb', line 172

def user(email)
  User.new(email, self)
end

#users(depth = 1, query = {}) ⇒ Object

Retrieve user list. Admin-only.



157
158
159
160
161
162
163
164
165
 
# File 'lib/cfoundry/v1/client.rb', line 157

def users(depth = 1, query = {})
  @base.users.collect do |json|
    User.new(
      json[:email],
      self,
      { :email => json[:email],
        :admin => json[:admin] })
  end
end