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 = "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.



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

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.



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

def base
  @base
end

Instance Method Details

#current_organization ⇒ Object 



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

def current_organization
  nil
end

#current_space ⇒ Object 



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

def current_space
  nil
end

#current_user ⇒ Object

The currently authenticated user.



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

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

#framework(name) ⇒ Object 



169
170
171
 
# File 'lib/cfoundry/v1/client.rb', line 169

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

#framework_by_name(name) ⇒ Object 



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

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

#frameworks(options = {}) ⇒ Object

Retrieve available frameworks.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cfoundry/v1/client.rb', line 152

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 



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

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

#info ⇒ Object

Retrieve target metadata.



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

def info
  @base.info
end

#log ⇒ Object

The current log. See log=.



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

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.



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

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

#logged_in? ⇒ Boolean

Is an authentication token set on the client?

Returns:

  • (Boolean) 


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

def logged_in?
  !!@base.token
end

#logout ⇒ Object

Clear client token. No requests are made for this.



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

def logout
  @base.token = nil
end

#proxy ⇒ Object

Current proxy user. Usually nil.



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.



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.



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

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

#runtime(name) ⇒ Object 



143
144
145
 
# File 'lib/cfoundry/v1/client.rb', line 143

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

#runtime_by_name(name) ⇒ Object 



147
148
149
 
# File 'lib/cfoundry/v1/client.rb', line 147

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

#runtimes(options = {}) ⇒ Object

Retrieve available runtimes.



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/cfoundry/v1/client.rb', line 132

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.



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

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.



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

def target
  @base.target
end

#token ⇒ Object

Current authentication token.



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

def token
  @base.token
end

#token=(token) ⇒ Object

Set the authentication token.



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?



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

def trace
  @base.trace
end

#trace=(bool) ⇒ Object

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



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

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

#version ⇒ Object 



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

def version
  1
end