eco-helpers 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caef8b4ee689f202db51c1be9ea77c1c2e3b21cf16dcaebdf7fd838a260b5e26
-  data.tar.gz: ad27f525af9bceff0342e5676f898a9da1dbb486c6aad796f2bb3646ccf5cb68
+  metadata.gz: 402f80f7e80fd4ecc9a97a9e96a0823ab4e26d63541540e14774db2dbf97ef60
+  data.tar.gz: 3d097ed8af5c5e1c0ecacb227b0a77e4f1d6d8bb15e77599a008aa1af361b230
 SHA512:
-  metadata.gz: 4780834f301910259cb8958c1277de1972ac710f59f7803d34ed2263dc777c18a7a2503e3d6b36879b131b2625b657832a78a27471b690a5d9da8025d381df9f
-  data.tar.gz: 28b74a9f5d8fe22aadb053fbed4af2e35e4700a04e87fbfc201bd2336521f04814e25c0cbac7f48426172f4b21a05f8b4e4b551eaaffd4067c49609fce0dac92
+  metadata.gz: c083c3f62d2f29c427f56a2b34b11e4cd238198a95e728e1afeaa4345ccab4c507b798b10427adca14c547161d210d0662d4ece666b67d6464052992d0cade62
+  data.tar.gz: 840bf5e3b90b3a9398a2eb2c5dc989e1ad321705d0785d5cb0b89a696756a721b2e66804a7a3fe7adc82f76611a58fba7379131c994312b01c2d576c93339df0

data/CHANGELOG.md

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

data/eco-helpers.gemspec

@@ -30,9 +30,9 @@ 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.8.2', '< 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-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/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/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.5"
+  VERSION = "2.0.6"
 end

metadata

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