Class: Eco::API::Common::Session::BaseSession

Inherits:
Object
  • Object
show all
Includes:
Helpers, Language::AuxiliarLogger
Defined in:
lib/eco/api/common/session/base_session.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Language::AuxiliarLogger

#log

Methods included from Helpers

included

Constructor Details

#initialize(env) ⇒ BaseSession

Returns a new instance of BaseSession.



10
11
12
13
14
15
 
# File 'lib/eco/api/common/session/base_session.rb', line 10

def initialize(env)
  msg = "Expected object Eco::API::Common::Session::Environment. Given: #{env.class}"
  raise msg unless env.is_a?(Environment)

  self.environment = env
end

Instance Attribute Details

#config ⇒ Object 



27
28
29
 
# File 'lib/eco/api/common/session/base_session.rb', line 27

def config
  enviro.config
end

#environment ⇒ Object Also known as: enviro

Returns the value of attribute environment.



4
5
6
 
# File 'lib/eco/api/common/session/base_session.rb', line 4

def environment
  @environment
end

#session ⇒ Object 



17
18
19
 
# File 'lib/eco/api/common/session/base_session.rb', line 17

def session
  enviro.session
end

Instance Method Details

#api(version: nil) ⇒ Object 



31
32
33
 
# File 'lib/eco/api/common/session/base_session.rb', line 31

def api(version: nil)
  enviro.api(version: version)
end

#api?(version: nil) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/eco/api/common/session/base_session.rb', line 35

def api?(version: nil)
  enviro.api?(version: version)
end

#fatal(msg) ⇒ Object

TODO: paremeter for the exception



77
78
79
80
 
# File 'lib/eco/api/common/session/base_session.rb', line 77

def fatal(msg)
  log(:fatal) { msg }
  raise msg
end

#file_manager ⇒ Object Also known as: fm 



43
44
45
 
# File 'lib/eco/api/common/session/base_session.rb', line 43

def file_manager
  enviro.file_manager
end

#logger ⇒ Object 



72
73
74
 
# File 'lib/eco/api/common/session/base_session.rb', line 72

def logger
  enviro.logger
end

#mailer ⇒ Object 



48
49
50
 
# File 'lib/eco/api/common/session/base_session.rb', line 48

def mailer
  enviro.mailer
end

#mailer? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/eco/api/common/session/base_session.rb', line 52

def mailer?
  enviro.mailer?
end

#missing_api_params(version: nil) ⇒ Object 



39
40
41
 
# File 'lib/eco/api/common/session/base_session.rb', line 39

def missing_api_params(version: nil)
  enviro.missing_api_params(version: version)
end

#s3uploader ⇒ Object 



64
65
66
 
# File 'lib/eco/api/common/session/base_session.rb', line 64

def s3uploader
  enviro.s3uploader
end

#s3uploader? ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/eco/api/common/session/base_session.rb', line 68

def s3uploader?
  enviro.s3uploader?
end

#sftp ⇒ Object 



56
57
58
 
# File 'lib/eco/api/common/session/base_session.rb', line 56

def sftp
  enviro.sftp
end

#sftp? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/eco/api/common/session/base_session.rb', line 60

def sftp?
  enviro.sftp?
end