rservicebus2 0.2.10 → 0.2.15

data/lib/rservicebus2/monitor/beanstalk.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'beanstalk-client'
+require 'cgi'
+
+module RServiceBus2
+  # Monitor S3 Bucket for objects
+  class MonitorBeanstalk < Monitor
+    def deduce_timeout(uri)
+      return 5 if uri.query.nil?
+
+      CGI.parse(u.query)['timeout1']&.first || 5
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def connect(uri)
+      @uri = uri
+      @timeout = deduce_timeout(uri)
+
+      queue_name = uri.path.sub('/', '')
+
+      port ||= 11_300
+      connection_string = "#{uri.host}:#{port}"
+      @beanstalk = Beanstalk::Pool.new([connection_string])
+
+      @beanstalk.watch(queue_name)
+      @message_uri = "beanstalk://#{uri.host}:#{port}/#{queue_name}"
+    rescue StandardError => e
+      puts "Error connecting to Beanstalk, Host string, #{connection_string}"
+      if e.message == 'Beanstalk::NotConnected'
+        puts '***Most likely, beanstalk is not running. Start beanstalk, and try running this again.\n' \
+             "***If you still get this error, check beanstalk is running at, #{connection_string}"
+        abort
+      end
+
+      puts e.message
+      puts e.backtrace
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def look
+      job = @beanstalk.reserve @timeout
+      send(job.body, "#{@message_uri}/#{job.id}")
+      job_body = job.body
+      job.delete
+      job_body
+    rescue StandardError => e
+      return if e.message == 'TIMED_OUT'
+
+      raise e
+    end
+  end
+end

data/lib/rservicebus2/monitor/dir.rb

@@ -1,38 +1,39 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'zip/zip'
 require 'zlib'
 
 module RServiceBus2
   # Monitor Directory for files
+
   # rubocop:disable Metrics/ClassLength
   class MonitorDir < Monitor
-    def connect(uri)
+    def input_dir(uri)
       # Pass the path through the Dir object to check syntax on startup
-      begin
-        input_dir = Dir.new(uri.path)
-        unless File.writable?(uri.path)
-          puts "***** Directory is not writable, #{uri.path}."
-          puts "***** Make the directory, #{uri.path}, writable and try again."
-          abort
-        end
-      rescue Errno::ENOENT
-        puts "***** Directory does not exist, #{uri.path}."
-        puts "***** Create the directory, #{uri.path}, and try again."
-        puts "***** eg, mkdir #{uri.path}"
-        abort
-      rescue Errno::ENOTDIR
-        puts "***** The specified path does not point to a directory,
-              #{uri.path}."
-        puts "***** Either repoint path to a directory, or remove, #{uri.path},
-              and create it as a directory."
-        puts "***** eg, rm #{uri.path} && mkdir #{uri.path}"
-        abort
-      end
+      return Dir.new(uri.path) if File.writable?(uri.path)
+
+      puts "***** Directory is not writable, #{uri.path}.\n" \
+           "***** Make the directory, #{uri.path}, writable and try again."
+      abort
+    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}.\n" \
+            "***** Either repoint path to a directory, or remove, #{uri.path}, and create it as a directory.\n" \
+            "***** eg, rm #{uri.path} && mkdir #{uri.path}"
+      abort
+    end
 
-      @path = input_dir.path
+    def connect(uri)
+      @path = input_dir(uri).path
       @input_filter = []
 
       return if uri.query.nil?
+
       parts = CGI.parse(uri.query)
       @querystringparts = parts
       if parts.key?('archive')
@@ -141,4 +142,5 @@ module RServiceBus2
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/rservicebus2/monitor/dirnotifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'fileutils'
 require 'pathname'
@@ -6,6 +8,7 @@ module RServiceBus2
   # Monitor for Directory
   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
@@ -45,7 +48,7 @@ module RServiceBus2
           begin
             open_folder processing_uri.path
             unless File.writable?(processing_uri.path)
-              puts "***** Processing Directory is not writable,
+              puts "***** 1Processing Directory is not writable,
                     #{processing_uri.path}."
               puts "***** Make the directory, #{processing_uri.path},
                     writable and try again."

data/lib/rservicebus2/monitor/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Monitor Message
   class MonitorMessage

data/lib/rservicebus2/monitor/xmldir.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rservicebus2/monitor/dir'
 require 'xmlsimple'
 

data/lib/rservicebus2/monitor_configure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rservicebus2/monitor'
 require 'rservicebus2/monitor/message'
 
@@ -16,56 +18,67 @@ module RServiceBus2
       @resource_list = {}
     end
 
+    def conditionally_set_app_resource(monitor, key, val)
+      monitor.instance_variable_set("@#{key}", val.resource)
+      @resource_list[monitor.class.name] = [] if @resource_list[monitor.class.name].nil?
+      @resource_list[monitor.class.name] << val
+      @host.log "App resource attribute, #{key}, set for: #{monitor.class.name}"
+    end
+
     # Assigns appropriate resources to writable attributes in the handler that
     #  match keys in the resource hash
     # @param [RServiceBus2::Handler] handler
-    def set_app_resources(monitor)
+    def conditionally_set_app_resources(monitor)
       RServiceBus2.rlog "Checking app resources for: #{monitor.class.name}"
-      RServiceBus2.rlog "If your attribute is not getting set, check that it is
-        in the 'attr_accessor' list"
+      RServiceBus2.rlog "If your attribute is not getting set, check that it is in the 'attr_accessor' list"
       @resource_manager.all.each do |k, v|
         next unless monitor.class.method_defined?(k)
 
-        monitor.instance_variable_set("@#{k}", v.resource)
-        @resource_list[monitor.class.name] = [] if
-          @resource_list[monitor.class.name].nil?
-        @resource_list[monitor.class.name] << v
-        @host.log "App resource attribute, #{k}, set for: " +
-          monitor.class.name
+        conditionally_set_app_resource(monitor, k, v)
       end
       self
     end
 
-    def get_monitors(env)
-      monitors = []
+    # rubocop:disable Metrics/MethodLength
+    def load_monitor(key, val)
+      name = key.sub('RSBOB_', '')
+      uri = URI.parse(val)
+      monitor = nil
+      case uri.scheme
+      when 'dir'
+        require 'rservicebus2/monitor/dir'
+        monitor = MonitorDir.new(@host, name, uri)
+      when 'awss3'
+        require 'rservicebus2/monitor/awss3'
+        monitor = MonitorAWSS3.new(@host, name, uri)
+      when 'awssqs'
+        require 'rservicebus2/monitor/awssqs'
+        monitor = MonitorAWSSQS.new(@host, name, uri)
+      when 'dirnotifier'
+        require 'rservicebus2/monitor/dirnotifier'
+        monitor = MonitorDirNotifier.new(@host, name, uri)
+      when 'beanstalk'
+        require 'rservicebus2/monitor/beanstalk'
+        monitor = MonitorBeanstalk.new(@host, name, uri)
+      else
+        abort("Scheme, #{uri.scheme}, not recognised when configuring
+          Monitor, #{key}=#{val}")
+      end
+      monitor
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def monitors(env)
+      list = []
 
       env.each do |k, v|
-        if v.is_a?(String) && k.start_with?('RSBOB_')
-          uri = URI.parse(v)
-          name = k.sub('RSBOB_', '')
-          monitor = nil
-          case uri.scheme
-          when 'dir'
-            require 'rservicebus2/monitor/dir'
-            monitor = MonitorDir.new(@host, name, uri)
-          when 'awss3'
-            require 'rservicebus2/monitor/awss3'
-            monitor = MonitorAWSS3.new(@host, name, uri)
-          when 'awssqs'
-            require 'rservicebus2/monitor/awssqs'
-            monitor = MonitorAWSSQS.new(@host, name, uri)
-          when 'dirnotifier'
-            require 'rservicebus2/monitor/dirnotifier'
-            monitor = MonitorDirNotifier.new(@host, name, uri)
-          else
-            abort("Scheme, #{uri.scheme}, not recognised when configuring
-              Monitor, #{k}=#{v}")
-          end
-          set_app_resources(monitor)
-          monitors << monitor
-        end
+        next unless v.is_a?(String) && k.start_with?('RSBOB_')
+
+        monitor = load_monitor(k, v)
+        conditionally_set_app_resources(monitor)
+        list << monitor
       end
-      monitors
+      list
     end
   end
 end

data/lib/rservicebus2/mq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module RServiceBus2
@@ -10,6 +12,7 @@ module RServiceBus2
   class MQ
     attr_reader :local_queue_name
 
+    # rubocop:disable Metrics/MethodLength
     def self.get
       mq_string = RServiceBus2.get_value('RSBMQ', 'beanstalk://localhost')
       uri = URI.parse(mq_string)
@@ -34,31 +37,26 @@ module RServiceBus2
 
       mq
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Resources are attached, and are be specified using the URI syntax
     # @param [URI] uri the type and location of queue,
     #  eg beanstalk://127.0.0.1/foo
     # @param [Integer] timeout the amount of time to wait for a msg to arrive
+
+    # rubocop:disable Metrics/MethodLength
     def initialize(uri)
-      if uri.is_a? URI
-        @uri = uri
-      else
-        puts 'uri must be a valid URI'
-        abort
-      end
+      abort 'Paramter to mq must be a valid URI' unless uri.is_a? URI
 
-      if uri.path == '' || uri.path == '/'
-        @local_queue_name = RServiceBus2.get_value('APPNAME', 'RServiceBus')
-      else
-        @local_queue_name = uri.path
-        @local_queue_name[0] = ''
-      end
+      @uri = uri
+      @local_queue_name = uri.path
+      @local_queue_name[0] = '' if @local_queue_name[0] == '/'
+      @local_queue_name = RServiceBus2.get_value('APPNAME', 'RServiceBus') if @local_queue_name == ''
 
       if @local_queue_name == ''
-        puts "@local_queue_name: #{@local_queue_name}"
-        puts 'Queue name must be supplied '
-        puts "*** uri, #{uri}, needs to contain a queue name"
-        puts '*** the structure is scheme://host[:port]/queuename'
+        puts 'Queue name must be supplied ' \
+             "*** uri, #{uri}, needs to contain a queue name" \
+             '*** the structure is scheme://host[:port]/queuename'
         abort
       end
 
@@ -66,42 +64,41 @@ module RServiceBus2
       connect(uri.host, uri.port)
       subscribe(@local_queue_name)
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Connect to the broker
     # @param [String] host machine runnig the mq
     # @param [String] port port the mq is running on
     def connect(_host, _port)
-      fail 'Method, connect, needs to be implemented'
+      raise 'Method, connect, needs to be implemented'
     end
 
     # Connect to the receiving queue
     # @param [String] queuename name of the receiving queue
     def subscribe(_queuename)
-      fail 'Method, subscribe, needs to be implemented'
+      raise 'Method, subscribe, needs to be implemented'
     end
 
     # Get next msg from queue
     def pop
-      fail 'Method, pop, needs to be implemented'
+      raise 'Method, pop, needs to be implemented'
     end
 
     # "Commit" the pop
     def ack
-      fail 'Method, ack, needs to be implemented'
+      raise 'Method, ack, needs to be implemented'
     end
 
     # At least called in the Host rescue block, to ensure all network links are
     #  healthy
     # @param [String] queue_name name of the queue to which the msg should be sent
     # @param [String] msg msg to be sent
-    def send(queue_name, msg)
-      begin
-        @connection.close
-      rescue
-        puts 'AppResource. An error was raised while closing connection to, ' + @uri.to_s
-      end
-
-end
-
-end
+    def send(_queue_name, _msg)
+      @connection.close
+    rescue StandardError => e
+      puts "AppResource. An error was raised while closing connection to, #{@uri}"
+      puts "Error: #{e.message}"
+      puts "Backtrace: #{e.backtrace}"
+    end
+  end
 end

data/lib/rservicebus2/saga_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RServiceBus2
   # Given a directory, this class is responsible loading Sagas
   class SagaLoader
@@ -17,11 +19,11 @@ module RServiceBus2
     #  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 Saga require doesn't exist")
+      abort("Filepath, #{file_path}, given for Saga require doesn't exist")
     end
 
     # Instantiate the saga named in sagaName from the file name in file_path
@@ -32,6 +34,8 @@ module RServiceBus2
     # @param [String] sagaName name of the saga to instantiate
     # @param [String] file_path the path to the file to be loaded
     # @return [RServiceBus2::Saga] the loader
+
+    # rubocop:disable Metrics/MethodLength
     def load_saga_from_file(saga_name, file_path)
       require_path = get_require_path(file_path)
 
@@ -39,52 +43,51 @@ module RServiceBus2
       begin
         saga = Object.const_get(saga_name)
       rescue StandardError => e
-        puts 'Expected class name: ' + saga_name + ', not found after require:
-          ' + require_path
-        puts '**** Check in ' + file_path + ' that the class is named : ' +
-          saga_name
-        puts '( In case its not that )'
+        puts "Expected class name: #{saga_name}, not found after require: #{require_path}" \
+             "**** Check in #{file_path} that the class is named: #{saga_name}" \
+             '( In case its not that )'
         raise e
       end
       saga
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Wrapper function
     # @param [String] file_path
     # @param [String] sagaName
     # @returns [RServiceBus2::Saga] saga
+
+    # rubocop:disable Metrics/MethodLength
     def load_saga(file_path, saga_name)
       if @list_of_loaded_paths.key?(file_path)
         RServiceBus2.log "Not reloading, #{file_path}"
         return
       end
 
-      begin
-        RServiceBus2.rlog 'file_path: ' + file_path
-        RServiceBus2.rlog 'saga_name: ' + saga_name
+      RServiceBus2.rlog "file_path: #{file_path}"
+      RServiceBus2.rlog "saga_name: #{saga_name}"
 
-        saga = load_saga_from_file(saga_name, file_path)
-        RServiceBus2.log 'Loaded Saga: ' + saga_name
+      saga = load_saga_from_file(saga_name, file_path)
+      RServiceBus2.log "Loaded Saga: #{saga_name}"
 
-        @saga_manager.register_saga(saga)
+      @saga_manager.register_saga(saga)
 
-        @list_of_loaded_paths[file_path] = 1
-      rescue StandardError => e
-        puts 'Exception loading saga from file: ' + file_path
-        puts e.message
-        puts e.backtrace[0]
-        abort
-      end
+      @list_of_loaded_paths[file_path] = 1
+    rescue StandardError => e
+      puts "Exception loading saga from file: #{file_path}"
+      puts e.message
+      puts e.backtrace[0]
+      abort
     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 "SagaLoader.getListOfFilesForDir. path: #{path},
-        list: #{list}"
+      RServiceBus2.rlog "SagaLoader.getListOfFilesForDir. path: #{path}, list: #{list}"
 
       list
     end
@@ -97,7 +100,7 @@ module RServiceBus2
 
       saga_name = base_name.sub(ext_name, '')
 
-      "saga_#{saga_name}".gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1')
+      "saga_#{saga_name}".gsub(/(?<=_|^)(\w)/) { Regexp.last_match(1).upcase }.gsub(/(?:_)(\w)/, '\1')
     end
 
     # Entry point for loading Sagas