Class: JFoundry::V2::App

Inherits:
Model
  • Object
show all
Includes:
UploadHelpers
Defined in:
lib/jfoundry/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, #created_at, #diff, #guid, #updated_at

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

#attributes, #defaults, #inherited, #object_name, params_from, #plural_object_name, #scoped_to_organization, #scoped_to_space, #to_many_relations, #to_one_relations

Methods included from ModelMagic::QueryableBy

#queryable_by

Methods included from ModelMagic::ToMany

#to_many

Methods included from ModelMagic::ToOne

#to_one

Methods included from ModelMagic::Attribute

#attribute

Methods included from ModelMagic::HasSummary

#has_summary

Methods included from ModelMagic::ClientExtensions

#add_client_methods

Constructor Details

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

Instance Method Details

#bind(*instances) ⇒ Object

Bind services to application.



260
261
262
263
264
265
266
267
268
269
# File 'lib/jfoundry/v2/app.rb', line 260

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)


282
283
284
285
286
# File 'lib/jfoundry/v2/app.rb', line 282

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

#crashesObject



60
61
62
63
64
# File 'lib/jfoundry/v2/app.rb', line 60

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

#delete!(opts = {}) ⇒ Object



50
51
52
# File 'lib/jfoundry/v2/app.rb', line 50

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

#deploy(package_path, check_resources = true) {|| ... } ⇒ Object

author:cdzhw4 date:2014-05-30 deploy app from package step 1: upload package to cc step 2: staging package to droplet black |url| url:staging log path

Yields:

  • ()


138
139
140
141
# File 'lib/jfoundry/v2/app.rb', line 138

def deploy(package_path,check_resources = true,&blk)
  response = upload(package_path,check_resources)
  yield response[:headers]["x-app-staging-log"] if block_given?
end

#domainObject



123
124
125
126
# File 'lib/jfoundry/v2/app.rb', line 123

def domain
  return nil if routes.empty?
  routes.first.domain.name
end

#envObject



80
81
82
83
84
# File 'lib/jfoundry/v2/app.rb', line 80

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

#env=(x) ⇒ Object



86
87
88
# File 'lib/jfoundry/v2/app.rb', line 86

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

#file(*path) ⇒ Object



292
293
294
# File 'lib/jfoundry/v2/app.rb', line 292

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

#files(*path) ⇒ Object



288
289
290
# File 'lib/jfoundry/v2/app.rb', line 288

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

#healthObject

Determine application health.

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

Otherwise, returns application’s status.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/jfoundry/v2/app.rb', line 204

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
rescue JFoundry::StagingError, JFoundry::NotStaged
  "STAGING FAILED"
end

#healthy?Boolean Also known as: running?

Check that all application instances are running.

Returns:

  • (Boolean)


239
240
241
242
243
# File 'lib/jfoundry/v2/app.rb', line 239

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

#hostObject



118
119
120
121
# File 'lib/jfoundry/v2/app.rb', line 118

def host
  return nil if routes.empty?
  routes.first.host
end

#instancesObject



54
55
56
57
58
# File 'lib/jfoundry/v2/app.rb', line 54

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

#restartObject

author:cdzhw4 date:2014-05-30 Grace restart



145
146
147
148
149
150
151
# File 'lib/jfoundry/v2/app.rb', line 145

def restart
  response = @client.base.restart(@guid)
   if response[:code].to_i !=200
     raise response[:note]
   end
  response
end

#restart!(&blk) ⇒ Object

Restart the application.



166
167
168
169
# File 'lib/jfoundry/v2/app.rb', line 166

def restart!(&blk)
  stop!
  start!(&blk)
end

#running_instancesObject



226
227
228
229
230
231
232
233
234
235
236
# File 'lib/jfoundry/v2/app.rb', line 226

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

#servicesObject



76
77
78
# File 'lib/jfoundry/v2/app.rb', line 76

def services
  service_bindings.collect(&:service_instance)
end

#start!(&blk) ⇒ Object

Start the application.



160
161
162
163
# File 'lib/jfoundry/v2/app.rb', line 160

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

#started?Boolean

Is the application started?

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

Returns:

  • (Boolean)


255
256
257
# File 'lib/jfoundry/v2/app.rb', line 255

def started?
  state == "STARTED"
end

#statsObject



66
67
68
69
70
71
72
73
74
# File 'lib/jfoundry/v2/app.rb', line 66

def stats
  stats = {}

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

  stats
end

#stop!Object

Stop the application.



154
155
156
157
# File 'lib/jfoundry/v2/app.rb', line 154

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

#stopped?Boolean

Is the application stopped?

Returns:

  • (Boolean)


247
248
249
# File 'lib/jfoundry/v2/app.rb', line 247

def stopped?
  state == "STOPPED"
end

#stream_file(*path, &blk) ⇒ Object



296
297
298
# File 'lib/jfoundry/v2/app.rb', line 296

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

#stream_update_log(log_url) ⇒ Object



183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/jfoundry/v2/app.rb', line 183

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 JFoundry::APIError
end

#unbind(*instances) ⇒ Object

Unbind services from application.



272
273
274
275
276
277
278
279
280
# File 'lib/jfoundry/v2/app.rb', line 272

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

  self
end

#update! {|| ... } ⇒ Object

Yields:

  • ()


171
172
173
174
175
176
177
178
179
180
181
# File 'lib/jfoundry/v2/app.rb', line 171

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

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

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

  @diff.clear

  true
end

#uriObject Also known as: url



107
108
109
110
111
112
113
114
115
# File 'lib/jfoundry/v2/app.rb', line 107

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=



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

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

#urisObject Also known as: urls



92
93
94
95
96
97
98
# File 'lib/jfoundry/v2/app.rb', line 92

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=



101
102
103
104
# File 'lib/jfoundry/v2/app.rb', line 101

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