power_strip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfbdf19d7bf07bffbe82762068326c83275bbbd2
+  data.tar.gz: 4822d861290a272543619889ed2cbfaa39537a95
+SHA512:
+  metadata.gz: 593302575354edec1f8b8d10e63779df75b59d9757bf0d18fb23aec48786b10d2031a264ee339d9a8081ffd007cdf75212db926994c9d976f6af0df41f02ff0a
+  data.tar.gz: 5a418383fce11f99fc3113fd8620d7a2a7b385278abe67c9743f39f8994811d02854d79567bb1dd3ec3dad02ddfd0c011e52f6dd83514818a7edfe1feaef0931

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

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 jgaskins@gmail.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 power_strip.gemspec
+gemspec

data/README.md

@@ -0,0 +1,131 @@
+# PowerStrip
+
+PowerStrip is a Ruby library to manage WebSockets easily. It combines the following pieces:
+
+- Rack app you can mount into your Ruby web app to handle incoming WebSocket connections
+- Connection manager
+- API for handling channels and events
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'power_strip'
+```
+
+And then execute:
+
+    $ bundle
+
+## Server-Side Usage
+
+Call `PowerStrip.start` to turn on the PowerStrip and mount `PowerStrip` as an endpoint of your app. Here are a couple of examples to get you started with Rails and Roda:
+
+### Rails
+
+```ruby
+# config/initializers/power_strip.rb
+PowerStrip.start
+
+# config/routes.rb
+mount PowerStrip, at: '/chat' # Example for a chat app
+```
+
+### Roda
+
+```ruby
+# config.ru
+require 'power_strip'
+
+PowerStrip.start
+
+class MyApp < Roda
+  r.on('chat') { r.run PowerStrip }
+end
+```
+
+### Sending updates to clients:
+
+```ruby
+PowerStrip[channel_name].send(event_name, key: value)
+```
+
+## Client-Side Usage
+
+If your front-end app is written in Ruby (via Opal), you can start with just a few lines of code:
+
+```ruby
+require 'opal'
+require 'power_strip'
+
+# This URL should point to where you have PowerStrip mounted on the server
+client = PowerStrip::Client.new('ws://localhost:9292/chat')
+
+client.on(:connect) { store.dispatch Connected.new }
+client.on(:disconnect) { store.dispatch Disconnected.new }
+
+channel = client.subscribe(:chat)
+channel.on :message do |message|
+  # Tell your app you've received this message. The payload is in message.data.
+end
+```
+
+### JavaScript
+
+```javascript
+// Note: this isn't implemented yet because I'm a Ruby developer
+import { Client } from 'power_strip';
+
+const client = new Client('ws://localhost:9292/chat');
+
+client.on('connect', () => dispatch(connected()));
+client.on('disconnect', () => dispatch(disconnected()));
+
+const channel = client.subscribe('chat');
+channel.on('message', message => {
+  dispatch(receivedMessage(message.data));
+});
+```
+
+## Sending Messages Client->Server
+
+Set up a message handler on the server:
+
+```ruby
+require 'power_strip'
+
+# Handle :message events in the "chat" channel.
+# @param message [PowerStrip::Message] the message we received
+# @param connection [Faye::WebSocket] the client connection this is from
+PowerStrip.on :message, channel: 'chat' do |message, connection|
+  IncomingMessageWorker.perform_async message
+end
+```
+
+Notice we don't do work directly on the message. We instead pass it off to a background worker. This is so that we can handle as many incoming messages as possible. To be able to send messages back to that channel, we can simply use the Server->Client message command specified above. Note the `perform` method here:
+
+```ruby
+require 'sidekiq'
+require 'power_strip'
+
+class IncomingMessageWorker
+  include Sidekiq::Worker
+
+  # @param message [PowerStrip::Message]
+  def perform(message)
+    # Simplest case, we send the message back out to everyone on the same channel
+    PowerStrip[message.channel].send :message, message.data
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clearwater-rb/power_strip. 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.

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 "power_strip"
+
+# 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/power_strip/app.rb

@@ -0,0 +1,107 @@
+require 'faye/websocket'
+require 'redis'
+require 'set'
+require 'json'
+
+require 'power_strip/channel_list'
+require 'power_strip/message'
+
+module PowerStrip
+  class App
+    attr_reader :redis, :sockets, :channels
+
+    def self.instance(**args)
+      @instance ||= new(**args)
+    end
+
+    def initialize(redis: Redis.new)
+      @redis = redis
+      @channels = ChannelList.new(redis: redis)
+      @handlers = Hash.new do |channels,channel|
+        channels[channel] = Hash.new do |handlers, event|
+          handlers[event] = []
+        end
+      end
+    end
+
+    def call env
+      if Faye::WebSocket.websocket? env
+        socket = Faye::WebSocket.new(env)
+
+        subscriptions = Set.new
+
+        socket.on :message do |event|
+          message = Message.new(JSON.parse(event.data))
+          channel_name = message.channel
+          channel = channels[channel_name]
+
+          case message.event
+          when '@subscribe'
+            channel << socket
+            subscriptions << channel_name
+
+            socket.send({
+              event: :subscribed,
+              channel: channel_name,
+            }.to_json)
+          when '@unsubscribe'
+            channels[channel_name].delete socket
+            if channels[channel_name].empty?
+              channels.delete channel_name
+            end
+
+            subscriptions.delete channel_name
+
+            socket.send({
+              event: :unsubscribed,
+              channel: channel_name,
+            }.to_json)
+          else
+            @handlers[channel_name][message.event].each do |callback|
+              begin
+                callback[message, socket]
+              rescue => e
+                warn "[PowerStrip] #{e.inspect}"
+              end
+            end
+          end
+        end
+
+        socket.on :close do
+          subscriptions.each do |channel_name|
+            channels[channel_name].delete socket
+          end
+        end
+
+        socket.rack_response
+      else
+        bad_request
+      end
+    end
+
+    def on event, channel:, &block
+      @handlers[channel.to_s][event.to_s] << block
+    end
+
+    def listen
+      redis.dup.subscribe(:power_strip) do |on|
+        on.message do |_, message|
+          channel = JSON.parse(message)['channel']
+          channels[channel].sockets.each do |socket|
+            socket.send message
+          end
+        end
+      end
+    end
+
+    private
+
+    def bad_request
+      [
+        400,
+        { 'Content-Type' => 'text/plain' },
+        ['This endpoint only handles websockets'],
+      ]
+    end
+  end
+end

data/lib/power_strip/channel.rb

@@ -0,0 +1,33 @@
+require 'set'
+
+require 'power_strip/message'
+
+module PowerStrip
+  class Channel
+    attr_reader :name, :sockets
+
+    def initialize(name, redis:)
+      @name = name
+      @redis = redis
+      @sockets = Set.new
+    end
+
+    def << socket
+      @sockets << socket
+    end
+
+    def delete socket
+      @sockets.delete socket
+    end
+
+    def send event, message
+      message = Message.new(
+        channel: name,
+        event: event,
+        data: message
+      )
+      @redis.publish :power_strip, message.to_json
+      self
+    end
+  end
+end

data/lib/power_strip/channel_list.rb

@@ -0,0 +1,24 @@
+require 'power_strip/channel'
+
+module PowerStrip
+  class ChannelList
+    def initialize(redis:)
+      @redis = redis
+      @channels = Hash.new do |hash, channel|
+        hash[channel.to_s] = Channel.new(channel, redis: redis)
+      end
+    end
+
+    def [] name
+      @channels[name.to_s]
+    end
+
+    def to_a
+      @channels.values
+    end
+
+    def delete channel_name
+      @channels.delete channel_name.to_s
+    end
+  end
+end

data/lib/power_strip/message.rb

@@ -0,0 +1,12 @@
+require 'grand_central/model'
+require 'json'
+
+module PowerStrip
+  class Message < GrandCentral::Model
+    attributes(:channel, :event, :data)
+
+    def to_json(*args)
+      to_h.to_json
+    end
+  end
+end

data/lib/power_strip/version.rb

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

data/lib/power_strip.rb

@@ -0,0 +1,41 @@
+require 'faye/websocket'
+require 'grand_central/model'
+require 'redis'
+require 'set'
+require 'json'
+
+require 'power_strip/version'
+require 'power_strip/app'
+
+module PowerStrip
+  module_function
+
+  def call env
+    app.call env
+  end
+
+  def app
+    @app ||= App.instance
+  end
+
+  def start(**args)
+    @app = App.instance(**args)
+    @thread = Thread.new { app.listen }
+  end
+
+  def [] channel
+    app.channels[channel]
+  end
+
+  def on event_name, channel:, &block
+    app.on event_name, channel: channel, &block
+  end
+end
+
+begin
+  require 'opal'
+  Opal.append_path File.expand_path('../opal', __FILE__)
+rescue
+  require 'sprockets'
+  Sprockets.append_path File.expand_path('../js', __FILE__)
+end

data/power_strip.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'power_strip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "power_strip"
+  spec.version       = PowerStrip::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Push data from server to client with Ruby}
+  spec.homepage      = "https://github.com/clearwater-rb/power_strip"
+
+  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_runtime_dependency "faye-websocket", "~> 0.10.4"
+  spec.add_runtime_dependency "grand_central"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: power_strip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: grand_central
+  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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/power_strip.rb
+- lib/power_strip/app.rb
+- lib/power_strip/channel.rb
+- lib/power_strip/channel_list.rb
+- lib/power_strip/message.rb
+- lib/power_strip/version.rb
+- power_strip.gemspec
+homepage: https://github.com/clearwater-rb/power_strip
+licenses: []
+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: Push data from server to client with Ruby
+test_files: []