Class: CFoundry::V2::App

Inherits:
Model
  • Object
show all
Includes:
UploadHelpers
Defined in:
lib/cfoundry/v2/app.rb

Overview

Class for representing a user’s application on a given target (via Client).

Does not guarantee that the app exists; used for both app creation and retrieval, as the attributes are all lazily retrieved. Setting attributes does not perform any requests; use #update! to commit your changes.

Defined Under Namespace

Classes: Instance

Constant Summary

Constants included from UploadHelpers

UploadHelpers::RESOURCE_CHECK_LIMIT, UploadHelpers::UPLOAD_EXCLUDE

Instance Attribute Summary

Attributes inherited from Model

#cache, #changes, #guid

Attributes included from ModelMagic

#scoped_organization, #scoped_space

Instance Method Summary collapse

Methods included from UploadHelpers

#upload

Methods inherited from Model

#attribute_for_error, #changed?, #create, #create!, #delete, #eql?, #exists?, #hash, inherited, #initialize, #inspect, #invalidate!, #manifest, #object_name, objects, #partial?, #persisted?, #plural_object_name, #query_target, #to_key, #to_param

Methods included from ModelMagic

#attribute, #attributes, #defaults, #define_base_client_methods, #define_client_methods, #has_summary, #inherited, #object_name, params_from, #plural_object_name, #queryable_by, #scoped_to_organization, #scoped_to_space, #to_many, #to_many_relations, #to_one, #to_one_relations

Constructor Details

This class inherits a constructor from CFoundry::V2::Model

Instance Method Details

#bind(*instances) ⇒ Object

Bind services to application.



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/cfoundry/v2/app.rb', line 231

def bind(*instances)
  instances.each do |i|
    binding = @client.service_binding
    binding.app = self
    binding.service_instance = i
    binding.create!
  end

  self
end

#binds?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


253
254
255
256
257
 
# File 'lib/cfoundry/v2/app.rb', line 253

def binds?(instance)
  service_bindings.any? { |b|
    b.service_instance == instance
  }
end

#crashes ⇒ Object 



63
64
65
66
67
 
# File 'lib/cfoundry/v2/app.rb', line 63

def crashes
  @client.base.crashes(@guid).collect do |m|
    Instance.new(self, m[:instance], @client, m)
  end
end

#delete! ⇒ Object 



53
54
55
 
# File 'lib/cfoundry/v2/app.rb', line 53

def delete!
  super({:recursive => true})
end

#env ⇒ Object 



83
84
85
86
87
 
# File 'lib/cfoundry/v2/app.rb', line 83

def env
  CFoundry::ChattyHash.new(
    method(:env=),
    stringify(environment_json))
end

#env=(x) ⇒ Object 



89
90
91
 
# File 'lib/cfoundry/v2/app.rb', line 89

def env=(x)
  self.environment_json = stringify(x.to_hash)
end

#file(*path) ⇒ Object 



263
264
265
 
# File 'lib/cfoundry/v2/app.rb', line 263

def file(*path)
  Instance.new(self, "0", @client).file(*path)
end

#files(*path) ⇒ Object 



259
260
261
 
# File 'lib/cfoundry/v2/app.rb', line 259

def files(*path)
  Instance.new(self, "0", @client).files(*path)
end

#health ⇒ Object

Determine application health.

If all instances are running, returns “RUNNING”. If only some are started, returns the precentage of them that are healthy.

Otherwise, returns application’s status.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cfoundry/v2/app.rb', line 177

def health
  if state == "STARTED"
    healthy_count = running_instances
    expected = total_instances

    if expected > 0
      ratio = healthy_count / expected.to_f
      if ratio == 1.0
        "RUNNING"
      else
        "#{(ratio * 100).to_i}%"
      end
    else
      "N/A"
    end
  else
    state
  end
end

#healthy? ⇒ Boolean Also known as: running?

Check that all application instances are running.

Returns:

  • (Boolean) 


210
211
212
213
214
 
# File 'lib/cfoundry/v2/app.rb', line 210

def healthy?
  # invalidate cache so the check is fresh
  invalidate!
  health == "RUNNING"
end

#instances ⇒ Object 



57
58
59
60
61
 
# File 'lib/cfoundry/v2/app.rb', line 57

def instances
  @client.base.instances(@guid).collect do |i, m|
    Instance.new(self, i.to_s, @client, m)
  end
end

#restart!(async = false, &blk) ⇒ Object

Restart the application.



139
140
141
142
 
# File 'lib/cfoundry/v2/app.rb', line 139

def restart!(async = false, &blk)
  stop!
  start!(async, &blk)
end

#running_instances ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/cfoundry/v2/app.rb', line 197

def running_instances
  return @cache[:running_instances] if @cache[:running_instances]

  running = 0

  instances.each do |i|
    running += 1 if i.state == "RUNNING"
  end

  running
end

#services ⇒ Object 



79
80
81
 
# File 'lib/cfoundry/v2/app.rb', line 79

def services
  service_bindings.collect(&:service_instance)
end

#start!(async = false, &blk) ⇒ Object

Start the application.



133
134
135
136
 
# File 'lib/cfoundry/v2/app.rb', line 133

def start!(async = false, &blk)
  self.state = "STARTED"
  update!(async, &blk)
end

#started? ⇒ Boolean

Is the application started?

Note that this does not imply that all instances are running. See #healthy?

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/cfoundry/v2/app.rb', line 226

def started?
  state == "STARTED"
end

#stats ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'lib/cfoundry/v2/app.rb', line 69

def stats
  stats = {}

  @client.base.stats(@guid).each do |idx, info|
    stats[idx.to_s] = info
  end

  stats
end

#stop! ⇒ Object

Stop the application.



127
128
129
130
 
# File 'lib/cfoundry/v2/app.rb', line 127

def stop!
  self.state = "STOPPED"
  update!
end

#stopped? ⇒ Boolean

Is the application stopped?

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/cfoundry/v2/app.rb', line 218

def stopped?
  state == "STOPPED"
end

#stream_file(*path, &blk) ⇒ Object 



267
268
269
 
# File 'lib/cfoundry/v2/app.rb', line 267

def stream_file(*path, &blk)
  Instance.new(self, "0", @client).stream_file(*path, &blk)
end

#stream_update_log(log_url) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cfoundry/v2/app.rb', line 156

def stream_update_log(log_url)
  offset = 0

  while true
    begin
      @client.stream_url(log_url + "&tail&tail_offset=#{offset}") do |out|
        offset += out.size
        yield out
      end
    rescue Timeout::Error
    end
  end
rescue CFoundry::APIError
end

#unbind(*instances) ⇒ Object

Unbind services from application.



243
244
245
246
247
248
249
250
251
 
# File 'lib/cfoundry/v2/app.rb', line 243

def unbind(*instances)
  service_bindings.each do |b|
    if instances.include? b.service_instance
      b.delete!
    end
  end

  self
end

#update!(async = false) {|| ... } ⇒ Object

Yields:

  • () 


144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cfoundry/v2/app.rb', line 144

def update!(async = false)
  response = @client.base.update_app(@guid, @diff, async)

  yield response[:headers]["x-app-staging-log"] if block_given?

  @manifest = @client.base.send(:parse_json, response[:body])

  @diff.clear

  true
end

#uri ⇒ Object Also known as: url 



110
111
112
113
114
115
116
117
118
 
# File 'lib/cfoundry/v2/app.rb', line 110

def uri
  if uris = @cache[:uris]
    return uris.first
  end

  if route = routes.first
    "#{route.host}.#{route.domain.name}"
  end
end

#uri=(x) ⇒ Object Also known as: url= 



121
122
123
 
# File 'lib/cfoundry/v2/app.rb', line 121

def uri=(x)
  self.uris = [x]
end

#uris ⇒ Object Also known as: urls 



95
96
97
98
99
100
101
 
# File 'lib/cfoundry/v2/app.rb', line 95

def uris
  return @cache[:uris] if @cache[:uris]

  routes.collect do |r|
    "#{r.host}.#{r.domain.name}"
  end
end

#uris=(uris) ⇒ Object Also known as: urls=

Raises:



104
105
106
107
 
# File 'lib/cfoundry/v2/app.rb', line 104

def uris=(uris)
  raise CFoundry::Deprecated,
    "App#uris= is invalid against V2 APIs; use add/remove_route"
end