cotton-tail 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9caf210e7f688e34cc64e7e212d1290692a0559ffaa9f72a948c416dda3b7d
-  data.tar.gz: a8657ad7cd3486e2ab3fb0fab7cd4a707b647fa9141f1184dda77afc2584601b
+  metadata.gz: 162f785a8c6f03379f26cc784a5c4a8e28a831d1f1b1145452addb16532f04c2
+  data.tar.gz: b5336ab860aafca2a2a15d9c6bc75aff74155bf43ee47948b2ea46688f805cdf
 SHA512:
-  metadata.gz: 6818a57540fa93192d254fe1884907d6c91fa9c745642b9b3d5b66025ed682d485f5201580cecdf715d5017c47aea47f71d457e6604b5cac4bee9c9401699847
-  data.tar.gz: 38f8f0afda612cd5045006cc5f03c164b70cac9b086f4a948c914e12d6e95c780e6b2ffdaf00cc150eac2956330ad7fd519d9a5f05bb462711163f4a635ddf50
+  metadata.gz: 1e95e2b691fbfe5ebdbc39b857fd26912015b7b8b74a0a7820540a2b5ab957ad437c06c235149cf7e8bbdadd4634007ce4ce83fc07c7e193c8996d0f71ea3e0f
+  data.tar.gz: 21e79d79373570d5d1371d29de75e0e918060f63c0877439bdf9da23ef030ccc85009d68d0f148c585e253a09a95d6dbd6f1a620b6cb67d94bbde1e0dd16df6e

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    cotton-tail (0.2.1)
+    cotton-tail (0.3.0)
       bunny (~> 2.12)
+      ibsciss-middleware (~> 0.4.2)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +21,7 @@ GEM
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
     hashie (3.6.0)
+    ibsciss-middleware (0.4.2)
     jaro_winkler (1.5.1)
     multi_json (1.13.1)
     multipart-post (2.0.0)

data/cotton-tail.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bunny', '~> 2.12'
+  spec.add_dependency 'ibsciss-middleware', '~> 0.4.2'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rabbitmq_http_api_client', '~> 1.9'

data/examples/app.rb

@@ -4,7 +4,9 @@
 require 'bundler/setup'
 require 'cotton_tail'
 
-app = CottonTail::App.new.define do
+app = CottonTail::App.new
+
+app.routes.draw do
   # Create the queue 'hello_world_queue' if it does not exists
   queue 'hello_world_queue', exclusive: true do
     # Create a binding from the default topic exchange ('amq.topic') to
@@ -18,26 +20,30 @@ app = CottonTail::App.new.define do
       puts 'Goodbye cruel world!'
     end
 
-    handle 'inspect.message' do |delivery_info, properties, message|
+    handle 'inspect.message' do |env, routing_key, delivery_info, properties, payload|
+      puts env: env
+      puts routing_key: routing_key
       puts delivery_info: delivery_info
       puts properties: properties
-      puts message: message
+      puts payload: payload
     end
   end
 
   queue 'require_ack_queue', exclusive: true, manual_ack: true do
-    handle 'get.acked' do |delivery_info, _props, _msg, opts|
-      conn = opts[:conn]
+    handle 'get.acked' do |_env, _routing_key, delivery_info, _properties, _message|
       delivery_tag = delivery_info[:delivery_tag]
       puts "acking with #{delivery_tag}"
-      conn.ack(delivery_tag)
+
+      ch = delivery_info[:channel]
+      ch.ack(delivery_tag)
     end
 
-    handle 'get.nacked' do |delivery_info, _props, _msg, opts|
-      conn = opts[:conn]
+    handle 'get.nacked' do |_env, _routing_key, delivery_info, _properties, _message|
       delivery_tag = delivery_info[:delivery_tag]
       puts "nacking with #{delivery_tag}"
-      conn.nack(delivery_tag)
+
+      ch = delivery_info[:channel]
+      ch.nack(delivery_tag)
     end
   end
 end

data/examples/app_with_middleware.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cotton_tail'
+
+app = CottonTail::App.new
+
+app.config.middleware do |_b|
+  # This is added to the end of the middleware stack
+  # 'message' is the return value of the handlers defined below
+  d.use ->(message) { puts message.upcase }
+end
+
+app.routes.draw do
+  queue 'hello_world_queue', exclusive: true do
+    handle 'say.hello' do
+      'Hello world!'
+    end
+
+    handle 'say.goodbye' do
+      'Goodbye cruel world!'
+    end
+  end
+end
+
+app.start

data/lib/cotton_tail/app.rb

@@ -3,22 +3,17 @@
 module CottonTail
   # App is the main class for a CottonTail server
   class App
-    def initialize(queue_strategy: Queue::Bunny, routing_strategy: Router)
-      @dependencies = {
-        queue_strategy: queue_strategy,
-        routing_strategy: routing_strategy
-      }
-    end
+    attr_reader :env, :config
 
-    # Define message routing
-    def define(&block)
-      @definition = DSL::App.new(**@dependencies)
-      @definition.instance_eval(&block)
-      self
+    def initialize(queue_strategy: Queue::Bunny, env: {}, connection: Bunny.new, config: Configuration.new)
+      @dependencies = { queue_strategy: queue_strategy, connection: connection }
+      @env = env
+      @config = config
+      @connection = connection.start
     end
 
     def queues
-      @definition.queues
+      routes.queues
     end
 
     # Get a single message queue
@@ -38,11 +33,15 @@ module CottonTail
       sleep 0.01 while running?
     end
 
+    def routes
+      @routes ||= DSL::Routes.new(**@dependencies)
+    end
+
     private
 
     def supervisors
       @supervisors ||= queues.map do |_name, queue|
-        Queue::Supervisor.new(queue, on_message: @definition.router)
+        Queue::Supervisor.new(queue, app: self)
       end
     end
 

data/lib/cotton_tail/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'middleware'
+
 module CottonTail
   # Configuration options
   class Configuration
@@ -7,11 +9,57 @@ module CottonTail
 
     def initialize
       @connection_args = nil
+      @middleware = Middleware::DEFAULT_STACK
+      @user_configs = {}
     end
 
+    # Sets the RabbitMQ connection params. Arguments are eventually passed
+    # to Bunny.new. Any valid params for Bunny.new are accepted.
+    #
+    # @see http://rubybunny.info/articles/connecting.html
     def connection_args=(*args, **kwargs)
       url, = args
       @connection_args = url ? Bunny::Session.parse_uri(url) : kwargs
     end
+
+    # Modify or retrieve the application middleware stack.
+    #
+    # @see https://github.com/Ibsciss/ruby-middleware
+    def middleware
+      return @middleware unless block_given?
+
+      @middleware = ::Middleware::Builder.new do |b|
+        b.use @middleware
+        yield b
+      end
+    end
+
+    def method_missing(method_id, *arguments, &block)
+      if user_config? method_id
+        @user_configs[method_id]
+      elsif setter?(method_id) && arguments.length == 1
+        @user_configs[getter_name(method_id)] = arguments.first
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_id, include_private = false)
+      user_config?(method_id) || super
+    end
+
+    private
+
+    def setter?(method_id)
+      method_id.to_s.end_with? '='
+    end
+
+    def user_config?(method_id)
+      @user_configs.key?(method_id)
+    end
+
+    def getter_name(setter)
+      setter.to_s.sub('=', '').to_sym
+    end
   end
 end

data/lib/cotton_tail/dsl/{app.rb → routes.rb}

@@ -4,18 +4,22 @@ module CottonTail
   module DSL
     # This is the top level DSL for defining the bindings and message routing of
     # a cotton App
-    class App
+    class Routes
       attr_reader :queues
 
-      def initialize(queue_strategy:, routing_strategy:)
+      def initialize(queue_strategy:, connection:)
         @queue_strategy = queue_strategy
-        @routing_strategy = routing_strategy
+        @connection = connection
         @queues = {}
       end
 
+      def draw(&block)
+        instance_eval(&block)
+      end
+
       # Define a new queue
       def queue(name, **opts, &block)
-        @queue_strategy.call(name: name, **opts).tap do |queue_instance|
+        @queue_strategy.call(name: name, connection: @connection, **opts).tap do |queue_instance|
           @queues[name] = queue_instance
           queue_dsl = Queue.new(name, queue_instance, self)
           queue_dsl.instance_eval(&block) if block_given?
@@ -39,11 +43,11 @@ module CottonTail
 
       def handle(key, handler = nil, &block)
         handler ||= block
-        router.route key, handler
+        handlers[key] = handler
       end
 
-      def router
-        @router ||= @routing_strategy.call
+      def handlers
+        @handlers ||= {}
       end
     end
   end

data/lib/cotton_tail/dsl/topic.rb

@@ -9,9 +9,9 @@ module CottonTail
         @context = context
       end
 
-      def handle(routing_suffix, klass)
+      def handle(routing_suffix, handler = nil, &block)
         key = routing_key(routing_suffix)
-        @context.instance_eval { handle key, klass }
+        @context.instance_eval { handle key, handler, &block }
       end
 
       private

data/lib/cotton_tail/dsl.rb

@@ -3,7 +3,7 @@
 module CottonTail
   # DSL namespace
   module DSL
-    autoload :App, 'cotton_tail/dsl/app'
+    autoload :Routes, 'cotton_tail/dsl/routes'
     autoload :Queue, 'cotton_tail/dsl/queue'
     autoload :Topic, 'cotton_tail/dsl/topic'
   end

data/lib/cotton_tail/middleware/router.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CottonTail
+  module Middleware
+    # Router Middleware
+    class Router
+      def initialize(app)
+        @app = app
+      end
+
+      def call(request)
+        message = parse(request)
+        request.shift
+        request.unshift message.app.env
+        @app.call handler(message.app, message.routing_key).call(request)
+      end
+
+      private
+
+      def handler(app, route)
+        handlers(app).fetch(route) { raise UndefinedRouteError }
+      end
+
+      def parse(msg)
+        Message.new(*msg)
+      end
+
+      def handlers(app)
+        app.routes.handlers
+      end
+    end
+  end
+end

data/lib/cotton_tail/middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'middleware'
+require 'logger'
+
+module CottonTail
+  # Top level namespace for Middleware
+  module Middleware
+    autoload :Router, 'cotton_tail/middleware/router'
+
+    DEFAULT_STACK = ::Middleware::Builder.new do |b|
+      b.use Router
+    end
+  end
+end

data/lib/cotton_tail/queue/bunny.rb

@@ -10,15 +10,16 @@ module CottonTail
     class Bunny < SimpleDelegator
       extend Forwardable
 
-      def self.call(name:, **opts)
-        new(name, **opts)
+      def self.call(**opts)
+        new(**opts)
       end
 
-      def initialize(name, manual_ack: false, **opts)
+      def initialize(name:, connection:, manual_ack: false, **opts)
         super ::Queue.new
 
         @name = name
         @source_opts = opts
+        @connection = connection
 
         watch_source manual_ack
       end
@@ -40,16 +41,12 @@ module CottonTail
 
       private
 
-      def_delegator :'CottonTail.configuration', :connection_args
+      attr_reader :connection
 
       def watch_source(manual_ack)
         source.subscribe(manual_ack: manual_ack) { |*args| self << args }
       end
 
-      def connection
-        @connection ||= ::Bunny.new(*connection_args).start
-      end
-
       def source
         @source ||= channel.queue(@name, **@source_opts)
       end

data/lib/cotton_tail/queue/reader.rb

@@ -10,9 +10,9 @@ module CottonTail
         Thread.new { new(queue, **kwargs).start }
       end
 
-      def initialize(queue, on_message:)
+      def initialize(queue, app:)
         @queue = queue
-        @on_message = on_message
+        @app = app
       end
 
       def fiber
@@ -22,10 +22,18 @@ module CottonTail
       end
 
       def start
-        while fiber.alive?
-          args = fiber.resume
-          @on_message.call(*args) if args
-        end
+        call_next while fiber.alive?
+      end
+
+      private
+
+      def call_next
+        args = fiber.resume
+        middleware.call([@app, *args]) if args
+      end
+
+      def middleware
+        @app.config.middleware
       end
     end
   end

data/lib/cotton_tail/queue/supervisor.rb

@@ -6,9 +6,9 @@ module CottonTail
   module Queue
     # A supervisor for a single queue
     class Supervisor
-      def initialize(queue, on_message:)
+      def initialize(queue, app:)
         @queue = queue
-        @on_message = on_message
+        @app = app
       end
 
       def start
@@ -28,7 +28,7 @@ module CottonTail
       private
 
       def process
-        @process ||= Reader.spawn(@queue, on_message: @on_message)
+        @process ||= Reader.spawn(@queue, app: @app)
       end
     end
   end

data/lib/cotton_tail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CottonTail
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/cotton_tail.rb

@@ -7,19 +7,16 @@ module CottonTail
   autoload :App, 'cotton_tail/app'
   autoload :Configuration, 'cotton_tail/configuration'
   autoload :DSL, 'cotton_tail/dsl'
+  autoload :Middleware, 'cotton_tail/middleware'
   autoload :Queue, 'cotton_tail/queue'
   autoload :Router, 'cotton_tail/router'
   autoload :Version, 'cotton_tail/version'
 
-  class << self
-    def configure
-      return configuration unless block_given?
+  # Message is a struct for working with the messages that are passed through
+  # the middleware stack.
+  Message = Struct.new(:app, :routing_key, :delivery_info, :properties,
+                       :payload)
 
-      yield configuration
-    end
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
+  class UndefinedRouteError < StandardError
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cotton-tail
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - James Brennan
@@ -30,7 +30,7 @@ cert_chain:
   fXe/xr/Sc+2wCjHPVE2J+auN5hk3KCp1I4s2fKqyLIwyhTEF3shuYfCpC8rt/YdN
   cy9/lg5LCI3OvakzxL4Xt1Sq4h/xJZ06ydTVJ1wxfk6BXHrg
   -----END CERTIFICATE-----
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -46,6 +46,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: ibsciss-middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +183,7 @@ files:
 - cotton-tail.gemspec
 - docker-compose.yml
 - examples/app.rb
+- examples/app_with_middleware.rb
 - examples/messages/get.acked
 - examples/messages/get.nacked
 - examples/messages/inspect.message
@@ -178,15 +193,16 @@ files:
 - lib/cotton_tail/app.rb
 - lib/cotton_tail/configuration.rb
 - lib/cotton_tail/dsl.rb
-- lib/cotton_tail/dsl/app.rb
 - lib/cotton_tail/dsl/queue.rb
+- lib/cotton_tail/dsl/routes.rb
 - lib/cotton_tail/dsl/topic.rb
+- lib/cotton_tail/middleware.rb
+- lib/cotton_tail/middleware/router.rb
 - lib/cotton_tail/queue.rb
 - lib/cotton_tail/queue/bunny.rb
 - lib/cotton_tail/queue/memory.rb
 - lib/cotton_tail/queue/reader.rb
 - lib/cotton_tail/queue/supervisor.rb
-- lib/cotton_tail/router.rb
 - lib/cotton_tail/version.rb
 homepage: https://github.com/jamesBrennan/cotton-tail
 licenses:

data/lib/cotton_tail/router.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module CottonTail
-  # Register message handlers and dispatch messages to them
-  class Router
-    def self.call
-      new
-    end
-
-    def initialize
-      @handlers = {}
-    end
-
-    def route(key, handler)
-      @handlers[key] = handler
-    end
-
-    def dispatch(key, *args)
-      @handlers[key].call(*args)
-    end
-
-    alias call dispatch
-  end
-end