mimi-messaging 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f372a9f357c460683c5be1e6a4da12e17c628a8
+  data.tar.gz: 4949e060f16f06515a14db225fb629d6e1b7a05d
+SHA512:
+  metadata.gz: 2f03dd1c4f51d39abcaeaa6edf11f4a3d00a71f27cf504eab966e33eda20f47869f6724a23a11d7f9c708b2cb0ad3de49f49806b00ecc4b97ba9bcb9b0d27008
+  data.tar.gz: db39cd12d196d7932e1a8f8fbb79b4bd12c949fa06b30393edeffcc0f8244992f566ffc2c79c1002cb59b1d2014ab16609d6d71dcaae62f0cfc54b27f98f4777

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alex@kukushk.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Kukushkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# mimi-messaging
+
+Communications via RabbitMQ for [mimi](https://github.com/kukushkin/mimi).
+
+[in development]
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mimi/messaging'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mimi/messaging.rb

@@ -0,0 +1,121 @@
+require 'mimi/core'
+require 'mimi/logger'
+
+module Mimi
+  module Messaging
+    include Mimi::Core::Module
+    include Mimi::Logger::Instance
+
+    default_options(
+      require_files: 'app/messaging/**/*.rb',
+      mq_host: 'localhost',
+      mq_port: 5672,
+      mq_username: nil,
+      mq_password: nil,
+      mq_vhost: nil
+    )
+
+    def self.module_path
+      Pathname.new(__dir__).join('..').join('..').expand_path
+    end
+
+    def self.module_manifest
+      {
+        mq_host: {
+          desc: 'RabbitMQ host',
+          default: 'localhost'
+        },
+        mq_port: {
+          desc: 'RabbitMQ port',
+          default: 5672
+        },
+        mq_username: {
+          desc: 'RabbitMQ username',
+          default: nil
+        },
+        mq_password: {
+          desc: 'RabbitMQ password',
+          default: nil
+        }
+      }
+    end
+
+    def self.configure(*)
+      super
+      connections << Mimi::Messaging::Connection.new(module_options)
+    end
+
+    # @return [Array<Mimi::Messaging::Connection>]
+    #
+    def self.connections
+      @connections ||= []
+    end
+
+    # @return [Array<Class < Mimi::Messaging::RequestProcessor>]
+    #
+    def self.request_processor_classes
+      @request_processor_classes ||= []
+    end
+
+    # @param [Class < Mimi::Messaging::RequestProcessor]
+    #
+    def self.register_request_processor_class(request_processor_class)
+      request_processor_classes << request_processor_class
+    end
+
+    # Selects the connection to be used for sending/receiving messages from/to given queue
+    #
+    # @param queue_name [String]
+    # @return [Mimi::Messaging::Connection]
+    #
+    def self.connection_for(queue_name)
+      connection_for_queue = connections.select do |c|
+        c.queue_prefix && (
+          (c.queue_prefix.is_a?(String) && queue_name.start_with?(c.queue_prefix)) ||
+          (c.queue_prefix.is_a?(Array) && c.queue_prefix.any? { |qp| queue_name.start_with?(qp) })
+        )
+      end.first
+      return connection_for_queue if connection_for_queue
+      connections.select { |c| c.queue_prefix.nil? }.first
+    end
+
+    def self.post(queue_name, raw_message, params = {})
+      connection_for(queue_name).post(queue_name, raw_message, params)
+    end
+
+    def self.get(queue_name, raw_message, params = {})
+      connection_for(queue_name).get(queue_name, raw_message, params)
+    end
+
+    def self.broadcast(queue_name, raw_message, params = {})
+      connection_for(queue_name).broadcast(queue_name, raw_message, params)
+    end
+
+    def self.start
+      Mimi.require_files(module_options[:require_files]) if module_options[:require_files]
+      connections.each(&:start)
+      request_processor_classes.each(&:start)
+      super
+    end
+
+    def self.stop
+      request_processor_classes.each(&:stop)
+      connections.each(&:stop)
+      super
+    end
+  end # module Messaging
+end # module Mimi
+
+require_relative 'messaging/version'
+require_relative 'messaging/packer'
+
+require_relative 'messaging/errors'
+require_relative 'messaging/connection'
+require_relative 'messaging/message'
+require_relative 'messaging/request'
+require_relative 'messaging/request_processor'
+require_relative 'messaging/provider'
+require_relative 'messaging/model'
+require_relative 'messaging/model_provider'
+require_relative 'messaging/notification'
+require_relative 'messaging/listener'

data/lib/mimi/messaging/connection.rb

@@ -0,0 +1,181 @@
+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