plumbus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b89f274da67d1f431e10b3d41cca145b5499b0f
+  data.tar.gz: d46ab230187b679ad802a982992eb2ff500315bf
+SHA512:
+  metadata.gz: b3b36c8a6264c6c03305d4f5aa56372369fac782404e7f91fda78112e118d21cab0c99c09e42a84d9e81815ba6af549071f2fb4fedff1225f960780118fe5c4d
+  data.tar.gz: 6ed57aac6f1582a7b9b94b23d720c638a7d9039c05d1e077115e097c835ea6437ccfedadd7f0d6d057cdd04f160df8f8c6db0a49d38173a39774e4f6a92c2bfd

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.0

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 seotownsend@icloud.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plumbus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 seo
+
+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,109 @@
+![Plumbus: The micro-service bus](https://raw.githubusercontent.com/sotownsend/plumbus/master/docs/images/banner.png)
+
+[![Gem Version](https://badge.fury.io/rb/iarrogant.svg)](http://badge.fury.io/rb/plumbus)
+[![Build Status](https://travis-ci.org/sotownsend/plumbus.svg)](https://travis-ci.org/sotownsend/plumbus)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sotownsend/plumbus/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/sotownsend/plumbus/blob/master/LICENSE)
+
+# What is this?
+
+Plubus is an agnostic micro-service router. 
+
+## Features
+  - [x] Bring your archaic HTTP api into the micro-service age without modifying the API
+  - [x] *Any language, any networking or queuing library*
+  - [x] Distributed by design, even session information
+  - [x] Everything is a stream/push. Even HTTP (just a very short stream session!)
+  - [x] Mix & Match - Daisy-chainable
+
+
+## Example scenerio
+Let's take the case where you have an aging HTTP web-service API, and a new modern sock-io client.
+<div style='text-align: center'>
+  <img width=600 src='./docs/images/request_response_drivers.png' />
+</div>
+
+In this example, we're using an HTTP driver and sockio-driver on the request side. On the response side we have an HTTP driver & a redis-queue driver. This configuration
+allows us to serve all of our services located on the redis-bus & HTTP-bus to both sockio users and HTTP users!
+
+## Routing schemes
+Each request contains an action-name and session-id used for routing. Each response-driver maintains a running-list of available actions. If multiple action-paths are available,
+a round-robin scheme is used to deliver messages. Responses are delivered based on the session-id back to the original source. This allows many responses, for a request that has
+requested multiple actions which resulted in requests to multiple response backends, to deliver to the correct requester & know the status of the requester as signals are propogated
+back to the responders in the event the request is closed. A session is deemed over if all responders hang-up.
+
+## Streaming
+All connections in plumbus are streams. HTTP, as it is stateless, is just treated as a degenerate stream that closes it's session after a response is given. One of the neat-things
+about plumbus is that streams are able to hit multiple responses (by virtue of a request stream has sent multiple action requests and those were routed to seperate responses). This
+provides you with load-balancing on traditionally single-server streams (like sock.io).
+
+## Configuration
+Configure is handled through a ruby file. This file contains a listing of `ports` which are just driver instances that are declared on either the request or response side.
+```ruby
+port(:request, 'plumbus-http') do
+  #Driver specific config
+end
+
+port(:request, 'plumbus-sockio') do
+  #Driver specific config
+end
+
+port(:response, 'plumbus-http') do
+  #Driver specific config
+end
+
+port(:response, 'plumbus-redis-queue') do
+  #Driver specific config
+end
+```
+
+# Setup
+```js
+#Setup
+gem install plumbus
+```
+
+# Usage
+#### SYNOPSIS
+```js
+plumbus config
+```
+#### DESCRIPTION
+config is a ruby file that declares backends & frontends (called ports).
+
+## Requirements
+
+- Modern **nix** (FreeBSD, Mac, or Linux)
+- Ruby 2.2.1 or Higher (Very important)
+
+## Communication
+> ♥ This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+- If you **found a bug**, open an issue.
+- If you **have a feature request**, open an issue.
+- If you **want to contribute**, submit a pull request.
+
+## Installation
+
+RVM users:
+Run `gem install plumbus`
+
+System ruby installation?
+Run `sudo gem install plumbus`
+
+---
+
+## FAQ
+
+### When should I use plumbus?
+
+Todo
+
+### Creator
+
+- [Seo Townsend](http://github.com/sotownsend) ([@seotownsend](https://twitter.com/seotownsend))
+
+
+## License
+
+plumbus is released under the MIT license. See LICENSE for details.

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/plumbus

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plumbus"
+require 'yaml'
+require 'optparse'
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: plumbus config"
+end
+parser.parse!
+
+unless config_path = ARGV.pop
+  $stderr.puts parser
+  exit -1
+end
+
+Plumbus::Loader.load config_path
+
+$stderr.puts <<HERE
+         (((                 
+  ((     ((((                
+   ((((((((((((((((((        
+     (((((((((((((           
+  (((((((((((((              
+(((((((((((((               
+        ******              
+         ******             
+          ******             
+          *******            
+           **********        
+            *************    
+         ******************  
+        ***************(**** 
+        *************((/((/**
+       *************((((((((/
+       *************//////(//
+       **********************
+        *********************
+         ******************* 
+          ****************   
+             ***********     
+-----------------------------------------
+HERE
+
+
+while 100
+  $stderr.puts ">Ready to get Riggity Riggity Wrecked Son!"
+  sleep 1000
+end

data/lib/plumbus.rb

@@ -0,0 +1,12 @@
+require "plumbus/version"
+require "plumbus/driver_facilities"
+require "plumbus/driver"
+require "plumbus/port"
+require "plumbus/ports"
+require "plumbus/loader"
+
+require "plumbus/helpers/trim"
+require "plumbus/helpers/remove_references"
+
+module Plumbus
+end

data/lib/plumbus/driver.rb

@@ -0,0 +1,28 @@
+require 'active_support/inflector'
+
+module Plumbus
+  module Driver
+    #Available drivers
+    @@link_table = {}
+
+    def self.load driver_name
+      require driver_name.to_s
+
+      return self.add_link driver_name
+    rescue LoadError => e
+      raise LoadError, "Driver named #{driver_name.inspect} failed to load.  Are you sure it's installed correctly?: #{e.inspect}"
+    end
+
+    private
+
+    def self.add_link name
+      mod = name.to_s.classify.constantize
+      @@link_table[name.to_sym] = mod
+      $stderr.puts "[Driver #{name.inspect} linked]"
+
+      return mod
+    end
+
+    def self.link_table() return @@link_table end
+  end
+end

data/lib/plumbus/driver_facilities.rb

@@ -0,0 +1,17 @@
+#Used by actual drivers
+module Plumbus
+  module DriverFacilities
+    #This is imported into the Port (which is a driver) interface
+    def invalidate_supported_actions
+      Ports.refresh_port_routing_table self
+    end
+
+    def emit_message sid, action, payload
+      Ports.forward_message port:self, sid:sid, action:action, payload:payload
+    end
+
+    def raise_signal name, info
+      Ports.signal port:self, name:name, info:info
+    end
+  end
+end

data/lib/plumbus/helpers/remove_references.rb

@@ -0,0 +1,30 @@
+class Hash
+  def remove_references! obj
+    self.select{|k, v| [Array, Hash].include? v.class}.each do |k, v|
+      v.remove_references! obj
+    end
+    self.select{|k, v| not [Array, Hash].include? v.class}.each do |k, v|
+      if v == obj
+        self.delete(k)
+      end
+    end
+
+    self
+  end
+end
+
+class Array
+  def remove_references! obj
+    self.select{|e| [Array, Hash].include? e.class}.each do |e|
+      e.remove_references! obj
+    end
+
+    self.select{|e| not [Array, Hash].include? e.class}.each_with_index do |e, i|
+      if e == obj
+        self.delete(obj)
+      end
+    end
+
+    self
+  end
+end

data/lib/plumbus/helpers/trim.rb

@@ -0,0 +1,45 @@
+class Hash
+  #Removes all sub-hashes & arrays that have no objects in them.
+  def trim!
+    self.each do |k, v|
+      if v.class == Array
+
+        v.trim!
+
+        #Blank array, dump it
+        if v.count == 0
+          self.delete k
+        end
+      elsif v.class == Hash
+        v.trim!
+
+        if v.keys.count == 0
+          self.delete k
+        end
+      end
+    end
+
+    return self
+  end
+end
+
+class Array
+  def trim!
+    self.each do |e|
+      if e.class == Hash
+        e.trim!
+
+        if e.keys.count == 0
+          self.delete e
+        end
+      elsif e.class == Array
+        e.trim!
+        if e.count == 0
+          self.delete(e)
+        end
+      end
+    end
+
+    return self
+  end
+end

data/lib/plumbus/loader.rb

@@ -0,0 +1,44 @@
+module Plumbus
+  module Loader
+    def self.load path
+      self.unload_all
+      dsl = LoaderDSL.new(path)
+
+      #Load ports
+      dsl.ports.each do |_port|
+        direction = _port[:direction]
+        driver = _port[:driver]
+        config_block = _port[:config_block]
+
+        #Load driver if not already loaded
+        klass = Driver.load driver
+
+        #Create instance of driver module
+        port = Port.new(driver_module_klass: klass, direction: direction)
+        port.config &config_block
+        port.attach!
+      end
+    end
+
+    def self.unload_all
+      Ports.detach_all
+    end
+  end
+
+  class LoaderDSL
+    attr_reader :ports
+
+    def initialize src_path
+      @ports = []
+      contents = File.read(src_path)
+
+      instance_eval contents, src_path
+    end
+
+    def port direction, driver, &config_block
+      raise ArgumentError, "The given direction #{direction.inspect} was not a valid direction. Valid directions include #{Port::SUPPORTED_DIRECTIONS.inspect}" unless Port::SUPPORTED_DIRECTIONS.include? direction
+      raise ArgumentError, "No config block was given for the port #{direction.inspect}, #{driver.inspect}" unless config_block
+      @ports << {:direction => direction, :driver => driver, :config_block => config_block}
+    end
+  end
+end

data/lib/plumbus/port.rb

@@ -0,0 +1,51 @@
+require 'active_support/inflector'
+
+#Contains the class for each port
+module Plumbus
+  class Port
+    SUPPORTED_DIRECTIONS = [:request, :response]
+
+    attr_reader :driver_module_klass, :direction
+
+    def initialize driver_module_klass:, direction:
+      @driver_module_klass = driver_module_klass
+      @direction = direction
+
+      #@driver = Plumbus::PortDriver.new
+      extend DriverFacilities
+      extend "#{@driver_module_klass.name}::PlumbusHandlers".constantize
+    end
+
+    def attach!
+      Ports.attach_port self
+    end
+
+    #def detach!
+      #Ports.detach_port self
+    #end
+
+    def opposite_direction
+      @direction == :request ? :response : :request
+    end
+  end
+
+  class PortDriver
+    #Plumbus extended handlers
+    ###############################################################
+    def config &block
+    end
+
+    #Forward a message to the block for a sid
+    def forward_message sid, action, info
+    end
+
+    #Forward a signal, like disconnection
+    def forward_signal signal, info
+    end
+
+    def supported_actions
+      return @supported_actions
+    end
+    ###############################################################
+  end
+end

data/lib/plumbus/ports.rb

@@ -0,0 +1,123 @@
+#Ports manages the actual instances of the port classes
+module Plumbus
+  module Ports
+    #Instances#########################################################
+    #Holds instances
+    @@instances = []
+    def self.instances; @@instances end
+
+    #Attach a port
+    def self.attach_port port
+      @@instances << port
+      refresh_port_routing_table port
+    end
+
+    def self.refresh_port_routing_table port
+      evict_routing_table_references port
+
+      port.supported_actions.each do |action|
+        action = action.to_s
+        @@routing_table[port.opposite_direction][action] ||= []
+        @@routing_table[port.opposite_direction][action] << port
+      end
+    end
+
+    def self.evict_routing_table_references port
+      @@routing_table[port.opposite_direction].remove_references! port
+      @@routing_table[port.opposite_direction].trim!
+    end
+
+    #def self.detach_port port
+      #evict_routing_table_references port
+      #@@instances -= [port]
+      #Needs to support the sid_to_ports
+    #end
+
+    def self.detach_all
+      @@instances.each do |port|
+        evict_routing_table_references port
+      end
+      @@instances = []
+      @@sid_to_ports = {}
+    end
+
+    #Routing###########################################################
+    #Holds routing table which maps from
+    @@routing_table = {
+      :request => {},
+      :response => {},
+    }
+
+    #Maps a sid into one request port and potentionally many response ports
+    #via [request, Set<response0, response1...>]
+    @@sid_to_ports = {}
+
+    #This returns the *response* (destination) ports for a request originating on the
+    #request side.  I.e. it returns a response port.
+    def self.response_ports_for_request(action:)
+      action = action.to_s
+      @@routing_table[:request][action] || []
+    end
+
+    def self.response_port_for_request(action:)
+      return self.response_ports_for_request(action: action).first
+    end
+
+    def self.request_port_for_response(sid:)
+      return (@@sid_to_ports[sid] || [])[0]
+    end
+
+    def self.signal(port:, name:, info:)
+      case name
+      when :hangup
+        sid = info[:sid]
+        if ports = @@sid_to_ports[sid]
+          #Get request port (0)
+          req_port = ports[0]
+
+          #The request side hungup
+          set = ports[1]
+          if req_port == port
+            set.each do |p|
+              p.handle_signal :hangup_notice, {:sid => sid}
+            end
+            @@sid_to_ports.delete sid
+          else
+            #Remove ourselves (response) from response set
+            set.delete(port)
+
+            #Signal request of termination
+            if set.length == 0
+              @@sid_to_ports.delete sid
+              req_port.handle_signal :hangup_notice, {:sid => sid}
+            end
+          end
+        end
+      end
+    end
+
+    def self.forward_message(port:, sid:, action:, payload:)
+      if port.direction == :request
+        if req_port = response_port_for_request(action: action)
+          if ports = @@sid_to_ports[sid]
+            ports[1] << req_port
+          else
+            req_set = Set.new [req_port]
+            @@sid_to_ports[sid] = [port, req_set]
+          end
+          req_port.handle_message sid, action.to_s, payload
+        else
+          #undeliverable
+          port.handle_signal :undeliverable, {sid: sid}
+        end
+      elsif port.direction == :response
+        if res_port = request_port_for_response(sid: sid)
+          res_port.handle_message sid, action, payload
+        else
+          #undeliverable
+          port.handle_signal :undeliverable, {sid: sid}
+        end
+      end
+    end
+  end
+end

data/lib/plumbus/version.rb

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

data/plumbus.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plumbus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plumbus"
+  spec.version       = Plumbus::VERSION
+  spec.authors       = ["seo"]
+  spec.email         = ["seotownsend@icloud.com"]
+
+ 
+  spec.summary       = "Plubus is an agnostic micro-service router."
+  spec.homepage      = "http://github.com/sotownsend/plumbus"
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_runtime_dependency "activesupport", "~> 4.2"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: plumbus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- seotownsend@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/plumbus
+- docs/images/banner.png
+- docs/images/request_response_drivers.png
+- lib/plumbus.rb
+- lib/plumbus/driver.rb
+- lib/plumbus/driver_facilities.rb
+- lib/plumbus/helpers/remove_references.rb
+- lib/plumbus/helpers/trim.rb
+- lib/plumbus/loader.rb
+- lib/plumbus/port.rb
+- lib/plumbus/ports.rb
+- lib/plumbus/version.rb
+- plumbus.gemspec
+homepage: http://github.com/sotownsend/plumbus
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Plubus is an agnostic micro-service router.
+test_files: []