sinatra_sockets 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d633c91055c9c1617045a385a61c450dcd65420b
-  data.tar.gz: c5e8a62363370912095bfab317173cf21c76e2c3
+  metadata.gz: c54288802748884e7b74e50b154fab2d598ea346
+  data.tar.gz: 363af3452bfd9684bd332d6c7988afc2d2b641b5
 SHA512:
-  metadata.gz: 5acd05d9fb2c0371bb4d5b69e753a259e26f0d648e22c9035b9ee0ac0e9fb871d88c73929e3ab5ca37eaf17688ecdccf6bd7363f50c9b10264e39488e65db3e8
-  data.tar.gz: 6cc81324c4f920f39dcbd2a556eef96f271bb6806e94219132dfba849a633cd0ff7b0fc8fd1113a065545cffb8ff33c19aff15da7b341a068123fa9678e4a511
+  metadata.gz: 3e5d8b07d6fe155af2297117a9e253631919e92b5aee628d90facbbcaa26c384a8b829e9fea94fd898026b62551da157feda59a9835a4685a5d82d7d760015c2
+  data.tar.gz: 6d59490fd5530989a90e0b031a0deb5069d849c09c4eb3ac819257b83378ba78fef91ff8e7efbb394059341375a572b4697a2769ef33f70074b820e6be59964a

data/lib/server_skeleton/Gemfile

@@ -1,10 +1,9 @@
 source "http://rubygems.org"
 
-gem 'gemmyrb'
 gem 'sinatra'
 gem 'faye-websocket'
-gem 'slim'
 gem "thin"
-gem 'rerun'
-gem "sass"
-gem 'coffee-script'
+gem 'sinatra_auth_github'
+gem 'dotenv'
+gem 'sinatra-cross_origin'
+gem "rack-proxy"

data/lib/server_skeleton/Gemfile.lock

@@ -6,6 +6,8 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     awesome_print (1.7.0)
     byebug (9.0.6)
     coderay (1.1.1)
@@ -17,9 +19,12 @@ GEM
     concurrent-ruby (1.0.4)
     corefines (1.9.0)
     daemons (1.2.4)
+    dotenv (2.2.0)
     engtagger (0.2.1)
     eventmachine (1.2.2)
     execjs (2.7.0)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
     faye-websocket (0.10.6)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
@@ -43,15 +48,21 @@ GEM
       ruby_dep (~> 1.2)
     method_source (0.8.2)
     minitest (5.10.1)
+    multipart-post (2.0.0)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
     odyssey (0.2.0)
       require_all
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    public_suffix (2.0.5)
     rack (1.6.5)
     rack-protection (1.5.3)
       rack
+    rack-proxy (0.6.0)
+      rack
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
@@ -60,11 +71,18 @@ GEM
       listen (~> 3.0)
     ruby_dep (1.5.0)
     sass (3.4.23)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     sentence_interpreter (0.0.7)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
+    sinatra-cross_origin (0.4.0)
+    sinatra_auth_github (1.2.0)
+      sinatra (~> 1.0)
+      warden-github (~> 1.2.0)
     slim (3.0.7)
       temple (~> 0.7.6)
       tilt (>= 1.3.3, < 2.1)
@@ -79,6 +97,12 @@ GEM
     tilt (2.0.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    warden (1.2.7)
+      rack (>= 1.0)
+    warden-github (1.2.0)
+      activesupport (> 3.0)
+      octokit (> 2.1.0)
+      warden (> 1.0)
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
@@ -88,11 +112,15 @@ PLATFORMS
 
 DEPENDENCIES
   coffee-script
+  dotenv
   faye-websocket
   gemmyrb
+  rack-proxy
   rerun
   sass
   sinatra
+  sinatra-cross_origin
+  sinatra_auth_github
   slim
   thin
 

data/lib/server_skeleton/README.md

@@ -1,13 +1,24 @@
-A simple sinatra websocket server with faye/eventmaching
 
-to start: `thin start`
+---
 
-to use command line client, open a new terminal and run `ruby client.rb`.
+This server is adapted from
+[sinatra_sockets](http://github.com/maxpleaner/sinatra_sockets),
+another boiler I made.
 
-To understand what's going on, look at the source code,
-and raise an issue on [the github page](http://github.com/maxpleaner/sinatra_sockets)
-if there's any confusion. 
+---
 
-**required ruby version** `2.3`
+Steps:
 
-**platform** tested only on MRI and unix
+1. bundle
+2. thin start
+
+---
+
+This version has a lot of stuff removed since it's serving no front-end.
+It's just the API for the webpack client
+
+Important files:
+  - websocket stuff in lib/routes/ws.rb
+  - regular routes in server.rb
+
+---

data/lib/server_skeleton/lib/routes/ws.rb

@@ -0,0 +1,46 @@
+class Routes::Ws
+
+  def self.run(request)
+    return unless Faye::WebSocket.websocket?(request.env)
+    socket = Faye::WebSocket.new(req.env)
+    socket.onopen { onopen(request, socket) }
+    socket.onmessage { |msg| onmessage(request, ws, msg) }
+    socket.onclose { onclose(request, ws) }
+    socket.rack_response
+  end
+
+  def self.onopen(request, ws)
+    token = request.params["token"]
+    unless token
+      ws.send({
+        msg: "no valid token was sent with websocket; invalid"
+      }.to_json)
+      ws.close
+      return
+    end
+    Sockets[token] = ws
+  end
+
+  def self.onmessage(request, ws, msg)
+  end
+
+  def self.onclose(request, ws)
+    delete_socket(request, ws)
+  end
+
+  class << self
+
+    private
+
+    def send_json_message(ws, msg)
+      EM.next_tick { ws.send msg.to_json }
+    end
+
+    def delete_socket(request, ws)
+      token = CGI.parse(URI.parse(ws.url).to_s)["token"]
+      Sockets.delete token
+    end
+
+  end
+
+end

data/lib/server_skeleton/server.rb

@@ -1,80 +1,152 @@
-# auto create accessor methods for hash keys
-require 'ostruct'
+# ================================================
+# Entry to the Sinatra server
+# ------------------------------------------------
+# This file should not be run directly
+# Run it with "thin start"
+# ================================================
 
-# The "modular" version of Sinatra (no global monkeypatch).
 require 'sinatra/base'
- 
-# Eventmachine-based websocket server
 require 'faye/websocket'
-
-# My gem of Ruby language utils. This in turn requires activesupport,
-# colored, awesome_print, etc.
-# see http://rubygems.org/gems/gemmyrb
-require 'gemmy'
-
-# A debugger. Pry has more functionality but has become buggy itself.
 require 'byebug'
-
-# better than CSS
-require 'sass'
-
-# better than JS
-require 'coffee_script'
+require 'sinatra_auth_github'
+require('dotenv'); Dotenv.load
+require 'sinatra/cross_origin'
 
 # Requires all ruby files in this directory.
 # Orders them by the count of "/" in their filename.
 # Therefore, shallower files are loaded first.
-# The reasoning for this is to encourage the common convention of naming
+# The reasoning for this is to support the common convention of naming
 # files according to their contained class hierarchies.
 # i.e. class Foo would be in foo.rb,
 #      class Foo::Bar would be in foo/bar.rb,
+#
+# If there is the situation where a class depends on another that is in a 
+# deeper-nested file, there's always the option to pass the dependency at
+# runtime.
+
 Dir.glob("./**/*.rb").sort_by { |x| x.count("/") }.each do |path|
   require path
 end
 
-# A global array of sockets.
-# This can certainly be altered to a hash if faster lookups are desired.
-Sockets = []
+# The REST routes (listed in this file) cannot store information in the session
+# since it's on another host.
+# Rather, they pass back and forth a token identifier
+#
+# This is the :token param, and is required on all routes except for
+# /token
+#
+# Here's an outline of the flow:
+#
+# 1. Client hits GET /token, gets a new token
+# 2. Client sends token with websocket connection request at GET /ws
+# 3. Client hits GET /authenticate and goes through Github oAuth login
+# 4. Github sends callback to server, which sends the OK to client over websocket
+
+# In leue of sessions, three global objects are used:
+#   Users: <Hash> with keys: <username> and vals: <Set(token)>
+#   AuthenticatedTokens: <hash> with keys: <token> and vals: <username>
+#   Sockets: <hash> with keys: <token> and vals: <socket>
+
+Sockets = {}
+AuthenticatedTokens = {}
+Users = Hash.new { |hash, key| hash[key] = Set.new }
 
-# Our server, a Sinatra app
 class Server < Sinatra::Base
 
-  # Thin works well with Faye and Sinatra
-  # However keep in mind that the server needs to be run with "thin start"
-  # NOT ruby server.rb,
-  #     rackup,
-  #     rackup -E production
-  #     etc.
-  # These will not work.
   set :server, 'thin'
   Faye::WebSocket.load_adapter('thin')
 
-  # The root route, which handles both websocket and HTTP requests
-  # See server_skeleton/lib/routes/index.rb
-  get '/' do
-    Routes::Index.run(request_obj)
+  # Allow some routes to be accessed from different origins
+  # This is unnecessary for websocket requests, since browsers don't implement
+  # the same restictions.
+
+  register Sinatra::CrossOrigin
+
+  # Github oAuth setup
+  # session is needed for the Github oAuth gem
+  # but its not used elsewhere
+
+  enable :sessions
+  set :github_options, {
+    scopes: "user",
+    secret: ENV["GITHUB_CLIENT_SECRET"],
+    client_id: ENV["GITHUB_CLIENT_ID"]
+  }
+  register Sinatra::Auth::Github
+  
+  # ------------------------------------------------
+  # Standard HTTP routes
+  # (get '/ws' is the entrance to the websocket API)
+  # ------------------------------------------------
+
+  # First clients request a token
+
+  get '/token' do
+    cross_origin allow_origin: "http://localhost:8080"
+    { token: new_token }.to_json
   end
 
-  # The 'request' variable is passed along to route handlers
-  # Some extra information is attached to make for a simpler API
-  def request_obj
-    if !defined?(request.renderers)
-      _renderers = method(:renderers)
-      request.define_singleton_method(:renderers) { _renderers.call }
+  # Then they send it in websocket connection request
+  # See server/lib/routes/ws.rb
+
+  get '/ws' do
+    Routes::Ws.run(request)
+  end
+
+  # Then they authenticate with Github
+  # TODO render a proper HTML page after this not just plaintext
+  # saying they can close the window.
+
+  get '/authenticate' do
+    if token = params["token"]
+      if socket = Sockets[token]
+        if !AuthenticatedTokens[token]
+          authenticate!
+          username = get_username
+          Users[username] << (token)
+          AuthenticatedTokens[token] = username
+        end
+        socket.send({
+          action: "logged_in",
+          username: username
+        }.to_json)
+        "authenticated as #{username}. (this window can be closed)"
+      else
+        "error. lost your websocket connection (this window can be closed)"
+      end
+    else
+      "error. That request requires a token (this window can be closed)"
     end
-    request
   end
 
-  # For now, the only extra information being sent in 'request'
-  # is the method 'slim', which would otherwise be unavailable in
-  # the scope of a different class.
-  def renderers
-    OpenStruct.new(
-      slim: method(:slim)
-    )
+  get '/logout' do
+    token = params[:token]
+    if token
+      if username = AuthenticatedTokens[token]
+        logout!
+        Sockets[token].send({
+          action: "logged_out"
+        }.to_json)
+      else
+        if ws = Sockets[token]
+          ws.send({msg: "can't find user to log out"}.to_json)
+        else
+          {error: "can't find user to log out"}.to_json
+        end
+      end
+    else
+      { error: 'cant log out; no token provided' }.to_json
+    end
   end
 
-end
+  private
 
-# This file should not be run directly
-# Run it with "thin start"
+  def get_username
+    github_user.login
+  end
+
+  def new_token
+    SecureRandom.urlsafe_base64
+  end
+
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SinatraSockets
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra_sockets
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - maxpleaner
@@ -36,22 +36,10 @@ files:
 - lib/server_skeleton/Gemfile
 - lib/server_skeleton/Gemfile.lock
 - lib/server_skeleton/README.md
-- lib/server_skeleton/client.rb
 - lib/server_skeleton/config.ru
-- lib/server_skeleton/deps.js
 - lib/server_skeleton/lib/routes.rb
-- lib/server_skeleton/lib/routes/index.rb
-- lib/server_skeleton/lib/websocket.rb
-- lib/server_skeleton/package.json
-- lib/server_skeleton/public/bundle.js
+- lib/server_skeleton/lib/routes/ws.rb
 - lib/server_skeleton/server.rb
-- lib/server_skeleton/views/index.slim
-- lib/server_skeleton/views/partials/url_input.slim
-- lib/server_skeleton/views/partials/videos.slim
-- lib/server_skeleton/views/script/add_video.slim
-- lib/server_skeleton/views/script/url_input.slim
-- lib/server_skeleton/views/script/websocket.slim
-- lib/server_skeleton/views/style/main.slim
 - lib/sinatra_sockets.rb
 - lib/version.rb
 homepage: http://github.com/maxpleaner/sinatra_sockets

data/lib/server_skeleton/client.rb

@@ -1,33 +0,0 @@
-require 'faye/websocket'
-require 'eventmachine'
-require 'byebug'
-require 'gemmy'
-
-if $start_client
-
-  Settings = {awaiting_input: false }
-  EM.run do
-
-    EM.tick_loop do
-    if !Settings[:awaiting_input]
-      Thread.new do
-        Settings[:awaiting_input] = true
-        inp = gets.chomp
-        Settings[:awaiting_input] = false
-        Ws.send inp
-      end
-      sleep 0.2
-    end
-    end.on_stop { EM.stop }
-
-    ServerWebsocketUrl = ENV["SERVER_WS_URL"] || 'ws://localhost:3000/'
-
-    Ws = Faye::WebSocket::Client.new ServerWebsocketUrl
-
-    Ws.on :message do |event|
-      puts event.data
-    end
-
-  end
-
-end

data/lib/server_skeleton/deps.js

@@ -1,3 +0,0 @@
-window.valid_url = require("valid-url");
-window.jquery = require("jquery");
-window.$ = jquery

data/lib/server_skeleton/lib/routes/index.rb

@@ -1,48 +0,0 @@
-class Routes::Index
-
-  Gemmy.patches.each { |patch| using patch }
-  # This method is called from the Sinatra route handler
-  def self.run(request)
-    is_websocket = websocket_request? request
-    m(is_websocket ? :websocket_request : :http_request).call request
-  end
-
-  # Check if the request is of the websocket variety
-  def self.websocket_request?(request)
-    Faye::WebSocket.websocket? request.env
-  end
-
-  # Handle HTTP requests
-  def self.http_request request
-    request.renderers.slim.call :index
-  end
-
-  # Handle websocket requests
-  def self.websocket_request request
-    socket = Websocket.new request
-    socket.onopen &method(:onopen)
-    socket.onmessage &method(:onmessage)
-    socket.onclose &method(:onclose)
-    socket.ready
-  end
-
-  # Handler for newly opened websocket
-  # Pushes the websocket connection object into the global Sockets array
-  def self.onopen(request, ws)
-    Sockets << ws
-  end
-
-  # Handler for received message from websocket
-  # Sends a message to all clients echoing what was received
-  def self.onmessage(request, ws, msg)
-    EM.next_tick { Sockets.each{|s| s.send "got #{msg.data}" } }
-  end
-
-  # Handler for closed websocket event
-  # Deletes the websocket connection object from the global Sockets array
-  def self.onclose(request, ws)
-    warn("websocket closed")
-    Sockets.delete(ws)
-  end
-
-end

data/lib/server_skeleton/lib/websocket.rb

@@ -1,48 +0,0 @@
-class Websocket
-
-  # A wrapper over an underlying websocket API
-  # If ever the websocket server dependency would need to change,
-  # this file would be a place to swap out libraries.
-  #
-  # With each handler (open, close, message) is passed the request object
-  # in addition to the websocket connection object and any additional arguments
-  # (such as message)
-  #
-  # If this is being initialized, the request is assumed to be of the
-  # websocket variety.
-  #
-  # Operations in this class are implemented in a stack which needs to be
-  # finalized by #ready.
-  #
-  # for example:
-  #   socket = Websocket.new(request)
-  #   socket.onopen { |req, socket| }
-  #   socket.onclose { |req, socket| }
-  #   socket.onmessage { |req, socket, msg| }
-  #   socket.ready
-  #
-  def initialize(req)
-    @req = req
-    @socket = Faye::WebSocket.new(req.env)
-    @stack = {}
-  end
-
-  def onopen &blk
-    @stack[:onopen] = blk
-  end
-
-  def onclose &blk
-    @stack[:onclose] = blk
-  end
-
-  def onmessage &blk
-    @stack[:onmessage] = blk
-  end
-
-  def ready
-    @socket.on(:open) { @stack[:onopen].call @req, @socket }
-    @socket.on(:close) { @stack[:onclose].call @req, @socket }
-    @socket.on(:message) { |msg| @stack[:onmessage].call @req, @socket, msg }
-    @socket.rack_response
-  end
-end

data/lib/server_skeleton/package.json

@@ -1,17 +0,0 @@
-{
-  "name": "mixer",
-  "version": "1.0.0",
-  "description": "A simple sinatra websocket server with faye/eventmaching",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "bower": "^1.8.0",
-    "browserify": "^14.1.0",
-    "jquery": "^3.1.1",
-    "valid-url": "^1.0.9"
-  }
-}