eco-helpers 2.0.46 → 2.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd9b2a6564e5ce38fa3ed762ab04f5e4e79b1a6580738d9091b846233c6fb66e
-  data.tar.gz: ac0200ad60b30fc0d40997b4975f016daee8cd48c881bfecae106ca0867ff123
+  metadata.gz: 2471c3dc047c0a9ec3c2f1e374d09e4ab9920bd92a54b52a1a0bb0647f869712
+  data.tar.gz: 21e3bb5e42b843ee896a4690df358c081accc2338f7afe4aa91acada0755e681
 SHA512:
-  metadata.gz: f72270169fd60eaee60b27d333391bc6d2235fe856752d9f7dcd5d5aca18fd129e148cd0830bea37cd86833cabc64f10e4fb09e71c4ba2ba9b6912313da82b4a
-  data.tar.gz: 690b338d062020a6d80794d794f00f8ce9c263bb8b12a84f774f50193bd49ff474b6a49f670a1e05df9a2db88f70d3639c54582fc8706617c44123753c0a7b9e
+  metadata.gz: e73fdfd9ea00ab63ef8fb49fb4dfd52de2c186f93d9fe6464507ea26acc4a8641ea46dd36f99e5c8bf9d1082537518dfd7404a28b43a6fd93cbdce52acd8b367
+  data.tar.gz: eb9f056454037f0ae46632b27f7a3e0b2922f0d0b4452eebe23ff34f1c205ce87a45693bcc9a8ff981e91acb0fdada9fd2e37c3a79cb2ab7898d7e0e4aad581e

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.47] - 2022-02-xx
+
+### Added
+  - `Eco::API::UseCases::DefaultCases::CleanUnknownTags`
+      - It is possible to extend or override `register_tags`
+      - New command option `-include-register-tags` (will not ignore register tags; they will be removed too)
+  - `Eco::API::UseCases::DefaultCases::Samples::Sftp`
+      - Default sample case to list, get and archive SFTP remote files
+### Changed
+  - upgraded `ecoportal-api-v2` dependency
+  
+### Fixed
+  - `Eco::API::Common::Session::S3Uploader#upload_file`: check if file exists before opening.
+
 ## [2.0.46] - 2021-12-24
 
 ### Added
@@ -9,7 +23,7 @@ All notable changes to this project will be documented in this file.
     - added also counter of failed to retrieve oozes
     - added also counter of double ups in search pagination
     - counter for updated pages and pages that failed update
-  - `Eco::API::Session#enviro_name`: to identify in whic environment we are running
+  - `Eco::API::Session#enviro_name`: to identify in which environment we are running
 
 ### Changed
   - upgraded `ecoportal-api-v2` dependency

data/eco-helpers.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.4', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.23', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.24', '< 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/session/s3_uploader.rb

@@ -32,8 +32,10 @@ module Eco
           # @param path [String] the target file to be uploaded
           # @return [String] S3 path to the uploaded `path` file
           def upload_file(path)
-            File.open(path, "rb") do |f|
-              upload(File.basename(path), f)
+            if File.exist?(path)
+              File.open(path, "rb") do |f|
+                upload(File.basename(path), f)
+              end
             end
           end
 

data/lib/eco/api/usecases/default_cases/clean_unknown_tags_case.rb

@@ -2,6 +2,8 @@ class Eco::API::UseCases::DefaultCases::CleanUnknownTags < Eco::API::Common::Loa
   name "clean-unknown-tags"
   type :transform
 
+  UNKNOWN_LOCS_FILE = "unknown_locations.txt"
+
   REGISTER_TAGS = [
     "EVENT", "INJURY", "RISK", "CONTRACTOR", "PERMIT",
     "AUDIT", "JSEA",
@@ -20,18 +22,52 @@ class Eco::API::UseCases::DefaultCases::CleanUnknownTags < Eco::API::Common::Loa
     people.each do |person|
       unknown_tags = person.filter_tags.select {|tag| !tag?(tag)}
       person.filter_tags -= unknown_tags
+      unknown_tag!(*unknown_tags)
       update.add(person)
     end
   end
 
   private
 
+  def unknown_tag!(*tags)
+    tags.each do |value|
+      unless unknown.include?(value)
+        unknown << value
+        File.open(unknown_tags_file, 'a') do |fd|
+          fd.write("#{value}\n")
+        end
+        puts "Custom detected: '#{value}'"
+      end
+    end
+  end
+
+  def register_tags
+    REGISTER_TAGS
+  end
+
+  def unknown
+    @unknown ||= []
+  end
+
   def tag?(value)
-    tagtree.tag?(value) || REGISTER_TAGS.any? {|reg| value == reg}
+    tagtree.tag?(value).yield_self do |is_loc|
+      next true if is_loc
+      if clean_register_tags?
+        register_tags.any? {|reg| value == reg}
+      end
+    end
   end
 
   def tagtree
     @tagtree ||= ASSETS.config.tagtree
   end
 
+  def unknown_tags_file
+    File.join(".","#{session.enviro_name}_#{UNKNOWN_LOCS_FILE}")
+  end
+
+  def clean_register_tags?
+    !options.dig(:usecase, :include_register_tags)
+  end
+
 end

data/lib/eco/api/usecases/default_cases/samples/sftp_case.rb

@@ -0,0 +1,109 @@
+class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loaders::UseCase
+  name "sftp-sample"
+  type :other
+
+  attr_reader :session
+
+  def main(session, options, usecase)
+    @session = session
+    options[:end_get] = false
+    raise "The SFTP is not configured" unless session.sftp?
+    case options.dig(:sftp, :command)
+    when :list
+      list_folder
+    when :get
+      get_files
+    when :get_last
+      get_last
+    when :archive
+      archive_files
+    end
+  end
+
+  private
+
+  def file_pattern
+    raise "You should redefine the file_pattern function as a RegEx expression that matches the target remote file"
+  end
+
+  # Ex: "/IN/Personnel"
+  def remote_subfolder
+    raise "You should redefine remote_subfolder as the folder where the target file sits"
+  end
+
+  def archive_subfolder
+    "Archive"
+  end
+
+  def with_remote_files
+    sftp.files(remote_folder, pattern: file_pattern).each do |remote_file|
+      yield(remote_file) if block_given?
+    end
+  end
+
+  def list_folder
+    puts "Listing remote folder: '#{remote_folder}':"
+    with_remote_files {|file| puts file.longname}
+  end
+
+  def get_files
+    with_remote_files.tap do |files|
+      unless files.empty?
+        file_names = files.map {|file| to_remote_path(file.name)}
+        puts "Getting the following files:"
+        puts file_names
+        sftp.download(file_names, local_folder: local_folder)
+      end
+    end
+  end
+
+  def get_last
+    with_remote_files.last.tap do |file|
+      if file
+        file_name = to_remote_path(file.name)
+        puts "Getting the following file: #{file_name}"
+        sftp.download(file_name, local_folder: local_folder)
+      end
+    end
+  end
+
+  def archive_files
+    with_remote_files do |file|
+      source = to_remote_path(file.name) # should probably be file.longname
+      dest   = to_remote_path("#{archive_subfolder}/#{file.name}")
+      move_file(source, dest)
+    end.tap do |files|
+      puts "Moved the file(s) to the #{archive_subfolder} folder" unless files.empty?
+    end
+  end
+
+  def move_file(source, dest)
+    sftp.move(source, dest, 0x0001) do |response|
+      if response.ok?
+        puts "#{source}\n  -to-> #{dest}"
+      else
+        puts "Could not move file #{source}"
+      end
+    end
+  end
+
+  def to_remote_path(file)
+    remote_folder + "/" + file
+  end
+
+  def local_folder
+    "."
+  end
+
+  def remote_folder
+    @remote_folder ||= sftp_config.remote_folder + remote_subfolder
+  end
+
+  def sftp_config
+    session.config.sftp
+  end
+
+  def sftp
+    session.sftp
+  end
+end

data/lib/eco/api/usecases/default_cases/samples.rb

@@ -0,0 +1,12 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        module Samples
+        end
+      end
+    end
+  end
+end
+
+require_relative 'samples/sftp_case'

data/lib/eco/api/usecases/default_cases.rb

@@ -9,6 +9,7 @@ module Eco
   end
 end
 
+require_relative 'default_cases/samples'
 require_relative 'default_cases/abstract_policygroup_abilities_case.rb'
 require_relative 'default_cases/analyse_people_case'
 require_relative 'default_cases/append_usergroups_case'

data/lib/eco/cli/config/default/usecases.rb

@@ -90,6 +90,9 @@ ASSETS.cli.config do |cnf|
     desc  = "Cleans from filter_tags those tags that are not present in the tagtree (as per tagtree.json file)."
     desc += " It will preserve standard register tags of most common registers (i.e. EVENT, RISK)."
     cases.add("-clean-unknown-tags", :transform, desc, case_name: "clean-unknown-tags")
+    .add_option("-include-register-tags", "Will also try to remove register tags") do |options|
+      options.deep_merge!(usecase: {include_register_tags: true})
+    end
 
     desc = "Removes the landing page or sets it to -page-id"
     cases.add("-reset-landing-page", :transform, desc, case_name: "reset-landing-page")

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.46"
+  VERSION = "2.0.47"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.46
+  version: 2.0.47
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.8.24
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.23
+        version: 0.8.24
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -546,6 +546,8 @@ files:
 - lib/eco/api/usecases/default_cases/remove_account_trans_case.rb
 - lib/eco/api/usecases/default_cases/reset_landing_page_case.rb
 - lib/eco/api/usecases/default_cases/restore_db_case.rb
+- lib/eco/api/usecases/default_cases/samples.rb
+- lib/eco/api/usecases/default_cases/samples/sftp_case.rb
 - lib/eco/api/usecases/default_cases/set_default_tag_case.rb
 - lib/eco/api/usecases/default_cases/set_supervisor_case.rb
 - lib/eco/api/usecases/default_cases/supers_cyclic_identify_case.rb