eco-helpers 3.0.22 → 3.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24fea5e80af03052ddec1ce701651a61e7575d812161ff4f62f8f70c29da1d1
-  data.tar.gz: 2c72186bf780afd1b706eb0fbf44669cd68ac1239e0ba95f923462190a08d85d
+  metadata.gz: 18bddd2602bd39dc28068e4a107a55a88d3d125edc9da7f103d1c55aca7fdc5a
+  data.tar.gz: 0dc6a9cbba0634f16c11334461dc769aebe58d79d8bdf638133f789269bdcb45
 SHA512:
-  metadata.gz: 4bf253ab9cc07090b25ffcec1ff853422e292ce4fe1dcddab026bead5ef48d5a4710d55f79b4a16477c6671d764296938374c6f18521e27ac808529eb1435fa7
-  data.tar.gz: 28da9eaed628e6e37c22b5dc3c703867c9941eac6ea2d364142823ffa3e00e86ed54d45648b75231b4e93f86aff666f5a69892cc9255260af4c2c6953b6483bd
+  metadata.gz: bae5d14a1360c8659d26d2fa6289112256c535a831a6390d302034d7536bb6a52e87861faf35a3bf24baf117576cfd8b1fd2c17ceed65f0369a93bb313446f80
+  data.tar.gz: 9b6ce31b296d103763366613958dc1a9a5a7744d8f4c8bf87c6560223ad6adf6cb5863af9d5f9d47e45fd801cf20e62d3815e4c0a12eb0a8e6d95ad191d35f80

data/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.22] - 2024-12-xx
+## [3.0.23] - 2025-02-xx
+
+### Added
+
+### Changed
+
+- Moved SFTP sample to **new** space `Samples`
+
+### Fixed
+
+## [3.0.22] - 2025-02-23
 
 ### Added
 

data/eco-helpers.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'
   spec.add_dependency 'hashdiff',      '>= 1.1.0',  '< 1.2'
   spec.add_dependency 'jaro_winkler',  '>= 1.5.6',  '< 1.6'
+  spec.add_dependency 'net-http',      '~> 0.6.0'
   spec.add_dependency 'net-sftp',      '>= 4.0.0',  '< 5'
   spec.add_dependency 'net-ssh',       '>= 7.2.1',  '< 8'
   spec.add_dependency 'nokogiri',      '>= 1.13',   '< 1.17'
@@ -55,6 +56,7 @@ Gem::Specification.new do |spec|
   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'
+  # spec.add_dependency 'uri',           '~> 1.0', '>= 1.0.3'
 end
 
 # rubocop:enable Gemspec/DevelopmentDependencies

data/lib/eco/api/common/class_helpers.rb

@@ -23,7 +23,7 @@ module Eco
                 raise if exception
               end
             when Symbol
-              resolve_class(self.send(klass))
+              resolve_class(send(klass))
             else
               raise "Unknown class: #{klass}" if exception
             end
@@ -120,6 +120,7 @@ module Eco
               class << self; attr_accessor :#{attr} end
             ), __FILE__, __LINE__ - 2
           end
+
           inheritable_class_vars(*attrs)
         end
 

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

@@ -0,0 +1,3 @@
+class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::UseCases::Samples::Drivers::Sftp
+end
+

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

@@ -9,4 +9,4 @@ module Eco
   end
 end
 
-require_relative 'samples/sftp_case'
+require_relative 'samples/sftp'

data/lib/eco/api/usecases/{default_cases/samples → samples/drivers}/cli/sftp_cli.rb

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::DefaultCases::Samples::Sftp
+class  Eco::API::UseCases::Samples::Drivers::Sftp
   class Cli < Eco::API::UseCases::Cli
     desc "SFTP case: manages remote files that match a file pattern"
 

data/lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb

@@ -0,0 +1,15 @@
+class Eco::API::UseCases::Samples::Drivers::UrlPull
+  class Cli < Eco::API::UseCases::Cli
+    desc "Url Pull sample: pull the file from a specific URL"
+
+    add_option("-target-url-const", "Constant that should be used as a pattern") do |options|
+      url_const = SCR.get_arg("-target-url-const", with_param: true)
+      options.deep_merge!(url_pull: {target_url_const: url_const})
+    end
+
+    add_option("-local-folder", "Local folder to pull the remote files to.") do |options|
+      local_folder = SCR.get_file("-local-folder", required: true, should_exist: true)
+      options.deep_merge!(url_pull: {local_folder: local_folder})
+    end
+  end
+end

data/lib/eco/api/usecases/{default_cases/samples/sftp_case.rb → samples/drivers/sftp_sample.rb}

@@ -1,17 +1,17 @@
 # rubocop:disable Naming/AccessorMethodName
-class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Samples::Drivers::Sftp < Eco::API::Common::Loaders::UseCase
   class WrongConst < ArgumentError; end
   class MissRemoteFolder < ArgumentError; end
 
   require_relative 'cli/sftp_cli'
-  name "sftp"
+  name 'sftp'
   type :other
 
   CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
 
   def main(session, options, _usecase)
     options[:end_get] = false
-    raise "The SFTP is not configured" unless session.sftp?
+    raise 'The SFTP is not configured' unless session.sftp?
 
     case options.dig(:sftp, :command)
     when :list
@@ -34,7 +34,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     return     unless require
 
     msg  = "(#{self.class}) You should redefine the file_pattern function "
-    msg << "as a RegEx expression that matches the target remote file"
+    msg << 'as a RegEx expression that matches the target remote file'
     raise WrongConst, msg
   end
 
@@ -52,7 +52,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
   end
 
-  # Ex: "/IN/Personnel"
+  # Ex: '/IN/Personnel'
   def remote_subfolder(require: true)
     rm_sf = options.dig(:sftp, :remote_subfolder)
 
@@ -60,7 +60,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     return unless require
 
     msg  = "(#{self.class}) You should redefine remote_subfolder "
-    msg << "as the folder where the target file sits. Ex: /IN/Personnel"
+    msg << 'as the folder where the target file sits. Ex: /IN/Personnel'
     raise MissRemoteFolder, msg
   end
 
@@ -77,7 +77,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def local_folder
-    options.dig(:sftp, :local_folder) || "."
+    options.dig(:sftp, :local_folder) || '.'
   end
 
   def with_remote_files(folder: remote_folder, pattern: file_pattern)
@@ -147,7 +147,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def archive_subfolder
-    "Archive"
+    'Archive'
   end
 
   def sftp_config

data/lib/eco/api/usecases/samples/drivers/url_pull_sample.rb

@@ -0,0 +1,110 @@
+class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders::UseCase
+  class WrongConst < ArgumentError; end
+  # class MissRemoteFolder < ArgumentError; end
+
+  require_relative 'cli/url_pull_cli'
+  name 'url-pull'
+  type :other
+
+  CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
+
+  def main(*_args)
+    options[:end_get] = false
+    require_dependencies
+
+    if (response = get(URI(target_url), **auth_params))
+      to_csv(response.body, out_filename)
+    else
+      log(:error) { "Could not pull from url: #{target_url}" }
+      exit 1
+    end
+  end
+
+  private
+
+  def require_dependencies
+    require 'net/http'
+    require 'uri'
+    require 'csv'
+    # require 'dotenv/load'
+  end
+
+  # Override this method to obtain authentication
+  # i.e. { user: ENV['KEY']}
+  def auth_params
+    {}
+  end
+
+  def get(uri, **kargs)
+    base_request(uri, **kargs) do |request|
+      http_start(uri) do |http|
+        puts "Pulling from url: #{uri}"
+        return http.request(request)
+      end
+    end
+  end
+
+  def to_csv(plain_data, filename)
+    data = CSV.parse(plain_data)
+
+    CSV.open(filename, 'w') do |csv|
+      data.each do |line|
+        csv << line
+      end
+    end
+
+    log(:info) { "Generated output file: #{filename}" }
+  end
+
+  def request_options(uri)
+    {
+      use_ssl: uri.scheme == 'https'
+    }
+  end
+
+  def http_start(uri, &block)
+    Net::HTTP.start(uri.hostname, uri.port, request_options(uri), &block)
+  end
+
+  def base_request(uri, user: nil, pass: '')
+    Net::HTTP::Get.new(uri).tap do |request|
+      request.basic_auth(user, pass) unless user.nil?
+      yield(request)
+    end
+  end
+
+  def out_filename
+    File.join(local_folder, "#{file_basename}.csv")
+  end
+
+  def file_basename
+    config.active_enviro
+  end
+
+  def local_folder
+    options.dig(:url_pull, :local_folder) || '.'
+  end
+
+  def target_url(required: true)
+    fpc = target_url_const
+    return fpc if fpc
+    return     unless required
+
+    msg = "(#{self.class}) You should redefine the target_url method "
+    raise WrongConst, msg
+  end
+
+  def target_url_const
+    if (fpc = options.dig(:url_pull, :target_url_const))
+      raise WrongConst, "(#{self.class}) Invalid file pattern const referral: #{fpc}" unless fpc.match(CONST_REFERRAL)
+
+      begin
+        self.eval(fpc)
+      rescue NameError
+        self.class.const_get(fpc)
+      end
+    end
+  rescue NameError
+    raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
+  end
+end

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

@@ -0,0 +1,13 @@
+module Eco
+  module API
+    class UseCases
+      class Samples
+        module Drivers
+        end
+      end
+    end
+  end
+end
+
+require_relative 'drivers/sftp_sample'
+require_relative 'drivers/url_pull_sample'

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

@@ -0,0 +1,11 @@
+module Eco
+  module API
+    class UseCases
+      class Samples < Eco::API::UseCases
+      end
+    end
+  end
+end
+
+require_relative 'samples/drivers'
+

data/lib/eco/api/usecases.rb

@@ -176,8 +176,9 @@ require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
 require_relative 'usecases/cli'
-require_relative 'usecases/default_cases'
 require_relative 'usecases/graphql'
+require_relative 'usecases/default'
+require_relative 'usecases/samples'
+require_relative 'usecases/default_cases' # legacy
 require_relative 'usecases/ooze_samples'
 require_relative 'usecases/ooze_cases'
-require_relative 'usecases/default'

data/lib/eco/language/methods/dsl_able.rb

@@ -1,6 +1,13 @@
 module Eco
   module Language
     module Methods
+      # Adds #evaluate, which will run `&block` where `DslAble` has been included.
+      # @note
+      #   1. If a method is missing on the evaluation object, it will re-try it on
+      #     on the block context.
+      #   2. **Override behaviour**: the above gives precedence to
+      #     methods defined in the context of the object that evaluates,
+      #     over those in the block context.
       module DslAble
         # It runs the `block` within this object context
         # @note if the object misses any method, redirects the method to the

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.22'.freeze
+  VERSION = '3.0.23'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.22
+  version: 3.0.23
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -374,6 +374,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -784,8 +798,7 @@ files:
 - lib/eco/api/usecases/default_cases/entries_to_csv_case.rb
 - lib/eco/api/usecases/default_cases/hris_case.rb
 - lib/eco/api/usecases/default_cases/samples.rb
-- lib/eco/api/usecases/default_cases/samples/cli/sftp_cli.rb
-- lib/eco/api/usecases/default_cases/samples/sftp_case.rb
+- lib/eco/api/usecases/default_cases/samples/sftp.rb
 - lib/eco/api/usecases/default_cases/to_csv_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_detailed_case.rb
 - lib/eco/api/usecases/default_cases/update_case.rb
@@ -873,6 +886,12 @@ files:
 - lib/eco/api/usecases/ooze_samples/register_migration_case.rb
 - lib/eco/api/usecases/ooze_samples/register_update_case.rb
 - lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb
+- lib/eco/api/usecases/samples.rb
+- lib/eco/api/usecases/samples/drivers.rb
+- lib/eco/api/usecases/samples/drivers/cli/sftp_cli.rb
+- lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb
+- lib/eco/api/usecases/samples/drivers/sftp_sample.rb
+- lib/eco/api/usecases/samples/drivers/url_pull_sample.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case/chainer.rb
 - lib/eco/api/usecases/use_case_chain.rb