eco-helpers 3.0.14 → 3.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660f0a85b269e559ec99381ea4f621dcf8495b4c9465594824ad30da872c0e75
-  data.tar.gz: 3baf736b197cbf7784f116dacaa28f5d049acf8d62f15cdfe3669adcb3ae0b10
+  metadata.gz: fb3a3362dc59886aca4136df89d2fbaabc5fddceab410a52556eb0c01bea4357
+  data.tar.gz: b66f988b6cc4dc9d1123860835c5163a96f1315fc9b94c9950a4c68d13f23bf7
 SHA512:
-  metadata.gz: ed21ee420598f8dc8d45895160475b37ebb5022219d9b6bd96ca9861faa8c03cb315db4a95626a24dd5f30627253661ed51c294792c050e99a8a9b3706610676
-  data.tar.gz: d3800bad4334ec5bbfe5d0aa5dde65befc003b66a1abb6dbb104773c7cc6c3fcbe8da959fe239b6fd9b5cf48bea570703117ca804e6c4cf1394a37c0f90dca43
+  metadata.gz: 466af194495d8d185602b19ef32641123dccc29da95f0fd8347925112b510909061b613f49eeed986a25d25fbd9e319366f70fafa560247cfd889a04cde28c3c
+  data.tar.gz: 60c260b8c85efc6be8b695ecf0097f8dbc203b2162296848f9fe012f4fd0c9f4ebaa926ee55a0c2b59b6e7225274d6a2030f2e3433351d482d4bd25fd3bc700e

data/CHANGELOG.md

@@ -2,15 +2,34 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.14] - 2024-09-xx
+## [3.0.15] - 2024-10-01
 
 ### Added
 
+- Support for **api** credential **spaces** (i.e. `uat`, etc.)
+  - `Eco::API::Session::Config::Api`
+  - `Eco::API::Session::Config::Apis`
+
 ### Changed
 
+- moved default mailer provider to `SendGrid`
+- upgrade core **gem** `ecoportal-api`
+- chain `-batch-mode`
+- `Eco::API::Session::Batch` print actual error message.
+- `Eco::API::UseCases::GraphQL::Helpers::Base::ErrorHandling` to treat `exit` as its own category `exiting?`
+  - **Added** `exception?` method which is `true` if there was an `exception` or an `exit`
+- `Eco::API::Session::Config#add_api`: added chaining capability via `add_space` method
+  - In a block it will use same params as root definition
+  - As a chained command, it will only define a new `space` for that enviro `name`
+
 ### Fixed
 
-- sftp errors
+- `SCR#get_arg` when the option can be invoked in multiple ways
+- `Eco::API::Session::Batch#offer_retry_on`
+  - Remove repetitive backtrace
+- `Eco::API::UseCases::GraphQL::Samples::Location::Command::Service::TreeUpdate#email_digest` to include a bit of backtrace when there is an exception
+- `Eco::API::UseCases::GraphQL::Samples::Location::Command::DSL#inputs`
+  - Moved **:error** `log` to only capture request errors alone.
 
 ## [3.0.13] - 2024-09-10
 

data/eco-helpers.gemspec

@@ -2,14 +2,14 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require "./lib/eco/version"
+require './lib/eco/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "eco-helpers"
+  spec.name          = 'eco-helpers'
   spec.version       = Eco::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ["Oscar Segura"]
-  spec.email         = ["oscar@ecoportal.co.nz"]
+  spec.authors       = ['Oscar Segura']
+  spec.email         = ['oscar@ecoportal.co.nz']
 
   spec.summary       = "eco-helpers to manage people api cases"
   spec.homepage      = "https://www.ecoportal.com"
@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
 
   #spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
-  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
-  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
-  spec.add_development_dependency "rubocop",   "~> 1"
-  spec.add_development_dependency "rubocop-rake", "~> 0"
-  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
+  spec.add_development_dependency 'rake',      '>= 13.0.3', '< 14'
+  spec.add_development_dependency 'redcarpet', '>= 3.6.0',  '< 4'
+  spec.add_development_dependency 'rspec',     '>= 3.12.0', '< 4'
+  spec.add_development_dependency 'rubocop',   '~> 1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0'
+  spec.add_development_dependency 'yard',         '~> 0.9'
 
   spec.add_dependency 'amatch',        '>= 0.4.1', '< 0.5'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.142.0', '< 2'
@@ -40,9 +40,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'ecoportal-api',         '~> 0.10'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4', '>= 0.4.1'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0', '>= 2.0.9'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.3'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.2'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.10'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'
@@ -54,6 +54,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'roo',           '>= 2.10.1', '< 2.11'
   spec.add_dependency 'roo-xls',       '>= 1.2.0',  '< 1.3'
   spec.add_dependency 'rubyzip',       '>= 2.3.2',  '< 2.4'
+  spec.add_dependency 'sendgrid-ruby', '~> 6.7.0'
 end
 
 # rubocop:enable Gemspec/DevelopmentDependencies

data/lib/eco/api/common/people/default_parsers/date_parser.rb

@@ -34,6 +34,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
     return nil   if blank?(value)
     return value if value.is_a?(String)
     return nil   unless [Date, Time].any? {|type| value.is_a?(type)}
+
     value&.strftime('%Y-%m-%d')
   rescue TypeError, Date::Error
     nil
@@ -42,6 +43,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
   def date?(value)
     return true if value.nil?
     return true if value.to_s.strip.empty?
+
     Date.parse(value)
     true
   rescue TypeError, Date::Error
@@ -51,11 +53,13 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
   def valid_range?(date)
     return true  if date.nil?
     return false unless min_date <= date
+
     max_date >= date
   end
 
   def wrong!(value, attr:, desc: "Can't make a date out of")
     return if wrong(attr).key?(value)
+
     wrong(attr)[value] = value
     log(:warn) { "#{desc} '#{value}' for '#{attr}'" }
     nil
@@ -64,6 +68,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
   def wrong(attr = nil)
     @wrong ||= {}
     return @wrong if attr.nil?
+
     @wrong[attr] ||= {}
   end
 
@@ -78,6 +83,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
   def blank?(value)
     return true if value.nil?
     return true if value.to_s.strip.empty?
+
     false
   end
 end

data/lib/eco/api/common/session/mailer/aws_provider.rb

@@ -0,0 +1,85 @@
+# rubocop:disable Naming/MethodParameterName
+module Eco
+  module API
+    module Common
+      module Session
+        class Mailer
+          class AwsProvider < ProviderBase
+            def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil)
+              ses.send_email(
+                destination: fetch_destination(to: to, cc: cc, bcc: bcc),
+                source:      fetch_from,
+                message:     {
+                  subject: {
+                    charset: "UTF-8",
+                    data:    subject
+                  },
+                  body:    {
+                    # NOTE: (html) will let you send html instead
+                    # you can use both at once if you like
+                    text: {
+                      charset: "UTF-8",
+                      data:    body
+                    }
+                  }
+                }
+              )
+            end
+
+            # @return [Boolean] whether or not the mailer is configured for usage.
+            def configured?
+              fetch_access_key_id && fetch_secret_access_key && fetch_region
+            end
+
+            private
+
+            def credentials
+              @credentials ||= {
+                id:  'AWS_ACCESS_KEY_ID',
+                key: 'AWS_SECRET_ACCESS_KEY'
+              }
+            end
+
+            def ses
+              require 'aws-sdk-ses'
+              @ses ||= Aws::SES::Client.new(
+                access_key_id:     fetch_access_key_id,
+                secret_access_key: fetch_secret_access_key,
+                region:            fetch_region
+              )
+            rescue StandardError => err
+              log(:error) {
+                "Trying to send an email with wrong email configuration: #{err}"
+              }
+            end
+
+            def fetch_destination(to: nil, cc: nil, bcc: nil)
+              {
+                to_addresses: [fetch_to(to)].flatten.compact.uniq
+              }.tap do |dest|
+                cc  = [cc].flatten.compact.uniq
+                bcc = [bcc].flatten.compact.uniq
+                dest.merge!(cc_addresses: cc)   unless cc.empty?
+                dest.merge!(bcc_addresses: bcc) unless bcc.empty?
+              end
+            end
+
+            def fetch_region
+              config.mailer.region || ENV['AWS_REGION']
+            end
+
+            def fetch_server
+              config.mailer.server
+            end
+
+            def fetch_message_id_domain
+              config.mailer.message_id_domain
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

data/lib/eco/api/common/session/mailer/provider_base.rb

@@ -0,0 +1,61 @@
+module Eco
+  module API
+    module Common
+      module Session
+        class Mailer
+          class ProviderBase
+            class << self
+              def to_desc(to: nil, cc: nil, bcc: nil)
+                cc_to  = [cc].flatten.compact.uniq
+                bcc_to = [bcc].flatten.compact.uniq
+                { to_addresses: [to].flatten.compact.uniq }.tap do |dest|
+                  dest.merge!(cc_addresses: cc_to)   unless cc_to.empty?
+                  dest.merge!(bcc_addresses: bcc_to) unless bcc_to.empty?
+                end
+              end
+            end
+
+            include Eco::Language::AuxiliarLogger
+
+            attr_reader :config
+
+            def initialize(config, logger:)
+              @config = config
+              @logger = logger
+            end
+
+            def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil) # rubocop:disable Lint/UnusedMethodArgument
+              raise "You must implement this method"
+            end
+
+            def fetch_to(value = nil)
+              value || config.mailer.to
+            end
+
+            private
+
+            def credentials
+              raise "You must implement this method"
+            end
+
+            def fetch_from(value = nil)
+              value || config.mailer.from
+            end
+
+            def fetch_access_key_id
+              env_mail(:id) || config.mailer.access_key_id
+            end
+
+            def fetch_secret_access_key
+              env_mail(:key) || config.mailer.secret_access_key
+            end
+
+            def env_mail(prop)
+              ENV[credentials[prop]]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/common/session/mailer/sendgrid_provider.rb

@@ -0,0 +1,117 @@
+# rubocop:disable Naming/MethodParameterName
+module Eco
+  module API
+    module Common
+      module Session
+        class Mailer
+          class SendgridProvider < ProviderBase
+            def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil)
+              return false unless sendgrid
+
+              data = to_data(
+                subject: subject,
+                body:    body,
+                to:      to,
+                cc:      cc,
+                bcc:     bcc
+              )
+
+              mailer._("send").post(request_body: data)
+            end
+
+            def fetch_to(value = nil)
+              emails = [super].flatten.compact
+              to_email_model(emails)
+            end
+
+            # @return [Boolean] whether or not the mailer is configured for usage.
+            def configured?
+              fetch_secret_access_key
+            end
+
+            private
+
+            def credentials
+              @credentials ||= {
+                id:  'SENDGRID_ACCESS_ID',
+                key: 'SENDGRID_ACCESS_KEY'
+              }
+            end
+
+            def to_data(subject:, body:, to: nil, cc: nil, bcc: nil)
+              {
+                "personalizations" => [
+                  {
+                    "to"      => fetch_to(to).flatten,
+                    "subject" => subject
+                  }.tap do |pers|
+                    merge_if('cc', cc, target: pers)
+                    merge_if('bcc', bcc, target: pers)
+                  end
+                ],
+                "from"             => fetch_from,
+                "content"          => [
+                  {
+                    "type"  => "text/plain",
+                    "value" => body
+                  }
+                ]
+              }
+            end
+
+            def mailer
+              @mailer ||= sendgrid&.client&.mail
+            end
+
+            def sendgrid
+              require 'sendgrid-ruby'
+              extend(::SendGrid) unless is_a?(SendGrid)
+
+              @sendgrid ||= SendGrid::API.new(
+                api_key: fetch_secret_access_key
+              )
+            rescue StandardError => err
+              log(:error) {
+                "Trying to send an email with wrong email configuration: #{err}"
+              }
+              nil
+            end
+
+            def to_email_model(value)
+              case value
+              when Array
+                value.map do |val|
+                  to_email_model(val)
+                end.compact
+              else
+                return if value.to_s.strip.empty?
+
+                {
+                  "email" => value
+                }
+              end
+            end
+
+            def merge_if(key, data, target: {})
+              return if data.to_s.strip.empty?
+
+              key_data = to_email_model(data)
+
+              return if key_data.nil?
+              return if key_data.empty?
+
+              target.merge!({key.to_s => key_data})
+            end
+
+            def fetch_from(value = nil)
+              email = [super].flatten.compact.first
+              to_email_model(email)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

data/lib/eco/api/common/session/mailer.rb

@@ -1,4 +1,8 @@
 # rubocop:disable Naming/MethodParameterName
+
+require_relative 'mailer/provider_base'
+require_relative 'mailer/aws_provider'
+require_relative 'mailer/sendgrid_provider'
 module Eco
   module API
     module Common
@@ -6,12 +10,17 @@ module Eco
         class Mailer
           include Eco::Language::AuxiliarLogger
 
+          DEFAULT_PROVIDER = :sendgrid
+
+          attr_reader :provider
+
           # @param enviro [Eco::API::Common::Session::Environment]
-          def initialize(enviro:)
+          def initialize(enviro:, provider: DEFAULT_PROVIDER)
             msg = "Required Environment object (enviro:). Given: #{enviro.class}"
             raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
 
-            @enviro = enviro
+            @enviro   = enviro
+            @provider = provider || DEFAULT_PROVIDER
           end
 
           # Sends an email
@@ -19,25 +28,27 @@ module Eco
           # @param subject [String] subject of the email
           # @param body [String] `html` or plain text message
           def mail(subject:, body:, to: nil, cc: nil, bcc: nil)
-            ses.send_email(
-              destination: fetch_destination(to: to, cc: cc, bcc: bcc),
-              source:      fetch_from,
-              message:     {
-                subject: {
-                  charset: "UTF-8",
-                  data:    subject,
-                },
-                body:    {
-                  # NOTE: (html) will let you send html instead
-                  # you can use both at once if you like
-                  text: {
-                    charset: "UTF-8",
-                    data:    body
-                  }
-                }
-              }
+            return false unless (serv = service)
+
+            unless serv.configured?
+              msg  = "Mailer: You are missing configuration parameters "
+              msg << "for '#{provider}'. Review your .env file"
+              log(:error) { msg }
+              return false
+            end
+
+            serv.send_mail(
+              subject: subject,
+              body:    body,
+              to:      to,
+              cc:      cc,
+              bcc:     bcc
             ).tap do |response|
-              msg = "Sent email (MessageId: #{response.message_id}) to #{fetch_destination(to: to, cc: cc, bcc: bcc)}"
+              next unless response
+
+              to_addr = serv.fetch_to(to)
+              # msg = "Sent email (MessageId: #{response.message_id}) to #{fetch_destination(to: to, cc: cc, bcc: bcc)}"
+              msg = "Sent email #{ProviderBase.to_desc(to: to_addr, cc: cc, bcc: bcc)}"
               puts msg
               log(:debug) { msg }
             end
@@ -45,21 +56,18 @@ module Eco
 
           private
 
-          def ses
-            require 'aws-sdk-ses'
-            begin
-              @ses ||= Aws::SES::Client.new(
-                access_key_id:     fetch_access_key_id,
-                secret_access_key: fetch_secret_access_key,
-                region:            fetch_region
-              )
-            rescue StandardError => err
-              log(:error) {
-                "Trying to send an email with wrong email configuration: #{err}"
-              }
+          def service
+            case provider
+            when :aws
+              AwsProvider.new(config, logger: logger)
+            when :sendgrid
+              SendgridProvider.new(config, logger: logger)
+            else
+              msg = "Unknown mail provider '#{provider}'"
+              puts msg
+              log(:debug) { msg }
+              nil
             end
-
-            @ses
           end
 
           def logger
@@ -69,43 +77,6 @@ module Eco
           def config
             @enviro.config || {}
           end
-
-          def fetch_destination(to: nil, cc: nil, bcc: nil)
-            cc_to  = [cc].flatten.compact.uniq
-            bcc_to = [bcc].flatten.compact.uniq
-            { to_addresses: [fetch_to(to)].flatten }.tap do |dest|
-              dest.merge!(cc_addresses: cc_to) unless cc_to.empty?
-              dest.merge!(bcc_addresses: bcc_to) unless bcc_to.empty?
-            end
-          end
-
-          def fetch_to(value = nil)
-            value || config.mailer.to
-          end
-
-          def fetch_from(value = nil)
-            value || config.mailer.from
-          end
-
-          def fetch_access_key_id
-            config.mailer.access_key_id || ENV['AWS_ACCESS_KEY_ID']
-          end
-
-          def fetch_secret_access_key
-            config.mailer.secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
-          end
-
-          def fetch_region
-            config.mailer.region || ENV['AWS_REGION']
-          end
-
-          def fetch_server
-            config.mailer.server
-          end
-
-          def fetch_message_id_domain
-            config.mailer.message_id_domain
-          end
         end
       end
     end

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

@@ -116,7 +116,7 @@ module Eco
             msgs = strs
 
             if msgs.empty?
-              "There were no errors for the current batch '#{method}'!! ;)"
+              "There were no errors for the current batch '#{method}'!! ;)   "
             else
               "There were #{msgs.length} errors:\n" + msgs.join("\n")
             end
@@ -127,7 +127,7 @@ module Eco
 
             if msgs.empty?
               log(:info) {
-                "There were no errors for the current batch '#{method}'!! ;)"
+                "There were no errors for the current batch '#{method}'!! ;)   "
               }
             else
               msg  = "There were #{msgs.length} errors:\n"