Class: Eco::API::Common::Session::BaseSession
- Inherits:
-
Object
- Object
- Eco::API::Common::Session::BaseSession
- Includes:
- Helpers
- Defined in:
- lib/eco/api/common/session/base_session.rb
Direct Known Subclasses
People::EntryFactory, MicroCases, Session, Session::Batch, Session::Batch::Job, Session::Batch::Jobs, Session::Batch::JobsGroups, Session::Batch::Status
Instance Attribute Summary collapse
-
#api(version: nil) ⇒ Object
readonly
Returns the value of attribute api.
-
#config ⇒ Object
Returns the value of attribute config.
-
#environment ⇒ Object
(also: #enviro)
Returns the value of attribute environment.
-
#file_manager ⇒ Object
readonly
Returns the value of attribute file_manager.
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
-
#session ⇒ Object
Returns the value of attribute session.
Instance Method Summary collapse
-
#enviro= ⇒ Object
Sets the attribute environment.
-
#fatal(msg) ⇒ Object
TODO: paremeter for the exception.
-
#fm ⇒ Object
Returns the value of attribute file_manager.
-
#initialize(e) ⇒ BaseSession
constructor
A new instance of BaseSession.
- #mailer ⇒ Object
- #mailer? ⇒ Boolean
- #s3uploader ⇒ Object
- #s3uploader? ⇒ Boolean
- #sftp ⇒ Object
- #sftp? ⇒ Boolean
Constructor Details
#initialize(e) ⇒ BaseSession
Returns a new instance of BaseSession.
16 17 18 19 |
# File 'lib/eco/api/common/session/base_session.rb', line 16 def initialize(e) raise "Expected object Eco::API::Common::Session::Environment. Given: #{e.class}" unless e.is_a?(Environment) self.environment = e end |
Instance Attribute Details
#api(version: nil) ⇒ Object (readonly)
Returns the value of attribute api.
11 12 13 |
# File 'lib/eco/api/common/session/base_session.rb', line 11 def api @api end |
#config ⇒ Object
Returns the value of attribute config.
7 8 9 |
# File 'lib/eco/api/common/session/base_session.rb', line 7 def config @config end |
#environment ⇒ Object 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 |
#file_manager ⇒ Object (readonly)
Returns the value of attribute file_manager.
11 12 13 |
# File 'lib/eco/api/common/session/base_session.rb', line 11 def file_manager @file_manager end |
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
11 12 13 |
# File 'lib/eco/api/common/session/base_session.rb', line 11 def logger @logger end |
#session ⇒ Object
Returns the value of attribute session.
6 7 8 |
# File 'lib/eco/api/common/session/base_session.rb', line 6 def session @session end |
Instance Method Details
#enviro= ⇒ Object
Sets the attribute environment
9 10 11 |
# File 'lib/eco/api/common/session/base_session.rb', line 9 def environment=(value) @environment = value end |
#fatal(msg) ⇒ Object
TODO: paremeter for the exception
71 72 73 74 |
# File 'lib/eco/api/common/session/base_session.rb', line 71 def fatal(msg) logger.fatal(msg) raise msg end |
#fm ⇒ Object
Returns the value of attribute file_manager.
12 13 14 |
# File 'lib/eco/api/common/session/base_session.rb', line 12 def file_manager @file_manager end |
#mailer ⇒ Object
42 43 44 |
# File 'lib/eco/api/common/session/base_session.rb', line 42 def mailer enviro.mailer end |
#mailer? ⇒ Boolean
46 47 48 |
# File 'lib/eco/api/common/session/base_session.rb', line 46 def mailer? enviro.mailer? end |
#s3uploader ⇒ Object
58 59 60 |
# File 'lib/eco/api/common/session/base_session.rb', line 58 def s3uploader enviro.s3uploader end |
#s3uploader? ⇒ Boolean
62 63 64 |
# File 'lib/eco/api/common/session/base_session.rb', line 62 def s3uploader? enviro.s3uploader? end |
#sftp ⇒ Object
50 51 52 |
# File 'lib/eco/api/common/session/base_session.rb', line 50 def sftp enviro.sftp end |
#sftp? ⇒ Boolean
54 55 56 |
# File 'lib/eco/api/common/session/base_session.rb', line 54 def sftp? enviro.sftp? end |