noticer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43653b4656c7a1b1cbf3da2176e40faadd0f865a
+  data.tar.gz: e2db94dbe6652c20cd2fd802ddbc6188e905e044
+SHA512:
+  metadata.gz: c2004bb679bbd12cb037a266f66d1be08d67f305fc46b9c0db0aebea5d2bcb3c8deb260c149fd569cba63e4a96ae0967804de230a3bd3ace57890d1c02be7b0f
+  data.tar.gz: 2ffcfd029020eb6bea1e7a88212973de307e64208e4d63e5a7946abc137d9015753f5bc6fc785419c3403dfb21b07b70013602389bdc7b2dc6e1b1ba010a4f4d

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown}]
+indent_size = 4

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,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - jruby-9.0.5.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in noticer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Leonardo Alifraco
+
+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,74 @@
+[![Build Status](https://travis-ci.org/leonardoalifraco/noticer.svg?branch=master)](https://travis-ci.org/leonardoalifraco/noticer)
+[![Code Climate](https://codeclimate.com/github/leonardoalifraco/noticer/badges/gpa.svg)](https://codeclimate.com/github/leonardoalifraco/noticer)
+
+# Noticer
+
+Noticer is a gem that allows the emission of notifications using a topic routing algorithm.
+
+Configure the routing patterns along with a callback which is executed when the notification routing key matches the pattern.
+
+It's useful when you want to abstract your application from different notification providers, or when the notification providers does not have message routing features (ie: AWS SNS).
+
+Routing patterns allow the following wildcards:
+
+```
+* (star) can substitute for exactly one word.
+# (hash) can substitute for zero or more words.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'noticer'
+```
+
+Then run:
+
+``` shell
+bundle install
+```
+
+## Usage
+
+First configure the routing patterns along with the callbacks.
+
+``` ruby
+Noticer.configure do |config|
+  config.notification_routes = [
+    {
+      routing_patterns: ['tree.green', 'tree.red'],
+      callback: -> (routing_key, message) {
+        # notify by email
+      }
+    },
+    {
+      routing_patterns: ['tree.*'],
+      callback: -> (routing_key, message) {
+        # notify to log
+      }
+    }
+  ]
+end
+```
+
+Then emit the required messages.
+
+``` ruby
+# This will dispatch both notification callbacks
+Noticer.emit('tree.green', 'A green tree was planted.')
+
+
+# This will dispatch only the log callback
+Noticer.emit('tree.blue', 'A blue tree was planted.')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leonardoalifraco/noticer.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "noticer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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/noticer/configuration.rb

@@ -0,0 +1,9 @@
+module Noticer
+  class Configuration
+    attr_accessor :notification_routes
+
+    def initialize
+      @notification_routes = []
+    end
+  end
+end

data/lib/noticer/dispatcher.rb

@@ -0,0 +1,47 @@
+module Noticer
+  class Dispatcher
+    def initialize(configuration = nil)
+      @configuration = configuration || Configuration.new
+    end
+
+    def emit(routing_key, message)
+      self.filtered_callbacks(routing_key).each do |ac|
+        ac[:callback].call(routing_key, message)
+      end
+    end
+
+    private
+    def filtered_callbacks(routing_key)
+      return @configuration.notification_routes.select do |ac|
+        ac[:routing_patterns].any? do |pattern|
+          topic_matches(pattern, routing_key)
+        end
+      end
+    end
+
+    def split_topic_key(key)
+      key.split(/\./).map(&:to_sym)
+    end
+
+    def topic_matches(p, r)
+      topic_matches_1(split_topic_key(p), split_topic_key(r))
+    end
+
+    def topic_matches_1(p, r)
+      p_head, *p_tail = *p
+      r_head, *r_tail = *r
+      return true if p.size == 1 && p_head == :"#"
+      return last_topic_match(p_tail, [], r.reverse) if p_head == :"#"
+      return true if p.empty? && r.empty?
+      return topic_matches_1(p_tail, r_tail) if p_head == :"*"
+      return topic_matches_1(p_tail, r_tail) if p_head == r_head
+      false
+    end
+
+    def last_topic_match(p, r, a)
+      return topic_matches_1(p, r) if a.empty?
+      backtrack_next, *backtrack_list = *a
+      return topic_matches_1(p, r) || last_topic_match(p, r.unshift(backtrack_next), backtrack_list)
+    end
+  end
+end

data/lib/noticer/version.rb

@@ -0,0 +1,3 @@
+module Noticer
+  VERSION = "0.1.0"
+end

data/lib/noticer.rb

@@ -0,0 +1,17 @@
+require "noticer/version"
+require "noticer/configuration"
+require "noticer/dispatcher"
+
+module Noticer
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/noticer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'noticer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "noticer"
+  spec.version       = Noticer::VERSION
+  spec.authors       = ["Leonardo Alifraco"]
+  spec.email         = ["leonardo.alifraco@gmail.com"]
+
+  spec.summary       = "Noticer a gem that allows the emission of notifications using a topic routing algorithm."
+  spec.description   = "Noticer a gem that allows the emission of notifications using a topic routing algorithm."
+  spec.homepage      = "https://github.com/leonardoalifraco/noticer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: noticer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonardo Alifraco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Noticer a gem that allows the emission of notifications using a topic
+  routing algorithm.
+email:
+- leonardo.alifraco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/noticer.rb
+- lib/noticer/configuration.rb
+- lib/noticer/dispatcher.rb
+- lib/noticer/version.rb
+- noticer.gemspec
+homepage: https://github.com/leonardoalifraco/noticer
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Noticer a gem that allows the emission of notifications using a topic routing
+  algorithm.
+test_files: []