socket2me 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f123c415850bb1bb171b3927e2b50bda54ef348e
+  data.tar.gz: 6fcc758271404f0e3ccb7e0aea791df36ac33b18
+SHA512:
+  metadata.gz: 654b89e9ea16c80b880c1535f24a6d6d111124d8d6d186bbdb554daf606f913f353ae12c995b429d36d0879308fd77183709d6f3e725f4e938a58f527c8ae59c
+  data.tar.gz: 530abc92eafcee8ebba2aa4ee94b099132ef1c4b0431bd6ba4cdee1e5ae19595e0aef56445deeda7ca15406d094262a37660ae6e8ace6b83ae39dd0a3f757722

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,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Scott Pierce
+
+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,95 @@
+# Socket2me
+
+Execute Javascript in the browser from the server using WebSockets.
+
+This is a proof of concept. There are no attempts to secure this feature or
+even make it practical in a multi-user environment. That's right, any browser
+that is viewing the site is going to get the same javascript executed on it.
+This gem should really only ever be used in development.
+
+The original use for this was to send all logs to browser as it was appended.
+
+```ruby
+def pipe_to_browser(src)
+  File.open(src,"r") do |f|
+    f.seek(0,IO::SEEK_END)
+    while true do
+      IO.select([f])    # wait for change
+      line = f.gets
+      Socket2me.exec_js "$('#logs').append(#{line.to_json})"
+    end
+  end
+end
+Thread.new{pipe_to_browser('log/development.log')}
+```
+
+Please don't run this in production. Ever.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'socket2me'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install socket2me
+
+## Usage
+
+A full rack example is in `example/counter.ru`. That app simply creates
+an HTML page and provides a helper js function to display some output. The
+example then outputs the server time a counter every second in a background
+thread.
+
+To run `example/counter.rb`:
+
+1. checkout the project: `git clone https://github.com/ddrscott/socket2me`
+2. go into the the socket2me directory: `cd socket2me`
+3. install requirements: `./bin/setup`
+4. start a rack server with the example: `rackup example/counter.ru`
+
+### Rack
+```ruby
+# config.ru
+use SocketToMe::Middleware::AddScriptTag
+```
+
+### Rails
+```ruby
+# config/environments/development.rb
+config.middleware.use SocketToMe::Middleware::AddScriptTag
+```
+
+### Execute Javascript
+```ruby
+# elsewhere.rb
+SocketToMe.exec_js "alert('hello world!')"
+```
+
+## 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).
+
+Spot check everything works by running `rackup example/counter.ru`. The browser
+should continually append a timestamp and counter below the header.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddrscott/socket2me.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "socket2me"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/counter.ru

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'socket2me'
+
+class Stub
+
+  def initialize
+    Socket2me.configure do |config|
+      config.ws_host = '0.0.0.0'
+      config.ws_port = '3002'
+    end
+
+    Socket2me.start_ws_server
+  end
+
+  def call(_)
+    [200, {'Content-Type' => 'text/html'}, [<<-HTML]]
+<html>
+<body>
+<h1>Stub <small>generated by #{__FILE__}</small></h1>
+<script>
+function appendP(text) {
+  var p = document.createElement("p");
+  p.innerHTML = text;
+  document.body.appendChild(p);
+}
+</script>
+</body>
+</html>
+    HTML
+  end
+
+  def start_counter
+    Thread.abort_on_exception = true
+    Thread.new do
+      counter = 0
+      while true
+        sleep 1
+        Socket2me.exec_js("appendP('[#{Time.now}]: #{counter += 1}')")
+      end
+    end
+  end
+end
+
+use Socket2me::Middleware::AddScriptTag
+
+stub = Stub.new
+stub.start_counter
+
+run stub
+
+

data/lib/socket2me/configuration.rb

@@ -0,0 +1,40 @@
+require 'logger'
+
+module Socket2me
+
+  class Configuration
+    # @attr [String] ws_host for the WebSocket listener
+    attr_accessor :ws_host
+
+    # @attr [String] ws_port for the WebSocket listener
+    attr_accessor :ws_port
+
+    def initialize
+      @ws_host = '0.0.0.0'
+      @ws_port = '3001'
+    end
+
+    # @return [Logger] a basic STDOUT logger if one hasn't been set
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    # @param [Logger] logger to use
+    def logger=(logger)
+      @logger = logger
+    end
+  end
+
+  # @yield [Configuration]
+  def self.configure(&block)
+    @config ||= Configuration.new
+    if block_given?
+      block.call @config
+    end
+  end
+
+  # @return [Configuration] current configuration
+  def self.config
+    @config
+  end
+end

data/lib/socket2me/middleware/add_script_tag.rb

@@ -0,0 +1,75 @@
+require 'json'
+require 'erb'
+require 'em-websocket'
+
+module Socket2me
+  module Middleware
+    class AddScriptTag
+
+      def initialize(app)
+        @app = app
+        @ws_url = "ws://#{Socket2me.config.ws_host}:#{Socket2me.config.ws_port}"
+      end
+
+      # 1. look for a text/html response type from parent app.
+      # 2. replace the closing `</body>` with the WebSocket client code.
+      #
+      # @param [Hash] env about Rack environment and the request
+      # @return [String, Hash, Array[String]]
+      def call(env)
+        response = @app.call(env)
+        status, headers, body = *response
+
+        return response unless headers['Content-Type'] == 'text/html'
+
+        full_body = body.join
+
+        # replace the last body with script
+        full_body.gsub!(%r{(</body>)}i,"#{script_tag}\\1")
+
+        return status, headers, [full_body]
+      end
+
+      # @return [String] the outer Javascript tag with WS client script
+      def script_tag
+        js = ERB.new(js_erb).result(binding)
+        "<script>#{js}</script>"
+      end
+
+      # Adjust the javascript client code as needed.
+      # @return [String] inner javascript contents.
+      def js_erb
+        <<-JS
+(function () {
+    var socket = new WebSocket("<%= @ws_url %>");
+
+    function log(message) {
+        console.log.apply(console, arguments);
+    }
+
+    try {
+        socket.onopen = function () {
+            log("Socket Status: " + socket.readyState + " (open)");
+        };
+
+        socket.onclose = function () {
+            log("Socket Status: " + socket.readyState + " (closed)");
+        };
+
+        socket.onmessage = function (msg) {
+            try {
+                // execute in an anonymous function
+                new Function(msg.data)();
+            } catch (msgEx){
+                console.error("Could not execute `%s` due to %o", msg.data, msgEx);
+            }
+        }
+    } catch (exception) {
+        console.error("Error: " + exception);
+    }
+})();
+        JS
+      end
+    end
+  end
+end

data/lib/socket2me/version.rb

@@ -0,0 +1,3 @@
+module Socket2me
+  VERSION = "0.5.1"
+end

data/lib/socket2me/ws_server.rb

@@ -0,0 +1,60 @@
+require 'em-websocket'
+require 'singleton'
+require 'logger'
+
+# Singleton wrapper class around an EM::WebSocket thread.
+module Socket2me
+  class WsServer
+    include Singleton
+
+    # initializes an empty client list
+    def initialize
+      @clients = []
+    end
+
+    # maps `Socket2me#config` options to `EM::WebSocket` options
+    # @return [Hash] hash of options compatible with EM::WebSocket#start
+    def ws_options
+      {
+          host: Socket2me.config.ws_host,
+          port: Socket2me.config.ws_port
+      }
+    end
+
+    # sends a message to all connected clients
+    # @param [String] msg to send to all the clients
+    def send_to_clients(msg)
+      EM.schedule do
+        @clients.each do |socket|
+          socket.send msg
+        end
+      end
+    end
+
+    def log(text)
+      Socket2me.config.logger.debug "[WsServer] #{text}"
+    end
+
+    # Start the EM::WebSocket thread.
+    # The server
+    def start
+      @thread = Thread.new do
+        EM::WebSocket.start(ws_options) do |ws|
+          ws.onopen do |handshake|
+            @clients << ws
+            log "onopen: #{handshake.headers}"
+          end
+
+          ws.onclose do |event|
+            log "closed: #{event}"
+            @clients.delete ws
+          end
+
+          ws.onmessage do |msg|
+            log "received: #{msg}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/socket2me.rb

@@ -0,0 +1,15 @@
+require 'socket2me/version'
+require 'socket2me/configuration'
+require 'socket2me/middleware/add_script_tag'
+require 'socket2me/ws_server'
+
+module Socket2me
+
+  def self.start_ws_server
+    WsServer.instance.start
+  end
+
+  def self.exec_js(js)
+    WsServer.instance.send_to_clients(js)
+  end
+end

data/socket2me.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socket2me/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "socket2me"
+  spec.version       = Socket2me::VERSION
+  spec.authors       = ["Scott Pierce"]
+  spec.email         = ["ddrscott@gmail.com"]
+
+  spec.summary       = %q{Execute Javascript in the browser from the server using WebSockets}
+  spec.homepage      = "https://github.com/ddrscott/socket2me"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack', '~> 1.6'
+  spec.add_dependency 'em-websocket', '~> 0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: socket2me
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Scott Pierce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ddrscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/counter.ru
+- lib/socket2me.rb
+- lib/socket2me/configuration.rb
+- lib/socket2me/middleware/add_script_tag.rb
+- lib/socket2me/version.rb
+- lib/socket2me/ws_server.rb
+- socket2me.gemspec
+homepage: https://github.com/ddrscott/socket2me
+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.1
+signing_key: 
+specification_version: 4
+summary: Execute Javascript in the browser from the server using WebSockets
+test_files: []
+has_rdoc: