rservicebus2 0.2.17 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 920ff69a3fdd0f96882ed1c8bc12dd82d78ed789fa92c664f1b80f1484365058
-  data.tar.gz: c41fa4a4284bfba83865cc6bac87e54312c26b556a6605f6e73022b8716c921c
+  metadata.gz: bdf786cee730fd3a1cb0ecb384d566ead93171cfa566b2b23bff09ab4dc75116
+  data.tar.gz: 4f8d812c2cf83ce2c1c561038d6d7b545afdb4e8ba5db414554fda52e19eb3d0
 SHA512:
-  metadata.gz: e68d15cc10acdb2565ab02d6d8cfd3dc8b1a871becfe9a6b66f319d763526c16df8977456aadec9b5c2cc66595082bfde320a02458e384b2753b7be68cc01726
-  data.tar.gz: f1c1c5ea85bf0920206067b92b58544068084b0e631c29ce6fdb00783114f87e507d59d3f2c237d1b307a9b3df7430deaf8ef74bf020ca6874c029801bfe99b0
+  metadata.gz: 3787ed00c7dd8947ae2e1b000f3953afb34ceb8ffce6925f9c97a3d7ce67cf8d10e2e0d7989da8b7abee110a608066a8e1f95acb752665376beb811a0636d519
+  data.tar.gz: c8f21f22ea7132ecdf43d6a14c681f68071def8e611ab91e1388fa2dbeaf38ad02c2e89ce9ded75551e444ade20eea54d0493f9252fee2dca2e5cab2fd6c3891

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/appresource.rb

@@ -33,7 +33,7 @@ module RServiceBus2
       finished
     end
 
-    # A notification that ocurs after getResource, to allow cleanup
+    # Allow for cleanup, outside of transaction semantics
     def finished
       @connection.close
     end
@@ -53,12 +53,18 @@ module RServiceBus2
     end
 
     # Transaction Semantics
-    def begin; end
+    def begin
+      RServiceBus2.rlog "#{self.class.name}. Default transaction.begin called"
+    end
 
     # Transaction Semantics
-    def commit; end
+    def commit
+      RServiceBus2.rlog "#{self.class.name}. Default transaction.commit called"
+    end
 
     # Transaction Semantics
-    def rollback; end
+    def rollback
+      RServiceBus2.rlog "#{self.class.name}. Default transaction.rollback called"
+    end
   end
 end

data/lib/rservicebus2/appresource/awsdynamodb.rb

@@ -11,6 +11,8 @@ module RServiceBus2
       Aws::DynamoDB::Client.new(region: region)
     end
 
-    def finished; end
+    def finished
+      RServiceBus2.rlog "#{self.class.name}. Finished"
+    end
   end
 end

data/lib/rservicebus2/appresource/awss3.rb

@@ -11,6 +11,8 @@ module RServiceBus2
       Aws::S3::Client.new(region: region)
     end
 
-    def finished; end
+    def finished
+      RServiceBus2.rlog "#{self.class.name}. Finished"
+    end
   end
 end

data/lib/rservicebus2/appresource/awssqs.rb

@@ -22,6 +22,8 @@ module RServiceBus2
       }
     end
 
-    def finished; end
+    def finished
+      RServiceBus2.rlog "#{self.class.name}. Finished"
+    end
   end
 end

data/lib/rservicebus2/appresource/fluiddb2.rb

@@ -18,8 +18,8 @@ module RServiceBus2
     def commit
       @connection.commit
     end
-    # Transaction Semantics
 
+    # Transaction Semantics
     def rollback
       @connection.rollback
     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

@@ -162,7 +162,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.rb

@@ -36,7 +36,9 @@ module RServiceBus2
     end
 
     # A notification that allows cleanup
-    def finished; end
+    def finished
+      RServiceBus2.rlog "#{self.class.name}. Default Finished"
+    end
 
     # At least called in the Host rescue block, to ensure all network links
     #  are healthy

data/lib/rservicebus2/monitor/dir.rb

@@ -9,6 +9,7 @@ module RServiceBus2
 
   # rubocop:disable Metrics/ClassLength
   class MonitorDir < Monitor
+    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
     def input_dir(uri)
       # Pass the path through the Dir object to check syntax on startup
       return Dir.new(uri.path) if File.writable?(uri.path)
@@ -27,42 +28,47 @@ module RServiceBus2
             "***** eg, rm #{uri.path} && mkdir #{uri.path}"
       abort
     end
+    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
-    # rubocop:disable Metrics/MethodLength
-    def connect(uri)
-      @path = input_dir(uri).path
-      @input_filter = []
-
-      return if uri.query.nil?
+    def initialise_archive(parts)
+      return unless parts.key?('archive')
 
-      parts = CGI.parse(uri.query)
-      @querystringparts = parts
-      if parts.key?('archive')
-        archiveuri = URI.parse(parts['archive'][0])
-        unless File.directory?(archiveuri.path)
-          puts '***** Archive file name templating not yet supported.'
-          puts "***** Directory's only."
-          abort
-        end
-        @archivedir = archiveuri.path
+      archiveuri = URI.parse(parts['archive'][0])
+      unless File.directory?(archiveuri.path)
+        puts '***** Archive file name templating not yet supported.'
+        puts "***** Directory's only."
+        abort
       end
+      @archivedir = archiveuri.path
+    end
 
-      return unless parts.key?('input_filter')
-
+    def initialise_input_filter(parts)
       if parts['input_filter'].count > 1
-        puts 'Too many input_filters specified.'
-        puts '*** ZIP, or GZ are the only valid input_filters.'
+        puts 'Too many input_filters specified.\n*** ZIP, or GZ are the only valid input_filters.'
         abort
       end
 
       unless %w[ZIP GZ TAR].include?(parts['input_filter'][0]).nil?
-        puts 'Invalid input_filter specified.'
-        puts '*** ZIP, or GZ are the only valid input_filters.'
+        puts 'Invalid input_filter specified.\n' \
+             '*** ZIP, or GZ are the only valid input_filters.'
         abort
       end
+
       @input_filter << parts['input_filter'][0]
     end
-    # rubocop:enable Metrics/MethodLength
+
+    def connect(uri)
+      @path = input_dir(uri).path
+      @input_filter = []
+
+      return if uri.query.nil?
+
+      parts = CGI.parse(uri.query)
+      @querystringparts = parts
+      initialise_archive(parts)
+
+      initialise_input_filter(parts) if parts.key?('input_filter')
+    end
 
     def process_content(content)
       content
@@ -85,14 +91,14 @@ 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)
         when 'GZ'
           content = read_content_from_gz_file(file_path)
-        when 'TAR'
-          raise 'TAR reader not implemented'
+        else
+          raise "#{@input_filter[0]} reader not implemented."
         end
 
       else
@@ -103,14 +109,6 @@ module RServiceBus2
     end
     # rubocop:enable Metrics/MethodLength
 
-    def process_path(file_path)
-      content = read_content_from_file(file_path)
-      payload = process_content(content)
-
-      send(payload, URI.parse(CGI.escape("file://#{file_path}")))
-      content
-    end
-
     def archive_file(file_path, content)
       basename = File.basename(file_path)
       new_file_path = "#{@archivedir}/#{basename}.#{Time.now.strftime('%Y%m%d%H%M%S%L')}.zip"
@@ -122,24 +120,34 @@ module RServiceBus2
       end
     end
 
+    def process_path(file_path)
+      if File.file?(file_path) != true
+        RServiceBus2.log "Skipping directory, #{file_path}"
+        return
+      end
+
+      RServiceBus2.log "Ready to process, #{file_path}"
+      content = read_content_from_file(file_path)
+      payload = process_content(content)
+
+      send(payload, URI.parse(CGI.escape("file://#{file_path}")))
+
+      archive_file(file_path, content) unless @archivedir.nil?
+
+      File.unlink(file_path)
+    end
+
     def look
       file_processed = 0
       max_files_processed = 10
 
       file_list = Dir.glob("#{@path}/*")
       file_list.each do |file_path|
-        if File.file?(file_path) != true
-          RServiceBus2.log "Skipping directory, #{file_path}"
-          next
-        end
-        RServiceBus2.log "Ready to process, #{file_path}"
-        content = process_path(file_path)
-
-        archive_file(file_path, content) unless @archivedir.nil?
-        File.unlink(file_path)
+        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,67 +9,66 @@ module RServiceBus2
   class MonitorDirNotifier < Monitor
     attr_reader :path, :processing_folder, :filter
 
-    def connect(uri)
-      # Pass the path through the Dir object to check syntax on startup
-      begin
-        open_folder uri.path
-        unless File.writable?(uri.path)
-          puts "***** Directory is not writable, #{uri.path}.\n" \
-               "***** Make the directory, #{uri.path}, writable and try again."
-          abort
-        end
-      rescue Errno::ENOENT
-        puts "***** Directory does not exist, #{uri.path}.\n" \
-             "***** Create the directory, #{uri.path}, and try again.\n" \
-             "***** eg, mkdir #{uri.path}"
-        abort
-      rescue Errno::ENOTDIR
-        puts "***** The specified path does not point to a directory, #{uri.path}." \
-             "***** Either repoint path to a directory, or remove, #{uri.path}, and create it as a directory." \
-             "***** eg, rm #{uri.path} && mkdir #{uri.path}"
-        abort
-      end
+    def directory_not_writable(path, param_name)
+      "***** #{param_name} is not writable, #{path}.\n" \
+      "***** Make the directory, #{path}, writable and try again."
+    end
 
-      @path = uri.path
+    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 directory_not_writable(path, param_name)
+      abort
+    rescue Errno::ENOENT
+      puts directory_does_not_exist(path, param_name)
+      abort
+    rescue Errno::ENOTDIR
+      puts path_is_not_a_directory(path)
+      abort
+    end
+
+    def validate_processing_directory(uri)
       if uri.query.nil?
-        puts '***** Processing Directory is not specified.'
-        puts '***** Specify the Processing Directory as a query string in the
-              Path URI'
-        puts "***** eg, '/#{uri.path}?processing=*ProcessingDir*"
+        puts processing_directory_not_specified(uri.path)
         abort
-      else
-        parts = CGI.parse(uri.query)
-
-        if parts.key? 'processing'
-          processing_uri = URI.parse parts['processing'][0]
-          begin
-            open_folder processing_uri.path
-            unless File.writable?(processing_uri.path)
-              puts "***** 1Processing Directory is not writable,
-                    #{processing_uri.path}."
-              puts "***** Make the directory, #{processing_uri.path},
-                    writable and try again."
-              abort
-            end
-          rescue Errno::ENOENT
-            puts "***** Processing Directory does not exist, #{processing_uri.path}." \
-                 "***** Create the directory, #{processing_uri.path}, and try again." \
-                 "***** eg, mkdir #{processing_uri.path}"
-            abort
-          rescue Errno::ENOTDIR
-            puts "***** Processing Directory does not point to a directory, #{processing_uri.path}." \
-                 "***** Either repoint path to a directory, or remove, #{processing_uri.path}, and create it as a directory.\n" \
-                 "***** eg, rm #{processing_uri.path} && mkdir #{processing_uri.path}"
-            abort
-          end
-
-          @processing_folder = processing_uri.path
-        end
-
-        @filter = '*'
-        @filter = parts['filter'][0] if parts.key? 'filter'
       end
+
+      parts = CGI.parse(uri.query)
+      return unless parts.key? 'processing'
+
+      processing_uri = URI.parse parts['processing'][0]
+      validate_directory processing_uri.path, 'Processing Directory'
+      @processing_folder = processing_uri.path
+    end
+
+    def connect(uri)
+      # Pass the path through the Dir object to check syntax on startup
+
+      validate_directory uri, 'Directory'
+      @path = uri.path
+      validate_processing_directory(uri)
+
+      @filter = '*'
+      @filter = parts['filter'][0] if parts.key? 'filter'
     end
 
     def look

data/lib/rservicebus2/mq/aws.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-sqs'
 require 'aws-sdk-sts'
 require 'rservicebus2/mq'
@@ -6,75 +8,59 @@ module RServiceBus2
   # Beanstalk client implementation.
   class MQAWS < MQ
     # Connect to the broker
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-    def connect(region, port)
-      begin
-        @max_job_size = 4_194_304
-        @region = region
+    def connect(region, _port)
+      @max_job_size = 4_194_304
+      @region = region
 
-        sts_client = Aws::STS::Client.new(region: region)
-        @caller_identity_account = sts_client.get_caller_identity.account
-      rescue StandardError => e
-        puts 'Error connecting to AWS'
-        puts "Host string, #{region}"
-        puts e.message
-        puts e.backtrace
-        abort
-      end
+      sts_client = Aws::STS::Client.new(region: region)
+      @caller_identity_account = sts_client.get_caller_identity.account
+    rescue StandardError => e
+      puts 'Error connecting to AWS'
+      puts "Host string, #{region}"
+      puts e.message
+      puts e.backtrace
+      abort
     end
 
     def subscribe(queuename)
       # For example:
       # 'https://sqs.us-east-1.amazonaws.com/111111111111/my-queue'
-      @queue_url = 'https://sqs.' + @region + '.amazonaws.com/' +
-        @caller_identity_account + '/' + queuename
+      @queue_url = "https://sqs.#{@region}.amazonaws.com/#{@caller_identity_account}/#{queuename}"
       @sqs_client = Aws::SQS::Client.new(region: @region)
     end
 
     # Get next msg from queue
     def pop
-      begin
-        response = @sqs_client.receive_message(
-          queue_url: @queue_url,
-          max_number_of_messages: 1
-        )
+      response = @sqs_client.receive_message(queue_url: @queue_url, max_number_of_messages: 1)
 
-        if response.messages.count.zero?
-          raise NoMsgToProcess
-        end
+      raise NoMsgToProcess if response.messages.count.zero?
 
-        response.messages.each do |message|
-          @job = message
-        end
-      rescue StandardError => e
-        raise e
+      response.messages.each do |message|
+        @job = message
       end
+    rescue StandardError => e
+      raise e
+    ensure
       @job.body
     end
 
     def return_to_queue
-#      @job.release if @job
       @job = nil
     end
 
     def ack
-      @sqs_client.delete_message({
-        queue_url: @queue_url,
-        receipt_handle: @job.receipt_handle
-      })
+      @sqs_client.delete_message({ queue_url: @queue_url, receipt_handle: @job.receipt_handle })
       @job = nil
     end
 
     def send(queue_name, msg)
       if msg.length > @max_job_size
-        puts '***Attempting to send a msg which will not fit on queue.'
-        puts "***Msg size, #{msg.length}, max msg size, #{@max_job_size}."
-        fail JobTooBigError, "Msg size, #{msg.length}, max msg size,
-              #{@max_job_size}"
+        puts '***Attempting to send a msg which will not fit on queue.' \
+             "***Msg size, #{msg.length}, max msg size, #{@max_job_size}."
+        raise JobTooBigError, "Msg size, #{msg.length}, max msg size, #{@max_job_size}"
       end
 
-      queue_url = 'https://sqs.' + @region + '.amazonaws.com/' +
-        @caller_identity_account + '/' + queue_name
+      queue_url = "https://sqs.#{@region}.amazonaws.com/#{@caller_identity_account}/#{queue_name}"
 
       @sqs_client.send_message(
         queue_url: queue_url,

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/mq/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'rservicebus2/mq'
 
@@ -5,18 +7,10 @@ module RServiceBus2
   # Beanstalk client implementation.
   class MQFile < MQ
     # Connect to the broker
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-    
+
     def initialize(uri)
-      if uri.is_a? URI
-        @uri = uri
-      else
-        puts 'uri must be a valid URI'
-        abort
-      end
+      super
 
-      FileUtils.mkdir_p(@uri.path)
-      @local_queue_name = RServiceBus2.get_value('APPNAME', 'RServiceBus')
       FileUtils.mkdir_p("#{@uri.path}/#{@local_queue_name}")
       @timeout = RServiceBus2.get_value('QUEUE_TIMEOUT', '5').to_i
     end
@@ -28,24 +22,23 @@ module RServiceBus2
     end
 
     # Get next msg from queue
+    # rubocop:disable Metrics/MethodLength
     def pop
       time = @timeout
-      while time > 0
+      while time.positive?
         files = Dir.glob("#{@uri.path}/#{@local_queue_name}/*.msg")
-        if files.length > 0
-          @file_path = files[0] 
+        if files.positive?
+          @file_path = files[0]
           @body = IO.read(@file_path)
-	  return @body
+          return @body
         end
-	time -= 1
-	sleep(1)
+        time -= 1
+        sleep(1)
       end
-	
-      raise NoMsgToProcess if files.length == 0
-    end
 
-    def return_to_queue
+      raise NoMsgToProcess if files.length.zero?
     end
+    # rubocop:enable Metrics/MethodLength
 
     def ack
       FileUtils.rm @file_path
@@ -53,7 +46,7 @@ module RServiceBus2
 
     def send(queue_name, msg)
       FileUtils.mkdir_p("#{@uri.path}/#{queue_name}")
-      IO.write("#{@uri.path}/#{queue_name}/#{rand()}.msg", msg)
+      IO.write("#{@uri.path}/#{queue_name}/#{rand}.msg", msg)
     end
   end
 end

data/lib/rservicebus2/mq/redis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'redis'
 require 'rservicebus2/mq'
 
@@ -5,38 +7,31 @@ module RServiceBus2
   # Redis client implementation.
   class MQRedis < MQ
     # Connect to the broker
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def connect(host, port)
       port ||= 6379
       string = "#{host}:#{port}"
 
-      begin
-        @redis = Redis.new(:host => host, :port => port)
-
-      rescue Exception => e
-        puts e.message
-        puts 'Error connecting to Redis for mq'
-        puts "Host string, #{string}"
-        abort()
-      end
+      @redis = Redis.new(host: host, port: port)
+    rescue StandardError => e
+      puts e.message
+      puts 'Error connecting to Redis for mq'
+      puts "Host string, #{string}"
+      abort
     end
 
     # Connect to the queue
-    def subscribe( queuename )
+    def subscribe(queuename)
       @queuename = queuename
     end
 
     # Get next msg from queue
     def pop
-      if @redis.llen( @queuename ) == 0 then
+      if @redis.llen(@queuename).zero?
         sleep @timeout
-        raise NoMsgToProcess.new
+        raise NoMsgToProcess
       end
 
-      return @redis.lindex @queuename, 0
-    end
-
-    def returnToQueue
+      @redis.lindex @queuename, 0
     end
 
     # "Commit" queue
@@ -45,9 +40,8 @@ module RServiceBus2
     end
 
     # At least called in the Host rescue block, to ensure all network links are healthy
-    def send( queueName, msg )
-      @redis.rpush queueName, msg
+    def send(queue_name, msg)
+      @redis.rpush queue_name, msg
     end
-
   end
 end

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,33 @@
+# 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 init
+    return unless @permitted_classes.nil?
+
+    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)
+    init
+
+    @permitted_classes << string
+    @permitted_classes.uniq!
+  end
+
+  def load(body)
+    init
+
+    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.17
+  version: 0.2.22
 platform: ruby
 authors:
 - Guy Irvine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-01 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