myxi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afd97a9d7707f7273a9cc1526c16b838840de982
+  data.tar.gz: c3a82e6d83e6da41657ba23d17bcfec4f4bea14a
+SHA512:
+  metadata.gz: c25c8b738510f2e80d1897a85353705474157b3ac6446f4109b896dddede06ca87bd38123b972d1cc6624799560ed2f96c4a7cfc7608778388e64adc775e44f1
+  data.tar.gz: bf1995d685b86924c6a346a932c30f46ba8ce633d8593cb3133a04bc6923d68de22bbb5fd3d0df57dbf621ada5093e32c7e3701b6b24002940a688b7e1150f5c

data/lib/myxi.rb

@@ -0,0 +1,61 @@
+module Myxi
+  class << self
+
+    #
+    # Return a bunny client instance which will be used by the web socket service.
+    # This can be overriden if you already have a connection RabbitMQ available
+    # if your application. By default, it will connect to localhost or use the
+    # RABBITMQ_URL environment variable.
+    #
+    def bunny
+      @bunny ||= begin
+        require 'bunny'
+        bunny = Bunny.new(ENV['RABBITMQ_URL'])
+        bunny.start
+        bunny
+      end
+    end
+    attr_writer :bunny
+
+    #
+    # Return a channel which this process can always use
+    #
+    def channel
+      @channel ||= bunny.create_channel
+    end
+
+    #
+    # Store a bool of configured exchanges
+    #
+    def exchanges
+      @exchanges ||= begin
+        Myxi::Exchange::EXCHANGES.keys.inject({}) do |hash, name|
+          hash[name.to_sym] = channel.direct(name.to_s)
+          hash
+        end
+      end
+    end
+
+    #
+    # Push data to a given
+    #
+    def push(exchange, routing_key, &block)
+      if exch = exchanges[exchange.to_sym]
+        block.call(exch)
+      else
+        raise Error, "Couldn't send message to '#{exchange}' as it isn't configured"
+      end
+    end
+
+    #
+    # Send an event to the given exchange
+    #
+    def push_event(exchange, routing_key, event, payload = {})
+      push(exchange, routing_key) do |exch|
+        exch.publish({:event => event, :payload => payload}.to_json, :routing_key => routing_key.to_s)
+      end
+      true
+    end
+
+  end
+end

data/lib/myxi/action.rb

@@ -0,0 +1,22 @@
+module Myxi
+  class Action
+
+    ACTIONS = {}
+
+    def self.add(name, &block)
+      ACTIONS[name.to_sym] = self.new(name, &block)
+    end
+
+    def initialize(name, &block)
+      @name = name
+      @block = block
+    end
+
+    def execute(session, payload = {})
+      @block.call(session, payload)
+    end
+
+  end
+end
+
+require 'myxi/default_actions'

data/lib/myxi/default_actions.rb

@@ -0,0 +1,13 @@
+Myxi::Action.add(:Subscribe) do |session, payload|
+  session.subscribe(payload['exchange'], payload['routing_key'])
+end
+
+Myxi::Action.add(:Unsubscribe) do |session, payload|
+  if payload['exchange'] && payload['routing_key']
+    session.unsubscribe(payload['exchange'], payload['routing_key'])
+  elsif payload['exchange'] && payload['routing_key'].nil?
+    session.unsubscribe_all_for_exchange(payload['exchange'])
+  else
+    session.unsubscribe_all
+  end
+end

data/lib/myxi/exchange.rb

@@ -0,0 +1,51 @@
+module Myxi
+  class Exchange
+
+    EXCHANGES = {}
+
+    attr_accessor :exchange_name
+    attr_accessor :model_name
+    attr_accessor :key_type
+
+    def self.add(exchange_name, *args, &block)
+      EXCHANGES[exchange_name.to_sym] = self.new(exchange_name, *args, &block)
+    end
+
+    def self.declare_all
+      EXCHANGES.keys.each do |exch|
+        Myxi.channel.direct(exch.to_s)
+      end
+    end
+
+    def initialize(exchange_name, model_name = nil, &block)
+      @exchange_name = exchange_name.to_sym
+      @model_name = model_name
+      @permission_block = block
+    end
+
+    def has_model?
+      !!@model_name
+    end
+
+    def model
+      has_model? && model_name.constantize
+    end
+
+    def key_type
+      @key_type || 'id'
+    end
+
+    def model_instance(id)
+      has_model? ? model.where(key_type.to_sym => id.to_i).first : nil
+    end
+
+    def can_subscribe?(routing_key, user)
+      if has_model?
+        @permission_block.call(model_instance(routing_key), user)
+      else
+        @permission_block.call(routing_key, user)
+      end
+    end
+
+  end
+end

data/lib/myxi/server.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'em-websocket'
+require 'myxi'
+require 'myxi/session'
+require 'myxi/action'
+
+module Myxi
+  class Server
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def log(message)
+      if options[:debug]
+        puts message
+      end
+    end
+
+    def run
+      Myxi::Exchange.declare_all
+      port = (options[:port] || ENV['MYXI_PORT'] || ENV['PORT'] || 5005).to_i
+      puts "Running Myxi Web Socket Server on 0.0.0.0:#{port}"
+      EM.run do
+        EM::WebSocket.run(:host => options[:bind_address] || ENV['MYXI_BIND_ADDRESS'] || '0.0.0.0', :port => port) do |ws|
+
+          session = Session.new(ws)
+
+          ws.onopen do |handshake|
+            case handshake.path
+            when /\A\/pushwss/
+              log "[#{session.id}] Connection opened"
+              ws.send({:event => 'Welcome', :payload => {:id => session.id}}.to_json)
+
+              session.queue = Myxi.channel.queue("", :exclusive => true)
+              session.queue.subscribe do |delivery_info, properties, body|
+                ws.send(body)
+              end
+            else
+              log "[#{session.id}] Invalid path"
+              ws.send({:event => 'Error', :payload => {:error => 'PathNotFound'}}.to_json)
+              ws.close
+            end
+          end
+
+          ws.onclose do
+            log "[#{session.id}] Disconnected"
+            session.queue.delete if session.queue
+          end
+
+          ws.onmessage do |msg|
+            if ws.state == :connected
+              if json = JSON.parse(msg) rescue nil
+                session.tag = json['tag'] || nil
+                payload = json['payload'] || {}
+                if action = Myxi::Action::ACTIONS[json['action'].to_sym]
+                  action.execute(session, payload)
+                else
+                  ws.send({:event => 'Error', :tag => session.tag, :payload => {:error => 'InvalidAction'}}.to_json)
+                end
+              else
+                ws.send({:event => 'Error', :payload => {:error => 'InvalidJSON'}}.to_json)
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/myxi/session.rb

@@ -0,0 +1,83 @@
+require 'json'
+require 'myxi/exchange'
+
+module Myxi
+  class Session
+
+    def initialize(ws)
+      @ws = ws
+      @id  = SecureRandom.hex(8)
+    end
+
+    attr_reader :id
+    attr_reader :ws
+    attr_accessor :queue
+    attr_accessor :auth_object
+    attr_accessor :tag
+
+    #
+    # Keep track of all subscriptions
+    #
+    def subscriptions
+      @subscriptions ||= {}
+    end
+
+    #
+    # Send an event back to the client on this session
+    #
+    def send(name, payload = {})
+      ws.send({:event => name, :tag => tag, :payload => payload}.to_json)
+    end
+
+    #
+    # Subscribe this session to receive items for the given exchange & routing key
+    #
+    def subscribe(exchange_name, routing_key)
+      if exchange = Myxi::Exchange::EXCHANGES[exchange_name.to_sym]
+        if exchange.can_subscribe?(routing_key, self.auth_object)
+          queue.bind(exchange.exchange_name.to_s, :routing_key => routing_key.to_s)
+          subscriptions[exchange_name.to_s] ||= []
+          subscriptions[exchange_name.to_s] << routing_key.to_s
+          puts "[#{id}] Subscribed to #{exchange_name} / #{routing_key}"
+          send('Subscribed', :exchange => exchange_name, :routing_key => routing_key)
+        else
+          send('Error', :error => 'SubscriptionDenied', :exchange => exchange_name, :routing_key => routing_key)
+        end
+      else
+        send('Error', :error => 'InvalidExchange', :exchange => exchange_name)
+      end
+    end
+
+    #
+    # Unsubscribe this session from the given exchange name and routing key
+    #
+    def unsubscribe(exchange_name, routing_key)
+      queue.unbind(exchange_name.to_s, :routing_key => routing_key.to_s)
+      if subscriptions[exchange_name.to_s]
+        subscriptions[exchange_name.to_s].delete(routing_key.to_s)
+      end
+      send('Unsubscribed', :exchange_name => exchange_name, :routing_key => routing_key)
+    end
+
+    #
+    # Unscubribe all for an exchange
+    #
+    def unsubscribe_all_for_exchange(exchange_name)
+      if array = self.subscriptions[exchange_name.to_s]
+        array.dup.each do |routing_key|
+          self.unsubscribe(exchange_name.to_s, routing_key)
+        end
+      end
+    end
+
+    #
+    # Unsubscribe all
+    #
+    def unsubscribe_all
+      self.subscriptions.keys.each do |exchange_name|
+        self.unsubscribe_all_for_exchange(exchange_name)
+      end
+    end
+
+  end
+end

data/lib/myxi/version.rb

@@ -0,0 +1,3 @@
+module Myxi
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: myxi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A RabbitMQ-based web socket server & framework
+email:
+- me@adamcooke.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/myxi.rb
+- lib/myxi/action.rb
+- lib/myxi/default_actions.rb
+- lib/myxi/exchange.rb
+- lib/myxi/server.rb
+- lib/myxi/session.rb
+- lib/myxi/version.rb
+homepage: https://github.com/adamcooke/myxi
+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.5
+signing_key: 
+specification_version: 4
+summary: A RabbitMQ-based web socket server & framework
+test_files: []