bunny-pub-sub 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebf2dd45611315008e984f3ba704b303493287641d4bee5d38093fe3b590c961
+  data.tar.gz: e27dd48bb74db55c094649a22a3e38a71e21a9753acbafbc46fa21f4b27d0999
+SHA512:
+  metadata.gz: 4034d92342ebe378956c949041b9e73dce79751c2264d5f568ffc7f2aa9ffb0b81ca15d77c8380f04db971ada7d2cb3028df570bc2b14afff46dfeabf837f5c9
+  data.tar.gz: df35aea44be82b1300da5927c92b1e691b6f3a78da50717baf57eb713a8bb9fa695321d3f48023449f9d1008763257325fcc138748c736849443a8dc07173651

data/lib/bunny-pub-sub/helper/config_checks.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class ConfigError < StandardError; end
+
+def valid_config?(config)
+  raise ConfigError, 'CONFIG must not be nil' if config.nil?
+
+  flag = true, error_msgs = []
+  if config[:RABBITMQ_HOSTNAME].nil? ||
+     config[:RABBITMQ_HOSTNAME]&.strip&.empty?
+    error_msgs << 'Must define config variable RABBITMQ_HOSTNAME'
+    flag = false
+  end
+  if config[:RABBITMQ_USERNAME].nil? ||
+     config[:RABBITMQ_USERNAME]&.strip&.empty?
+    error_msgs << 'Must define config variable RABBITMQ_USERNAME'
+    flag = false
+  end
+  if config[:RABBITMQ_PASSWORD].nil? ||
+     config[:RABBITMQ_PASSWORD]&.strip&.empty?
+    error_msgs << 'Must define config variable RABBITMQ_PASSWORD'
+    flag = false
+  end
+  if config[:EXCHANGE_NAME].nil? ||
+     config[:EXCHANGE_NAME]&.strip&.empty?
+    error_msgs << 'Must define config variable EXCHANGE_NAME'
+    flag = false
+  end
+  if config[:DURABLE_QUEUE_NAME].nil? ||
+     config[:DURABLE_QUEUE_NAME]&.strip&.empty?
+    error_msgs << 'Must define config variable DURABLE_QUEUE_NAME'
+    flag = false
+  end
+  raise ConfigError, error_msgs unless flag
+
+  flag
+end
+
+# Subscriber only checks BEGIN =================================================
+# ==============================================================================
+def valid_binding_keys?(language_environments, type='topic')
+  # TODO: Exchanges of type `topic` PROBABLY can't simply have multiple
+  # words like `direct` exchanges.
+  # Rather they must be a list of words, delimited by dots.
+  # VERIFY and if true, ensure that all the strings in
+  # language_environments adhere to this rule.
+  # language_environments must be something like "#.csharp",
+  # "#.splashkit.csharp", "#.python", etc.
+  case type
+  when 'topic'
+    language_environments.each do |language_environment|
+      if !language_environment.is_a?(String) ||
+         language_environment.strip.empty?
+        # TODO: Add regex check here.
+        return false
+      end
+    end
+  end
+  true
+end
+
+def binding_keys_to_array(config)
+  language_environments = []
+  unless config[:DEFAULT_BINDING_KEY]&.strip&.empty?
+    language_environments.push(config[:DEFAULT_BINDING_KEY])
+  end
+
+  if !config[:BINDING_KEYS].nil? && !config[:BINDING_KEYS].empty?
+    # Pushing array to another array:
+    # https://stackoverflow.com/questions/1801516/how-do-you-add-an-array-to-another-array-in-ruby-and-not-end-up-with-a-multi-dim
+    language_environments = [language_environments | config[:BINDING_KEYS].split(',')].flatten
+  end
+
+  return nil if language_environments.empty?
+
+  valid_binding_keys?(language_environments) ? language_environments : nil
+end
+
+def at_least_one_binding_key_exists?(config)
+  if (config[:BINDING_KEYS].nil? &&
+     config[:DEFAULT_BINDING_KEY].nil?) ||
+     (config[:BINDING_KEYS]&.strip&.empty? &&
+     config[:DEFAULT_BINDING_KEY]&.strip&.empty?)
+    puts 'Either BINDING_KEYS or '\
+         'DEFAULT_BINDING_KEY must be defined and must not be empty'
+    false
+  else
+    true
+  end
+end
+
+# Subscriber only checks END ===================================================
+# ==============================================================================
+
+# Publisher only checks BEGIN ==================================================
+# ==============================================================================
+def routing_key_exists?(config)
+  if config[:ROUTING_KEY].nil? ||
+     config[:ROUTING_KEY]&.strip&.empty?
+    puts 'ROUTING_KEY must be defined and must not be empty'
+    false
+  else
+    true
+  end
+end
+
+# Publisher only checks END ====================================================
+# ==============================================================================

data/lib/bunny-pub-sub/publisher.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'helper/config_checks'
+require 'bunny'
+require 'json'
+
+class Publisher
+  attr_reader :connection
+  attr_reader :exchange
+  attr_reader :channel
+  attr_reader :config
+
+  def initialize(config)
+    return unless valid_config? config
+    return unless routing_key_exists? config
+
+    @config = config
+
+    @connection = Bunny.new(
+      hostname: @config[:RABBITMQ_HOSTNAME],
+      username: @config[:RABBITMQ_USERNAME],
+      password: @config[:RABBITMQ_PASSWORD]
+    )
+  end
+
+  def start_connection
+    ServicesManager.instance.start_connection(@connection, 0)
+  end
+
+  def create_channel
+    @channel = @connection.create_channel
+    @channel.confirm_select if @publisher_confirms
+  end
+
+  def set_topic_exchange
+    @exchange = @channel.topic(@config[:EXCHANGE_NAME], durable: true)
+  end
+
+  def connect_publisher(publisher_confirms = true)
+    start_connection
+    @publisher_confirms = publisher_confirms
+    create_channel
+    set_topic_exchange
+  end
+
+  def default_routing_key=(routing_key)
+    if routing_key.nil? || routing_key&.strip&.empty?
+      puts 'routing_key must be defined and must not be empty'
+      return
+    end
+
+    @config[:ROUTING_KEY] = routing_key
+  end
+
+  def unset_default_routing_key
+    @config[:ROUTING_KEY] = nil
+  end
+
+  def publish_message(msg, routing_key=nil)
+    if (routing_key.nil? || routing_key&.strip&.empty?) &&
+       (@config[:ROUTING_KEY].nil? || @config[:ROUTING_KEY]&.strip&.empty?)
+      return 'No default routing key exists in config. You must specify one.'
+    end
+
+    @exchange.publish(msg.to_json, routing_key: routing_key || @config[:ROUTING_KEY], persistent: true)
+    return puts ' [x] Message sent!' unless @publisher_confirms
+
+    success = @channel.wait_for_confirms
+    return puts ' [x] Message sent!' if success
+
+    @channel.nacked_set.each do |n|
+      # Do something with the nacked message ID
+      # TODO: Add a yielding block to this
+      puts " [x] Message #{n} failed."
+    end
+  end
+
+  def close_channel
+    @channel.close
+  end
+
+  def close_connection
+    @connection.close
+  end
+
+  def disconnect_publisher
+    close_channel
+    close_connection
+  end
+end

data/lib/bunny-pub-sub/services_manager.rb

@@ -0,0 +1,219 @@
+require_relative 'publisher.rb'
+require_relative 'subscriber.rb'
+require 'singleton'
+
+class ServicesManager
+  include Singleton
+  attr_reader :clients
+
+  def initialize
+    @clients = {}
+  end
+
+  def register_client(name,
+                      publisher_config = nil,
+                      subscriber_config = nil,
+                      action = nil,
+                      results_publisher = nil)
+
+    return unless valid_name? name, true
+    unless @clients[name].nil?
+      return puts "Service with the name: #{name} already registered"
+    end
+
+    @clients[name] = RabbitServiceClient.new name
+    return @clients[name] if publisher_config.nil?
+
+    # Note: results_publisher CAN be nil.
+    @clients[name].create_publisher publisher_config
+    return @clients[name] if subscriber_config.nil?
+
+    if action.nil?
+      @clients[name].create_subscriber_without_action(
+        subscriber_config, results_publisher
+      )
+      return @clients[name]
+    end
+
+    @clients[name].create_and_start_subscriber(
+      subscriber_config, action, results_publisher
+    )
+
+    @clients[name]
+  end
+
+  def create_client_publisher(name, config)
+    return unless valid_name? name
+
+    @clients[name].create_publisher config
+  end
+
+  def remove_client_publisher(name)
+    return unless valid_name? name
+
+    @clients[name].remove_publisher
+  end
+
+  def create_and_start_client_subscriber(
+    name, subscriber_config, action, results_publisher
+  )
+    return unless valid_name? name
+
+    @clients[name].create_and_start_subscriber(
+      subscriber_config, action, results_publisher
+    )
+  end
+
+  def cancel_and_remove_client_subscriber(name)
+    return unless valid_name? name
+
+    @clients[name].cancel_and_remove_subscriber
+  end
+
+  def deregister_client(name)
+    return unless valid_name? name
+
+    @clients[name].remove_all
+    @clients[name] = nil
+    @clients.delete name
+  end
+
+  def start_connection(connection, repeat)
+    (1 + repeat).times do 
+      begin
+        connection.start
+        return
+      rescue
+        puts 'Unable to start connection to rabbitmq -- delaying 10 seconds'
+        sleep(10) unless repeat == 0
+      end
+    end
+    raise "Unable to connect to rabbitmq"
+  end
+
+  private
+  def service_exists?(name)
+    return true unless @clients[name].nil?
+
+    puts "Service with the name: #{name} not found"
+    false
+  end
+
+  def name_is_symbol?(name)
+    return true if name.is_a? Symbol
+
+    puts "NAME: #{name} must be a symbol"
+    false
+  end
+
+  def valid_name?(name, new_service=false)
+    if name.nil?
+      puts "NAME must be a defined symbol and can't be empty"
+      return false
+    end
+    return false if !new_service && !service_exists?(name)
+    return false unless name_is_symbol? name
+
+    true
+  end
+
+  class RabbitServiceClient
+    attr_reader :subscriber
+    attr_reader :publisher
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def create_publisher(publisher_config)
+      publisher_created?
+      @publisher = Publisher.new publisher_config
+    end
+
+    def remove_publisher
+      return if @publisher.nil?
+
+      @publisher = nil
+    end
+
+    def action=(action)
+      valid_action? action
+      @action = action
+    end
+
+    def create_subscriber_without_action(subscriber_config,
+                                         results_publisher)
+
+      subscriber_created?
+
+      @subscriber_config = subscriber_config
+      @results_publisher = results_publisher
+      @subscriber = Subscriber.new subscriber_config, results_publisher
+    end
+
+    def create_and_start_subscriber(subscriber_config,
+                                    action,
+                                    results_publisher)
+
+      subscriber_created?
+
+      @subscriber_config = subscriber_config
+      @results_publisher = results_publisher
+
+      valid_action? action
+      @action = action
+
+      @subscriber = Subscriber.new subscriber_config, results_publisher
+      start_subscriber
+    end
+
+    def start_subscriber
+      @subscriber.start_subscriber(@action)
+    end
+
+    def cancel_and_remove_subscriber
+      return if @subscriber.nil?
+
+      @subscriber.cancel_subscriber
+      @subscriber = nil
+    end
+
+    def remove_all
+      remove_publisher
+      cancel_and_remove_subscriber
+    end
+
+    private
+    def subscriber_created?
+      return if @subscriber.nil?
+
+      raise 'A subscriber for this service client'\
+        ' has already been created and can\'t be'\
+        ' created again. Please create a new RabbitServiceClient.'
+    end
+
+    def publisher_created?
+      return if @publisher.nil?
+
+      raise 'A publisher for this service client'\
+        ' has already been created and can\'t be'\
+        ' created again. Please create a new RabbitServiceClient.'
+    end
+
+    def valid_action?(action)
+      unless @action.nil?
+        raise 'An action has already been set'\
+        ' for this subscriber. A service\'s'\
+        ' action can only be set once.'
+      end
+
+      return unless action.nil?
+
+      raise 'Subscriber action can\'t be set to nil.'\
+      ' Halting the program.'
+
+      # TODO: Check if action is of the right type.
+    end
+  end
+end

data/lib/bunny-pub-sub/subscriber.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'bunny'
+require 'json'
+require_relative 'helper/config_checks'
+require_relative 'publisher'
+
+class ErrorReporter < RuntimeError
+  attr_reader :status
+
+  def self.publisher=(publisher)
+    @@publisher = publisher
+  end
+
+  def self.publisher
+    @@publisher
+  end
+
+  def initialize(message, status = 400)
+    unless @@publisher.nil?
+      @@publisher.connect_publisher
+      @@publisher.publish_message message
+      @@publisher.disconnect_publisher
+    end
+    @status = status
+    super(message)
+  end
+end
+
+class Subscriber
+  attr_reader :cancel_ok
+  class ClientException < ErrorReporter
+    def initialize(message, status = 400)
+      puts "Client error: #{message}, #{status}"
+      super(message, status)
+    end
+  end
+
+  class ServerException < ErrorReporter
+    def initialize(message, status = 500)
+      puts "Server error: #{message}, #{status}"
+      super(message, status)
+    end
+  end
+
+  def client_error!(message, status, _headers = {}, _backtrace = [])
+    raise ClientException.new message, status
+  end
+
+  def server_error!(message, status, _headers = {}, _backtrace = [])
+    raise ServerException.new message, status
+  end
+
+  def initialize(subscriber_config, results_publisher)
+    return unless valid_config? subscriber_config
+    return unless at_least_one_binding_key_exists? subscriber_config
+
+    subscriber_config[:BINDING_KEYS] = binding_keys_to_array subscriber_config
+    return if subscriber_config[:BINDING_KEYS].nil?
+
+    ServerException.publisher = results_publisher
+    ClientException.publisher = results_publisher
+
+    @subscriber_config = subscriber_config
+    @results_publisher = results_publisher
+  end
+
+  def start_subscriber(callback)
+    @connection = Bunny.new(
+      hostname: @subscriber_config[:RABBITMQ_HOSTNAME],
+      username: @subscriber_config[:RABBITMQ_USERNAME],
+      password: @subscriber_config[:RABBITMQ_PASSWORD]
+    )
+    ServicesManager.instance.start_connection(@connection, 6)
+
+    @channel = @connection.create_channel
+    # With the created communication @channel, create/join an existing exchange
+    # of the TYPE 'topic' and named as 'assessment'
+    # Durable exchanges survive broker restart while transient exchanges do not.
+    topic_exchange = @channel.topic(@subscriber_config[:EXCHANGE_NAME], durable: true)
+
+    # Use this for making rabbitMQ not give a worker more than 1 jobs
+    # if it is already working on one.
+    # @channel.prefetch(1)
+
+    queue = @channel.queue(@subscriber_config[:DURABLE_QUEUE_NAME], durable: true)
+
+    @subscriber_config[:BINDING_KEYS].each do |language_environment|
+      queue.bind(topic_exchange, routing_key: language_environment)
+    end
+
+    begin
+      puts ' [*] Waiting for messages. To exit press CTRL+C'
+
+      @consumer = queue.subscribe(manual_ack: true, block: true) do |delivery_info, properties, params|
+        callback.call(self, @channel, @results_publisher, delivery_info, properties, params)
+      end
+    rescue Interrupt => _e
+      @channel.close
+      @connection.close
+
+      exit(0)
+    end
+  end
+
+  # TODO: Fix this. Probably doesn't work because
+  # @consumer has no value assigned to it.
+  def cancel_subscriber
+    @cancel_ok = @consumer.cancel
+    puts 'Consumer cancelled:'
+    puts @cancel_ok.inspect
+  rescue RuntimeError => e
+    puts e
+  ensure
+    @channel.close
+    @connection.close
+  end
+
+  # We can't privatize the exception classes because they are being
+  # used in rescue blocks.
+  # private_constant :ServerException
+  # private_constant :ClientException
+end
+
+def register_subscriber(subscriber_config,
+                        action,
+                        results_publisher)
+
+  subscriber_instance = Subscriber.new subscriber_config, results_publisher
+  subscriber_instance.start_subscriber(action)
+  subscriber_instance
+rescue RuntimeError => e
+  puts e
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: bunny-pub-sub
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Akash Agarwal
+- Andrew Cain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Bunny publisher/subscriber client gemfor OnTrack and Overseer.
+email:
+- agarwal.akash333@gmail.com
+- macite@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bunny-pub-sub/helper/config_checks.rb
+- lib/bunny-pub-sub/publisher.rb
+- lib/bunny-pub-sub/services_manager.rb
+- lib/bunny-pub-sub/subscriber.rb
+homepage: https://github.com/doubtfire-lms/bunny-pub-sub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: bunny-pub-sub
+test_files: []