eco-helpers 2.0.3 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44dd3a1b4d94cef2da5fc8c4618c6898bf0310f48778be120cd83503913af297
-  data.tar.gz: 128f7c6d4a4112636089c82ec61a127914263553af0fe4d54aad563d73088532
+  metadata.gz: 507156a88f88bc8227f255251d1f8861f486a23a0fe3b23e003706dfe708507b
+  data.tar.gz: '07952da6db5134dfecc5461d41ad4ce0e264c0eaaec3d9ec55d9d42b41b2620b'
 SHA512:
-  metadata.gz: d14f77e2cf74584eafc8c9834a71d52d1e399767352d27167ef5cbf05266c2a77777f866e64c482e610c8ca2a600aea3640256ed16ee1c6855a6b2db30af2c76
-  data.tar.gz: 1db0afa72df07479f22eca03553b3ac3c51f0228a7d726422a2f6e313565c960554be778c8b36515f1b14dc1085d8378d5d1ec859e96ef26cd116b36ccc738cf
+  metadata.gz: fcfa79dfa92123af03399391797013e7a23a032504570d8cc2cfcb890f8a93ece62a7acbbd43b2fbd70a4de20c28baa60635536d9b431ac260de2905db825332
+  data.tar.gz: 0e63f504d100e5647e9b48eceeebda57814d1dda0ce3d8c0147cb58ce7c40bf5e1225bc261d207d531af22611dc4fd0461461f70016647cda0eaf1147e653c12

data/CHANGELOG.md

@@ -1,6 +1,45 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.8] - 2021-03-xx
+
+### Added
+### Changed
+### Fixed
+  - `Ecoportal::API::External::Person#identity` adjust behaviour
+  
+## [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
+  - `Eco::API::Session::Batch:Errors` moved some methods to be private
+### Fixed
+  - `Eco::API::Error` should inherit from `StandardError`, rather than from `Exception`
+
+## [2.0.5] - 2021-02-24
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Common::People::PersonParser#symbol_keys` to use `Array#select`
+    - as `Array#filter` was introduced in ruby `2.5.5`
+
+## [2.0.4] - 2021-02-23
+
+### Added
+### Changed
+  - `Eco::API::Common::People::PersonParser#defined_attrs` to include virtual attributes
+
+### Fixed
+
 ## [2.0.3] - 2021-02-23
 
 ### Added

data/eco-helpers.gemspec

@@ -30,9 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.8.1', '< 0.9'
-  #spec.add_dependency 'ecoportal-api', '>= 0.7.5', '< 0.8'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.3', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.2', '< 0.9'
+  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'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'

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}'"

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

@@ -99,9 +99,16 @@ module Eco
           #  - the list is sorted according `CORE_ATTRS` + `ACCOUNT_ATTRS` + schema attrs
           # @return [Array<String>] list of all attribute defined parsers.
           def defined_attrs
-            defined = @parsers.keys
-            defined = (all_attrs || defined) && defined
-            defined - (defined - all_attrs)
+            defined     = @parsers.keys
+            defined     = (all_attrs | defined) & defined
+            defined - symbol_keys
+          end
+
+          # Symbol keys are type or import parsers (that do not belong to the model)
+          # @note this was introduced to boost virtual fields to treat in different phases of the parsing process
+          # @return [Array<Symbol>] all the parsers defined as Symbol
+          def symbol_keys
+            @parsers.keys.select {|k| k.is_a?(Symbol)}
           end
 
           # Returns a list of all the internal attributes of the model that have a parser defined & that should be active.

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

@@ -1,8 +1,8 @@
 module Eco
   module API
     # To identify api server errors
-    class Error < Exception
-      class UnknownErrorClass < Exception
+    class Error < StandardError
+      class UnknownErrorClass < StandardError
         def initialize(msg = nil, klass:)
           msg ||= "Unkown api error class #{klass}"
           super(msg)

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

@@ -8,6 +8,8 @@ module Eco
           # @attr_reader status [Eco::API::Session::Batch::Status] `batch status` this `Errors` object is associated to.
           attr_reader :status
 
+          ErrorCache = Struct.new(:type, :err, :entry)
+
           # @param status [Eco::API::Session::Batch::Status] `batch status` this `Errors` object is associated to.
           def initialize(status:)
             "Expected Batch::Status as root. Given: #{status.class}" unless status.is_a?(Eco::API::Session::Batch::Status)
@@ -55,29 +57,6 @@ module Eco
             entries.length
           end
 
-          # Input entries that got **error** response from the _Server_.
-          # @raise [Exception] if there are elements of the final `queue` that did not get response
-          # @note discards those that did not get _response_ from the Server (so those that were not queried)
-          #   - 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.each_with_index.map 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"
-                msg += "Query with no response. Person: #{person_ref(query)}\n"
-                queue.map do |entry|
-                  if [:id, :external_id, :email].any? {|attr| (v = get_attr(entry, attr)) && v == get_attr(query, attr)}
-                    msg += "It could be this peson entry (idx: #{to_index(entry)}): #{person_ref(entry)}\n"
-                  end
-                end
-                raise msg
-              end
-
-              response.success?? nil : query
-            end.compact
-          end
-
           # For all the `entries` with errors generates a `Hash` object
           # @return [Array<Hash>] where each `Hash` has
           #   1. `:type` -> the error type
@@ -88,11 +67,11 @@ module Eco
               if body = status[entry].body
                 if errs = body["errors"]
                   errs.each do |msg|
-                    arr.push({
-                      type:  klass = Eco::API::Error.get_type(msg),
-                      err:   klass.new(err_msg: msg, entry: entry, session: session),
-                      entry: entry
-                    })
+                    arr.push(ErrorCache.new(
+                      klass = Eco::API::Error.get_type(msg),
+                      klass.new(err_msg: msg, entry: entry, session: session),
+                      entry
+                    ))
                   end
                 end
               end
@@ -103,45 +82,16 @@ module Eco
           # @return [Hash] where each `key` is a `type` **error** and each value is
           #   an `Array` of `entries` that got that error
           def by_type
-            errors.group_by do |h|
-              h[:type]
+            errors.group_by do |e|
+              e.type
             end.transform_values do |arr|
-              arr.map {|h| h[:entry]}
+              arr.map {|e| e.entry}
             end
           end
           # @!endgroup
 
           # @!group Messaging methods
 
-          # Generates a `String` specifying the error for the entry `key`.
-          # @param key [Integer, Ecoportal::API::V1::Person]
-          # @return [String] the error description.
-          def str(key)
-            msg = ""
-            unless status.success?(key)
-              i        = to_index(key)
-              entry    = queue.to_a[i]
-              response = status[i]
-              msg      = "Error #{response.status}: #{response.body}\n"
-              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
-            end
-            msg
-          end
-
-          # Sorts the entries that got server error by error `type` and generates the error messages.
-          # @return [Array<String>] the errors messages.
-          def strs
-            by_type.values.flatten(1).each_with_object([]) do |query, msgs|
-              msgs.push(str(query))
-            end
-          end
-
-          def print_one(key)
-            unless status.success?(key)
-              logger.error(str(key))
-            end
-          end
-
           def message
             msgs = strs
             if msgs.length > 0
@@ -163,6 +113,29 @@ module Eco
 
           private
 
+          # Input entries that got **error** response from the _Server_.
+          # @raise [Exception] if there are elements of the final `queue` that did not get response
+          # @note discards those that did not get _response_ from the Server (so those that were not queried)
+          #   - 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|
+              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"
+                msg += "Query with no response. Person: #{person_ref(query)}\n"
+                queue.map do |entry|
+                  if [:id, :external_id, :email].any? {|attr| (v = get_attr(entry, attr)) && v == get_attr(query, attr)}
+                    msg += "It could be this peson entry (idx: #{to_index(entry)}): #{person_ref(entry)}\n"
+                  end
+                end
+                raise msg
+              end
+
+              !response.success?
+            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)}')"
@@ -185,6 +158,35 @@ module Eco
             end
           end
 
+          # Sorts the entries that got server error by error `type` and generates the error messages.
+          # @return [Array<String>] the errors messages.
+          def strs
+            by_type.values.flatten(1).each_with_object([]) do |query, msgs|
+              msgs.push(str(query))
+            end
+          end
+
+          # Generates a `String` specifying the error for the entry `key`.
+          # @param key [Integer, Ecoportal::API::V1::Person]
+          # @return [String] the error description.
+          def str(key)
+            msg = ""
+            unless status.success?(key)
+              i        = to_index(key)
+              entry    = queue.to_a[i]
+              response = status[i]
+              msg      = "Error #{response.status}: #{response.body}\n"
+              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
+            end
+            msg
+          end
+
+          def print_one(key)
+            unless status.success?(key)
+              logger.error(str(key))
+            end
+          end
+
         end
       end
     end

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

@@ -212,6 +212,13 @@ module Eco
 
           private
 
+          def subjobs_summary
+            return "" unless subjobs.count > 0
+            [].tap do |msg|
+              subjobs.map {|subjob| msg << subjob.summary}
+            end.join("\n")
+          end          
+
           def as_update(*args)
             feedback.as_update(*args)
           end
@@ -310,13 +317,6 @@ module Eco
             end
           end
 
-          def subjobs_summary
-            return "" unless subjobs.count > 0
-            [].tap do |msg|
-              subjobs.map {|subjob| msg << subjob.summary}
-            end.join("\n")
-          end
-
         end
       end
     end

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/api/session/batch/status.rb

@@ -122,7 +122,9 @@ module Eco
           def valid_index(index: nil, entry: nil)
             index ||= @hash[entry]
             unless index && index < @queue.length
-              fatal "You must provide either the index on the final 'queue' or the original entry object of the batch"
+              msg  = "You must provide either the index on the final 'queue' or the original entry object of the batch. "
+              msg += "Given, index=#{index.class}, entry:#{entry.class}"
+              fatal msg
             end
             index
           end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.3"
+  VERSION = "2.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.8
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'