eco-helpers 2.0.6 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402f80f7e80fd4ecc9a97a9e96a0823ab4e26d63541540e14774db2dbf97ef60
-  data.tar.gz: 3d097ed8af5c5e1c0ecacb227b0a77e4f1d6d8bb15e77599a008aa1af361b230
+  metadata.gz: 61ef9270db24cf1582814423b75bc1f3a74bf88cd14281862658c972d1f94f05
+  data.tar.gz: 30ac39b330426fcb8840b7e7456d240e6e7324030aea00b6950328708bbeb53b
 SHA512:
-  metadata.gz: c083c3f62d2f29c427f56a2b34b11e4cd238198a95e728e1afeaa4345ccab4c507b798b10427adca14c547161d210d0662d4ece666b67d6464052992d0cade62
-  data.tar.gz: 840bf5e3b90b3a9398a2eb2c5dc989e1ad321705d0785d5cb0b89a696756a721b2e66804a7a3fe7adc82f76611a58fba7379131c994312b01c2d576c93339df0
+  metadata.gz: 4dcfa4714c6b245c017194eb6b3fb623702472c260f5717b5485141fb9765fd7e10f891938e65978b7bc13142cc45e06efbc430db9cb63270355f6341e0991d3
+  data.tar.gz: 7cd4382209bef6d5b0db07b2adb90237500050b4ac9340ec39457f7f23d1131bc6562367bc5cf005fdcc4f3af1553dafd446aa02e551549b1bbb90c08e51e15d

data/CHANGELOG.md

@@ -1,7 +1,56 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.6] - 2021-02-xx
+## [2.0.11] - 2021-03-xx
+
+### Added
+
+### Changed
+
+### Fixed
+  - `Eco::API::Session::Batch:Errors#errors` changed `Array#filter` call to `Array#select` call
+
+## [2.0.10] - 2021-03-26
+
+### Added
+  - `Eco::API::Common::People::PersonParser`
+    - `#defined_attrs`: list of all attribute defined parsers (regardless they belong to the model)
+  - `Eco::API::Organization::TagTree` methods
+    - `#total_depth` to know the total depth of a tree
+    - `#flat?` to know if the tagtree has only 1 level
+
+### Changed
+  - `Eco::API::Common::People::PersonParser`
+    - Renamed `#all_attrs` to `#all_model_attrs`
+    - Ranamed `#defined_attrs` to `#defined_model_attrs`
+    - Ranamed `#undefined_attrs` to `#undefined_model_attrs`
+
+### Fixed
+
+## [2.0.9] - 2021-03-19
+
+### Added
+### Changed
+  - `Eco::API::Session::Batch:Errors#person_ref` moved to the public method
+
+### Fixed
+
+## [2.0.8] - 2021-03-09
+
+### Added
+### Changed
+### Fixed
+  - `Ecoportal::API::V1::Person#identity` adjust behavior
+
+## [2.0.7] - 2021-03-09
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Session::Batch::JobsGroups` and `Eco::API::Session::Batch::Jobs`: when new `Batch::Job`s are creating during launch, they remained unlaunched
+    - this fix makes `#launch` method to iterate until there are no pending
+
+## [2.0.6] - 2021-03-08
 
 ### Added
 ### Changed

data/eco-helpers.gemspec

@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.2', '< 0.9'
-  #spec.add_dependency 'ecoportal-api', '>= 0.7.5', '< 0.8'
   spec.add_dependency 'ecoportal-api-v2', '>= 0.8.6', '< 0.9'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'

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

@@ -154,14 +154,20 @@ module Eco
             final_entry["default_tag"]
           end
 
-          # Provides a reference of this person.
+          # Provides a reference to this person entry.
+          # @return [String] string summary of this person identity.
+          def identify
+            str_id = id ? "id: '#{id}'; " : ""
+            "(row: #{idx}) '#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
+          end
+
+          # Provides a reference of this person entry.
           # @return [String] string summary of this person identity.
           def to_s(options)
             options = into_a(options)
             case
             when options.include?(:identify)
-              str_id = id ? "id: '#{id}'; " : ""
-              "(row: #{idx}) '#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
+              identify
             else
               final_entry.each.map do |k, v|
                 "'#{k}': '#{v.to_json}'"
@@ -250,7 +256,7 @@ module Eco
           # @param mapped_entry [Hash] that with **internal** names but **external** values and types.
           # @return [Hash] with **external** names, values and types.
           def _external_serializing(mapped_entry)
-            target_attrs    = @emap.all_attrs | @emap.aliased_attrs
+            target_attrs    = @emap.all_model_attrs | @emap.aliased_attrs
             rest_keys       = mapped_entry.keys - target_attrs
             target_attrs   -= ["send_invites"]
             external_entry  = target_attrs.each_with_object({}) do |attr, hash|

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

@@ -6,14 +6,14 @@ module Eco
         # @attr_reader core_attrs [Array<String>] core attributes that are present in the person entry.
         # @attr_reader details_attrs [Array<String>] schema details attributes that are present in the person entry.
         # @attr_reader account_attrs [Array<String>] account attributes that are present in the person entry.
-        # @attr_reader all_attrs [Array<String>] all the attrs that are present in the person entry.
+        # @attr_reader all_model_attrs [Array<String>] all the attrs that are present in the person entry.
         # @attr_reader internal_attrs [Array<String>] all the internally named attributes that the person entry has.
         # @attr_reader aliased_attrs [Array<String>] only those internal attributes present in the person entry that have an internal/external name mapping.
         # @attr_reader direct_attrs [Array<String>] only those internal attributes present in the person entry that do **not** have an internal/external name mapping.
         class PersonEntryAttributeMapper
           @@cached_warnings = {}
 
-          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_attrs
+          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_model_attrs
           attr_reader :internal_attrs, :aliased_attrs, :direct_attrs
 
           # Helper class tied to `PersonEntry` that allows to track which attributes of a person entry are present
@@ -41,14 +41,14 @@ module Eco
               init_attr_trackers
             else  # SERIALIZING
               @person          = data
-              @internal_attrs  = @person_parser.all_attrs
+              @internal_attrs  = @person_parser.all_model_attrs
               @aliased_attrs   = @attr_map.list(:internal)
             end
 
             @core_attrs    = @person_parser.target_attrs_core(@internal_attrs)
             @details_attrs = @person_parser.target_attrs_details(@internal_attrs)
             @account_attrs = @person_parser.target_attrs_account(@internal_attrs)
-            @all_attrs     = @core_attrs | @account_attrs | @details_attrs
+            @all_model_attrs = @core_attrs | @account_attrs | @details_attrs
           end
 
           # To know if currently the object is in parse or serialize mode.
@@ -98,7 +98,7 @@ module Eco
               end
             end
 
-            return nil unless @person_parser.all_attrs.include?(attr)
+            return nil unless @person_parser.all_model_attrs.include?(attr)
           end
 
           # Serializing helper also used to do a reverse mapping when parsing:
@@ -146,9 +146,9 @@ module Eco
           # when parsing:
           def init_attr_trackers
             # (def) all internal attributes we can expect
-            def_all_attrs     = @person_parser.all_attrs
+            def_all_attrs     = @person_parser.all_model_attrs
             # (def) internal attrs with no aliasing nor parser definition (expected to be direct)
-            def_unlinked      = @person_parser.undefined_attrs.select { |attr| !to_external(attr) }
+            def_unlinked      = @person_parser.undefined_model_attrs.select { |attr| !to_external(attr) }
             # (def) those with parser or alias:
             def_linked        = def_all_attrs - def_unlinked
 
@@ -168,7 +168,7 @@ module Eco
             # (data) virtual internal attrs (the internal names of those virtual attrs)
             data_vi_int_aliased = data_vi_ext_alias.map do |attr|
               # to_internal(attr) can't be used here, becauase virtual fields would get filtered out,
-              # as they are not recognized by @parser.all_attrs.include?(attr)
+              # as they are not recognized by @parser.all_model_attrs.include?(attr)
               @attr_map.to_internal(attr)
             end.compact
 

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

@@ -7,7 +7,7 @@ module Eco
         #
         # @attr_reader schema [Ecoportal::API::V1::PersonSchema, nil] schema of person details that this parser will be based upon.
         # @attr_reader details_attrs [Array<String>] internal names of schema details attributes.
-        # @attr_reader all_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
+        # @attr_reader all_model_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
         class PersonParser
           extend  Eco::API::Common::ClassAutoLoader
           autoloads_children_of     "Eco::API::Common::Loaders::Parser"
@@ -19,8 +19,7 @@ module Eco
           FORMAT        = [:csv, :xml, :json]
 
           attr_reader :schema
-          attr_reader :details_attrs, :all_attrs
-          attr_reader :defined_attrs
+          attr_reader :details_attrs, :all_model_attrs
           attr_reader :patch_version
 
           # @example Example of usage:
@@ -46,7 +45,7 @@ module Eco
               @details_attrs  = @schema&.fields.map { |fld| fld.alt_id }
             end
 
-            @all_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
+            @all_model_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
             self.class.autoload_children(self)
           end
 
@@ -60,6 +59,11 @@ module Eco
 
           # @!group Scopping attributes (identifying, presence & active)
 
+          # All the internal name attributes, including _core_, _account_ and _details_.
+          def all_attrs(include_defined_parsers: false)
+            all_model_attrs | defined_model_attrs
+          end
+
           # Scopes `source_attrs` using the _**core** attributes_.
           # @note use this helper to know which among your attributes are **core** ones.
           # @param source_attrs [Array<String>]
@@ -93,14 +97,21 @@ module Eco
             @parsers.keys
           end
 
+          # Returns a list of all the internal attributes that have a parser defined.
+          # @note These attributes do not necessarily belong to the model. They could be virtual attributes
+          # @return [Array<String>] list of all attribute defined parsers.
+          def defined_attrs
+            defined_list - symbol_keys
+          end
+
           # Returns a list of all the internal attributes of the model that have a parser defined.
           # @note
           #  - it excludes any parser that is not in the model, such as type parsers (i.e. `:boolean`, `:multiple`)
           #  - the list is sorted according `CORE_ATTRS` + `ACCOUNT_ATTRS` + schema attrs
-          # @return [Array<String>] list of all attribute defined parsers.
-          def defined_attrs
+          # @return [Array<String>] list of all attribute defined parsers in the model.
+          def defined_model_attrs
             defined     = @parsers.keys
-            defined     = (all_attrs | defined) & defined
+            defined     = (all_model_attrs | defined) & defined
             defined - symbol_keys
           end
 
@@ -118,7 +129,7 @@ module Eco
           # @param process [Symbol] either `:parse` or `:serialize`, depending if we want to parse or serialize the `attr`.
           # @return [Array<String>] list of all attribute defined parsers that should be active for the given `source_data`.
           def active_attrs(source_data, phase = :any, process: :parse)
-            defined_attrs.select do |attr|
+            defined_model_attrs.select do |attr|
               if process == :serialize
                 @parsers[attr].serializer_active?(phase)
               else
@@ -130,8 +141,8 @@ module Eco
           # Returns a list of all the internal attributes of the model that do **not** have a parser defined.
           # @note it excludes any parser that is **not** in the model, such as type parsers (i.e. :boolean, :multiple)
           # @return [Array<String>] list of all attributes without a defined parser.
-          def undefined_attrs
-            all_attrs - defined_attrs
+          def undefined_model_attrs
+            all_model_attrs - defined_model_attrs
           end
 
           # @param attr [String] internal name of an attribute.
@@ -238,7 +249,7 @@ module Eco
           end
 
           def valid_attr?(attr)
-            attr.is_a?(String) && (!@schema || @all_attrs.include?(attr))
+            attr.is_a?(String) && (!@schema || @all_model_attrs.include?(attr))
           end
 
           def valid_type?(attr)

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

@@ -13,8 +13,8 @@ module Ecoportal
           original_doc["details"] = JSON.parse(doc["details"])
         end
 
-        def identify
-          if entry
+        def identify(section = :person)
+          if entry && section == :entry
             entry.to_s(:identify)
           else
             str_id = id ? "id: '#{id}'; " : ""

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

@@ -4,7 +4,7 @@ module Eco
 
       # Provides helpers to deal with tagtrees.
       class TagTree
-        attr_reader :tag, :nodes
+        attr_reader :tag, :nodes, :children_count
         attr_reader :depth, :path
         attr_reader :enviro
 
@@ -37,6 +37,7 @@ module Eco
 
           nodes = @source.is_a?(Array) ? @source : @source.dig('nodes') || []
           @nodes = nodes.map {|cnode| TagTree.new(cnode, depth: @depth + 1, path: @path.dup, enviro: @enviro)}
+          @children_count = @nodes.count
 
           init_hashes
         end
@@ -46,6 +47,21 @@ module Eco
           @has_tags.empty?
         end
 
+        # @return [Integer] the highest `depth` of all the children.
+        def total_depth
+          @total_depth ||= if children_count > 0
+              deepest_node = nodes.max_by {|node| node.total_depth}
+              deepest_node.depth
+            else
+              depth
+            end
+        end
+
+        # @return [Integer] if there's only top level.
+        def flat?
+          self.total_depth <= 0
+        end
+
         # Gets all the tags of the current node tree.
         # @note
         #   - this will include the upper level tag(s) as well
@@ -147,7 +163,8 @@ module Eco
         # * take the deepest tag (the one that is further down in the tree)
         # * if there are different options (several nodes at the same depth):
         #    * take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
-        #    * if there's no common node between them, take the `first` (unless they are at top level of the tree)
+        #    * if there's no common node between them, take the `first`, unless they are at top level of the tree
+        #    * to the above, take the `first` also on top level, but only if there's 1 level for the entire tree
         # @param [Array<String>] values list of tags.
         # @return [String] default tag.
         def default_tag(*values)
@@ -169,7 +186,7 @@ module Eco
             common      = nodes.reduce(self.tags.reverse) {|com, cnode| com & cnode.path.reverse}
             default_tag = common.first if common.length > 0 && depth > 0
           end
-          default_tag = nodes.first&.tag if !default_tag && depth > 0
+          default_tag = nodes.first&.tag  if !default_tag && ( (depth > 0) || flat?)
           default_tag
         end
 

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

@@ -111,6 +111,11 @@ module Eco
           end
           # @!endgroup
 
+          def person_ref(entry)
+            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
+
           private
 
           # Input entries that got **error** response from the _Server_.
@@ -119,7 +124,7 @@ module Eco
           #   - please, observe that this can only happen if there were repeated entries in the `source_queue`
           # @return [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
           def entries
-            queue.filter.with_index do |query, i|
+            queue.select.with_index do |query, i|
               unless response = status[i]
                 msg  = "Error: query with no response. You might have duplicated entries in your queue.\n"
                 msg += "Queue length: #{queue.length}; Queue elements class: #{queue.first.class}\n"
@@ -136,11 +141,6 @@ module Eco
             end
           end
 
-          def person_ref(entry)
-            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)
             if entry.respond_to?(attr.to_sym)
               entry.public_send(attr.to_sym)

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

@@ -45,25 +45,22 @@ module Eco
           # @!group Pure feedback methods
 
           # Slightly modifies the behaviour of `Ecoportal::API::Common::BaseModel#as_update`, so schema details fields show the `alt_id`
+          # It also fixes possible patch updates that are incomplete or unnecessary.
           # @note for better feedback
           # @param entry [Hash, Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
-          def as_update(entry)
+          # @param add_feedback [Boolean] if `true` it tweak the hash update with additional data.
+          def as_update(entry, add_feedback: true)
             case
             when entry.is_a?(Hash)
               hash = entry
             else #entry.is_a?(Ecoportal::API::V1::Person)
               if only_ids?
-                hash = {
-                  "id"          => entry.id,
-                  "external_id" => entry.external_id,
-                  "email"       => entry.email
-                }
                 hash = entry.as_json.slice("id", "external_id", "email")
               else
                 hash = entry.as_update
-                #if entry.details
-                if hash["details"]
-                  if hfields = hash.dig("details", "fields")
+
+                if add_feedback && details = hash["details"]
+                  if hfields = details["fields"]
                     hfields.each do |fld|
                       fld.merge!("alt_id" => entry.details.get_field(fld["id"]).alt_id)
                     end

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

@@ -169,7 +169,8 @@ module Eco
 
             unless simulate
               if pqueue.length > 0
-                backup_update(requests)
+                req_backup = pqueue.map {|e| as_update(e, add_feedback: false)}
+                backup_update(req_backup)
                 session.batch.launch(pqueue, method: type).tap do |job_status|
                   @status     = job_status
                   status.root = self
@@ -217,7 +218,7 @@ module Eco
             [].tap do |msg|
               subjobs.map {|subjob| msg << subjob.summary}
             end.join("\n")
-          end          
+          end
 
           def as_update(*args)
             feedback.as_update(*args)

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

@@ -94,7 +94,7 @@ module Eco
                 callback.call(job, job_status) if callback
               end
             end
-
+            launch(simulate: simulate) if pending?
             return status
           end
 

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

@@ -96,6 +96,7 @@ module Eco
                 self.class.counter(DELAY_BETWEEN_GROUPS) if !simulate && idx < @order.length - 1
               end
             end
+            launch(simulate: simulate) if pending?            
             return status
           end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.6"
+  VERSION = "2.0.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.11
 platform: ruby
 authors:
 - Oscar Segura