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.



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/cfoundry/v2/app.rb', line 175

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) 


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

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

#command ⇒ Object

TODO v2



61
62
63
 
# File 'lib/cfoundry/v2/app.rb', line 61

def command # TODO v2
  nil
end

#console ⇒ Object

TODO v2



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

def console # TODO v2
  nil
end

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/cfoundry/v2/app.rb', line 85

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



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

def debug_mode # TODO v2
  nil
end

#env ⇒ Object 



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

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

#file(*path) ⇒ Object 



245
246
247
 
# File 'lib/cfoundry/v2/app.rb', line 245

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

#files(*path) ⇒ Object 



241
242
243
 
# File 'lib/cfoundry/v2/app.rb', line 241

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.



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

def health
  state
end

#healthy? ⇒ Boolean Also known as: running?

Check that all application instances are running.

Returns:

  • (Boolean) 


150
151
152
153
154
155
156
157
158
 
# File 'lib/cfoundry/v2/app.rb', line 150

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

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

#instances ⇒ Object 



39
40
41
42
43
 
# File 'lib/cfoundry/v2/app.rb', line 39

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.



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

def restart!
  stop!
  start!
end

#services ⇒ Object 



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

def services
  service_bindings.collect(&:service_instance)
end

#start! ⇒ Object

Start the application.



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

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) 


170
171
172
 
# File 'lib/cfoundry/v2/app.rb', line 170

def started?
  state == "STARTED"
end

#stats ⇒ Object 



45
46
47
 
# File 'lib/cfoundry/v2/app.rb', line 45

def stats
  @client.base.stats(@guid)
end

#stop! ⇒ Object

Stop the application.



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

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

#stopped? ⇒ Boolean

Is the application stopped?

Returns:

  • (Boolean) 


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

def stopped?
  state == "STOPPED"
end

#total_instances ⇒ Object 



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

alias :total_instances :instances

#unbind(*instances) ⇒ Object

Unbind services from application.



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

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.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/cfoundry/v2/app.rb', line 218

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 



113
114
115
 
# File 'lib/cfoundry/v2/app.rb', line 113

def uri
  uris[0]
end

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



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

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

#uris ⇒ Object Also known as: urls 



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

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

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



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

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