mimi-messaging 0.1.9 → 1.1.0

data/lib/mimi/messaging/json_serializer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Mimi
+  module Messaging
+    #
+    # JSON serializer.
+    #
+    # De/Serializes a message (Hash) from/into a JSON object
+    #
+    module JsonSerializer
+      #
+      # Serialize given message into JSON object
+      #
+      # @param message [Hash]
+      # @return [String]
+      #
+      def self.serialize(message)
+        unless message.is_a?(Hash)
+          raise ArgumentError, "Invalid message passed to #{self}#serialize, Hash is expected"
+        end
+
+        message.to_json
+      rescue StandardError => e
+        raise "#{self} failed to serialize a message: #{e}"
+      end
+
+      # Deserializes a JSON into a message
+      #
+      # @param message [String]
+      # @return [Hash]
+      #
+      def self.deserialize(message)
+        unless message.is_a?(String)
+          raise ArgumentError, "Invalid message passed to #{self}#deserialize, String is expected"
+        end
+
+        JSON.parse(message)
+      rescue StandardError => e
+        raise "#{self} failed to deserialize a message: #{e}"
+      end
+    end # module JsonSerializer
+  end # module Messaging
+end # module Mimi

data/lib/mimi/messaging/message.rb

@@ -1,74 +1,34 @@
-require 'json'
-require 'msgpack'
+# frozen_string_literal: true
 
 module Mimi
   module Messaging
-    class Message < Hashie::Mash
-      def self.queue(name, _opts = {})
-        @queue_name = name
-      end
-
-      def self.queue_name
-        @queue_name || default_queue_name
-      end
-
-      def self.default_queue_name
-        Mimi::Messaging::RequestProcessor.class_name_to_resource_name(self, 'message')
-      end
-
-      def self.get(name, data = {}, opts = {})
-        headers = {
-          method_name: name.to_s,
-          Mimi::Messaging::CONTEXT_ID_KEY => Mimi::Messaging.logger.context_id
-        }
-        _d, _m, response = Mimi::Messaging.get(
-          queue_name, encode(data), opts.deep_merge(headers: headers)
-        )
-        raise Timeout::Error unless response
-        message = new(decode(response))
-        raise RequestError.new(message.error, Message.new(message.params)) if message.error?
-        message
-      end
-
-      def self.post(name, data = {}, opts = {})
-        headers = {
-          method_name: name.to_s,
-          Mimi::Messaging::CONTEXT_ID_KEY => Mimi::Messaging.logger.context_id
-        }
-        Mimi::Messaging.post(
-          queue_name, encode(data), opts.deep_merge(headers: headers)
-        )
-      end
-
-      def self.add_method(name, &block)
-        self.class.instance_eval do
-          define_method(name, &block)
+    #
+    # A Message is a Hash and additional headers structure.
+    #
+    class Message < Hash
+      attr_reader :headers
+
+      # Creates a Message out of Hash or another Message.
+      #
+      # @param message_or_hash [Hash,Message]
+      # @param headers [Hash,nil] additional headers to attach to the message
+      #
+      def initialize(message_or_hash, headers = nil)
+        unless message_or_hash.is_a?(Hash) # or a Message
+          raise ArgumentError, "Message or Hash is expected as argument"
         end
-      end
 
-      def self.methods(*names)
-        names.each do |method_name|
-          add_method(method_name) do |*params|
-            get(method_name, *params)
-          end
-          add_method("#{method_name}!") do |*params|
-            post(method_name, *params)
-            nil
-          end
-        end
-      end
+        # copy attributes
+        message_or_hash.each { |k, v| self[k] = v.dup }
 
-      def self.encode(data)
-        MessagePack.pack(data) # data.to_json
-      end
-
-      def self.decode(raw_message)
-        MessagePack.unpack(raw_message) # JSON.parse(raw_message)
-      end
-
-      def to_s
-        to_hash.to_s
+        # copy headers
+        headers ||= {}
+        if message_or_hash.is_a?(Mimi::Messaging::Message)
+          @headers = message_or_hash.headers.merge(headers)
+        else
+          @headers = headers
+        end
       end
     end # class Message
   end # module Messaging
-end # module Mimi
+end # module Mimi

data/lib/mimi/messaging/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Mimi
   module Messaging
-    VERSION = '0.1.9'.freeze
+    VERSION = "1.1.0"
   end
 end

data/mimi-messaging.gemspec

@@ -1,39 +1,41 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mimi/messaging/version'
+require "mimi/messaging/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'mimi-messaging'
+  spec.name          = "mimi-messaging"
   spec.version       = Mimi::Messaging::VERSION
-  spec.authors       = ['Alex Kukushkin']
-  spec.email         = ['alex@kukushk.in']
+  spec.authors       = ["Alex Kukushkin"]
+  spec.email         = ["alex@kukushk.in"]
 
-  spec.summary       = 'Communications via RabbitMQ for mimi'
-  spec.description   = 'Communications via RabbitMQ for mimi'
-  spec.homepage      = 'https://github.com/kukushkin/mimi-messaging'
-  spec.license       = 'MIT'
+  spec.summary       = "Interservice communication via message bus for microservices"
+  spec.description   = "Interservice communication via message bus for microservices"
+  spec.homepage      = "https://github.com/kukushkin/mimi-messaging"
+  spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'bunny', '~> 2.9'
-  spec.add_dependency 'mimi-core', '~> 0.1'
-  spec.add_dependency 'mimi-logger', '~> 0.2', '>= 0.2.3'
-  spec.add_dependency 'msgpack', '~> 1.2'
+  spec.add_dependency "mimi-core", "~> 1.1"
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,105 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: mimi-messaging
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bunny
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: mimi-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: mimi-logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.3
-- !ruby/object:Gem::Dependency
-  name: msgpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Communications via RabbitMQ for mimi
+description: Interservice communication via message bus for microservices
 email:
 - alex@kukushk.in
 executables: []
@@ -137,36 +89,41 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
+- docs/Messaging_Layer_Properties.md
+- docs/Why_HTTP_is_a_bad_choice.md
+- docs/diagrams/Pattern -- Command.drawio
+- docs/diagrams/Pattern -- Event direct.drawio
+- docs/diagrams/Pattern -- Event with Queue.drawio
+- docs/diagrams/Pattern -- Event.drawio
+- docs/diagrams/Pattern -- Query.drawio
+- docs/img/pattern--command.png
+- docs/img/pattern--event-direct.png
+- docs/img/pattern--event-using-queue.png
+- docs/img/pattern--event.png
+- docs/img/pattern--query.png
+- examples/basic_event_listener.rb
+- examples/basic_request_processor.rb
+- examples/using_messaging_low.rb
+- examples/using_pure_adapter.rb
 - lib/mimi/messaging.rb
-- lib/mimi/messaging/connection.rb
+- lib/mimi/messaging/adapters.rb
+- lib/mimi/messaging/adapters/base.rb
+- lib/mimi/messaging/adapters/memory.rb
+- lib/mimi/messaging/adapters/test.rb
 - lib/mimi/messaging/errors.rb
-- lib/mimi/messaging/listener.rb
+- lib/mimi/messaging/json_serializer.rb
 - lib/mimi/messaging/message.rb
-- lib/mimi/messaging/mock.rb
-- lib/mimi/messaging/mock/connection.rb
-- lib/mimi/messaging/mock/request.rb
-- lib/mimi/messaging/mock/request_processor.rb
-- lib/mimi/messaging/model.rb
-- lib/mimi/messaging/model_provider.rb
-- lib/mimi/messaging/msgpack/msgpack_ext.rb
-- lib/mimi/messaging/msgpack/type_packer.rb
-- lib/mimi/messaging/notification.rb
-- lib/mimi/messaging/provider.rb
-- lib/mimi/messaging/request.rb
-- lib/mimi/messaging/request_processor.rb
-- lib/mimi/messaging/request_processor/context.rb
-- lib/mimi/messaging/request_processor/dsl.rb
 - lib/mimi/messaging/version.rb
-- lib/tasks/console_ext.rake
-- lib/tasks/console_helpers.rb
 - mimi-messaging.gemspec
 homepage: https://github.com/kukushkin/mimi-messaging
 licenses:
@@ -189,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
-summary: Communications via RabbitMQ for mimi
+summary: Interservice communication via message bus for microservices
 test_files: []

data/lib/mimi/messaging/connection.rb

@@ -1,181 +0,0 @@
-require 'bunny'
-
-module Mimi
-  module Messaging
-    class Connection
-      attr_reader :queue_prefix
-
-      # Creates a Connection with given connection params
-      #
-      # @param params [Hash] Connection params as accepted by Bunny
-      # @param params[:queue_prefix] [String] (optional) Use this connection for all communication
-      #                                       related to queues, having names starting with given
-      #                                       prefix
-      #
-      def initialize(params = {})
-        @queue_prefix = params[:queue_prefix]
-        @channel_pool = {}
-        bunny_params = {
-          host: params[:mq_host],
-          port: params[:mq_port],
-          username: params[:mq_username],
-          password: params[:mq_password],
-          vhost: params[:mq_vhost]
-        }
-        @connection = Bunny.new(bunny_params)
-      end
-
-      # Starts the connection, opening actual connection to RabbitMQ
-      #
-      def start
-        @connection.start
-      end
-
-      # Stops the connection
-      #
-      def stop
-        @connection.close
-        @channel_pool = {}
-      end
-
-      def started?
-        @connection.status == :open
-      end
-
-      def channel
-        raise ConnectionError unless started?
-        @channel_pool[Thread.current.object_id] ||= create_channel
-      end
-
-      def create_channel(opts = {})
-        Channel.new(@connection, opts)
-      end
-
-      def reply_queue
-        raise ConnectionError unless started?
-        channel.reply_queue
-      end
-
-      def post(queue_name, raw_message, params = {})
-        channel.post(queue_name, raw_message, params)
-      end
-
-      def get(queue_name, raw_message, params = {})
-        channel.get(queue_name, raw_message, params)
-      end
-
-      def broadcast(queue_name, raw_message, params = {})
-        channel.broadcast(queue_name, raw_message, params)
-      end
-
-      class Channel
-        attr_reader :options, :connection
-
-        DEFAULT_OPTIONS = {
-          concurrency: 1
-        }
-        DEFAULT_GET_TIMEOUT = 60 # seconds
-
-        def initialize(connection, opts = {})
-          @connection = connection
-          @options = DEFAULT_OPTIONS.merge(opts)
-          @channel = @connection.create_channel(nil, options[:concurrency])
-          @mutex = Mutex.new
-        end
-
-        def create_queue(name, opts = {})
-          @channel.queue(name, opts)
-        end
-
-        def reply_queue
-          @reply_queue ||= create_queue('', exclusive: true)
-        end
-
-        def ack(tag)
-          @channel.ack(tag)
-        end
-
-        def fanout(name)
-          @channel.fanout(name)
-        end
-
-        def active?
-          @channel && @channel.active
-        end
-
-        # Sends a raw RabbitMQ message to a given direct exchange
-        #
-        # @param queue_name [String] Queue name to send the message to
-        # @param raw_message [String]
-        # @param params [Hash] Message params (metadata)
-        #
-        def post(queue_name, raw_message, params = {})
-          x = @channel.default_exchange
-          params = { routing_key: queue_name }.merge(params.dup)
-          publish(x, raw_message, params)
-        end
-
-        # Sends a raw RabbitMQ message to a given direct exchange and listens for response
-        #
-        # @param queue_name [String] Queue name to send the message to
-        # @param raw_message [String]
-        # @param params [Hash] Message params (metadata)
-        #
-        # @param params[:timeout] [Integer] (optional) Timeout in seconds
-        #
-        # @return [nil,Array]
-        #
-        def get(queue_name, raw_message, params = {})
-          correlation_id = Time.now.utc.to_f.to_s
-          params = params.dup.merge(
-            reply_to: reply_queue.name,
-            correlation_id: correlation_id
-          )
-          post(queue_name, raw_message, params)
-          response = nil
-          begin
-            Timeout.timeout(params[:timeout] || DEFAULT_GET_TIMEOUT) do
-              loop do
-                d, m, p = reply_queue.pop
-                next if d && m.correlation_id != correlation_id
-                response = [d, m, p] if d
-                break if response
-                sleep 0.001 # s
-              end
-            end
-          rescue Timeout::Error
-            # respond with nil
-          end
-          response
-        end
-
-        # Sends a raw RabbitMQ message to a given fanout exchange
-        #
-        # @param fanout_name [String] Fanout exchange name to send the message to
-        # @param raw_message [String]
-        # @param params [Hash] Message params (metadata)
-        #
-        def broadcast(fanout_name, raw_message, params = {})
-          x = @channel.fanout(fanout_name)
-          publish(x, raw_message, params)
-        end
-
-        private
-
-        def publish(exchange, raw_message, params = {})
-          # HACK: Connection-level mutex reduces throughoutput, hopefully improves stability (ku)
-          @mutex.synchronize do
-            # TODO: may be make publishing an atomic operation using a separate thread? (ku)
-            exchange.publish(raw_message, params)
-          end
-        rescue StandardError => e
-          # Raising fatal error:
-          unless Thread.main == Thread.current
-            Thread.main.raise ConnectionError, "failed to publish message in a child thread: #{e}"
-          end
-          raise ConnectionError, "failed to publish message: #{e}"
-        end
-      end # class Channel
-    end # class Connection
-  end # module Messaging
-end # module Mimi