eco-helpers 1.5.4 → 1.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd844b9beef06b6b7433f14dcd1138be3796e381c6f9fb9b339449cf324f5f0
-  data.tar.gz: 6376fa023304d0e3b0a0ce07a700359a3e5891d6f1a95b37f723318f6a4965df
+  metadata.gz: 37896bf21f1661d488b3af20ac7ed8ee298536d3e96324308f84459ad0e2abb2
+  data.tar.gz: 05e8eac1fcb530509af91b62c17e89380f3b5ac0926a3a445bd29a309a440c44
 SHA512:
-  metadata.gz: b458416828c6a84d17ac0ed83b68dd15b4fa154627365ab00928410008874305f3cd54210f10ee90cca1f8172587e44140470e43b00f2348e6b3eaf5fa6ec17c
-  data.tar.gz: 67a49053cb25f484639603c6a95c42de53d501b441a72aeb139bb18352f4820f36cb7a3a3ce3fbdf3138dc4a7c9ac62d927523c4cd2ce61bd2f45306c2fb4fa5
+  metadata.gz: 75e90bf526e20a8dde18a64445f07d5bcaadd7038cb5e2070d8e777341a9799f604da94f4aae359772959a7d92da01db658311afa2d765c31882bf59b138dabe
+  data.tar.gz: 338389f47335ae1f01f683ba3d54974ecce8eb70e90243534d835aa5cede39ab44458a37aa800206c018e023ff0e45eb228c7a52721a3e95801606743ae2b971

data/CHANGELOG.md

@@ -1,6 +1,47 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.9] - 2021-01-08
+
+### Added
+  - `Eco::API::Organization::TagTree#subtags` to get all the tags but those of the highest level.
+
+### Changed
+### Fixed
+
+
+## [1.5.8] - 2021-01-05
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Session::Batch::Jobs#job` shouldn't be calling the post-launch callback function on creation.
+  - `Eco::API::Session#new_job` should include a `&block` parameter.
+  - `Eco::API::UseCases::DefaultCases::RefreshCase`: fixed typo
+
+## [1.5.7] - 2020-12-17
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Sesssion#parse_attribute` was not using phase argument
+
+## [1.5.6] - 2020-12-04
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::UseCases::DefaultCases::RestoreDBCase` fixed typo and slightly improved
+  - fixed some back-end errors when chaining usecases
+  - `Eco::API::UseCases::DefaultCases::OrgDataConvertCase` improved
+
+## [1.5.5] - 2020-12-03
+
+### Added
+### Changed
+### Fixed
+  - rubies previous to `2.5` do not have `yield_self`
+
 ## [1.5.4] - 2020-12-02
 
 ### Added

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

@@ -7,6 +7,7 @@ module Eco
   end
 end
 
+require_relative 'version_patches/object'
 require_relative 'version_patches/exception'
 require_relative 'version_patches/hash'
 require_relative 'version_patches/ecoportal_api'

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

@@ -0,0 +1,10 @@
+Object.class_eval do
+  unless method_defined?(:yield_self)
+    define_method(:yield_self) do |&block|
+      return block.call(self) if block
+      out = self
+      out = [self] unless self.is_a?(Enumerable)
+      out.each
+    end
+  end
+end

data/lib/eco/api/organization/tag_tree.rb

@@ -46,6 +46,10 @@ module Eco
           @has_tags.empty?
         end
 
+        # Gets all the tags of the current node tree.
+        # @note
+        #   - this will include the upper level tag(s) as well
+        #   - to get all but the upper level tag(s) use `subtags` method instead
         # @param depth [Integer] if empty, returns the list of tag nodes of that level. Otherwise the list of tag nodes of the entire subtree.
         # @return [Array<String>]
         def tags(depth: nil)
@@ -58,6 +62,12 @@ module Eco
           end
         end
 
+        # Gets all but the upper level tags of the current node tree.
+        # @return [Array<String>]
+        def subtags
+          tags - tags(depth: depth)
+        end
+
         # Verifies if a tag exists in the tree.
         # @param key [String] tag to verify.
         # @return [Boolean]

data/lib/eco/api/session.rb

@@ -126,7 +126,7 @@ module Eco
         unless parsers = entry_factory.person_parser
           raise "There are no parsers defined"
         end
-        parsers.parse(attr, source)
+        parsers.parse(attr, source, phase)
       end
 
       # @see Eco::API::Common::People::EntryFactory#export
@@ -217,6 +217,7 @@ module Eco
         @job_groups ||= Batch::JobsGroups.new(enviro)
       end
 
+      # It retrives the group of `Batch::Jobs` named `name`. It creates it if it doesn't exist.
       # @return [Eco::API::Session::Batch::Jobs]
       def job_group(name, order: :last)
         case
@@ -228,9 +229,10 @@ module Eco
       end
 
       # Shortcut to create a job of certain type within a group
+      # @param [see @Eco::API::Session::Batch::Jobs#new]
       # @return [Eco::API::Session::Batch::Job]
-      def new_job(group, name, type, usecase, sets = [:core, :details, :account])
-        job_group(group).new(name, usecase: usecase, type: type, sets: sets)
+      def new_job(group, name, type, usecase, sets = [:core, :details, :account], &block)
+        job_group(group).new(name, usecase: usecase, type: type, sets: sets, &block)
       end
 
       # @see Eco::API::Session::Batch::JobsGroups#launch

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

@@ -96,7 +96,7 @@ module Eco
           # @param entry [Ecoportal::API::V1::Person, Enumberable<Person>] the person(s) we want to update, carrying the changes to be done.
           # @param unique [Boolean] specifies if repeated entries should be avoided in the queue.
           # @yield [person] callback before launching the batch job request against the server.
-          # @yieldparam param [Person] current person object that that should be treated by the callback before launching the batch.
+          # @yieldparam person [Person] current person object that that should be treated by the callback before launching the batch.
           # @return [Eco::API::Session::Batch::Job] this `Batch::Job`.
           def add(entry, unique: true, &block)
             case entry

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

@@ -42,13 +42,23 @@ module Eco
             @jobs.key?(name)
           end
 
+          # It retrieves an existing job named `name` or creates it if it doesn't exist.
+          # @note
+          #   - the block should only be passed when creating the job
+          # @param [see @Eco::API::Session::Batch::Jobs#new]
+          # @return [Eco::API::Session::Batch::Job]
           def job(name, type: nil, sets: nil, usecase: nil, &block)
+            fatal "Can't give a job post-launch callback &block to an already existing job" if exists?(name)
             new(name, type: type, sets: sets, usecase: usecase, &block) unless exists?(name)
-            self[name].tap do |job|
-              block.call(job) if block
-            end
+            self[name]
           end
 
+          # Creates a new `Batch::Job` included as part of this `Batch::Jobs`.
+          # @param [see Eco::API::Session::Job#new]
+          # @yield [job, status] callback after launching the batch job request against the server.
+          # @yieldparam job [Eco::API::Session::Batch::Job] the job we have launched against the server.
+          # @yieldparam status [Eco::API::Session::Batch::Status] the status of the batch job launch.
+          # @return [Eco::API::Session::Batch::Job]
           def new(name, type:, sets:, usecase: nil, &block)
             fatal "Can't create job named '#{name}' because it already exists." if exists?(name)
 
@@ -57,6 +67,11 @@ module Eco
             end
           end
 
+          # @param job [Eco::API::Session::Batch::Job] the `Batch::Job` to add.
+          # @yield [job, status] callback after launching the batch job request against the server.
+          # @yieldparam job [Eco::API::Session::Batch::Job] the job we have launched against the server.
+          # @yieldparam status [Eco::API::Session::Batch::Status] the status of the batch job launch.
+          # @return [Eco::API::Session::Batch::Job]
           def add(job)
             fatal "Expected Eco::API::Session::Batch::Job object. Given #{job.class}" unless job.is_a?(Eco::API::Session::Batch::Job)
             @jobs[job.name] = job
@@ -67,6 +82,10 @@ module Eco
             any? {|job| job.pending?}
           end
 
+          # Launches every `Batch::Job` in the group.
+          # @note
+          #   - if there was post-launch callback for a `Batch::Job`, it calls it.
+          # @return [Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>]
           def launch(simulate: false)
             each do |job|
               if job.pending?

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

@@ -58,6 +58,11 @@ module Eco
             @groups.key?(name)
           end
 
+          # Creates a new group of `Batch::Jobs` named `name`.
+          # @yield [group, group_status] callback after launching the batch job request against the server.
+          # @yieldparam group [Eco::API::Session::Batch::Jobs] the group of jobs we have launched against the server.
+          # @yieldparam group_status [Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>] the status of the launched batch jobs.
+          # @return [Eco::API::Session::Batch::Jobs] the group of jobs.
           def new(name, order: :last)
             fatal "Can't create job group named '#{name}' because it already exists." if exists?(name)
 
@@ -78,6 +83,10 @@ module Eco
             any? {|group| group.pending?}
           end
 
+          # Launches every `Batch::Jobs` group in the current `Batch::JobGroups`
+          # @note
+          #   - if there was post-launch callback for a `Batch::Jobs` groups, it calls it.
+          # @return [Hash<Eco::API::Session::Batch::Jobs,Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>>]
           def launch(simulate: false)
             @order.each_with_index do |group, idx|
               if group.pending?

data/lib/eco/api/usecases/default_cases/org_data_convert_case.rb

@@ -2,6 +2,8 @@ class Eco::API::UseCases::DefaultCases::OrgDataConvertCase < Eco::API::Common::L
   name "org-data-convert"
   type :import
 
+  attr_reader :session, :options
+
   def org_data_convert(people)
     pp "Going to convert data from '#{source_enviro}' to '#{ASSETS.active_config}'"
     puts "\n"
@@ -50,27 +52,43 @@ class Eco::API::UseCases::DefaultCases::OrgDataConvertCase < Eco::API::Common::L
 
   def policy_groups_convert(ids)
     ids.map do |id|
-      unless name = source_config.policy_groups.to_name(id)
-        error("Ops, do not know #{id} usergroup for source environment")
+      unless name = source_policy_groups.to_name(id) || ignore_missing_policy_groups?
+        msg  = "Ops, do not know #{id} usergroup for source environment"
+        msg += "\nUse the option -ignore-missing-policy-groups if you do not care"
+        error(msg)
       end
       session.policy_groups.to_id(name).tap do |new_id|
-        unless new_id
-          error("Ops, do not know #{name} usergroup for destination environment")
+        unless new_id || ignore_missing_policy_groups?
+          msg  = "Ops, do not know #{name} usergroup for destination environment"
+          msg += "\nUse the option -ignore-missing-policy-groups if you do not care"
+          error(msg)
         end
       end
-    end
+    end.compact
+  end
+
+  def source_policy_groups
+    source_config.policy_groups
   end
 
   def source_config
-    @source_config ||= ASSETS.config(key: source_enviro, update_active: false)
+    @source_config ||= ASSETS.config(key: source_enviro, update_active: false).tap do |config|
+      unless config
+        error("The source environment '#{source_enviro}' does not exit or is not configured")
+      end
+    end
   end
 
   def source_enviro
     @source_enviro ||= options.dig(:source_enviro).tap do |enviro|
-      error("A source organization is required to migrate data") unless enviro
+      error("A source environment is required to migrate data from") unless enviro
     end
   end
 
+  def ignore_missing_policy_groups?
+    options.dig(:ignore, :missing, :policy_groups)
+  end
+
   def logger
     @session.logger
   end

data/lib/eco/api/usecases/default_cases/refresh_case.rb

@@ -4,7 +4,7 @@ class Eco::API::UseCases::DefaultCases::RefreshCase < Eco::API::Common::Loaders:
 
   def main(people, session, options, usecase)
     update   = session.new_job("main", "update", :update, usecase)
-    people.each {|person| job.add(person)}
+    people.each {|person| update.add(person)}
   end
 
 end

data/lib/eco/api/usecases/default_cases/restore_db_case.rb

@@ -2,7 +2,11 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
   name "restore-db"
   type :sync
 
+  attr_reader :session, :options
+
   def main(entries, people, session, options, usecase)
+    @session = session; @options = options
+
     micro    = session.micro
     require_people_as_entries!(entries)
 
@@ -26,21 +30,21 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
 
       person.new? ? restart.add(person) : update.add(person)
 
-      core_copy(entry, person, options) unless options.dig(:exclude, :core)
-      person.details = entry.details    unless options.dig(:exclude, :details)
+      core_copy(entry, person)        unless options.dig(:exclude, :core)
+      person.details = entry.details  unless options.dig(:exclude, :details)
 
       unless options.dig(:exclude, :account) || !entry.account
         person.account ||= {}
-        account_copy(entry.account, person.account, options)
+        account_copy(entry.account, person.account)
       end
     end
 
-    report_re_starters(re_starters, session.logger)
+    report_re_starters(re_starters)
   end
 
   private
 
-  def core_copy(entry, person, options)
+  def core_copy(entry, person)
     person.external_id   = entry.external_id   unless options.dig(:exclude, :external_id)
     person.name          = entry.name          unless options.dig(:exclude, :name)
     person.email         = entry.email         unless options.dig(:exclude, :email)
@@ -49,8 +53,8 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
     person.freemium      = entry.freemium
   end
 
-  def account_copy(src, dst, options)
-    if src = entry.account
+  def account_copy(src, dst)
+    if src
       dst.default_tag        = src.default_tag      unless options.dig(:exclude, :filter_tags)
       dst.policy_group_ids   = src.policy_group_ids unless options.dig(:exclude, :policy_groups)
 
@@ -59,27 +63,31 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
         dst.permissions_custom = src.permissions_custom
       end
 
-      dst.login_provider_ids = src.login_provider_ids
-      dst.accept_eula        = src.accept_eula
+      unless options.dig(:exclude, :login_providers) || options.dig(:source_enviro)
+        dst.login_provider_ids = src.login_provider_ids
+      end
 
       if src.preferences
         dst.doc["preferences"] = JSON.parse((src.doc["preferences"] || {}).to_json)
       end
 
-      dst.starred_ids        = src.starred_ids
-      dst.landing_page_id    = src.landing_page_id
+      unless options.dig(:source_enviro)
+        dst.starred_ids        = src.starred_ids
+        dst.landing_page_id    = src.landing_page_id
+      end
+      
       dst&.send_invites      = options[:send_invites] if options.key?(:send_invites)
     end
   end
 
-  def require_people_as_entries!(entries, logger)
+  def require_people_as_entries!(entries)
     unless entries.is_a?(Eco::API::Organization::People)
       logger.error("Your input should be an 'Eco::API::Organization::People' object. Got: #{entries.class}")
       exit(1)
     end
   end
 
-  def report_re_starters(re_starters, logger)
+  def report_re_starters(re_starters)
     unless re_starters.empty?
       logger.error("There were #{re_starters.length} entries of the backup that do not exist in the (filtered?) people manager")
       logger.error("Some examples:")
@@ -89,4 +97,8 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
     end
   end
 
+  def logger
+    session.logger
+  end
+
 end

data/lib/eco/api/usecases/use_case.rb

@@ -36,7 +36,7 @@ module Eco
         # @option kargs [Eco::API:Session] :session
         # @option kargs [Hash] :options hash with symbol keys (i.e. behaviour modifiers, cli trackers, filters, etc.)
         def launch(io: nil, **kargs)
-          params = io&.params(keyed: true) || {}
+          params = io&.params(keyed: true, all: true) || {}
           kargs  = params.merge(kargs).merge(usecase: self)
 
           UseCaseIO.new(**kargs).tap do |uio|

data/lib/eco/api/usecases/use_case_io.rb

@@ -65,7 +65,6 @@ module Eco
           #kargs  = aux_io.params(keyed: true)
           kargs  = params(keyed: true, all: true).merge(usecase: usecase)
           kargs.delete(:job)
-
           case self.type
           when :import
             kargs[:input]  = output

data/lib/eco/cli/config/default/usecases.rb

@@ -55,6 +55,27 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(super: {new: new_id})
     end
 
+    desc  = "Usage '-org-data-convert backup.json -restore-db-from'."
+    desc += " Transforms an input .json file to the values of the destination environment "
+    desc += " (names missmatch won't solve: i.e. usergroups)"
+    cases.add("-org-data-convert", :import, desc, case_name: "org-data-convert") do |input, session, options|
+      unless input && input.is_a?(Eco::API::Organization::People)
+        file  = SCR.get_file("-org-data-convert", required: true)
+        input = Eco::API::Organization::People.new(JSON.parse(File.read(file)))
+        session.logger.info("Source DB: loaded #{input.length} entries.")
+      end
+
+      if source_enviro = SCR.get_arg("-source-enviro", with_param: true)
+        options.merge!(source_enviro: source_enviro)
+      else
+        session.logger.error("You need to specify a -source-enviro for the conversion to work out")
+        exit(1)
+      end
+
+      options.deep_merge!(ignore: {missing: {policy_groups: true}}) if SCR.get_arg("-ignore-missing-policy-groups")
+      
+    end
+
     desc = "Restores the people manager by using a backup.json file"
     cases.add("-restore-db-from", :sync, desc, case_name: "restore-db") do |input, people, session, options|
       unless input && input.is_a?(Eco::API::Organization::People)

data/lib/eco/cli/config/default/workflow.rb

@@ -122,7 +122,7 @@ ASSETS.cli.config do |config|
 
     wf.on(:report) do |wf_report, io|
       #config.reports.active(io: io)
-      #io.session.reports 
+      #io.session.reports
       io
     end
 

data/lib/eco/cli/config/use_cases.rb

@@ -94,7 +94,7 @@ module Eco
           when Eco::API::UseCases::UseCaseIO
             io.chain(usecase: usecase)
           when Eco::API::UseCases::BaseIO
-            params = io.params(keyed: true).merge(usecase: usecase)
+            params = io.params(keyed: true, all: true).merge(usecase: usecase)
             Eco::API::UseCases::UseCaseIO.new(**params)
           end
         end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.4"
+  VERSION = "1.5.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.9
 platform: ruby
 authors:
 - Oscar Segura
@@ -296,6 +296,7 @@ files:
 - lib/eco/api/common/version_patches/exception.rb
 - lib/eco/api/common/version_patches/hash.rb
 - lib/eco/api/common/version_patches/hash/deep_merge.rb
+- lib/eco/api/common/version_patches/object.rb
 - lib/eco/api/custom.rb
 - lib/eco/api/custom/error_handler.rb
 - lib/eco/api/custom/namespace.rb