Class: Eco::API::Session
- Inherits:
-
Common::Session::BaseSession
- Object
- Common::Session::BaseSession
- Eco::API::Session
- Defined in:
- lib/eco/api/session.rb,
lib/eco/api/session/batch.rb,
lib/eco/api/session/config.rb,
lib/eco/api/session/batch/job.rb,
lib/eco/api/session/batch/jobs.rb,
lib/eco/api/session/config/api.rb,
lib/eco/api/session/config/apis.rb,
lib/eco/api/session/config/sftp.rb,
lib/eco/api/session/batch/errors.rb,
lib/eco/api/session/batch/status.rb,
lib/eco/api/session/config/files.rb,
lib/eco/api/session/config/logger.rb,
lib/eco/api/session/config/mailer.rb,
lib/eco/api/session/config/people.rb,
lib/eco/api/session/batch/feedback.rb,
lib/eco/api/session/batch/policies.rb,
lib/eco/api/session/config/tagtree.rb,
lib/eco/api/session/config/workflow.rb,
lib/eco/api/session/batch/base_policy.rb,
lib/eco/api/session/batch/jobs_groups.rb,
lib/eco/api/session/config/s3_storage.rb,
lib/eco/api/session/config/base_config.rb,
lib/eco/api/session/config/post_launch.rb,
lib/eco/api/session/batch/request_stats.rb
Overview
Class to manage the current session. Central helper of resources.
Defined Under Namespace
Instance Attribute Summary
Attributes inherited from Common::Session::BaseSession
#api, #config, #environment, #file_manager, #logger, #session
Pure organization helpers collapse
- #live_tree(include_archived: false, &block) ⇒ Object
- #login_providers ⇒ Object
- #policy_groups ⇒ Object
- #schemas ⇒ Object
- #tagtree ⇒ Object
People and Input entries helpers collapse
-
#csv_entries(file, **kargs) ⇒ Eco::API::Common::People::Entries
Generates an entries collection from a csv input file.
-
#discarded_entries ⇒ Eco::API::Common::People::Entries
Generates the collection of entries that should be discarded from an update.
-
#entries(*args, **kargs) ⇒ Eco::API::Common::People::Entries
Collection of entries.
-
#entry_factory(schema: nil) ⇒ Eco::API::Common::People::EntryFactory
Helper to obtain a EntryFactory.
- #export(*args) ⇒ Object
-
#fields_mapper ⇒ Eco::Data::Mapper
The mappings between the internal and external attribute/property names.
-
#new_entry(data, dependencies: {}) ⇒ Eco::API::Common::People::PersonEntry
Builds the entry for the given data.
- #new_person(**keyed_args) ⇒ Ecoportal::API::Internal::Person
-
#parse_attribute(attr, source, phase = :internal, deps: {}) ⇒ Object
Allows to use the defined parsers.
-
#person_factory(schema: nil) ⇒ Eco::API::Common::People::PersonFactory
Helper to obtain a PersonFactory.
-
#presets_factory ⇒ Object
Helper to state the abilities that a person should have with given their usergroups.
-
#schema ⇒ String, Ecoportal::API::V1::PersonSchema
Current active session's schema.
-
#schema=(value) ⇒ Object
Sets the current target
PersonSchema
of this session.
Session workflow and batch job launces collapse
-
#job_group(name, order: :last) ⇒ Eco::API::Session::Batch::Jobs
It retrives the group of
Batch::Jobs
namedname
. - #job_groups ⇒ Eco::API::Session::Batch::JobsGroups
- #jobs_launch(simulate: false) ⇒ Object
-
#micro ⇒ Eco::API::MicroCases
Set of helpers to simplify your code.
-
#new_job(group, name, type, usecase, sets = [:core, :details, :account], accept_update_with_no_id = false, &block) ⇒ Eco::API::Session::Batch::Job
Shortcut to create a job of certain type within a group.
-
#policies ⇒ Eco::API::Policies
Does merge
Eco::API::Policies::DefaultPolicies
with the custom policies. - #post_launch ⇒ Object
- #process_case(name, io: nil, type: nil, **params) ⇒ Object
- #summary ⇒ Object
-
#usecases ⇒ Eco::API::UseCases
Does merge
Eco::API::UseCases::DefaultCases
with the custom cases. -
#workflow(io:) ⇒ Object
Opens up the
workflow
configuration.
Additional resources collapse
-
#mail(**kargs) ⇒ Object
Sends an email.
-
#s3upload(content: nil, file: nil, directory: nil, recurse: false, link: false) ⇒ String+
Uploads content into a file, a file or a directory to S3.
Instance Method Summary collapse
-
#batch ⇒ Eco::API::Session::Batch
Provides helper to launch batch operations.
- #enviro_name ⇒ Object
-
#initialize(init = {}) ⇒ Session
constructor
A new instance of Session.
Methods inherited from Common::Session::BaseSession
#enviro=, #fatal, #fm, #mailer, #mailer?, #s3uploader, #s3uploader?, #sftp, #sftp?
Constructor Details
#initialize(init = {}) ⇒ Session
Returns a new instance of Session.
7 8 9 10 11 12 13 14 15 16 17 18 |
# File 'lib/eco/api/session.rb', line 7 def initialize(init = {}) e = init msg = "Expected object Eco::API::Session::Config or Eco::API::Common::Session::Environment. Given: #{init}" raise msg unless e.is_a?(Session::Config) || e.is_a?(Eco::API::Common::Session::Environment) e = Eco::API::Common::Session::Environment.new(init, session: self) if !e.is_a?(Eco::API::Common::Session::Environment) super(e) @entry_factories = {} @person_factories = {} logger.debug("LINE COMMAND: #{$0} #{ARGV.join(" ")}") end |
Instance Method Details
#batch ⇒ Eco::API::Session::Batch
Returns provides helper to launch batch operations.
26 27 28 |
# File 'lib/eco/api/session.rb', line 26 def batch @batch ||= Batch.new(enviro) end |
#csv_entries(file, **kargs) ⇒ Eco::API::Common::People::Entries
Generates an entries collection from a csv input file.
168 169 170 171 172 173 174 |
# File 'lib/eco/api/session.rb', line 168 def csv_entries(file, **kargs) kargs.merge!({ file: file, format: :csv }) return entries(**kargs) end |
#discarded_entries ⇒ Eco::API::Common::People::Entries
requires session.config.people.discarded_file
to be defined.
Generates the collection of entries that should be discarded from an update.
179 180 181 182 183 184 |
# File 'lib/eco/api/session.rb', line 179 def discarded_entries return @discarded_entries if instance_variable_defined?(:@discarded_entries) file = config.people.discarded_file fatal("You have not specified the 'discarded_people_file'") unless file = file_manager.dir.file(file) @discarded_entries = csv_entries(file) end |
#entries(*args, **kargs) ⇒ Eco::API::Common::People::Entries
Returns collection of entries.
157 158 159 160 161 |
# File 'lib/eco/api/session.rb', line 157 def entries(*args, **kargs) entry_factory.entries(*args, **kargs).tap do |collection| logger.info("Loaded #{collection.length} input entries.") end end |
#entry_factory(schema: nil) ⇒ Eco::API::Common::People::EntryFactory
Helper to obtain a EntryFactory
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/eco/api/session.rb', line 94 def entry_factory(schema: nil) schema = to_schema(schema) || self.schema return @entry_factories[schema&.id] if @entry_factories.key?(schema&.id) unless @entry_factories.empty? @entry_factories[schema&.id] = @entry_factories.values.first.newFactory(schema: schema) return @entry_factories[schema&.id] end @entry_factories[schema&.id] = Eco::API::Common::People::EntryFactory.new( enviro, schema: schema, person_parser: config.people.parser, attr_map: fields_mapper ) end |
#enviro_name ⇒ Object
21 22 23 |
# File 'lib/eco/api/session.rb', line 21 def enviro_name config.active_enviro end |
#export(*args) ⇒ Object
136 137 138 |
# File 'lib/eco/api/session.rb', line 136 def export(*args) entry_factory.export(*args) end |
#fields_mapper ⇒ Eco::Data::Mapper
Returns the mappings between the internal and external attribute/property names.
80 81 82 83 84 85 86 87 |
# File 'lib/eco/api/session.rb', line 80 def fields_mapper return @fields_mapper if instance_variable_defined?(:@fields_mapper) mappings = [] if map_file = config.people.fields_mapper mappings = map_file ? file_manager.load_json(map_file) : [] end @fields_mapper = Eco::Data::Mapper.new(mappings) end |
#job_group(name, order: :last) ⇒ Eco::API::Session::Batch::Jobs
It retrives the group of Batch::Jobs
named name
. It creates it if it doesn't exist.
242 243 244 245 246 247 248 249 |
# File 'lib/eco/api/session.rb', line 242 def job_group(name, order: :last) case when job_groups.exists?(name) job_groups[name] else job_groups.new(name, order: order) end end |
#job_groups ⇒ Eco::API::Session::Batch::JobsGroups
236 237 238 |
# File 'lib/eco/api/session.rb', line 236 def job_groups @job_groups ||= Batch::JobsGroups.new(enviro) end |
#jobs_launch(simulate: false) ⇒ Object
259 260 261 |
# File 'lib/eco/api/session.rb', line 259 def jobs_launch(simulate: false) job_groups.launch(simulate: simulate) end |
#live_tree(include_archived: false, &block) ⇒ Object
48 49 50 |
# File 'lib/eco/api/session.rb', line 48 def live_tree(include_archived: false, &block) config.live_tree(enviro: enviro, &block) end |
#login_providers ⇒ Object
38 39 40 |
# File 'lib/eco/api/session.rb', line 38 def login_providers config.login_providers end |
#mail(**kargs) ⇒ Object
Sends an email
274 275 276 277 278 279 280 281 |
# File 'lib/eco/api/session.rb', line 274 def mail(**kargs) if mailer? mailer.mail(**kargs) else logger.error("You are trying to use the mailer, but it's not configured") nil end end |
#micro ⇒ Eco::API::MicroCases
Set of helpers to simplify your code
221 222 223 |
# File 'lib/eco/api/session.rb', line 221 def micro @micro ||= Eco::API::MicroCases.new(enviro) end |
#new_entry(data, dependencies: {}) ⇒ Eco::API::Common::People::PersonEntry
Builds the entry for the given data.
150 151 152 |
# File 'lib/eco/api/session.rb', line 150 def new_entry(data, dependencies: {}) entry_factory(schema: data&.details&.schema_id).new(data, dependencies: dependencies) end |
#new_job(group, name, type, usecase, sets = [:core, :details, :account], accept_update_with_no_id = false, &block) ⇒ Eco::API::Session::Batch::Job
Shortcut to create a job of certain type within a group
254 255 256 |
# File 'lib/eco/api/session.rb', line 254 def new_job(group, name, type, usecase, sets = [:core, :details, :account], accept_update_with_no_id = false, &block) job_group(group).new(name, usecase: usecase, type: type, sets: sets, accept_update_with_no_id: accept_update_with_no_id, &block) end |
#new_person(**keyed_args) ⇒ Ecoportal::API::Internal::Person
143 144 145 |
# File 'lib/eco/api/session.rb', line 143 def new_person(**keyed_args) person_factory.new(**keyed_args) end |
#parse_attribute(attr, source, phase = :internal, deps: {}) ⇒ Object
the use of these method requires to know which is the expected format of source
Allows to use the defined parsers
127 128 129 130 131 132 |
# File 'lib/eco/api/session.rb', line 127 def parse_attribute(attr, source, phase = :internal, deps: {}) unless parsers = entry_factory.person_parser raise "There are no parsers defined" end parsers.parse(attr, source, phase, deps: deps) end |
#person_factory(schema: nil) ⇒ Eco::API::Common::People::PersonFactory
Helper to obtain a PersonFactory
115 116 117 118 |
# File 'lib/eco/api/session.rb', line 115 def person_factory(schema: nil) schema = to_schema(schema) || self.schema @person_factories[schema&.id] ||= Eco::API::Common::People::PersonFactory.new(schema: schema) end |
#policies ⇒ Eco::API::Policies
- the default policies are added at the end (meaning they will run after the custom policies)
Does merge Eco::API::Policies::DefaultPolicies
with the custom policies.
211 212 213 214 215 216 |
# File 'lib/eco/api/session.rb', line 211 def policies @policies ||= config.policies.dup.tap do |policies| default_policies = Eco::API::Policies::DefaultPolicies.new policies.merge(default_policies) end end |
#policy_groups ⇒ Object
33 34 35 |
# File 'lib/eco/api/session.rb', line 33 def policy_groups config.policy_groups end |
#post_launch ⇒ Object
225 226 227 |
# File 'lib/eco/api/session.rb', line 225 def post_launch @post_launch ||= config.post_launch.select(usecases) end |
#presets_factory ⇒ Object
Helper to state the abilities that a person should have with given their usergroups
75 76 77 |
# File 'lib/eco/api/session.rb', line 75 def presets_factory @presets_factory ||= Eco::API::Organization::PresetsFactory.new(enviro: enviro) end |
#process_case(name, io: nil, type: nil, **params) ⇒ Object
230 231 232 233 |
# File 'lib/eco/api/session.rb', line 230 def process_case(name, io: nil, type: nil, **params) args = { session: self }.merge(params) usecases.case(name, type: type).launch(io: io, **args) end |
#s3upload(content: nil, file: nil, directory: nil, recurse: false, link: false) ⇒ String+
Uploads content into a file, a file or a directory to S3
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/eco/api/session.rb', line 293 def s3upload(content: nil, file: nil, directory: nil, recurse: false, link: false) if s3uploader? if content == :target path = micro.s3upload_targets elsif content && file path = s3uploader.upload(file, content) elsif file path = s3uploader.upload_file(file) elsif directory path = s3uploader.upload_directory(directory, recurse: recurse) else logger.error("To use Session.s3upload, you must specify either directory, file or content and file name") end return path unless link s3uploader.link(path) else logger.error("You are trying to use S3 uploader, but it's not configured") nil end end |
#schema ⇒ String, Ecoportal::API::V1::PersonSchema
Returns current active session's schema.
61 62 63 64 |
# File 'lib/eco/api/session.rb', line 61 def schema self.schema = config.people.default_schema || schemas.first unless @schema @schema end |
#schema=(value) ⇒ Object
observe that it is essential for the parsers/serialisers to identify target/present attributes.
Sets the current target PersonSchema
of this session.
69 70 71 72 |
# File 'lib/eco/api/session.rb', line 69 def schema=(value) @schema = to_schema(value) self end |
#schemas ⇒ Object
53 54 55 |
# File 'lib/eco/api/session.rb', line 53 def schemas config.schemas end |
#summary ⇒ Object
264 265 266 |
# File 'lib/eco/api/session.rb', line 264 def summary job_groups.summary end |
#tagtree ⇒ Object
43 44 45 |
# File 'lib/eco/api/session.rb', line 43 def tagtree config.tagtree(enviro: enviro) end |
#usecases ⇒ Eco::API::UseCases
- the order matters, as a default usecase can be redefined by a custom one with same name
Does merge Eco::API::UseCases::DefaultCases
with the custom cases.
200 201 202 203 204 205 |
# File 'lib/eco/api/session.rb', line 200 def usecases @usecases ||= config.usecases.dup.tap do |cases| all_cases = Eco::API::UseCases::DefaultCases.new.merge(config.usecases) cases.merge(all_cases) end end |
#workflow(io:) ⇒ Object
Opens up the workflow
configuration
190 191 192 193 194 |
# File 'lib/eco/api/session.rb', line 190 def workflow(io:) config.workflow.tap do |wf| yield(wf, io) if block_given? end end |