eco-helpers 0.6.13 → 0.6.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '097d36be4a38f2e209bb2b2d80861d17a45c83d7'
-  data.tar.gz: db938dd522faf091e76714c7c4b58f4591144f02
+  metadata.gz: 12bd692f0b9d72b4116b42bfba1159f32d0be43f
+  data.tar.gz: 9e5d0d188d6a5b2ea908e96c2ac5ff17e8b322a4
 SHA512:
-  metadata.gz: a2fdfafe595b112bc81f4a6fe1e7fbbb32ed9ef306a54a40b1bb96849101a81ec19bd58c6240150f06f69c425d667b3f59d173bc98424c0878d8ece17231dc99
-  data.tar.gz: 55a8f3879f996db311974429e9ae1b111448cc51b4e676b9b714701fbfff05d07d0ead0011425fdad0d47d72d96c48be6cb987e127b1d4ac902e8b2ab0e273f2
+  metadata.gz: e3d1a520ec06cb397d3a24b3daf3113d1a4766db082649fc0317cbd29bf0088374a1380c66e6724159fff070cbdacbf71fc7157649cc913c86a21df941513271
+  data.tar.gz: 30feb556fd73cf5c3fca8c39769ba2e0749394d6e1c0de4e608151ed8d6f0f4fa19da76dc2737f2eef146ed86e1a8aafddc386f0d9c335674458625f4fce4deb

data/eco-helpers.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
   s.add_development_dependency "redcarpet", "~> 3.4", ">= 3.4.0"
 
-  s.add_dependency 'ecoportal-api', '~> 0.3', '>= 0.3.6'
+  s.add_dependency 'ecoportal-api', '~> 0.3', '>= 0.3.6', '< 0.4.0'
   s.add_dependency 'faker',         '~> 1',   '>= 1.9'
   s.add_dependency 'distribution',  '~> 0.7', '>= 0.7.3'
   s.add_dependency 'thor',          '~> 0',   '>= 0.20'

data/lib/eco/api.rb

@@ -7,7 +7,6 @@ end
 
 require_relative 'api/common'
 require_relative 'api/organization'
-require_relative 'api/session'
 require_relative 'api/usecases'
-require_relative 'api/session_config'
+require_relative 'api/session'
 require_relative 'api/eco_faker'

data/lib/eco/api/common/people/person_entry.rb

@@ -237,7 +237,7 @@ module Eco
             unserialized_entry.merge(serial_attrs)
           end
 
-          # returns entry with interal names and values
+          # returns entry with internal names and values
           def internal_entry(data)
             return parsed_entry(data) if parsing?
             unserialized_entry(data)

data/lib/eco/api/common/people/person_factory.rb

@@ -10,9 +10,9 @@ module Eco
 
           def initialize(person: {}, schema: {}, account: {}, modifier: Common::People::PersonModifier.new)
             @modifier = Common::People::PersonModifier.new(modifier)
-            @person = person
+            @person  = person
             @account = account
-            @schema = schema
+            @schema  = schema
             @schema_attrs = @schema&.fields&.map { |fld| fld.alt_id }
           end
 
@@ -21,7 +21,7 @@ module Eco
             return PersonFactory.new(person: person, schema: @schema, modifier: in_raw_modifier).new unless !person
             person = klass.new(person_hash(@person))
             person.account = account_hash(@account) if @modifier.add_account? && @modifier.internal?
-            person.details = details_hash(@schema) unless @modifier.no_details?
+            person.add_details(@schema) unless @modifier.no_details?
             person
           end
 

data/lib/eco/api/common/session/base_session.rb

@@ -6,6 +6,7 @@ module Eco
 
           include Common::People
 
+          attr_accessor :session
           attr_accessor :environment, :config
           alias_method :enviro, :environment
           alias_method :enviro=, :environment=
@@ -14,8 +15,13 @@ module Eco
           alias_method :fm, :file_manager
 
           def initialize(e)
-            e = Environment.new(e) if !e.is_a?(Environment)
-            self.environment = e if e.is_a?(Environment)
+            raise "Expected object Eco::API::Common::Session::Environment. Given: #{e.class}" unless e.is_a?(Environment)
+            #e = Environment.new(e) if !e.is_a?(Environment)
+            self.environment = e   #if e.is_a?(Environment)
+          end
+
+          def session
+            enviro.session
           end
 
           def environment=(value)
@@ -39,6 +45,12 @@ module Eco
             enviro.logger
           end
 
+          # TODO: paremeter for the exception
+          def fatal(msg)
+            logger.fatal(msg)
+            raise msg
+          end
+
         end
       end
     end

data/lib/eco/api/common/session/environment.rb

@@ -6,18 +6,20 @@ module Eco
 
           include Common::People
 
-          attr_reader :config
+          attr_reader :config, :session
           attr_reader :api #, :host, :version
           attr_reader :file_manager, :logger
 
           alias_method :fm, :file_manager
 
-          def initialize(init = {})
+          def initialize(init = {}, session:)
             init = init.conf if init.is_a?(Environment)
-            msg = "Wrong Session::Environment initializer. Expected Hash or Environment object. Given: #{init}"
-            raise msg unless init.is_a?(Eco::API::SessionConfig)
+            msg = "Expected object Eco::API::Session::Config or Environment. Given: #{init}"
+            raise msg unless init.is_a?(Eco::API::Session::Config)
+            raise "Expected an Eco::API::Session object. Given: #{session}" if session  && !session.is_a?(Eco::API::Session)
 
-            @config = init
+            @config  = init
+            @session = session
             @file_manager = Eco::API::Common::Session::FileManager.new(enviro: self)
             @logger       = Eco::API::Common::Session::Logger.new(enviro: self)
             new_api
@@ -27,9 +29,9 @@ module Eco
             return nil unless config.apis.active_api
 
             log_connection = config.logger.log_connection?
-            log = log_connection ? @logger : ::Logger.new(IO::NULL)
+            logg = log_connection ? logger : ::Logger.new(IO::NULL)
 
-            api = config.api(log)
+            api = config.api(logg)
 
             unless log_connection
               logger.info("Created connection pointing to '#{config.apis.active_api.host}' in '#{config.apis.active_api.mode}' mode")

data/lib/eco/api/common/version_patches/external_person.rb

@@ -1,10 +1,24 @@
 module Ecoportal
   module API
     class V1
-      class Person < Common::BaseModel
-        def sync
+      class Person
+
+        def consolidate!
           @original_doc = JSON.parse(@doc.to_json)
         end
+
+        def sync
+          consolidate!
+        end
+
+        #def reset_details!
+        #  doc["details"] = JSON.parse(original_doc["details"])
+        #end
+
+        #def consolidate_details!
+        #  original_doc["details"] = JSON.parse(doc["details"])
+        #end
+
       end
     end
   end

data/lib/eco/api/common/version_patches/internal_person.rb

@@ -0,0 +1,17 @@
+module Ecoportal
+  module API
+    class Internal
+      class Person
+
+        #def reset_account!
+        #  doc["account"] = JSON.parse(original_doc["account"])
+        #end
+
+        #def consolidate_account!
+        #  original_doc["account"] = JSON.parse(doc["account"])
+        #end
+
+      end
+    end
+  end
+end

data/lib/eco/api/session.rb

@@ -1,7 +1,6 @@
 module Eco
   module API
     class Session < Common::Session::BaseSession
-
       attr_reader :batch, :policy_groups
       attr_accessor :schema, :schemas_hash
       attr_reader :tagtree
@@ -11,12 +10,17 @@ module Eco
       #alias_method :org, :organization
 
       def initialize(init = {})
-        super(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)
+
         logger.debug("LINE COMMAND: #{$0} #{ARGV.join(" ")}")
 
         @batch        = Batch.new(enviro)
-        @task         = Task.new(self, enviro)
-        @job_groups   = JobGroups.new(session: self)
+        @task         = Task.new(enviro)
+        @job_groups   = JobGroups.new(enviro)
 
         @use_cases    = Eco::API::UseCases::DefaultCases.new.merge(config.usecases.use_group)
 
@@ -46,16 +50,12 @@ module Eco
       end
 
       def self.configure
-        #SessionConfig.new.tap
-        conf = SessionConfig.new
+        # TODO: change to  Session::Config.new.tap
+        conf = Session::Config.new
         yield(conf) if block_given?
         conf
       end
 
-      def config
-        enviro.config
-      end
-
       # TASKS & JOBS
       def do
         @task
@@ -100,7 +100,7 @@ module Eco
         case value
         when String
           sch = @schemas_hash[value.downcase]
-          raise "The schema with id or name '#{value}' does not exist" if !sch
+          fatal "The schema with id or name '#{value}' does not exist" if !sch
           @schema = sch
         when Ecoportal::API::V1::PersonSchema
           @schema = value
@@ -163,20 +163,14 @@ module Eco
         @use_cases.case(name, type: type).process(**args)
       end
 
-      private
-
-      def fatal(msg)
-        logger.fatal(msg)
-        raise msg
-      end
-
     end
   end
 end
 
+require_relative 'session/config'
 require_relative 'session/batch'
 require_relative 'session/batch_status'
 require_relative 'session/task'
 require_relative 'session/batch_job'
-require_relative 'session/job_group'
+require_relative 'session/batch_jobs'
 require_relative 'session/job_groups'

data/lib/eco/api/session/batch.rb

@@ -15,11 +15,7 @@ module Eco
         end
 
         def launch(people = nil, method:, api: nil, params: {per_page: DEFAULT_BATCH_BLOCK})
-          if !valid_method?(method)
-            msg = "Invalid batch method: #{method}."
-            logger.fatal(msg)
-            raise msg
-          end
+          fatal "Invalid batch method: #{method}." if !valid_method?(method)
           return nil if !people || !people.is_a?(Array)
           batch_from(people, method, api || self.api, params: params)
         end
@@ -35,11 +31,7 @@ module Eco
         end
 
         def batch_get(api, params: {})
-          unless people_api = api&.people
-            msg = "cannot batch get without api connnection, please provide a valid api connection!"
-            logger.fatal(msg)
-            raise msg
-          end
+          fatal "cannot batch get without api connnection, please provide a valid api connection!" unless people_api = api&.people
 
           params = {per_page: DEFAULT_BATCH_BLOCK}.merge(params)
           client = people_api.client
@@ -69,8 +61,7 @@ module Eco
           unless response.success?
             msg = "Request failed - params: #{params}"
             msg += "\n Error message: - Status #{response.status}: #{response.body}"
-            logger.fatal(msg)
-            raise msg
+            fatal(msg)
           end
           people = []
           response.body["results"].each do |person_hash|
@@ -83,11 +74,7 @@ module Eco
 
         def batch_from(people, method, api, params: {})
           return nil if !people || !people.is_a?(Array)
-          unless people_api = api&.people
-            msg = "cannot batch #{method} without api connnection, please provide a valid api connection!"
-            logger.fatal(msg)
-            raise msg
-          end
+          fatal "cannot batch #{method} without api connnection, please provide a valid api connection!" unless people_api = api&.people
 
           # batch Status
           status = new_status(people, method)

data/lib/eco/api/session/batch_job.rb

@@ -7,16 +7,15 @@ module Eco
 
         attr_reader :name, :status
 
-        def initialize(name, type:, sets:, root:)
+        def initialize(e, name:, type:, sets:)
           raise "A name is required to refer a job. Given: #{name}" if !name
           raise "Type should be one of #{TYPES}. Given: #{type}"    if !BatchJob.valid_type?(type)
           raise "Sets should be some of #{SETS}. Given: #{sets}"    if !BatchJob.valid_sets?(sets)
-          super(root.enviro)
+          super(e)
 
           @name = name
           @type = type
-          @sets = [sets].flatten
-          @root = root
+          @sets = [sets].flatten.compact
           reset
         end
 
@@ -66,7 +65,7 @@ module Eco
 
           if !simulate && queue.length > 0
             backup_update(queue)
-            @status = batch.launch(queue, method: @type.to_s)
+            @status = session.batch.launch(queue, method: @type.to_s)
             @status.root = self
           end
 
@@ -141,14 +140,6 @@ module Eco
           file_manager.save_json(data_body, file, :timestamp)
         end
 
-        def session
-          @root.session
-        end
-
-        def batch
-          session.batch
-        end
-
       end
 
     end

data/lib/eco/api/session/{job_group.rb → batch_jobs.rb}

@@ -2,13 +2,11 @@ module Eco
   module API
     class Session
       class BatchJobs < API::Common::Session::BaseSession
-        attr_reader :name, :session
+        attr_reader :name
 
-        def initialize(name, session:)
-          raise("BatchJobs requires a session object") unless session.is_a?(API::Session)
-          super(session.enviro)
-          @session = session
-          @name     = name
+        def initialize(e, name:)
+          super(e)
+          @name = name
           reset
         end
 
@@ -26,9 +24,9 @@ module Eco
         end
 
         def new(name, type:, sets:)
-          raise("Can't create job named '#{name}' because it already exists.") if exists?(name)
+          fatal "Can't create job named '#{name}' because it already exists." if exists?(name)
 
-          job = BatchJob.new(name, type: type, sets: sets, root: self)
+          job = BatchJob.new(enviro, name: name, type: type, sets: sets)
           @jobs[name] = job
           @callbacks[job] = Proc.new if block_given?
 

data/lib/eco/api/session/batch_status.rb

@@ -7,12 +7,8 @@ module Eco
 
         def initialize(e, queue:, method:)
           super(e)
+          fatal("In batch operations you must batch an array. Received: #{queue}")  unless queue && queue.is_a?(Array)
 
-          unless queue && queue.is_a?(Array)
-            msg = "In batch operations you must batch an array. Received: #{queue}"
-            logger.fatal(msg)
-            raise msg
-          end
           @method = method
           @queue = queue
           @hash  = @queue.each_with_index.map do |entry, i|
@@ -42,7 +38,7 @@ module Eco
         end
 
         def people
-          raise "This batch wasn't a 'get'. Can't obtain people without 'get' method" unless method == "get"
+          fatal "This batch wasn't a 'get'. Can't obtain people without 'get' method" unless method == "get"
           out = Array(0..queue.length-1)
           @responses.each_with_index do |respose, i|
             out[i] = response.result
@@ -123,7 +119,7 @@ module Eco
         def valid_index(index: nil, entry: nil)
           index ||= @hash[entry]
           unless index && index < @queue.length
-            raise "You must provide either the index or the original entry object of the batch"
+            fatal "You must provide either the index or the original entry object of the batch"
           end
           index
         end

data/lib/eco/api/session/config.rb

@@ -0,0 +1,186 @@
+module Eco
+  module API
+    class Session
+      class Config < Hash
+        def initialize()
+          super(nil)
+          self["org"] = {}
+        end
+
+        def reopen
+          yield(self)
+        end
+
+        def apis
+          self["apis"] ||= Session::Config::Apis.new(root: self)
+        end
+
+        def logger
+          self["logger"] ||= Session::Config::Logger.new(root: self)
+        end
+
+        def s3storage
+          self["s3_storage"] ||= Session::Config::S3Storage.new(root: self)
+        end
+
+        def files
+          self["files"] ||= Session::Config::Files.new(root: self)
+        end
+
+        def mailer
+          self["mailer"] ||= Session::Config::Mailer.new(root: self)
+        end
+
+        def org
+          self["org"]
+        end
+
+        def people
+          self["people"] ||= Session::Config::People.new(root: self)
+        end
+
+        def usecases
+          self["usecases"] ||= Session::Config::UseCases.new(root: self)
+        end
+
+        # LOGGER
+        def log_console_level=(value)
+          logger.console_level= value
+        end
+
+        def log_file_level=(value)
+          logger.file_level = value
+        end
+
+        def log_file=(file)
+          logger.file = file
+        end
+
+        def timestamp_console=(value)
+          logger.timestamp_console = value
+        end
+
+        def log_connection=(value)
+          logger.log_connection = value
+        end
+
+        # API
+        def dry_run!
+          self["dry-run"] = true
+        end
+
+        def dry_run?
+          self["dry-run"]
+        end
+
+        def run_mode=(mode)
+          apis.active_api.mode = mode
+        end
+
+        def run_mode_local?
+          apis.active_api.local?
+        end
+
+        def run_mode_remote?
+          apis.active_api.remote?
+        end
+
+        def apis?
+          apis.apis?
+        end
+
+        def add_api(name, **kargs)
+          apis.add(name, **kargs)
+          self
+        end
+
+        def active_api(name)
+          apis.active_name = name
+          self
+        end
+
+        def api(logger = ::Logger.new(IO::NULL))
+          apis.api(logger)
+        end
+
+        def policy_groups
+          policy_groups = api&.policy_groups.to_a.compact
+          Eco::API::Organization::PolicyGroups.new(policy_groups)
+        end
+
+        # FILES
+        def working_directory=(path)
+          files.working_directory = path
+        end
+
+        def file_timestamp_pattern=(pattern)
+          files.timestamp_pattern = pattern
+        end
+
+        def file_manager
+          Eco::API::Common::Session::FileManager.new(self)
+        end
+
+        def require(file)
+          require_relative "#{File.expand_path(file_manager.dir.file(file))}"
+        end
+
+        # ORG
+        def tagtree=(file)
+          org["tagtree"] = file
+        end
+
+        # PEOPLE
+        def discarded_people_file=(value)
+          people.discarded_file = value
+        end
+
+        def people_cache=(file)
+          people.cache = file
+        end
+
+        def requests_backup_folder=(folder)
+          people.requests_folder = folder
+        end
+
+        # PERSON FIELDS MAPPER
+        def person_fields_mapper=(file)
+          people.fields_mapper = file
+        end
+
+        def default_schema=(name)
+          people.default_schema = name
+        end
+
+        # ACCOUNT PRESETS
+        def presets_custom=(file)
+          people.presets_custom = file
+        end
+
+        def presets_map=(file)
+          people.presets_map = file
+        end
+
+        # CUSTOM PERSON PARSERS
+        def person_parser(format: :csv, &block)
+          people.add_parser(format: format, &block)
+        end
+
+        # CUSTOM USE CASES
+        def use_cases(&block)
+          usecases.add(&block)
+        end
+
+      end
+    end
+  end
+end
+
+require_relative 'config/api'
+require_relative 'config/apis'
+require_relative 'config/logger'
+require_relative 'config/mailer'
+require_relative 'config/s3_storage'
+require_relative 'config/files'
+require_relative 'config/people'
+require_relative 'config/use_cases'