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.



194
195
196
 
# File 'lib/cfoundry/v1/client.rb', line 194

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

#app_by_name(name) ⇒ Object 



198
199
200
201
 
# File 'lib/cfoundry/v1/client.rb', line 198

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.



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

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

#current_organization ⇒ Object 



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

def current_organization
  nil
end

#current_space ⇒ Object 



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

def current_space
  nil
end

#current_user ⇒ Object

The currently authenticated user.



50
51
52
53
54
 
# File 'lib/cfoundry/v1/client.rb', line 50

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

#frameworks ⇒ Object

Retrieve available frameworks.



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

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



66
67
68
 
# File 'lib/cfoundry/v1/client.rb', line 66

def info
  @base.info
end

#logged_in? ⇒ Boolean

Is an authentication token set on the client?

Returns:

  • (Boolean) 


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

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



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cfoundry/v1/client.rb', line 160

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



143
144
145
146
147
148
149
150
151
 
# File 'lib/cfoundry/v1/client.rb', line 143

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.



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

def logout
  @base.token = nil
end

#proxy ⇒ Object

Current proxy user. Usually nil.



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

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.



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

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

#register(email, password) ⇒ Object

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



137
138
139
140
 
# File 'lib/cfoundry/v1/client.rb', line 137

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

#runtimes ⇒ Object

Retrieve available runtimes.



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cfoundry/v1/client.rb', line 87

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



215
216
217
 
# File 'lib/cfoundry/v1/client.rb', line 215

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

#service_instance_by_name(name) ⇒ Object 



219
220
221
222
 
# File 'lib/cfoundry/v1/client.rb', line 219

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.



204
205
206
207
208
 
# File 'lib/cfoundry/v1/client.rb', line 204

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

#services ⇒ Object

Retrieve available services.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cfoundry/v1/client.rb', line 71

def services
  services = []

  @base.system_services.each do |type, vendors|
    vendors.each do |vendor, versions|
      versions.each do |num, meta|
        services <<
          Service.new(vendor.to_s, num.to_s, meta[:description], type)
      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

#trace ⇒ Object

Is the client tracing API requests?



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

def trace
  @base.trace
end

#trace=(bool) ⇒ Object

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



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

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.



132
133
134
 
# File 'lib/cfoundry/v1/client.rb', line 132

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

#users ⇒ Object

Retrieve user list. Admin-only.



117
118
119
120
121
122
123
124
125
 
# File 'lib/cfoundry/v1/client.rb', line 117

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