eco-helpers 2.0.4 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b5de98751cc76d2642fa0ac4d08a2567ce937095bed3d567c728ccc8503580
-  data.tar.gz: a69fb97c974f2241f563c203689eca6c8b584b84634a606de037cf529fa595ba
+  metadata.gz: 75a468069bd29d7dc25347e6da7d4d9faebc52043eba8b4ea1e91f6d383a8690
+  data.tar.gz: dee338f8e23d4608f0d359bd44712377d15723c70730e823c11766f179f4877e
 SHA512:
-  metadata.gz: 75b8a884c4dbcaf27898cb9ea046e91e492eebf6d54d93b69c4b8303fefde9f25daf548aea2b7fea37ec2087a38596f5d506909a0295accae0bac2ccfe7751d2
-  data.tar.gz: dbdd106ad836cef111d8293e338adcc6b79d5cc37f6e61995569e73f1749a7dc896c9fa77192a1a27ffe07d185ce5057461cc45b99598321f1d30bc8c4cf25a0
+  metadata.gz: 36c25c8a37c8fe894c57309e07126251e658846881698d4eec1660bf2a1a6cdc2e09f6b3f94c28434e47e7ea1f70cbf69196d2965d0a45609492867b2b356478
+  data.tar.gz: 98bdbf74599ab4a3ab98ac6c76d068bbcf7871774e3f7315f992dbcb9cc31066ac7d2293b8cbee1bc3019bf94e1b9f78c7fdf02b8751cafb403451be12c8c159

data/CHANGELOG.md

@@ -1,6 +1,45 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.9] - 2021-03-xx
+
+### 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
+  - `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

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

@@ -108,7 +108,7 @@ module Eco
           # @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.filter {|k| k.is_a?(Symbol)}
+            @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
@@ -161,13 +111,36 @@ module Eco
           end
           # @!endgroup
 
-          private
-
           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_.
+          # @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 get_attr(entry, attr)
             if entry.respond_to?(attr.to_sym)
               entry.public_send(attr.to_sym)
@@ -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.4"
+  VERSION = "2.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.9
 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'