rmessage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 027c26a46e85945a595e17f63f468b7db4bbc5445e62337e72aba85136ebd089
+  data.tar.gz: 5059e66328f264c26c20d42ab152dc4d1486b02f7990a87dec54560f94455def
+SHA512:
+  metadata.gz: a7a1371e9e285c7f8313478f8ee7ecdce68d90b411922ed321d634781122a375534278439bfa02c175bfd1448212f08008339ada3b73e23306d27554e56cde21
+  data.tar.gz: ffdc5a57b6e9d5a99f9f22536478c45287076cc03a1fa2ac6ce25778f90b8b9e3f3ea316632a7d771c995f6c97e912ab479f4181010c2ee696513b3d415718b7

data/lib/rmessage/message.rb

@@ -0,0 +1,81 @@
+module RMessage
+  # A Message encapsulates a JSON payload that is sent to or received from Redis.
+  class Message
+
+    # @!attribute [r] label
+    # @return [Symbol, String] the label.
+    attr :label
+
+    # @!attribute [r] signature
+    # @return [Integer, String] the signature.
+    attr :signature
+
+    # @!attribute [r] payload
+    # @return [Hash] the payload.
+    attr :payload
+
+    # Constructs a new Message
+    # @param opts [Hash] message options
+    # * label [Symbol, String] the Message label
+    # * signature [Integer, String] the Message signature
+    # * payload [Hash, String] the Message data
+    # @param data [Hash, String] message data
+    def initialize(opts = {}, data = nil)
+      @label = opts[:label] || :UNTITLED
+      @signature = opts[:signature] || Druuid.gen
+      @payload = data || opts[:payload]
+    end
+
+    # Read and parse data. Defaults to the Message#payload.
+    # @param data [Hash, String] the data.
+    def read(data = @payload)
+      case data
+      when Hash
+        @label ||= data[:label]
+        @signature ||= data[:signature]
+        @payload ||= data[:payload]
+      when String
+        parsed = Oj.load(data)
+        @label ||= parsed['label']
+        @signature ||= parsed['signature']
+        @payload ||= parsed['payload']
+      else raise TypeError, 'Invalid type for Message#payload'
+      end
+    end
+
+    # Build a JSON string using data in this message
+    # @param data [Hash, String] the payload.
+    def build(data = @payload)
+      Oj.dump({ 'label' => @label, 'signature' => @signature, 'payload' => data })
+    end
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/lib/rmessage/publisher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# A module to provide publishing functions to an Object.
+module RMessage::Publisher
+  # @!attribute [r] channel
+  # @return [String, Integer, Symbol] the channel to publish to
+  attr :channel
+
+  # Publishes a message to the specified redis channel.
+  # @param message [RMessage::Message] the message
+  # @param channel [String, Integer, Symbol] the channel
+  # @param connection_index [Integer] the index of the connection to Redis within the {RMessage::CONNECTION_POOL}
+  def publish(message, channel: @channel, connection_index: 0)
+    RMessage::CONNECTION_POOL[connection_index].publish(channel, message.build)
+  end
+end

data/lib/rmessage/subscriber.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Utility functions to allow setting up and parsing messages received from Redis publishers.
+module RMessage::Subscriber
+  # @!attribute [r] channel
+  # @return [String, Symbol, Integer] the channel to subscribe to
+  attr :channel
+
+  # @!attribute [r] events
+  # @return [Hash] a map of event labels to classes
+  attr :events
+
+  # Setup a subscription to a specific Redis channel
+  # @param channel [Symbol, String, Integer] the channel
+  # @param auto_parse [Boolean] should messages be parsed automatically?
+  # @param connection_index [Integer] the index of the redis connection in {RMessage::CONNECTION_POOL}
+  def setup_subscription(channel: @channel, auto_parse: false, connection_index: 0, &_)
+    RMessage::CONNECTION_POOL[connection_index].subscribe(channel) do |event|
+      event.subscribe do
+        puts "Subscribed to #{channel}"
+      end
+
+      if auto_parse
+        event.message { |_, message| parse_message(message) }
+      else
+        event.message { |_, message| yield(message) }
+      end
+    end
+  end
+
+  private
+
+  def parse_message(message_data)
+    msg = RMessage::Message.new(message_data)
+    msg.read
+    @events[msg.label].new(msg)
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/rmessage.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+Dir[File.dirname(__FILE__)].each { |file| $LOAD_PATH.unshift(file) if File.directory? file }
+
+require 'druuid'
+require 'dotenv'
+require 'redis'
+require 'oj'
+
+# Utility modules to make it easier to build Pub/Sub systems in Ruby using Redis.
+module RMessage
+  # @!attribute [r] CONNECTION_POOL
+  # @return [Array] a pool of connections
+  CONNECTION_POOL = []
+
+  autoload :Broker,                       'rmessage/broker'
+  autoload :Publisher,                    'rmessage/publisher'
+  autoload :Subscriber,                   'rmessage/subscriber'
+  autoload :Message,                      'rmessage/message'
+
+  def self.add_connection(opts = {})
+    CONNECTION_POOL << Redis.new(host: opts[:host], port: opts[:port])
+  end
+
+  def self.load_defaults
+    # Load ENV vars.
+    Dotenv.load('.env') if File.exist?('.env')
+    Oj.default_options = { mode: :object, cache_keys: true, cache_strings: true, symbol_keys: false }
+    RMessage.add_connection(host: ENV['RMESSAGE_REDIS_HOST'], port: ENV['RMESSAGE_REDIS_PORT'])
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rmessage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrick W.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+- !ruby/object:Gem::Dependency
+  name: druuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.13.11
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+description:
+email: Sickday@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rmessage.rb
+- lib/rmessage/message.rb
+- lib/rmessage/publisher.rb
+- lib/rmessage/subscriber.rb
+homepage: https://git.repos.pw/Sickday/rmessage
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://git.repos.pw/Sickday/rmessage
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Utility modules to make it easier to build Pub/Sub systems in Ruby using
+  Redis.
+test_files: []