eco-helpers 1.5.6 → 1.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc18ef6018f837f7a9b85f51553667710197aa3d47be99a41ecf7167c86d5d5
-  data.tar.gz: 9b451c907cc1b9386d107fffdcde38cba56a1983b24783bd321e48acc33d43b3
+  metadata.gz: 9b9af4f974524b36ddd0fad5316d37281f0a9a2e7dd2f03d2f5febbaef957313
+  data.tar.gz: '003906cbfc9389e184b238001997ad1f444355cfbccd9d609f9197445ad3a369'
 SHA512:
-  metadata.gz: 3832e2d59233c3ffc1b61e72a84e6823e8f65091362c2a1867e5a62ca136557379c77e7d4bf555b370e8cb7bb6f6898d081780dfb0248976b9421bcfd0396800
-  data.tar.gz: 132d7db16cf17073736c7bbc57982cf6a85645162ea87a52e58a0f97561ea58c416e40f2b4f7db81da35bc2cc384210c0e753b470c2a1c056b5a87546efd9d99
+  metadata.gz: 5f3b5aa580a10398ebcbf99203f2e6fd4951a20d45d2edd8fd9fff2c0e894ed18f8a54d0537fef4e281465fd7ef7326454df3647bf80051348e6c56d3215866e
+  data.tar.gz: b53b697f1b07ad41bac8550150d3ab7d9cfe6eb842507e5cc77d8bd3a2dc4a8568621f1f2ba849d44440a42c646c7f844336f43de0db058b798c5cdebd643764

data/CHANGELOG.md

@@ -1,6 +1,48 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.11] - 2021-01-xx
+
+### Added
+  - `Eco::API::Organization::TagTree#subtag?` to check if the tag is in any subtree.
+
+### Changed
+
+### Fixed
+  - `Eco::API::MicroCases#set_supervisor` shouldn't set it if the entry does not have it.
+
+## [1.5.10] - 2021-01-19
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Session::Batch::Errors#print` show the row number of the input data.
+
+## [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

data/eco-helpers.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.summary       = %q{eco-helpers to manage people api cases}
   s.homepage      = "https://www.ecoportal.com"
   s.licenses      = %w[MIT]
+  s.required_ruby_version = '>= 2.4.4'
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

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

@@ -75,7 +75,7 @@ module Eco
             !parsing?
           end
 
-          # @note `Eco::API::Common::People::EntryFactory#entries` adds this `idx`
+          # @note `Eco::API::Common::People::EntryFactory#entries` adds this `idx` (i.e. row number)
           # @return [Integer] the entry number in the input file
           def idx
             final_entry["idx"]

data/lib/eco/api/microcases/set_core_with_supervisor.rb

@@ -11,9 +11,11 @@ module Eco
       def set_core_with_supervisor(entry, person, people, supers_job, options)
         unless options.dig(:exclude, :core) && !person.new?
           micro.set_core(entry, person, options)
-          micro.set_supervisor(entry.supervisor_id, person, people, options) do |unkown_id|
-            # delay setting supervisor if does not exit
-            supers_job.add(person) {|person| person.supervisor_id = unkown_id}
+          if entry.supervisor_id?
+            micro.set_supervisor(entry.supervisor_id, person, people, options) do |unkown_id|
+              # delay setting supervisor if does not exit
+              supers_job.add(person) {|person| person.supervisor_id = unkown_id}
+            end
           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,19 @@ 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 subtree(s).
+        # @param key [String] tag to verify.
+        # @return [Boolean]
+        def subtag?(key)
+          subtags.include?(key&.upcase)
+        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/errors.rb

@@ -123,7 +123,7 @@ module Eco
               entry    = queue.to_a[i]
               response = status[i]
               msg      = "Error #{response.status}: #{response.body}\n"
-              msg     += "-- Failed to batch #{method} (entry #{i+1}). Person: #{person_ref(entry)}"
+              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
             end
             msg
           end
@@ -164,7 +164,8 @@ module Eco
           private
 
           def person_ref(entry)
-            "(id: '#{get_attr(entry, :id)}') '#{get_attr(entry, :name)}' ('#{get_attr(entry, :external_id)}': '#{get_attr(entry, :email)}')"
+            row_str = (row = get_row(entry)) ? "(row: #{row}) " : nil
+            "#{row_str}(id: '#{get_attr(entry, :id)}') '#{get_attr(entry, :name)}' ('#{get_attr(entry, :external_id)}': '#{get_attr(entry, :email)}')"
           end
 
           def get_attr(entry, attr)
@@ -175,6 +176,15 @@ module Eco
             end
           end
 
+          def get_row(value)
+            case value
+            when Eco::API::Common::People::PersonEntry
+              value.idx
+            when Ecoportal::API::V1::Person
+              get_row(value.entry)
+            end
+          end
+
         end
       end
     end

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/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/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.6"
+  VERSION = "1.5.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.5.11
 platform: ruby
 authors:
 - Oscar Segura
@@ -474,7 +474,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="