Class: CFoundry::V1::Client

Inherits:
Object
  • Object
show all
Includes:
LoginHelpers, ClientMethods
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

Methods included from LoginHelpers

#login, #login_prompts

Constructor Details

#initialize(target = "https://api.cloulu.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.

[View source]

15
16
17
 
# File 'lib/cfoundry/v1/client.rb', line 15

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

Instance Attribute Details

#base ⇒ Object (readonly)

Returns the value of attribute base.


10
11
12
 
# File 'lib/cfoundry/v1/client.rb', line 10

def base
  @base
end

Instance Method Details

#current_organization ⇒ Object

[View source]

106
107
108
 
# File 'lib/cfoundry/v1/client.rb', line 106

def current_organization
  nil
end

#current_space ⇒ Object

[View source]

102
103
104
 
# File 'lib/cfoundry/v1/client.rb', line 102

def current_space
  nil
end

#current_user ⇒ Object

The currently authenticated user.

[View source]

96
97
98
99
100
 
# File 'lib/cfoundry/v1/client.rb', line 96

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

#framework(name) ⇒ Object

[View source]

189
190
191
 
# File 'lib/cfoundry/v1/client.rb', line 189

def framework(name)
  Framework.new(name)
end

#framework_by_name(name) ⇒ Object

[View source]

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

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

#frameworks(options = {}) ⇒ Object

Retrieve available frameworks.

[View source]

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/cfoundry/v1/client.rb', line 172

def frameworks(options = {})
  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

#generate_plans(meta) ⇒ Object

[View source]

140
141
142
143
144
145
146
147
148
149
 
# File 'lib/cfoundry/v1/client.rb', line 140

def generate_plans(meta)
  names = meta[:plans]
  descriptions = meta[:plan_descriptions]
  default_name = meta[:default_plan]
  names.map { |name|
    description = descriptions[name.to_sym] if descriptions
    is_default = name == default_name || names.length == 1
    ServicePlan.new(name, description, is_default)
  }
end

#http_proxy ⇒ Object

Current http proxy URI. Usually nil.

[View source]

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

def http_proxy
  @base.http_proxy
end

#http_proxy=(uri) ⇒ Object

Set the http proxy URI.

[View source]

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

def http_proxy=(uri)
  @base.http_proxy = uri
end

#https_proxy ⇒ Object

Current https proxy URI. Usually nil.

[View source]

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

def https_proxy
  @base.https_proxy
end

#https_proxy=(uri) ⇒ Object

Set the https proxy URI.

[View source]

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

def https_proxy=(uri)
  @base.https_proxy = uri
end

#info ⇒ Object

Retrieve target metadata.

[View source]

112
113
114
 
# File 'lib/cfoundry/v1/client.rb', line 112

def info
  @base.info
end

#log ⇒ Object

The current log. See log=.

[View source]

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

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.

[View source]

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

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

#logged_in? ⇒ Boolean

Is an authentication token set on the client?

Returns:

  • (Boolean)
[View source]

209
210
211
 
# File 'lib/cfoundry/v1/client.rb', line 209

def logged_in?
  !!@base.token
end

#logout ⇒ Object

Clear client token. No requests are made for this.

[View source]

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

def logout
  @base.token = nil
end

#proxy ⇒ Object

Current proxy user. Usually nil.

[View source]

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

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.

[View source]

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

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

#register(email, password) ⇒ Object

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

[View source]

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

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

#runtime(name) ⇒ Object

[View source]

163
164
165
 
# File 'lib/cfoundry/v1/client.rb', line 163

def runtime(name)
  Runtime.new(name)
end

#runtime_by_name(name) ⇒ Object

[View source]

167
168
169
 
# File 'lib/cfoundry/v1/client.rb', line 167

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

#runtimes(options = {}) ⇒ Object

Retrieve available runtimes.

[View source]

152
153
154
155
156
157
158
159
160
161
 
# File 'lib/cfoundry/v1/client.rb', line 152

def runtimes(options = {})
  runtimes = []

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

  runtimes
end

#services(options = {}) ⇒ Object

Retrieve available services.

[View source]

117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/cfoundry/v1/client.rb', line 117

def services(options = {})
  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.to_s, provider.to_s, state && state.first,
                          generate_plans(meta))
          end
        end
      end
    end
  end

  services
end

#target ⇒ Object

The current target URL of the client.

[View source]

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

def target
  @base.target
end

#token ⇒ Object

Current authentication token.

[View source]

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

def token
  @base.token
end

#token=(token) ⇒ Object

Set the authentication token.

[View source]

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

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

#trace ⇒ Object

Is the client tracing API requests?

[View source]

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

def trace
  @base.trace
end

#trace=(bool) ⇒ Object

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

[View source]

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

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

#version ⇒ Object

[View source]

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

def version
  1
end