sock-drawer 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ab68044399788524e5e29a7937713cd512e609a
-  data.tar.gz: e3bb6c724cb37eed6d71946906ab47b2f6372202
+  metadata.gz: a2e3e0c5fd32ba6df30d8b2d50fec26a94bbcf51
+  data.tar.gz: 0fd0deb7386a08d81f8a70a427282bab09b2b490
 SHA512:
-  metadata.gz: 279ad0b81ce5d9d0365992084c776abf361f19375e33757ef9bb9c2917d92986a83e768ae7c04b3c09c0b2f882e08c3b83505f061f2b0c04b3d5fef34df28634
-  data.tar.gz: c89ea6d068ca911f355112f4a375345e9f7c0a82fbb54e1b0c1a31600093f72080426b70e57c68e236b987d72c94af3ad08f9c996b863933e44d859c355d3535
+  metadata.gz: df26b6ff39efb6fb87292133e728c250728cd54a0f1cc819a0f41b555fea95eca245c32f650e839774182108c72c84c1cf100252b98e34332e20114ef8b36f14
+  data.tar.gz: 753591b431fc63947bdf19836258fe6397431287052a93709938fcc74e99e896525acab419172b30f669615756697d6091ef691d5957bded4b9069706e07b1a5

data/.gitignore

@@ -21,7 +21,7 @@ mkmf.log
 /test/tmp/
 /test/version_tmp/
 /tmp/
-
+dump.rdb
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/

data/README.md

@@ -25,26 +25,28 @@ Or install it yourself as:
 
 ## Usage
 
-Initialize a instance of the sock client
+Initialize a instance of the sock-drawer client
 
 ```Ruby
 sock = Sock::Client.new(logger: Rails.logger, redis: redis)
 ```
 
+### Publishing
+
 Publish an event on a channel,
 
 ```Ruby
-sock.pub("my message", postfix: "my-channel")
+sock.pub("my message", channel: "my-channel")
 ```
 
-Subscribe to events fired from a specific sock server,
+or publish to all channels,
 
 ```Ruby
-sock.sub(server, "my-channel") do |message|
-  puts message
-end
+sock.pub("my message")
 ```
 
+### Receiving in Javascript
+
 To capture the event in Javascript use something like,
 
 ```javascript
@@ -55,9 +57,57 @@ webSocket.onmessage = function(event) {
 }
 ```
 
-If you wish to start the sock server in another thread you can use
+### Subscribing
+
+Create a class to handle redis events like,
+
+```Ruby
+class MyListener
+  include Sock::Subscriber
+
+  on 'echo' do |msg|
+    msg
+  end
+end
+```
+
+Then register your listener with the server
+
+```Ruby
+Sock::Server.new(listener: MockClass)
+```
+
+Whenever an event is fired on the `sock-hook/echo` channel the block will be executed.
+
+
+### Configuration
+
+you can configure your sock server to run as a rake task like,
+
+```Ruby
+namespace :sock do
+  desc 'start the sock-drawer server to manage socket connections'
+  task :server do
+    Sock::Server.new.start!
+  end
+end
+```
+
+Then run it with `rake sock:server`
+Current supported configuration options:
+
+| keyword arg | default |
+| ----------- | ------- |
+| name | 'sock-hook'
+| logger | Logger.new(STDOUT) |
+| socket_params | { host: '0.0.0.0', port: 8020 } |
+| mode | 'default' |
+| listener | N/A |
+
+## Wish List
 
-    $ rake sock:server
+- Right now all configuration is passed into new, it would be nice to read from a config file
+- There isn't a way of having multiple event handlers. Should be easy to pass multiple in or intelligently find them (given some convention)
 
 And you are good to go!
 

data/lib/sock/client.rb

@@ -10,15 +10,9 @@ module Sock
     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) }
+    def pub(msg, channel: '')
+      @logger.info "sending #{msg} on channel: #{channel_name(channel)}"
+      @redis.publish(channel_name(channel), msg)
     end
 
     private

data/lib/sock/drawer.rb

@@ -5,6 +5,7 @@ require 'redis'
 require 'logger'
 require 'sock/client'
 require 'sock/server'
+require 'sock/subscriber'
 
 # Sock is the top level module for sock objects
 module Sock

data/lib/sock/drawer/version.rb

@@ -2,6 +2,6 @@ module Sock
   # supply the version number
   class Drawer
     # The current version of sock-drawer
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/lib/sock/server.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Sock
   # server provides a EM process that will manage websocket connections
   class Server
@@ -5,23 +7,26 @@ module Sock
     def initialize(name: DEFAULT_NAME,
                    logger: Logger.new(STDOUT),
                    socket_params: { host: HOST, port: PORT },
-                   mode: 'default')
+                   mode: 'default',
+                   listener: nil)
       @name = name
       @socket_params = socket_params
       @channels = {}
       @logger = logger
       @mode = mode
+      @listener = listener
     end
 
     # utility method used to subscribe on the default name and start the socket server
     def start!
       EM.run do
+        register!
         subscribe(@name)
         socket_start_listening
       end
     end
 
-    # subscribe fires a event on a EM channel whenever a message is fired on a pattern matching
+    # subscribe fires a event on a EM channel whenever a message is fired on a pattern matching `name`.
     # @name (default: "sock-hook/") + '*'
     def subscribe(subscription)
       @logger.info "Subscribing to: #{subscription + '*'}"
@@ -38,7 +43,6 @@ module Sock
       @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.
@@ -51,6 +55,15 @@ module Sock
       end
     end
 
+    def register!
+      @listener.channels.each do |chan, block|
+        subscribe(@name + '/' + chan)
+        channel(@name + '/' + chan).subscribe { |msg|
+          block.call(msg)
+        }
+      end
+    end
+
     private
 
     def handle_open(ws)

data/lib/sock/subscriber.rb

@@ -0,0 +1,18 @@
+module Sock
+  # module for catching events fired from redis
+  module Subscriber
+    def self.included(base)
+      base.extend(SubscriberDSL)
+    end
+
+    module SubscriberDSL
+      def on(channel, &block)
+        channels[channel] = block
+      end
+
+      def channels
+        @_channels ||= {}
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -1,34 +1,15 @@
 require 'spec_helper'
 require 'logger'
+require 'mock_class'
 
 RSpec.describe Sock::Drawer do
-  let(:redis) { Redis.new }
-  let(:sock) { Sock::Client.new(redis: redis, logger: Logger.new(nil)) }
-
   context '#pub' do
+    let(:redis) { Redis.new }
+    let(:sock) { Sock::Client.new(redis: redis, logger: Logger.new(nil)) }
+
     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
+      sock.pub('hi', channel: 'new_channel')
     end
   end
 end

data/spec/mock_class.rb

@@ -0,0 +1,17 @@
+class MockClass
+  include Sock::Subscriber
+
+  on 'hi' do
+    'success'
+  end
+
+  on 'echo' do |msg|
+    msg
+  end
+
+  on 'test' do |msg|
+    test_method
+  end
+
+  def self.test_method; end
+end

data/spec/server_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 require 'em-websocket-client'
-
-# TODO rename to server spec
+require 'json'
 
 RSpec.describe Sock::Server do
   let(:server) { Sock::Server.new(logger: Logger.new(nil)) }
@@ -50,6 +49,26 @@ RSpec.describe Sock::Server do
     end
   end
 
+  context 'listener' do
+    let(:server) {
+      Sock::Server.new(logger: Logger.new(nil), listener: MockClass)
+    }
+    it 'will fire a ruby event when a server event comes in' do
+      allow(MockClass).to receive(:test_method)
+      steps :fire
+      event_block do
+        server.register!
+        hi_redis.publish('sock-hook/test', 'success').callback {
+          expect(server.channels.keys).to eq(['sock-hook/hi',
+                                              'sock-hook/echo',
+                                              'sock-hook/test'])
+          expect(MockClass).to have_received(:test_method)
+          complete :fire
+        }
+      end
+    end
+  end
+
   context '#channel' do
     it 'finds or creates a channel' do
       server.channel('heyo')

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require 'pry'
 require 'codeclimate-test-reporter'
 require 'simplecov'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[SimpleCov::Formatter::HTMLFormatter,CodeClimate::TestReporter::Formatter]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[SimpleCov::Formatter::HTMLFormatter, CodeClimate::TestReporter::Formatter]
 
 dir = File.join("..", "coverage")
 SimpleCov.coverage_dir(dir)

data/spec/subscriber_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'logger'
+require 'mock_class'
+
+RSpec.describe Sock::Subscriber do
+  context 'when included' do
+    it 'runs the block when that event fires' do
+      expect(MockClass.channels['hi'].call('hello')).to eq('success')
+    end
+
+    it 'can access the msg' do
+      expect(MockClass.channels['echo'].call('hello')).to eq('hello')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sock-drawer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Hess
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -169,10 +169,13 @@ files:
 - lib/sock/drawer.rb
 - lib/sock/drawer/version.rb
 - lib/sock/server.rb
+- lib/sock/subscriber.rb
 - sock-drawer.gemspec
 - spec/client_spec.rb
+- spec/mock_class.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
+- spec/subscriber_spec.rb
 homepage: http://www.thisisadam.me
 licenses:
 - MIT
@@ -199,5 +202,7 @@ specification_version: 4
 summary: Super simple websocket manager.
 test_files:
 - spec/client_spec.rb
+- spec/mock_class.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
+- spec/subscriber_spec.rb