Class: Arkaan::Utils::MicroService

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/arkaan/utils/micro_service.rb

Overview

This class is a singleton to load and save parameters for the whole application.

Author:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MicroService

Returns a new instance of MicroService.



27
28
29
30
31
32
33
34
 
# File 'lib/arkaan/utils/micro_service.rb', line 27

def initialize
  @location = false
  @service = false
  @instance = false
  @name = false
  @type = ENV['INSTANCE_TYPE'] || :heroku
  @controller_classes = []
end

Instance Attribute Details

#controller_classes ⇒ Array<Class>

Returns an array of controller classes to run.

Returns:

  • (Array<Class>) —

    an array of controller classes to run



25
26
27
 
# File 'lib/arkaan/utils/micro_service.rb', line 25

def controller_classes
  @controller_classes
end

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



19
20
21
 
# File 'lib/arkaan/utils/micro_service.rb', line 19

def instance
  @instance
end

#location ⇒ Object (readonly)

Returns the value of attribute location.



13
14
15
 
# File 'lib/arkaan/utils/micro_service.rb', line 13

def location
  @location
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



10
 
# File 'lib/arkaan/utils/micro_service.rb', line 10

attr_reader :service

#service ⇒ Object (readonly)

Returns the value of attribute service.



10
11
12
 
# File 'lib/arkaan/utils/micro_service.rb', line 10

def service
  @service
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



22
23
24
 
# File 'lib/arkaan/utils/micro_service.rb', line 22

def type
  @type
end

Instance Method Details

#add_controller_class(classname) ⇒ Object

Add a controller class to the controllers to use.

Parameters:

  • classname (Class) —

    the class to add to the controller to load at startup.



38
39
40
 
# File 'lib/arkaan/utils/micro_service.rb', line 38

def add_controller_class(classname)
  @controller_classes << classname
end

#deactivate! ⇒ Object

Deactivates the current instance and the associated service if no more instances are available.



94
95
96
97
 
# File 'lib/arkaan/utils/micro_service.rb', line 94

def deactivate!
  instance.update_attribute(:running, false)
  service.update_attribute(:test_mode, false) if ENV['TEST_MODE']
end

#from_location(filename) ⇒ Arkaan::utils::MicroService

Sets the location of the file calling the micro service and initializing it so that it’s used as root.

Parameters:

  • filename (String) —

    the full naame of the file with the extension.

Returns:

  • (Arkaan::utils::MicroService) —

    the instance of the micro-service to chain other calls.



65
66
67
68
 
# File 'lib/arkaan/utils/micro_service.rb', line 65

def from_location(filename)
  @location = File.dirname(filename)
  return self
end

#in_standard_mode ⇒ Arkaan::utils::MicroService

Loads the application in standard (production/development) mode, without the test files.

Returns:

  • (Arkaan::utils::MicroService) —

    the instance of the micro-service to chain other calls.



72
73
74
 
# File 'lib/arkaan/utils/micro_service.rb', line 72

def in_standard_mode
  return load_application(test_mode: false)
end

#in_test_mode ⇒ Arkaan::utils::MicroService

Loads the application in test mode, by adding the needed files to run the test suite to the standard loading process.

Returns:

  • (Arkaan::utils::MicroService) —

    the instance of the micro-service to chain other calls.



78
79
80
81
 
# File 'lib/arkaan/utils/micro_service.rb', line 78

def in_test_mode
  @location = File.join(location, '..')
  return load_application(test_mode: true)
end

#in_websocket_mode ⇒ Arkaan::utils::MicroService

Loads the application as a websockets service. Only the websockets application should use that.

Returns:

  • (Arkaan::utils::MicroService) —

    the instance of the micro-service to chain other calls.



85
86
87
88
89
90
91
 
# File 'lib/arkaan/utils/micro_service.rb', line 85

def in_websocket_mode
  load_mongoid_configuration
  load_standard_files

  Arkaan::Monitoring::Websocket.find_or_create_by(url: ENV['WEBSOCKET_URL']).save
  return self
end

#loadable? ⇒ Boolean

Determines if the application can be loaded (all the parameters have been correctly set)

Returns:

  • (Boolean) —

    TRUE if the application can be safely loaded, FALSE otherwise.



44
45
46
 
# File 'lib/arkaan/utils/micro_service.rb', line 44

def loadable?
  return !!(service && location)
end

#path ⇒ String, Boolean

Getter for the path on which the service is mapped.

Returns:

  • (String, Boolean) —

    the absolute path in the URL on which the service is mapped upon, or FALSE if it’s not set already.



50
51
52
 
# File 'lib/arkaan/utils/micro_service.rb', line 50

def path
  return service ? service.path : false
end

#register_as(service_name) ⇒ Arkaan::utils::MicroService

Look for the service and sets it if it’s found in the database, or set it to nil if not found.

Parameters:

  • service_name (String) —

    • the name of the service to look for in the database.

Returns:

  • (Arkaan::utils::MicroService) —

    the instance of the micro-service to chain other calls.



57
58
59
60
 
# File 'lib/arkaan/utils/micro_service.rb', line 57

def register_as(service_name)
  @name = service_name
  return self
end