Class: VMC::Client

Inherits:
Object show all
Defined in:
lib/vmc/client.rb

Defined Under Namespace

Classes: AuthError, BadResponse, BadTarget, HTTPException, NotFound, TargetError

Constant Summary collapse

VMC_HTTP_ERROR_CODES =

Error codes

[ 400, 403, 404, 500 ]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_url = VMC::DEFAULT_TARGET, auth_token = nil) ⇒ Client

Initialize new client to the target_uri with optional auth_token



39
40
41
42
43
44
 
# File 'lib/vmc/client.rb', line 39

def initialize(target_url=VMC::DEFAULT_TARGET, auth_token=nil)
  target_url = "http://#{target_url}" unless /^https?/ =~ target_url
  target_url = target_url.gsub(/\/+$/, '')
  @target =  target_url
  @auth_token = auth_token
end

Instance Attribute Details

#auth_token ⇒ Object (readonly)

Returns the value of attribute auth_token.



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

def auth_token
  @auth_token
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



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

def host
  @host
end

#proxy ⇒ Object

Returns the value of attribute proxy.



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

def proxy
  @proxy
end

#target ⇒ Object (readonly)

Returns the value of attribute target.



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

def target
  @target
end

#trace ⇒ Object

Returns the value of attribute trace.



25
26
27
 
# File 'lib/vmc/client.rb', line 25

def trace
  @trace
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.version ⇒ Object 



20
21
22
 
# File 'lib/vmc/client.rb', line 20

def self.version
  VMC::VERSION
end

Instance Method Details

#add_user(user_email, password) ⇒ Object 



302
303
304
 
# File 'lib/vmc/client.rb', line 302

def add_user(user_email, password)
  json_post(VMC::USERS_PATH, { :email => user_email, :password => password })
end

#app_crashes(name) ⇒ Object 



139
140
141
142
 
# File 'lib/vmc/client.rb', line 139

def app_crashes(name)
  
  json_get("#{VMC::APPS_PATH}/#{name}/crashes")
end

#app_files(name, path, instance = 0) ⇒ Object

List the directory or download the actual file indicated by the path.



146
147
148
149
150
151
152
 
# File 'lib/vmc/client.rb', line 146

def app_files(name, path, instance=0)
  
  url = "#{VMC::APPS_PATH}/#{name}/instances/#{instance}/files/#{path}"
  url.gsub!('//', '/')
  _, body, headers = http_get(url)
  body
end

#app_info(name) ⇒ Object 



110
111
112
113
 
# File 'lib/vmc/client.rb', line 110

def app_info(name)
  
  json_get("#{VMC::APPS_PATH}/#{name}")
end

#app_instances(name) ⇒ Object 



134
135
136
137
 
# File 'lib/vmc/client.rb', line 134

def app_instances(name)
  
  json_get("#{VMC::APPS_PATH}/#{name}/instances")
end

#app_stats(name) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/vmc/client.rb', line 120

def app_stats(name)
  
  stats_raw = json_get("#{VMC::APPS_PATH}/#{name}/stats")
  stats = []
  stats_raw.each_pair do |k, entry|
    # Skip entries with no stats
    next unless entry[:stats]
    entry[:instance] = k.to_s.to_i
    entry[:state] = entry[:state].to_sym if entry[:state]
    stats << entry
  end
  stats.sort { |a,b| a[:instance] - b[:instance] }
end

#app_update_info(name) ⇒ Object 



115
116
117
118
 
# File 'lib/vmc/client.rb', line 115

def app_update_info(name)
  
  json_get("#{VMC::APPS_PATH}/#{name}/update")
end

#apps ⇒ Object

Apps



70
71
72
73
 
# File 'lib/vmc/client.rb', line 70

def apps
  
  json_get(VMC::APPS_PATH)
end

#bind_service(service, appname) ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/vmc/client.rb', line 200

def bind_service(service, appname)
  
  app = app_info(appname)
  services = app[:services] || []
  app[:services] = services << service
  update_app(appname, app)
end

#change_password(new_password) ⇒ Object

sets the password for the current logged user



276
277
278
279
280
281
282
283
 
# File 'lib/vmc/client.rb', line 276

def change_password(new_password)
  
   = json_get("#{VMC::USERS_PATH}/#{@user}")
  if 
    [:password] = new_password
    json_put("#{VMC::USERS_PATH}/#{@user}", )
  end
end

#check_resources(resources) ⇒ Object

Send in a resources manifest array to the system to have it check what is needed to actually send. Returns array indicating what is needed. This returned manifest should be sent in with the upload if resources were removed. E.g. [=> xxx, :size => xxx, :fn => filename]



226
227
228
229
230
 
# File 'lib/vmc/client.rb', line 226

def check_resources(resources)
  
  status, body, headers = json_post(VMC::RESOURCES_PATH, resources)
  json_parse(body)
end

#create_app(name, manifest = {}) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/vmc/client.rb', line 75

def create_app(name, manifest={})
  
  app = manifest.dup
  app[:name] = name
  app[:instances] ||= 1
  json_post(VMC::APPS_PATH, app)
end

#create_service(service, name) ⇒ Object

Raises:



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/vmc/client.rb', line 164

def create_service(service, name)
  
  services = services_info
  services ||= []
  service_hash = nil

  service = service.to_s

  # FIXME!
  services.each do |service_type, value|
    value.each do |vendor, version|
      version.each do |version_str, service_descr|
        if service == service_descr[:vendor]
          service_hash = {
            :type => service_descr[:type], :tier => 'free',
            :vendor => service, :version => version_str
          }
          break
        end
      end
    end
  end

  raise TargetError, "Service [#{service}] is not a valid service choice" unless service_hash
  service_hash[:name] = name
  json_post(VMC::SERVICES_PATH, service_hash)
end

#delete_app(name) ⇒ Object 



105
106
107
108
 
# File 'lib/vmc/client.rb', line 105

def delete_app(name)
  
  http_delete("#{VMC::APPS_PATH}/#{name}")
end

#delete_service(name) ⇒ Object

Raises:



192
193
194
195
196
197
198
 
# File 'lib/vmc/client.rb', line 192

def delete_service(name)
  
  svcs = services || []
  names = svcs.collect { |s| s[:name] }
  raise TargetError, "Service [#{name}] not a valid service" unless names.include? name
  http_delete("#{VMC::SERVICES_PATH}/#{name}")
end

#delete_user(user_email) ⇒ Object 



306
307
308
309
 
# File 'lib/vmc/client.rb', line 306

def delete_user(user_email)
  
  http_delete("#{VMC::USERS_PATH}/#{user_email}")
end

#info ⇒ Object

Retrieves information on the target cloud, and optionally the logged in user



51
52
53
54
 
# File 'lib/vmc/client.rb', line 51

def info
  # TODO: Should merge for new version IMO, general, services, user_account
  json_get(VMC::INFO_PATH)
end

#logged_in? ⇒ Boolean

Checks that the auth_token is valid

Returns:

  • (Boolean) 


249
250
251
252
253
254
255
256
257
 
# File 'lib/vmc/client.rb', line 249

def logged_in?
  descr = info
  if descr
    return false unless descr[:user]
    return false unless descr[:usage]
    @user = descr[:user]
    true
  end
end

#login(user, password) ⇒ Object

login and return an auth_token Auth token can be retained and used in creating new clients, avoiding login.



266
267
268
269
270
271
272
273
 
# File 'lib/vmc/client.rb', line 266

def (user, password)
  status, body, headers = json_post("#{VMC::USERS_PATH}/#{user}/tokens", {:password => password})
  response_info = json_parse(body)
  if response_info
    @user = user
    @auth_token = response_info[:token]
  end
end

#proxy_for(proxy) ⇒ Object 



293
294
295
 
# File 'lib/vmc/client.rb', line 293

def proxy_for(proxy)
  @proxy = proxy
end

#raw_info ⇒ Object 



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

def raw_info
  http_get(VMC::INFO_PATH)
end

#services ⇒ Object

listing of services that are available in the system



159
160
161
162
 
# File 'lib/vmc/client.rb', line 159

def services
  
  json_get(VMC::SERVICES_PATH)
end

#services_info ⇒ Object

Global listing of services that are available on the target system



61
62
63
64
 
# File 'lib/vmc/client.rb', line 61

def services_info
  
  json_get(VMC::GLOBAL_SERVICES_PATH)
end

#target_valid? ⇒ Boolean

Checks that the target is valid

Returns:

  • (Boolean) 


237
238
239
240
241
242
243
244
245
246
 
# File 'lib/vmc/client.rb', line 237

def target_valid?
  return false unless descr = info
  return false unless descr[:name]
  return false unless descr[:build]
  return false unless descr[:version]
  return false unless descr[:support]
  true
rescue
  false
end

#unbind_service(service, appname) ⇒ Object 



208
209
210
211
212
213
214
215
 
# File 'lib/vmc/client.rb', line 208

def unbind_service(service, appname)
  
  app = app_info(appname)
  services = app[:services] || []
  services.delete(service)
  app[:services] = services
  update_app(appname, app)
end

#update_app(name, manifest) ⇒ Object 



83
84
85
86
 
# File 'lib/vmc/client.rb', line 83

def update_app(name, manifest)
  
  json_put("#{VMC::APPS_PATH}/#{name}", manifest)
end

#upload_app(name, zipfile, resource_manifest = nil) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/vmc/client.rb', line 88

def upload_app(name, zipfile, resource_manifest=nil)
  #FIXME, manifest should be allowed to be null, here for compatability with old cc's
  resource_manifest ||= []
  
  upload_data = {:_method => 'put'}
  if zipfile
    if zipfile.is_a? File
      file = zipfile
    else
      file = File.new(zipfile, 'rb')
    end
    upload_data[:application] = file
  end
  upload_data[:resources] = resource_manifest.to_json if resource_manifest
  http_post("#{VMC::APPS_PATH}/#{name}/application", upload_data)
end

#users ⇒ Object 



297
298
299
300
 
# File 'lib/vmc/client.rb', line 297

def users
  
  json_get(VMC::USERS_PATH)
end