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

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

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.



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cfoundry/v2/app.rb', line 239

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) 


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

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

#crashes ⇒ Object 



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

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

#create_routes(*uris) ⇒ Object Also known as: create_route 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/cfoundry/v2/app.rb', line 103

def create_routes(*uris)
  uris.each do |uri|
    host, domain_name = uri.split(".", 2)

    domain =
      @client.current_space.domains.find { |d|
        d.name == domain_name
      }

    unless domain
      raise CFoundry::Error, "Invalid domain '#{domain_name}'"
    end

    route = @client.routes.find { |r|
      r.host == host && r.domain == domain
    }

    unless route
      route = @client.route
      route.host = host
      route.domain = domain
      route.space = space
      route.create!
    end

    add_route(route)
  end
end

#env ⇒ Object 



76
77
78
79
80
 
# File 'lib/cfoundry/v2/app.rb', line 76

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

#env=(x) ⇒ Object 



82
83
84
 
# File 'lib/cfoundry/v2/app.rb', line 82

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

#file(*path) ⇒ Object 



271
272
273
 
# File 'lib/cfoundry/v2/app.rb', line 271

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

#files(*path) ⇒ Object 



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

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.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/cfoundry/v2/app.rb', line 185

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) 


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

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

#instances ⇒ Object 



50
51
52
53
54
 
# File 'lib/cfoundry/v2/app.rb', line 50

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.



162
163
164
165
 
# File 'lib/cfoundry/v2/app.rb', line 162

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

#running_instances ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cfoundry/v2/app.rb', line 205

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 



72
73
74
 
# File 'lib/cfoundry/v2/app.rb', line 72

def services
  service_bindings.collect(&:service_instance)
end

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

Start the application.



156
157
158
159
 
# File 'lib/cfoundry/v2/app.rb', line 156

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) 


234
235
236
 
# File 'lib/cfoundry/v2/app.rb', line 234

def started?
  state == "STARTED"
end

#stats ⇒ Object 



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

def stats
  stats = {}

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

  stats
end

#stop! ⇒ Object

Stop the application.



150
151
152
153
 
# File 'lib/cfoundry/v2/app.rb', line 150

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

#stopped? ⇒ Boolean

Is the application stopped?

Returns:

  • (Boolean) 


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

def stopped?
  state == "STOPPED"
end

#stream_file(*path, &blk) ⇒ Object 



275
276
277
 
# File 'lib/cfoundry/v2/app.rb', line 275

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

#unbind(*instances) ⇒ Object

Unbind services from application.



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

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:

  • () 


167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cfoundry/v2/app.rb', line 167

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 



133
134
135
136
137
138
139
140
141
 
# File 'lib/cfoundry/v2/app.rb', line 133

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= 



144
145
146
 
# File 'lib/cfoundry/v2/app.rb', line 144

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

#uris ⇒ Object Also known as: urls 



88
89
90
91
92
93
94
 
# File 'lib/cfoundry/v2/app.rb', line 88

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:



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

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