cotton-tail 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea50d4559d3b22547293d0efb07f7841837e272b877a96646c948a2d125313a8
-  data.tar.gz: 640b18d1aefc48686535b9f1f3685c38c5fc1724492192bb766dfdd39573d0ca
+  metadata.gz: a096975de51e023b80e464904906b993f74192d556b868810c752571697d8de4
+  data.tar.gz: 70cec1e974a049e58ca92370e646cf3adddf138bd03b4cc101bfa2956c0c5fcd
 SHA512:
-  metadata.gz: 433de64af1c506e5f997e7cd24c70453110822662b6ba5139673b443bff235100a15d6dad2f1e3e23f0e429cab08dd927c0c47b614094b3f0160893ee6644541
-  data.tar.gz: 18a12763f6a88ab0940c20850e1110b0a4305f69451f5ef2ef2c7a5f82ec1f59bf48e41dccc8e9740da3854314c3c82c4c84a50d0878ae94c662617c2fa434bc
+  metadata.gz: 5334e9b79d5d5762c5f98066866c5e08cd54a4ed0b051dfc6a3b68d3b1bee80a4800b734edc063e5043a2a2a56527997c65e6e1fb5d7ed9b7091e51ca137062b
+  data.tar.gz: d936c74e21b1570b283b513e8b5921215df7c1ebc31b95db9a57bb64cab742208cccf65c294c13a078d8d80b2a6cecc027ebf5a895315a7abb0a36904ff7d573

data/.rspec

@@ -1,4 +1,5 @@
 --format documentation
 --color
 --require spec_helper
+--require integration_helper
 -I integration

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cotton-tail (0.5.0)
+    cotton-tail (0.6.0)
       bunny (~> 2.12)
       ibsciss-middleware (~> 0.4.2)
 
@@ -12,7 +12,7 @@ GEM
     ast (2.4.0)
     benchmark-perf (0.4.0)
     benchmark-trend (0.2.0)
-    bunny (2.12.1)
+    bunny (2.13.0)
       amq-protocol (~> 2.3, >= 2.3.0)
     diff-lcs (1.3)
     effin_utf8 (1.0)

data/examples/app.rb

@@ -25,6 +25,11 @@ app.routes.draw do
       puts request: request
       puts response: response
     end
+
+    handle 'send.*:gift.to.*:name' do |_env, request, _response|
+      gift, name = request.route_params.values_at('gift', 'name')
+      puts "#{gift} sent to #{name}!"
+    end
   end
 
   queue 'require_ack_queue', exclusive: true, manual_ack: true do

data/examples/messages/send.kitten.to.tom

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+read -r -d '' MESSAGE << EOM
+{
+  "properties":{},
+  "routing_key":"send.kitten.to.tom",
+  "payload": "ignored",
+  "payload_encoding": "string"
+}
+EOM
+
+curl -i -XPOST -d"${MESSAGE}" http://guest:guest@localhost:15672/api/exchanges/%2f/amq.topic/publish

data/lib/cotton_tail.rb

@@ -7,26 +7,15 @@ module CottonTail
   autoload :App, 'cotton_tail/app'
   autoload :Configuration, 'cotton_tail/configuration'
   autoload :DSL, 'cotton_tail/dsl'
+  autoload :MessageProperties, 'cotton_tail/message_properties'
   autoload :Middleware, 'cotton_tail/middleware'
   autoload :Queue, 'cotton_tail/queue'
+  autoload :Request, 'cotton_tail/request'
   autoload :Route, 'cotton_tail/route'
+  autoload :RouteSegment, 'cotton_tail/route_segment'
   autoload :Router, 'cotton_tail/router'
   autoload :Version, 'cotton_tail/version'
 
-  Request = Struct.new(:delivery_info, :properties, :payload) do
-    def routing_key
-      delivery_info[:routing_key]
-    end
-
-    def delivery_tag
-      delivery_info[:delivery_tag]
-    end
-
-    def channel
-      delivery_info[:channel]
-    end
-  end
-
   Response = Struct.new(:body)
 
   class RouteConflictError < StandardError

data/lib/cotton_tail/dsl/queue.rb

@@ -10,9 +10,9 @@ module CottonTail
         @context = context
       end
 
-      def handle(key, handler = nil, &block)
-        bind(key)
-        @context.handle(key, handler, &block)
+      def handle(pattern, handler = nil, &block)
+        bind pattern
+        @context.handle(pattern, handler, &block)
       end
 
       def topic(routing_prefix, &block)
@@ -20,10 +20,10 @@ module CottonTail
         topic.instance_eval(&block)
       end
 
-      def bind(key)
+      def bind(pattern)
         return unless @queue.respond_to?(:bind)
 
-        @queue.bind key
+        @queue.bind pattern
       end
     end
   end

data/lib/cotton_tail/message_properties.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CottonTail
+  # Wrapper around Bunny MessageProperties, used to supply route params
+  class MessageProperties < Bunny::MessageProperties
+    def merge(properties)
+      self.class.new(@properties.merge(properties))
+    end
+
+    def route_params
+      @properties[:route_params]
+    end
+
+    def ==(other)
+      to_h == other.to_h
+    end
+  end
+end

data/lib/cotton_tail/middleware/router.rb

@@ -15,30 +15,50 @@ module CottonTail
 
       def call(message)
         env, req, = message
-        @app.call [env, req, response(req.routing_key, message)]
+        @app.call [env, req, response(*message)]
       end
 
       private
 
-      def route(routing_key)
-        CottonTail::Route.new(routing_key)
-      end
+      def response(env, req, res)
+        routing_key = req.routing_key
+        handler = lookup_handler(routing_key)
+        route = lookup_route(routing_key)
+        req = add_route_params(req, route) if route_params?(route, routing_key)
 
-      def response(routing_key, message)
-        CottonTail::Response.new handler(routing_key).call(message)
+        CottonTail::Response.new handler.call([env, req, res])
       end
 
       def routes(routing_key)
         handlers.keys.select { |route| route.match? routing_key }
       end
 
-      def handler(routing_key)
+      def lookup_handler(routing_key)
+        handlers[lookup_route(routing_key)]
+      end
+
+      def lookup_route(routing_key)
         route, *conflicts = routes(routing_key)
         raise UndefinedRouteError if route.nil?
 
         raise RouteConflictError unless conflicts.empty?
 
-        handlers[route]
+        route
+      end
+
+      def add_route_params(req, route)
+        delivery_info, properties, payload = req.to_a
+        Request.new(
+          delivery_info,
+          properties.merge(
+            route_params: route.extract_params(req.routing_key)
+          ),
+          payload
+        )
+      end
+
+      def route_params?(route, routing_key)
+        route.extract_params(routing_key) == {} || true
       end
     end
   end

data/lib/cotton_tail/queue/bunny.rb

@@ -30,11 +30,12 @@ module CottonTail
       end
 
       def pop
-        Request.new(*super)
+        delivery_info, properties, payload = super
+        Request.new(delivery_info, MessageProperties.new(properties.to_h), payload)
       end
 
       def bind(routing_key)
-        source.bind('amq.topic', routing_key: routing_key)
+        source.bind('amq.topic', routing_key: Route.new(routing_key).binding)
       end
 
       private

data/lib/cotton_tail/request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CottonTail
+  # Value object wrapper for Bunny Message
+  class Request
+    extend Forwardable
+
+    attr_reader :delivery_info, :properties, :payload
+
+    def initialize(delivery_info, properties, payload)
+      @delivery_info = delivery_info
+      @properties = properties
+      @payload = payload
+    end
+
+    def to_a
+      [delivery_info, properties, payload]
+    end
+
+    def to_h
+      {
+        delivery_info: delivery_info,
+        properties: properties,
+        payload: payload
+      }
+    end
+
+    def ==(other)
+      to_h == other.to_h
+    end
+
+    def_delegators :delivery_info, :routing_key, :delivery_tag, :channel
+    def_delegators :properties, :route_params
+  end
+end

data/lib/cotton_tail/route.rb

@@ -1,36 +1,48 @@
 # frozen_string_literal: true
 
 module CottonTail
-  # Route value object
-  class Route
-    attr_reader :pattern
-
+  # Route pattern matcher
+  class Route < SimpleDelegator
     def initialize(pattern)
       @pattern = pattern
+      super build_regex
     end
 
-    def match?(routing_key)
-      return true if @pattern == routing_key
+    def extract_params(routing_key)
+      return {} unless match? routing_key
 
-      regex.match? routing_key
+      match(routing_key).named_captures
     end
 
-    def to_s
-      @pattern
+    def binding
+      segments.map(&:binding).join('.')
     end
 
     private
 
-    def regex
-      @regex ||= Regexp.new build_regex(@pattern)
+    def explode
+      @pattern.split('.').map(&RouteSegment.method(:new))
+    end
+
+    def collapse
+      segments.zip(separators).join
+    end
+
+    def segments
+      @segments ||= explode
+    end
+
+    def separators
+      separators = segments.each_with_index.map do |segment, idx|
+        [Regexp.escape('.')].tap do |sep|
+          sep << '?' if segment.hash? && idx.zero?
+        end
+      end
+      separators.map(&:join)[0..-2]
     end
 
-    def build_regex(pattern)
-      [
-        '^',
-        pattern.gsub('*', '([^.]+)').gsub(/\.?#\.?/, '([^.]{0,}\.?)+'),
-        '$'
-      ].join
+    def build_regex
+      Regexp.new "^#{collapse}$"
     end
   end
 end

data/lib/cotton_tail/route_segment.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module CottonTail
+  # RouteSegment implements the pattern matching for route segments
+  class RouteSegment < SimpleDelegator
+    def initialize(value)
+      @value = value
+      super Regexp.new definition(value)
+    end
+
+    def star?
+      /^#{STAR}|#{NAMED_STAR}$/.match? @value
+    end
+
+    def hash?
+      /^#{HASH}|#{NAMED_HASH}$/.match? @value
+    end
+
+    def binding
+      return '*' if star?
+
+      return '#' if hash?
+
+      @value
+    end
+
+    private
+
+    TRANSFORM = ->(val, func) { func.call(val) }
+
+    def definition(value)
+      transformers.reduce(value, &TRANSFORM)
+    end
+
+    # Converts named route segment to Regexp named capture group
+    #   "#:foo" -> "(?<foo>.+)"
+    def sub_named_group_wildcard(pattern)
+      pattern.gsub(NAMED_HASH, '(?<\1>.+)')
+    end
+
+    # Converts named route segment to Regexp named capture group
+    #   "*:foo" -> "(?<foo>[^.]+)"
+    def sub_named_single_wildcard(pattern)
+      pattern.gsub(NAMED_STAR, '(?<\1>[^.]+)')
+    end
+
+    def sub_single_wildcard(pattern)
+      pattern.gsub(STAR, '([^.]+)')
+    end
+
+    def sub_multi_wildcard(pattern)
+      pattern.gsub(HASH, '([^.]{0,}\.?)+')
+    end
+
+    def transformers
+      [
+        method(:sub_named_group_wildcard),
+        method(:sub_named_single_wildcard),
+        method(:sub_single_wildcard),
+        method(:sub_multi_wildcard)
+      ]
+    end
+
+    STAR = /\*/.freeze
+    HASH = /#/.freeze
+    NAMED = /:(\w+)/.freeze
+    NAMED_STAR = /#{STAR}#{NAMED}/.freeze
+    NAMED_HASH = /#{HASH}#{NAMED}/.freeze
+  end
+end

data/lib/cotton_tail/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cotton-tail
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.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-12-13 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -205,6 +205,7 @@ files:
 - examples/messages/intercept.with.middleware
 - examples/messages/say.goodbye
 - examples/messages/say.hello
+- examples/messages/send.kitten.to.tom
 - lib/cotton_tail.rb
 - lib/cotton_tail/app.rb
 - lib/cotton_tail/configuration.rb
@@ -212,6 +213,7 @@ files:
 - lib/cotton_tail/dsl/queue.rb
 - lib/cotton_tail/dsl/routes.rb
 - lib/cotton_tail/dsl/topic.rb
+- lib/cotton_tail/message_properties.rb
 - lib/cotton_tail/middleware.rb
 - lib/cotton_tail/middleware/router.rb
 - lib/cotton_tail/queue.rb
@@ -219,7 +221,9 @@ files:
 - lib/cotton_tail/queue/memory.rb
 - lib/cotton_tail/queue/reader.rb
 - lib/cotton_tail/queue/supervisor.rb
+- lib/cotton_tail/request.rb
 - lib/cotton_tail/route.rb
+- lib/cotton_tail/route_segment.rb
 - lib/cotton_tail/version.rb
 homepage: https://github.com/jamesBrennan/cotton-tail
 licenses: