rservicebus2 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea0b8dd06a2280f3ca70bef921b34f4bad2c1d6a4c043a6accb119b83566940
-  data.tar.gz: b7607e7ed6a0fe7fbe935aa5b3cc2d27817973b33f96c5dda58d0651a1f17570
+  metadata.gz: 7cf46f6455ed14f25642855bd4839b0c910447bb07007bdb2dba0c9a65b7f4d0
+  data.tar.gz: 5ef71ec901e2d142d731d2dd8be176b297116ef8b6b07ab182c295496f1dfd85
 SHA512:
-  metadata.gz: 1963af8198779b9efabe33b85c236205fcdababb5a75e5b551d72073b9e4342818ac13878e2f533f295ca2e0a90be2767da641230d8382b15d4d485566fc9ac5
-  data.tar.gz: 06dc10763f2a56066405abbe7dff686d120d755f26d3ce8a3b6ca43152c31c8ca2f8826a51ec4fdb3a3d5bb836c4890770919b9cdd9ce603fb94eb4a710dbb0c
+  metadata.gz: 35999f1a63cf911f2dc2d2d9580dc3afd26f70203db43bf7c58ee079606bb318246e292ffd382ceadfe4747d37a826a0784b3407d611c1957d61b7ea266aef05
+  data.tar.gz: c19a66ce0e83b4c2ae617ed0e8b9827f91cf31c9820e7f0e8ba5f405f83792b097e5ed0bd9769faf331bd15c4bdfeaf9748cea40677c29e050f4f3d1d6e58815

data/lib/rservicebus2/agent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   class QueueNotFoundForMsg < StandardError
   end
@@ -22,9 +24,9 @@ module RServiceBus2
     # @param [Object] messageObj The msg to be sent
     # @param [String] queueName the name of the queue to be send the msg to
     # @param [String] returnAddress the name of a queue to send replies to
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength
     def send_msg(message_obj, queue_name, return_address = nil)
-      fail QueueNotFoundForMsg, message_obj.class.name if queue_name.nil?
+      raise QueueNotFoundForMsg, message_obj.class.name if queue_name.nil?
 
       msg = RServiceBus2::Message.new(message_obj, return_address)
       if queue_name.index('@').nil?
@@ -40,6 +42,7 @@ module RServiceBus2
 
       @mq.send(q, serialized_object)
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Gives an agent the means to receive a reply
     #

data/lib/rservicebus2/appresource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module RServiceBus2
@@ -8,7 +10,7 @@ module RServiceBus2
 
     # The method which actually connects to the resource.
     def connect(_uri)
-      fail 'Method, connect, needs to be implemented for resource'
+      raise 'Method, connect, needs to be implemented for resource'
     end
 
     def _connect
@@ -16,7 +18,7 @@ module RServiceBus2
       RServiceBus2.rlog "#{self.class.name}. Connected to, #{@uri}"
     end
 
-    def get_resource
+    def resource
       @connection
     end
 
@@ -44,22 +46,19 @@ module RServiceBus2
       rescue StandardError => e
         puts '** AppResource. An error was raised while closing connection
               to, ' + @uri
-        puts 'Message: ' + e.message
+        puts "Message: #{e.message}"
         puts e.backtrace
       end
       _connect
     end
 
     # Transaction Semantics
-    def begin
-    end
+    def begin; end
 
     # Transaction Semantics
-    def commit
-    end
+    def commit; end
 
     # Transaction Semantics
-    def rollback
-    end
+    def rollback; end
   end
 end

data/lib/rservicebus2/appresource/awsdynamodb.rb

@@ -1,18 +1,16 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-dynamodb'
 
 module RServiceBus2
   # AppResourceAWSDynamoDb
   class AppResourceAWSDynamoDb < AppResource
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def connect(uri)
       region = uri.host
 
-      aws = Aws::DynamoDB::Client.new(region: region)
-      puts "aws #{aws}"
-      aws
+      Aws::DynamoDB::Client.new(region: region)
     end
 
-    def finished
-    end
+    def finished; end
   end
 end

data/lib/rservicebus2/appresource/awss3.rb

@@ -0,0 +1,16 @@
+require 'aws-sdk-s3'
+
+module RServiceBus2
+  # AppResourceAWSDynamoDb
+  class AppResourceAWSS3 < AppResource
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def connect(uri)
+      region = uri.host
+
+      Aws::S3::Client.new(region: region)
+    end
+
+    def finished
+    end
+  end
+end

data/lib/rservicebus2/appresource/awssqs.rb

@@ -0,0 +1,25 @@
+require 'aws-sdk-sqs'
+require 'aws-sdk-sts'
+
+module RServiceBus2
+  # AppResourceAWSDynamoDb
+  class AppResourceAWSSQS < AppResource
+    def connect(uri)
+      queue_name = uri.path.sub('/', '')
+
+      region = uri.host
+
+      sts_client = Aws::STS::Client.new(region: region)
+      caller_identity_account = sts_client.get_caller_identity.account
+
+      queue_url = "https://sqs.#{region}.amazonaws.com/" \
+                  "#{caller_identity_account}/#{queue_name}"
+      {
+        client: Aws::SQS::Client.new(region: region),
+        url: queue_url
+      }
+    end
+
+    def finished; end
+  end
+end

data/lib/rservicebus2/appresource_configure.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module RServiceBus2
   # Configure AppResources for an rservicebus host
   class ConfigureAppResource
-    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     def get_resources(env, host, state_manager, saga_storage)
-      # rm = resource_manager
       rm = ResourceManager.new(state_manager, saga_storage)
+      # rubocop:disable Metrics/BlockLength
       env.each do |k, v|
         if v.is_a?(String) && k.start_with?('RSBFDB2_')
           uri = URI.parse(v)
@@ -15,8 +17,8 @@ module RServiceBus2
           k = k.sub('RSBFDB2_', '')
           rm.add k, AppResourceFluidDb2.new(host, uri)
         elsif v.is_a?(String) &&
-              (k.start_with?('RSBFDB_') || v.index('fluiddb') == 0)
-          v = v['fluiddb'.length..-1] if v.index('fluiddb') == 0
+              (k.start_with?('RSBFDB_') || v.start_with?('fluiddb'))
+          v = v['fluiddb'.length..-1] if v.start_with?('fluiddb')
           uri = URI.parse(v)
           require 'rservicebus2/appresource/fluiddb'
 
@@ -34,14 +36,22 @@ module RServiceBus2
           when 'awsdynamodb'
             require 'rservicebus2/appresource/awsdynamodb'
             rm.add k.sub('RSB_', ''), AppResourceAWSDynamoDb.new(host, uri)
+          when 'awss3'
+            require 'rservicebus2/appresource/awss3'
+            rm.add k.sub('RSB_', ''), AppResourceAWSS3.new(host, uri)
+          when 'awssqs'
+            require 'rservicebus2/appresource/awssqs'
+            rm.add k.sub('RSB_', ''), AppResourceAWSSQS.new(host, uri)
           else
             abort("Scheme, #{uri.scheme}, not recognised when configuring
                   app resource, #{k}=#{v}")
           end
         end
       end
+      # rubocop:enable Metrics/BlockLength
 
       rm
     end
+    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
   end
 end

data/lib/rservicebus2/audit.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Audit Class
   class Audit
-    def initialize(mq)
-      @mq = mq
+    def initialize(message_queue)
+      @mq = message_queue
       audit_queue_name = RServiceBus2.get_value('AUDIT_QUEUE_NAME')
       if audit_queue_name.nil?
         @sent_messages_to = RServiceBus2.get_value('sent_messages_to')

data/lib/rservicebus2/circuitbreaker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   class MessageArrivedWhileCricuitBroken < StandardError
   end
@@ -42,7 +44,7 @@ module RServiceBus2
       message_arrived
 
       ## logFirstFailure
-      if @number_of_failures == 0
+      if @number_of_failures.zero?
         @number_of_failures = 1
         @time_of_first_failure = Time.now
         @time_to_break = @time_of_first_failure + @seconds_to_break
@@ -68,7 +70,7 @@ module RServiceBus2
     def message_arrived
       reset if !@time_to_break.nil? && Time.now > @time_to_break
 
-      fail MessageArrivedWhileCricuitBroken if @broken == true
+      raise MessageArrivedWhileCricuitBroken if @broken == true
     end
 
     def break_circuit

data/lib/rservicebus2/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Marshals configuration information for an rservicebus host
   class Config
@@ -19,7 +21,7 @@ module RServiceBus2
     end
 
     def get_value(name, default = nil)
-      value = (ENV[name].nil? || ENV[name] == '') ? default : ENV[name]
+      value = ENV[name].nil? || ENV[name] == '' ? default : ENV[name]
       log "Env value: #{name}: #{value}"
       value
     end
@@ -131,21 +133,19 @@ module RServiceBus2
     # Note. trailing slashs will be stripped
     # Expected format: <path 1>;<path 2>
     def load_working_dir_list
-      puts "Config.load_working_dir_list.1"
-      puts "Config.load_working_dir_list.2 #{@contract_list}"
       path_list = get_value('WORKING_DIR', './')
       return self if path_list.nil?
 
       path_list.split(';').each do |path|
         path = path.strip.chomp('/')
-        unless Dir.exist?("#{path}")
+        unless Dir.exist?(path.to_s)
           puts 'Error while processing working directory list'
           puts "*** path, #{path}, does not exist"
           abort
         end
         @handler_path_list << "#{path}/messagehandler" if Dir.exist?("#{path}/messagehandler")
         @saga_path_list << "#{path}/saga" if Dir.exist?("#{path}/saga")
-        @contract_list << "#{path}/contract.rb" if File.exist?( "#{path}/contract.rb" )
+        @contract_list << "#{path}/contract.rb" if File.exist?("#{path}/contract.rb")
         @lib_list << "#{path}/lib" if File.exist?("#{path}/lib")
       end
       self
@@ -154,14 +154,14 @@ module RServiceBus2
 
   # Class
   class ConfigFromEnv < Config
-    def initialize
-    end
+    def initialize; end;
   end
 
   # Class
   class ConfigFromSetter < Config
-    attr_writer :appName, :messageEndpointMappings, :handler_path_list, :errorQueueName, :maxRetries, :forward_received_messages_to, :beanstalkHost
-    def initialize
-    end
+    attr_writer :app_name, :message_endpoint_mappings, :handler_path_list, :error_queue_name, \
+                :max_retries, :forward_received_messages_to, :beanstalk_host
+
+    def initialize; end;
   end
 end

data/lib/rservicebus2/cron_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parse-cron'
 
 module RServiceBus2
@@ -27,7 +29,8 @@ module RServiceBus2
       @msg_names.each do |n|
         list << n if Globber.new(name) =~ n
       end
-      fail NoMatchingMsgForCron, name if list.length == 0
+      raise NoMatchingMsgForCron, name if list.empty?
+
       list
     end
 
@@ -44,6 +47,7 @@ module RServiceBus2
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(host, msg_names = [])
       @bus = host
       @msg_names = msg_names
@@ -61,6 +65,7 @@ module RServiceBus2
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def run
       now = Time.now

data/lib/rservicebus2/endpointmapping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Marshals data for message end points
   # Expected format: <msg mame 1>:<end point 1>;<msg mame 2>:<end point 2>
@@ -6,16 +8,18 @@ module RServiceBus2
       RServiceBus2.get_value(name)
     end
 
-    def log(string, _ver = false)
+    def log(string, _ver: false)
       RServiceBus2.log(string)
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def configure_mapping(mapping)
       match = mapping.match(/(.+):(.+)/)
       if match.nil?
-        log 'Mapping string provided is invalid'
-        log "The entire mapping string is: #{mapping}"
-        log "*** Could not find ':' in mapping entry, #{line}"
+        log 'Mapping string provided is invalid\n' \
+            "The entire mapping string is: #{mapping}\n" \
+            "*** Could not find ':' in mapping entry, #{line}\n"
         exit
       end
 
@@ -23,16 +27,19 @@ module RServiceBus2
       @endpoints[match[1]] = match[2]
 
       @queue_name_list.each do |q|
-        if q != match[2] && q.downcase == match[2].downcase
-          log('*** Two queues specified with only case sensitive difference.')
-          log("*** #{q} != #{match[2]}")
-          log('*** If you meant these queues to be the same, please match case
-                and restart the bus.')
-        end
+        next unless q != match[2] && q.downcase == match[2].downcase
+
+        log('*** Two queues specified with only case sensitive difference.')
+        log("*** #{q} != #{match[2]}")
+        log('*** If you meant these queues to be the same, please match case
+              and restart the bus.')
       end
       @queue_name_list << match[2]
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
     def configure(local_queue_name = nil)
       log('EndpointMapping.Configure')
 
@@ -40,9 +47,9 @@ module RServiceBus2
       @queue_name_list << local_queue_name unless local_queue_name.nil?
 
       unless get_value('MESSAGE_ENDPOINT_MAPPING').nil?
-        log('*** MESSAGE_ENDPOINT_MAPPING environment variable was detected')
-        log("*** You may have intended MESSAGE_ENDPOINT_MAPPINGS, note the 'S'
-              on the end")
+        log '*** MESSAGE_ENDPOINT_MAPPING environment variable was detected\n' \
+            "*** You may have intended MESSAGE_ENDPOINT_MAPPINGS, note the 'S'
+              on the end"
       end
 
       mappings = get_value('MESSAGE_ENDPOINT_MAPPINGS')
@@ -54,6 +61,7 @@ module RServiceBus2
 
       self
     end
+    # rubocop:enable Metrics/MethodLength
 
     def initialize
       @endpoints = {}
@@ -65,7 +73,7 @@ module RServiceBus2
       nil
     end
 
-    def get_subscription_endpoints
+    def subscription_endpoints
       @endpoints.keys.select { |el| el.end_with?('Event') }
     end
   end

data/lib/rservicebus2/errormessage.rb

@@ -1,5 +1,6 @@
-module RServiceBus2
+# frozen_string_literal: true
 
+module RServiceBus2
   # Error Message
   class ErrorMessage
     attr_reader :occurredat, :source_queue, :error_msg

data/lib/rservicebus2/handler_loader.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Given a directory, this class is responsible for finding
   #  msgnames,
   #  handlernames, and
   #  loading handlers
   class HandlerLoader
-    attr_reader :handlerList
+    # attr_reader :handlerList - 8 May 2021
 
     # Constructor
     #
@@ -22,12 +24,11 @@ module RServiceBus2
     # Cleans the given path to ensure it can be used for as a parameter for the require statement.
     # @param [String] file_path the path to be cleaned
     def get_require_path(file_path)
-      file_path = './' + file_path unless file_path.start_with?('/')
+      file_path = "./#{file_path}" unless file_path.start_with?('/')
 
       return file_path.sub('.rb', '') if File.exist?(file_path)
 
-      abort('Filepath, ' + file_path + ", given for messagehandler require
-        doesn't exist")
+      abort("Filepath, #{file_path}, given for messagehandler require doesn't exist")
     end
 
     # Instantiate the handler named in handlerName from the file name in
@@ -38,6 +39,7 @@ module RServiceBus2
     # @param [String] handler_name name of the handler to instantiate
     # @param [String] file_path the path to the file to be loaded
     # @return [RServiceBus2::Handler] the loader
+    # rubocop:disable Metrics/MethodLength
     def load_handler_from_file(handler_name, file_path)
       require_path = get_require_path(file_path)
 
@@ -45,22 +47,22 @@ module RServiceBus2
       begin
         handler = Object.const_get(handler_name).new
       rescue StandardError => e
-        puts 'Expected class name: ' + handler_name + ', not found after
-          require: ' + require_path
-        puts '**** Check in ' + file_path + ' that the class is named : ' +
-          handler_name
-        puts '( In case its not that )'
+        puts "Expected class name: #{handler_name}, not found after require: #{require_path}\n" \
+             "**** Check in #{file_path} that the class is named: #{handler_name}\n" \
+             '( In case its not that )'
         raise e
       end
 
       handler
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Wrapper function
     #
     # @param [String] file_path
     # @param [String] handler_name
     # @returns [RServiceBus2::Handler] handler
+    # rubocop:disable Metrics/MethodLength
     def load_handler(msg_name, file_path, handler_name)
       if @list_of_loaded_paths.key?(file_path)
         RServiceBus2.log "Not reloading, #{file_path}"
@@ -68,29 +70,30 @@ module RServiceBus2
       end
 
       begin
-        RServiceBus2.rlog 'file_path: ' + file_path
-        RServiceBus2.rlog 'handler_name: ' + handler_name
+        RServiceBus2.rlog "file_path: #{file_path}"
+        RServiceBus2.rlog "handler_name: #{handler_name}"
 
         handler = load_handler_from_file(handler_name, file_path)
-        RServiceBus2.log 'Loaded Handler: ' + handler_name
+        RServiceBus2.log "Loaded Handler: #{handler_name}"
 
         @handler_manager.add_handler(msg_name, handler)
 
         @list_of_loaded_paths[file_path] = 1
       rescue StandardError => e
-        puts 'Exception loading handler from file: ' + file_path
+        puts "Exception loading handler from file: #{file_path}"
         puts e.message
         puts e.backtrace[0]
         abort
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # This method is overloaded for unit tests
     #
     # @param [String] path directory to check
     # @return [Array] a list of paths to files found in the given path
     def get_list_of_files_for_dir(path)
-      list = Dir[path + '/*']
+      list = Dir["#{path}/*"]
       RServiceBus2.rlog "HandlerLoader.getListOfFilesForDir. path: #{path},
         list: #{list}"
       list
@@ -105,14 +108,14 @@ module RServiceBus2
     def load_handlers_from_second_level_path(msg_name, base_dir)
       get_list_of_files_for_dir(base_dir).each do |file_path|
         next if file_path.end_with?('.')
+        next unless !File.directory?(file_path) && File.extname(file_path) == '.rb'
 
-        ext_name = File.extname(file_path)
-        if !File.directory?(file_path) && ext_name == '.rb'
-          file_name = File.basename(file_path).sub('.rb', '')
-          handler_name = "message_handler_#{msg_name}_#{file_name}".gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1') # Classify
+        file_name = File.basename(file_path).sub('.rb', '')
+        # Classify
+        handler_name = "message_handler_#{msg_name}_#{file_name}"
+                       .gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
 
-          load_handler(msg_name, file_path, handler_name)
-        end
+        load_handler(msg_name, file_path, handler_name)
       end
 
       self
@@ -130,22 +133,26 @@ module RServiceBus2
     # Load top level handlers from the given directory
     #
     # @param [String] baseDir directory to check - should not have trailing slash
+    # rubocop:disable Metrics/MethodLength
     def load_handlers_from_top_level_path(base_dir)
       RServiceBus2.rlog "HandlerLoader.loadHandlersFromTopLevelPath. baseDir: #{base_dir}"
       get_list_of_files_for_dir(base_dir).each do |file_path|
-        unless file_path.end_with?('.')
-          msg_name = get_msg_name(file_path)
-          if File.directory?(file_path)
-            load_handlers_from_second_level_path(msg_name, file_path)
-          else
-            handler_name = "message_handler_#{msg_name}".gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1') # Classify
-            load_handler(msg_name, file_path, handler_name)
-          end
+        next if file_path.end_with?('.')
+
+        msg_name = get_msg_name(file_path)
+        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)
         end
       end
 
       self
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Entry point for loading handlers
     #