sock-drawer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aed78bab3749fc12dac0bab025f9677595d9300
+  data.tar.gz: 1ef7a4f58fd5810ee7a9abe707ca5919cae8f882
+SHA512:
+  metadata.gz: c5c7a1b748211288e7b9c265c78baec327483cddbbbc8c40ea81f5e96af6e6187c6f2c962af923b0e89642b5473bd0fe30f83bb0a31f9c43b4b6a628aa8191e4
+  data.tar.gz: 5f90cb1049216f6e32fb69653c807a51e29761d7a08a9604d050f78f87c75439243c183243f64f6ca092f9f6c223caa4b9a1e89ef530fb5d19d69b3721513996

data/.gitignore

@@ -0,0 +1,43 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adam Hess
+
+MIT License
+
+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,71 @@
+# Sock::Drawer
+
+This gem allows message async message calls to subscribed listeners.
+Messages can be fired between ruby objects or to listening websocket connections.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sock-drawer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sock-drawer
+
+## Usage
+
+Initialize a instance of the sock client
+
+```Ruby
+sock = Sock::Client.new(logger: Rails.logger, redis: redis)
+```
+
+Publish an event on a channel,
+
+```Ruby
+sock.pub("my message", postfix: "my-channel")
+```
+
+Subscribe to events fired from a specific sock server,
+
+```Ruby
+sock.sub(server, "my-channel") do |message|
+  puts message
+end
+```
+
+To capture the event in Javascript use something like,
+
+```javascript
+var webSocket = new WebSocket("ws://" + location.hostname + ":8081/" + "my-channel");
+
+webSocket.onmessage = function(event) {
+  console.log(event.data);
+}
+```
+
+If you wish to start the sock server in another thread you can use
+
+    $ rake sock:server
+
+And you are good to go!
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sock-drawer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Running the tests
+
+if you are going to contribute, I hope you run the tests at least once -- hopefully many times.
+to run the tests, you must have redis-server running in the background with default configuration.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'sock/drawer'
+
+namespace :sock do
+  desc 'start the sock-drawer server to manage socket connections'
+  task :server do
+    Sock::Server.new.start!
+  end
+end

data/lib/sock/client.rb

@@ -0,0 +1,30 @@
+module Sock
+  # Client is the interface for publishing events to Drawer
+  class Client
+    def initialize(name: DEFAULT_NAME,
+                   logger: Logger.new(STDOUT),
+                   redis: Redis.new)
+      @logger = logger
+      @name = name
+      @redis = redis
+    end
+
+    # send a message to all subscribed listeners.
+    def pub(msg, postfix: '')
+      @logger.info "sending #{msg} on channel: #{channel_name(postfix)}"
+      @redis.publish(channel_name(postfix), msg)
+    end
+
+    # subscribe to all events fired on a given channel
+    def sub(server, channel, &block)
+      @logger.info "subscribing to #{channel}"
+      server.channel(channel_name(channel)).subscribe { |msg| block.call(msg) }
+    end
+
+    private
+
+    def channel_name(postfix)
+      "#{@name}/#{postfix}"
+    end
+  end
+end

data/lib/sock/drawer/version.rb

@@ -0,0 +1,7 @@
+module Sock
+  # supply the version number
+  class Drawer
+    # The current version of sock-drawer
+    VERSION = '0.0.2'
+  end
+end

data/lib/sock/drawer.rb

@@ -0,0 +1,17 @@
+require 'sock/drawer/version'
+require 'em-websocket'
+require 'em-hiredis'
+require 'redis'
+require 'logger'
+require 'sock/client'
+require 'sock/server'
+
+# Sock is the top level module for sock objects
+module Sock
+  # the default prefix of events listened to on redis
+  DEFAULT_NAME = 'sock-hook'
+  # the default host to run the websocket server on
+  HOST = '0.0.0.0'
+  # the default port to run the websocket server on.
+  PORT = 8020
+end

data/lib/sock/server.rb

@@ -0,0 +1,79 @@
+module Sock
+  # server provides a EM process that will manage websocket connections
+  class Server
+    attr_reader :channels, :logger, :name
+    def initialize(name: DEFAULT_NAME,
+                   logger: Logger.new(STDOUT),
+                   socket_params: { host: HOST, port: PORT },
+                   mode: 'default')
+      @name = name
+      @socket_params = socket_params
+      @channels = {}
+      @logger = logger
+      @mode = mode
+    end
+
+    # utility method used to subscribe on the default name and start the socket server
+    def start!
+      EM.run do
+        subscribe(@name)
+        socket_start_listening
+      end
+    end
+
+    # subscribe fires a event on a EM channel whenever a message is fired on a pattern matching
+    # @name (default: "sock-hook/") + '*'
+    def subscribe(subscription)
+      @logger.info "Subscribing to: #{subscription + '*'}"
+      pubsub.psubscribe(subscription + '*') do |chan, msg|
+        @logger.info "pushing c: #{chan} msg: #{msg}"
+        channel(chan).push(msg)
+      end
+    end
+
+    # channel will find or create a EM channel.
+    # channels can have new events pushed on them or subscribe to events from them.
+    def channel(channel_name)
+      @logger.info "creating channel #{channel_name}" unless @channels[channel_name]
+      @channels[channel_name] ||= EM::Channel.new
+    end
+
+
+    # starts the websocket server
+    # on open this server will find a new channel based on the path
+    # on message it will fire an event to the default 'incoming-hook' channel.
+    # on close, we do nothing. (future direction: would be nice to unsubscribe the websocket event if we know it is the only one listening to that channel)
+    def socket_start_listening
+      EventMachine::WebSocket.start(@socket_params) do |ws|
+        handle_open(ws)
+        handle_message(ws)
+        handle_close(ws)
+      end
+    end
+
+    private
+
+    def handle_open(ws)
+      ws.onopen do |handshake|
+        @logger.info "sock opened on #{handshake.path}"
+        channel(@name + handshake.path).subscribe { |msg| ws.send(msg) }
+      end
+    end
+
+    def handle_message(ws)
+      ws.onmessage { |msg| channel('incoming-hook').push(msg) }
+    end
+
+    def handle_close(ws)
+      # TODO: how can I know the sid to remove this subscription?
+      ws.onclose {
+        @logger.info "connection closed"
+        # channel(@name + handshake.path).unsubscribe(sid)
+      }
+    end
+
+    def pubsub
+      @pubsub ||= EM::Hiredis.connect.pubsub
+    end
+  end
+end

data/sock-drawer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sock/drawer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sock-drawer'
+  spec.version       = Sock::Drawer::VERSION
+  spec.authors       = ['Adam Hess']
+  spec.email         = ['adamhess1991@gmail.com']
+  spec.summary       = 'Super simple websocket manager.'
+  spec.description   = 'Provide a really simple interface'\
+                       'to manage events in ruby and via websockets using ruby and event machine.'
+  spec.homepage      = 'http://www.thisisadam.me'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis'
+  spec.add_dependency 'eventmachine'
+  spec.add_dependency 'em-hiredis'
+  spec.add_dependency 'em-websocket'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'em-websocket-client'
+end

data/spec/client_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'logger'
+
+RSpec.describe Sock::Drawer do
+  let(:redis) { Redis.new }
+  let(:sock) { Sock::Client.new(redis: redis, logger: Logger.new(nil)) }
+
+  context '#pub' do
+    it 'subscribes to events from redis with that name' do
+      expect(redis).to receive(:publish).with('sock-hook/new_channel', 'hi')
+      sock.pub('hi', postfix: 'new_channel')
+    end
+  end
+
+  context '#sub' do
+    let(:server) { Sock::Server.new(logger: Logger.new(nil)) }
+    let(:hi_redis) { EM::Hiredis.connect }
+
+    it 'can register a callback to be run when a event comes through redis' do
+      steps :fire, :received
+      sock.sub(server, 'hi') { |msg|
+        expect(msg).to eq('hi there')
+        complete :received
+      }
+      event_block do
+        server.subscribe(server.name).callback do
+          hi_redis.publish('sock-hook/hi', 'hi there').callback do
+            complete :fire
+          end
+        end
+      end
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'em-websocket-client'
+
+# TODO rename to server spec
+
+RSpec.describe Sock::Server do
+  let(:server) { Sock::Server.new(logger: Logger.new(nil)) }
+  let(:redis) { Redis.new }
+  let(:hi_redis) { EM::Hiredis.connect }
+  let(:sock) { Sock::Client.new(redis: redis, logger: Logger.new(nil)) }
+
+  context '#subscribe' do
+    it 'creates a channel for redis events to fire on' do
+      steps :subscribe
+      event_block do
+        df = server.subscribe('my-sub')
+        df.callback { |subs|
+          expect(subs).to eq(1)
+          complete :subscribe
+        }
+      end
+    end
+
+    it 'pushes an event onto a channel when a redis event is fired' do
+      steps :fire
+      event_block do
+        server.subscribe('my-sub')
+        df = hi_redis.publish('my-sub', 'hello')
+        df.callback {
+          expect(server.channels.keys).to eq(['my-sub'])
+          complete :fire
+        }
+      end
+    end
+
+    it 'will not create another channel if one already exists' do
+      steps :fire_1, :fire_2
+      event_block do
+        server.subscribe('my-sub')
+        hi_redis.publish('my-sub', 'hello').callback {
+          expect(server.channels.keys).to eq(['my-sub'])
+          complete :fire_1
+
+          hi_redis.publish('my-sub', 'goodbye').callback {
+            expect(server.channels.keys).to eq(['my-sub'])
+            complete :fire_2
+          }
+        }
+      end
+    end
+  end
+
+  context '#channel' do
+    it 'finds or creates a channel' do
+      server.channel('heyo')
+      expect(server.channels.keys).to eq(['heyo'])
+    end
+
+    it 'prevents duplicates' do
+      server.channel('heyo')
+      server.channel('whatup')
+      expect(server.channels.keys.sort).to eq(['heyo', 'whatup'].sort)
+    end
+
+    it 'can have events attached to it' do
+      steps :subscribe
+      event_block do
+        server.channel('9 news').subscribe { |msg|
+          expect(msg).to eq('hello there')
+          complete :subscribe
+        }
+        server.channel('9 news').push("hello there")
+      end
+    end
+  end
+
+  context '#socket_start_listening' do
+    let(:conn) { EventMachine::WebSocketClient.connect("ws://0.0.0.0:8020/") }
+
+    it 'subscribes to a channel when a connection opens' do
+      steps :open
+      event_block do
+        server.socket_start_listening
+        EventMachine::WebSocketClient.connect("ws://0.0.0.0:8020/").callback do
+          expect(server.channels.keys).to eq(['sock-hook/'])
+          complete :open
+        end
+      end
+    end
+
+    it 'opens different channels for different routes' do
+      steps :open
+      event_block do
+        server.socket_start_listening
+        EventMachine::WebSocketClient.connect("ws://0.0.0.0:8020/hi").callback do
+          expect(server.channels.keys).to eq(['sock-hook/hi'])
+          complete :open
+        end
+      end
+    end
+
+    it 'sends whatever message is sent across the channel' do
+      steps :open, :receive
+      event_block do
+        server.socket_start_listening
+        conn.callback do
+          server.channels['sock-hook/'].push('What up')
+          complete :open
+        end
+
+        conn.stream do |msg|
+          expect(msg.data).to eq('What up')
+          complete :receive
+        end
+      end
+    end
+
+    it 'will send incoming webhooks to a channel' do
+      steps :open, :receive
+      event_block do
+        server.socket_start_listening
+        conn.callback do
+          conn.send_msg('LGTM')
+          complete :open
+          server.channel('incoming-hook').subscribe { |msg|
+            expect(msg).to eq('LGTM')
+            complete :receive
+          }
+        end
+      end
+    end
+
+    it 'does nothing on close yet' do
+      # TODO: unsub sid
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'sock/drawer'
+require 'pry'
+
+def event_block
+  Timeout::timeout(5) do
+    EM.run do
+      EM.epoll
+      yield
+    end
+  end
+rescue Timeout::Error
+  fail "Eventmachine was not stopped with #{@_em_steps} left"
+end
+
+def steps(*steps)
+  @_em_steps = *steps
+end
+
+def complete(step)
+  @_em_steps.delete(step)
+  EM.stop if @_em_steps.empty?
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: sock-drawer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adam Hess
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide a really simple interfaceto manage events in ruby and via websockets
+  using ruby and event machine.
+email:
+- adamhess1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sock/client.rb
+- lib/sock/drawer.rb
+- lib/sock/drawer/version.rb
+- lib/sock/server.rb
+- sock-drawer.gemspec
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.thisisadam.me
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Super simple websocket manager.
+test_files:
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb