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::UPLOAD_EXCLUDE

Instance Attribute Summary

Attributes inherited from Model

#guid

Instance Method Summary collapse

Methods included from UploadHelpers

#check_unreachable_links, #find_sockets, #make_fingerprints, #prepare_package

Methods inherited from Model

attribute, #create!, defaults, #delete!, #eql?, #exists?, #hash, #initialize, #inspect, #invalidate!, #manifest, #object_name, to_many, to_one, #update!, validate_type, value_matches?

Constructor Details

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

Instance Method Details

#bind(*instances) ⇒ Object

Bind services to application.



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cfoundry/v2/app.rb', line 185

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) 


207
208
209
210
211
 
# File 'lib/cfoundry/v2/app.rb', line 207

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

#crashes ⇒ Object 



47
48
49
50
51
 
# File 'lib/cfoundry/v2/app.rb', line 47

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 



93
94
95
96
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/v2/app.rb', line 93

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
      }

    raise "Invalid domain '#{domain_name}'" unless domain

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

    unless route
      route = @client.route
      route.host = host
      route.domain = domain
      route.organization = @client.current_organization
      route.create!
    end

    add_route(route)
  end
end

#debug_mode ⇒ Object

TODO v2



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

def debug_mode # TODO v2
  nil
end

#env ⇒ Object 



67
68
69
70
71
 
# File 'lib/cfoundry/v2/app.rb', line 67

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

#env=(x) ⇒ Object 



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

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

#file(*path) ⇒ Object 



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

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

#files(*path) ⇒ Object 



251
252
253
 
# File 'lib/cfoundry/v2/app.rb', line 251

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.



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

def health
  state
end

#healthy? ⇒ Boolean Also known as: running?

Check that all application instances are running.

Returns:

  • (Boolean) 


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

def healthy?
  # invalidate cache so the check is fresh
  @manifest = nil

  case health
  when "RUNNING", "STARTED"
    true
  end
end

#instances ⇒ Object 



41
42
43
44
45
 
# File 'lib/cfoundry/v2/app.rb', line 41

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

#restart! ⇒ Object

Restart the application.



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

def restart!
  stop!
  start!
end

#services ⇒ Object 



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

def services
  service_bindings.collect(&:service_instance)
end

#start! ⇒ Object

Start the application.



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

def start!
  update! :state => "STARTED"
end

#started? ⇒ Boolean

Is the application started?

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

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/cfoundry/v2/app.rb', line 180

def started?
  state == "STARTED"
end

#stats ⇒ Object 



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

def stats
  stats = {}

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

  stats
end

#stop! ⇒ Object

Stop the application.



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

def stop!
  update! :state => "STOPPED"
end

#stopped? ⇒ Boolean

Is the application stopped?

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/cfoundry/v2/app.rb', line 172

def stopped?
  state == "STOPPED"
end

#total_instances ⇒ Object 



36
 
# File 'lib/cfoundry/v2/app.rb', line 36

alias :total_instances :instances

#unbind(*instances) ⇒ Object

Unbind services from application.



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

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

  self
end

#upload(path, check_resources = true) ⇒ Object

Upload application’s code to target. Do this after #create! and before #start!

path

A path pointing to either a directory, or a .jar, .war, or .zip file.

If a .vmcignore file is detected under the given path, it will be used to exclude paths from the payload, similar to a .gitignore.

check_resources

If set to ‘false`, the entire payload will be uploaded without checking the resource cache.

Only do this if you know what you’re doing.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cfoundry/v2/app.rb', line 228

def upload(path, check_resources = true)
  unless File.exist? path
    raise "invalid application path '#{path}'"
  end

  zipfile = "#{Dir.tmpdir}/#{@guid}.zip"
  tmpdir = "#{Dir.tmpdir}/.vmc_#{@guid}_files"

  FileUtils.rm_f(zipfile)
  FileUtils.rm_rf(tmpdir)

  prepare_package(path, tmpdir)

  resources = determine_resources(tmpdir) if check_resources

  packed = CFoundry::Zip.pack(tmpdir, zipfile)

  @client.base.upload_app(@guid, packed && zipfile, resources || [])
ensure
  FileUtils.rm_f(zipfile) if zipfile
  FileUtils.rm_rf(tmpdir) if tmpdir
end

#uri ⇒ Object Also known as: url 



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

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

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



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

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

#uris ⇒ Object Also known as: urls 



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

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

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



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

def uris=(uris)
  raise "App#uris= is invalid against V2 APIs. Use add/remove_route."
end