rservicebus2 0.2.18 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70e06273be45dd1c4fb2c5611962b1b2f0bd13f8bbf1dd6f19e1f0efaac3d26f
-  data.tar.gz: d9efd6d11e1162a8f6d17a214d4d7e2c4d2cd9f1501a14f160ac0e9e79477b09
+  metadata.gz: 71f2b7544eaabb8ac574d01767ff0649ac84cd5d3be3e08978f7e81a66a55fbe
+  data.tar.gz: abb04b187ab3c1bdc2b798df1172305f03e527b932e8a84079de203b03ac938c
 SHA512:
-  metadata.gz: a8b7715cf19a079210e4a8d07eba4046d3742012b271c2642c4c116309fec30cf32031058dba3788081295857a51adff0fac18eb72b24df49266fed1261cce4e
-  data.tar.gz: a063b4320249df6cfa2ed2fad0b9bccf33581920db0b44434c5ad4de499b34d074cb535c043ed3d3cde459482fa6f78aa09084c5b241220a46f9e2ee9079f63a
+  metadata.gz: f4e0fadea46712cb6d027936620eb2cbdd78b25dbbfc38c912f16eedb1a2793ccdbc71535ee34c68764b0433ba6c01c0e7d951fe0ed93c8b034d0e3153fc8958
+  data.tar.gz: 433bf092c220e1eafe3b3ae365fe9633bcabec7330c940445a983bbce2da65db835d54026fa95848ed72b163bf3fbd17cf6dc6eacbe1aa950fb1608a42667b73

data/bin/return_messages_to_source_queue

@@ -13,7 +13,8 @@ def return_msg(beanstalk, job, request_nbr)
 
   msg_name = payload.match('(\w*)', start_index)[1]
 
-  msg = YAML.load(payload)
+  msg = RServiceBus2.safe_load(payload)
+
   if msg.last_error_string.nil?
     puts "*** Requested msg, #{request_nbr}, does not have a sourceQueue to
           which it can be returned"

data/lib/rservicebus2.rb

@@ -23,6 +23,7 @@ require 'rservicebus2/config'
 require 'rservicebus2/endpointmapping'
 require 'rservicebus2/statistic_manager'
 require 'rservicebus2/audit'
+require 'rservicebus2/yaml_safe_loader'
 
 require 'rservicebus2/message'
 require 'rservicebus2/message/subscription'

data/lib/rservicebus2/agent.rb

@@ -50,7 +50,7 @@ module RServiceBus2
     def check_for_reply(queue_name)
       @mq.subscribe(queue_name)
       body = @mq.pop
-      @msg = YAML.load(body)
+      @msg = RServiceBus2.safe_load(body)
       @mq.ack
       @msg.msg
     end

data/lib/rservicebus2/handler_loader.rb

@@ -140,14 +140,17 @@ module RServiceBus2
         next if file_path.end_with?('.')
 
         msg_name = get_msg_name(file_path)
+        YamlSafeLoader.instance.add_permitted_class(msg_name
+                       .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1'))
         if File.directory?(file_path)
           load_handlers_from_second_level_path(msg_name, file_path)
-        else
-          # Classify
-          handler_name = "message_handler_#{msg_name}"
-                         .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
-          load_handler(msg_name, file_path, handler_name)
+          next
         end
+
+        # Classify
+        handler_name = "message_handler_#{msg_name}"
+                       .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
+        load_handler(msg_name, file_path, handler_name)
       end
 
       self

data/lib/rservicebus2/helper_functions.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 # Helper functions
 module RServiceBus2
+  def self.safe_load(body)
+    # YAML.safe_load(body, permitted_classes: Module.constants)
+    YamlSafeLoader.instance.load(body)
+  end
+
   def self.convert_dto_to_hash(obj)
     hash = {}
     obj.instance_variables.each do |var|

data/lib/rservicebus2/host.rb

@@ -99,6 +99,7 @@ module RServiceBus2
 
     def initialize
       RServiceBus2.rlog "Current directory: #{Dir.pwd}"
+      YamlSafeLoader.instance
       @config = ConfigFromEnv.new
                              .load_host_section
                              .load_contracts
@@ -162,7 +163,7 @@ module RServiceBus2
           body = @mq.pop
           begin
             @stats.inc_total_processed
-            @msg = YAML.load(body)
+            @msg = RServiceBus2.safe_load(body)
             case @msg.msg.class.name
             when 'RServiceBus2::MessageSubscription'
               @subscription_manager.add(@msg.msg.event_name,

data/lib/rservicebus2/message.rb

@@ -55,9 +55,9 @@ module RServiceBus2
 
     # @return [Object] The msg to be sent
     def msg
-      return YAML.load(Zlib::Inflate.inflate(@_msg)) if @compressed == true
+      return RServiceBus2.safe_load(Zlib::Inflate.inflate(@_msg)) if @compressed == true
 
-      YAML.load(@_msg)
+      RServiceBus2.safe_load(@_msg)
     rescue ArgumentError => e
       raise e if e.message.index('undefined class/module ').nil?
 

data/lib/rservicebus2/monitor/dir.rb

@@ -91,7 +91,7 @@ module RServiceBus2
     # rubocop:disable Metrics/MethodLength
     def read_content_from_file(file_path)
       content = ''
-      if @input_filter.positive?
+      if @input_filter.length.positive?
         case @input_filter[0]
         when 'ZIP'
           content = read_content_from_zip_file(file_path)
@@ -146,7 +146,8 @@ module RServiceBus2
         process_path(file_path)
 
         file_processed += 1
-        RServiceBus2.log "Processed #{file_processed} of #{file_list.length}.\nAllow system tick #{self.class.name}"
+        RServiceBus2.log "Processed #{file_processed} of #{file_list.length}."
+        RServiceBus2.log "Allow system tick #{self.class.name}"
 
         break if file_processed >= max_files_processed
       end

data/lib/rservicebus2/monitor/dirnotifier.rb

@@ -9,30 +9,46 @@ module RServiceBus2
   class MonitorDirNotifier < Monitor
     attr_reader :path, :processing_folder, :filter
 
+    def directory_not_writable(path, param_name)
+      "***** #{param_name} is not writable, #{path}.\n" \
+      "***** Make the directory, #{path}, writable and try again."
+    end
+
+    def directory_does_not_exist(path, param_name)
+      "***** #{param_name} does not exist, #{path}.\n" \
+      "***** Create the directory, #{path}, and try again.\n" \
+      "***** eg, mkdir #{path}"
+    end
+
+    def path_is_not_a_directory(path)
+      "***** The specified path does not point to a directory, #{path}.\n" \
+      "***** Either repoint path to a directory, or remove, #{path}, and create it as a directory.\n" \
+      "***** eg, rm #{path} && mkdir #{path}"
+    end
+
+    def processing_directory_not_specified(path)
+      '***** Processing Directory is not specified.' \
+      '***** Specify the Processing Directory as a query string in the Path URI' \
+      "***** eg, '/#{path}?processing=*ProcessingDir*'"
+    end
+
     def validate_directory(path, param_name)
       open_folder path
       return if File.writable?(path)
 
-      puts "***** #{param_name} is not writable, #{path}.\n
-           ***** Make the directory, #{path}, writable and try again."
+      puts directory_not_writable(path, param_name)
       abort
     rescue Errno::ENOENT
-      puts "***** #{param_name} does not exist, #{path}.\n" \
-           "***** Create the directory, #{path}, and try again.\n" \
-           "***** eg, mkdir #{path}"
+      puts directory_does_not_exist(path, param_name)
       abort
     rescue Errno::ENOTDIR
-      puts "***** The specified path does not point to a directory, #{path}.
-           ***** Either repoint path to a directory, or remove, #{path}, and create it as a directory.
-           ***** eg, rm #{path} && mkdir #{path}"
+      puts path_is_not_a_directory(path)
       abort
     end
 
     def validate_processing_directory(uri)
       if uri.query.nil?
-        puts '***** Processing Directory is not specified.' \
-             '***** Specify the Processing Directory as a query string in the Path URI' \
-             "***** eg, '/#{uri.path}?processing=*ProcessingDir*'"
+        puts processing_directory_not_specified(uri.path)
         abort
       end
 

data/lib/rservicebus2/mq/beanstalk.rb

@@ -16,19 +16,17 @@ module RServiceBus2
         @beanstalk = Beanstalk::Pool.new([string])
         @max_job_size = @beanstalk.stats['max-job-size']
         if @max_job_size < 4_194_304
-          puts "***WARNING: Lowest recommended.max-job-size is 4m, current
-                max-job-size, #{@max_job_size.to_f / (1024 * 1024)}m"
-          puts '***WARNING: Set the job size with the -z switch, eg
-                /usr/local/bin/beanstalkd -z 4194304'
+          puts '***WARNING: Lowest recommended.max-job-size is 4m, current ' \
+                "max-job-size, #{@max_job_size.to_f / (1024 * 1024)}m"
+          puts '***WARNING: Set the job size with the -z switch, eg ' \
+                '/usr/local/bin/beanstalkd -z 4194304'
         end
       rescue StandardError => e
         puts 'Error connecting to Beanstalk'
         puts "Host string, #{string}"
         if e.message == 'Beanstalk::NotConnected'
-          puts '***Most likely, beanstalk is not running. Start beanstalk,
-                  and try running this again.'
-          puts "***If you still get this error, check beanstalk is running
-                  at, #{string}"
+          puts '***Most likely, beanstalk is not running. Start beanstalk, and try running this again.'
+          puts "***If you still get this error, check beanstalk is running at, #{string}"
         else
           puts e.message
           puts e.backtrace

data/lib/rservicebus2/saga_storage/dir.rb

@@ -81,7 +81,7 @@ module RServiceBus2
 
       return {} if content == ''
 
-      YAML.load(content)
+      RServiceBus2.safe_load(content)
     end
   end
 end

data/lib/rservicebus2/sendat_storage/file.rb

@@ -16,7 +16,7 @@ module RServiceBus2
 
       return [] if content == ''
 
-      YAML.load(content)
+      RServiceBus2.safe_load(content)
     end
 
     def add(msg)

data/lib/rservicebus2/state_storage/dir.rb

@@ -61,7 +61,7 @@ module RServiceBus2
 
       return {} if content == ''
 
-      YAML.load(content)
+      RServiceBus2.safe_load(content)
     end
   end
 end

data/lib/rservicebus2/subscription_storage/file.rb

@@ -7,11 +7,11 @@ module RServiceBus2
       RServiceBus2.log 'Load subscriptions'
       return {} unless File.exist?(@uri.path)
 
-      YAML.load(File.open(@uri.path))
+      RServiceBus2.safe_load(File.open(@uri.path))
     end
 
     def add(event_name, queue_name)
-      s = File.exist?(@uri.path) ? YAML.load(File.open(@uri.path)) : {}
+      s = File.exist?(@uri.path) ? RServiceBus2.safe_load(File.open(@uri.path)) : {}
       s[event_name] = [] if s[event_name].nil?
 
       s[event_name] << queue_name

data/lib/rservicebus2/transporter.rb

@@ -114,7 +114,7 @@ module RServiceBus2
     def process
       # Get the next job from the source queue
       job = @source.reserve @timeout
-      msg = YAML.load(job.body)
+      msg = RServiceBus2.safe_load(job.body)
 
       connect(msg.remote_host_name)
 

data/lib/rservicebus2/yaml_safe_loader.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'singleton'
+
+# YamlSafeLoader
+class YamlSafeLoader
+  include Singleton
+
+  DEFAULT_PERMITTED_CLASSES = 'RServiceBus2::Message,Time,UUIDTools::UUID,YamlSafeLoader,' \
+                              'URI::Generic,URI::RFC3986_Parser,Symbol,Regexp'
+
+  def initialize
+    string = "#{RServiceBus2.get_value('PERMITTED_CLASSES_BASE', DEFAULT_PERMITTED_CLASSES)}," \
+             "#{RServiceBus2.get_value('PERMITTED_CLASSES', '')}"
+    @permitted_classes = CSV.parse(string)[0].reject { |c| c.to_s.rstrip.empty? }
+  end
+
+  def add_permitted_class(string)
+    @permitted_classes << string
+    @permitted_classes.uniq!
+  end
+
+  def load(body)
+    YAML.safe_load(body, permitted_classes: @permitted_classes)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rservicebus2
 version: !ruby/object:Gem::Version
-  version: 0.2.18
+  version: 0.2.23
 platform: ruby
 authors:
 - Guy Irvine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
@@ -165,6 +165,7 @@ files:
 - lib/rservicebus2/test/bus.rb
 - lib/rservicebus2/transporter.rb
 - lib/rservicebus2/usermessage/withpayload.rb
+- lib/rservicebus2/yaml_safe_loader.rb
 homepage: http://rubygems.org/gems/rservicebus2
 licenses:
 - LGPL-3.0