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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env) ⇒ BaseSession

Returns a new instance of BaseSession.



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

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

#configObject



29
30
31
# File 'lib/eco/api/common/session/base_session.rb', line 29

def config
  enviro.config
end

#environmentObject Also known as: enviro

Returns the value of attribute environment.



7
8
9
# File 'lib/eco/api/common/session/base_session.rb', line 7

def environment
  @environment
end

#sessionObject



19
20
21
# File 'lib/eco/api/common/session/base_session.rb', line 19

def session
  enviro.session
end

Instance Method Details

#api(version: nil) ⇒ Object



33
34
35
# File 'lib/eco/api/common/session/base_session.rb', line 33

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

#api?(version: nil) ⇒ Boolean

Returns:

  • (Boolean)


37
38
39
# File 'lib/eco/api/common/session/base_session.rb', line 37

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

#fatal(msg) ⇒ Object

TODO: paremeter for the exception



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

def fatal(msg)
  logger.fatal(msg)
  raise msg
end

#file_managerObject Also known as: fm



41
42
43
# File 'lib/eco/api/common/session/base_session.rb', line 41

def file_manager
  enviro.file_manager
end

#loggerObject



70
71
72
# File 'lib/eco/api/common/session/base_session.rb', line 70

def logger
  enviro.logger
end

#mailerObject



46
47
48
# File 'lib/eco/api/common/session/base_session.rb', line 46

def mailer
  enviro.mailer
end

#mailer?Boolean

Returns:

  • (Boolean)


50
51
52
# File 'lib/eco/api/common/session/base_session.rb', line 50

def mailer?
  enviro.mailer?
end

#s3uploaderObject



62
63
64
# File 'lib/eco/api/common/session/base_session.rb', line 62

def s3uploader
  enviro.s3uploader
end

#s3uploader?Boolean

Returns:

  • (Boolean)


66
67
68
# File 'lib/eco/api/common/session/base_session.rb', line 66

def s3uploader?
  enviro.s3uploader?
end

#sftpObject



54
55
56
# File 'lib/eco/api/common/session/base_session.rb', line 54

def sftp
  enviro.sftp
end

#sftp?Boolean

Returns:

  • (Boolean)


58
59
60
# File 'lib/eco/api/common/session/base_session.rb', line 58

def sftp?
  enviro.sftp?
end