sinatra-hijacker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f44232f0de9db5f182cbdf80526545cc85746a03
+  data.tar.gz: 2607a96f0b93e1c4b9e97c4f4ad0d8434083db51
+SHA512:
+  metadata.gz: 416cec18c0b0d4f7194b125f7060e0609fcfee923d928cccf926c8a4a2bc9f1e0250d8f352c146a6f0ab6051d02989b010ac37b7ad7ad479d7b20760b85b4523
+  data.tar.gz: 14e99b96fdca89101c778e14a3bb0d0d116513a122a917cedaf26af95ffb636e0667d3e5bce66350eea8d6b45c201ae373b44798a394f854bcb5d24ca66c47d0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-hijacker.gemspec
+gemspec
+
+group :development do
+  gem 'puma'
+  gem 'sinatra'
+  gem 'minitest'
+  gem 'rack-test'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 minoritea
+
+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,42 @@
+# Sinatra::Hijacker
+
+A sinatra plugin to handle websockets by Rack hijacking API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-hijacker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-hijacker
+
+## Usage
+
+Register Sinatra::Hijacker and define route by "websocket" method.
+
+```ruby
+require 'sinatra/hijacker'
+
+class YourApp < Sinatra::Base
+
+  register Sinatra::Hijacker
+
+  websocket '/ws' do
+    ws.onopen{ws.send_data "hello"}
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new
+task :default => :test

data/lib/rack/hijack_wrapper.rb

@@ -0,0 +1,6 @@
+require 'rack'
+
+#A monkey patch for HijackWrapper in rack/lint
+class Rack::Lint::HijackWrapper
+  def_delegators :@io, :to_io, :recvfrom
+end

data/lib/sinatra/hijacker.rb

@@ -0,0 +1,39 @@
+require "sinatra/hijacker/version"
+require "tubesock"
+
+module Sinatra
+  module Hijacker
+
+    def call env
+      if websocket? env
+        env['sinatra.hijacker.websocket'] = Tubesock.hijack(env).tap &:listen
+        env['REQUEST_METHOD'] = 'WEBSOCKET'
+        super
+        [101, {}, []]
+      else
+        super
+      end
+    end
+
+    # Taken from https://github.com/simulacre/sinatra-websocket/
+    # Originally taken from skinny https://github.com/sj26/skinny and updated to support Firefox
+    def websocket? env
+      env['HTTP_CONNECTION'] && env['HTTP_UPGRADE'] &&
+        env['HTTP_CONNECTION'].split(',').map(&:strip).map(&:downcase).include?('upgrade') &&
+        env['HTTP_UPGRADE'].downcase == 'websocket'
+    end
+    
+    def self.registered app
+      app.helpers do
+        def ws
+          env['sinatra.hijacker.websocket']
+        end
+      end
+    end
+    
+    def websocket(path, opts = {}, &bk)
+      route 'WEBSOCKET',     path, opts, &bk
+    end
+
+  end
+end

data/lib/sinatra/hijacker/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Hijacker
+    VERSION = "0.0.1"
+  end
+end

data/sample/sinatra.rb

@@ -0,0 +1,35 @@
+require 'sinatra/base'
+require 'rack/handler/puma'
+require 'sinatra/hijacker'
+
+class App < Sinatra::Base
+  register Sinatra::Hijacker
+
+  get '/' do
+    index_html
+  end
+  
+  websocket '/ws' do
+    ws.onmessage do |msg|
+      ws.send_data "Hello, #{msg}"
+    end
+  end
+  
+  helpers do
+    def index_html
+      <<-EOS
+      <html>
+      <body>
+      <script>
+      var ws = new WebSocket('ws://#{env["HTTP_HOST"]}/ws');
+      ws.onmessage = function(msg){console.log(msg.data)};
+      ws.onopen = function(){ws.send("Minoritea")};
+      </script>
+      </body>
+      <html>
+      EOS
+    end
+  end
+end
+
+Rack::Handler::Puma.run App

data/sinatra-hijacker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/hijacker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-hijacker"
+  spec.version       = Sinatra::Hijacker::VERSION
+  spec.authors       = ["minoritea"]
+  spec.email         = ["m.tokuda@aol.jp"]
+  spec.description   = %q{sinatra plugin to handle websockets}
+  spec.summary       = %q{Register Sinatra::Hijacker and define route by "websocket" method}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  
+  spec.add_dependency "rack"
+  spec.add_dependency "tubesock"
+end

data/test/test_sinatra_hijacker.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+#require 'rack/test'
+require 'sinatra'
+require 'sinatra/hijacker'
+require 'socket'
+
+class HijackerTest < MiniTest::Test
+  include Rack::Test::Methods
+
+  class App < Sinatra::Base
+    register Sinatra::Hijacker
+    get '/' do
+      200
+    end
+    websocket '/ws' do
+      ws.onmessage do
+        throw :onmessage
+      end
+    end
+  end
+  
+  def app
+    App
+  end
+  
+  def test_get
+    get '/'
+    assert last_response.ok?
+  end
+  
+  def test_through_websocket?
+    assert_raises Tubesock::HijackNotAvailable do
+      get '/ws', {}, {'HTTP_CONNECTION' => 'UPGRADE', 'HTTP_UPGRADE' => 'WEBSOCKET' }
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-hijacker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- minoritea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rack
+  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: tubesock
+  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'
+description: sinatra plugin to handle websockets
+email:
+- m.tokuda@aol.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/hijack_wrapper.rb
+- lib/sinatra/hijacker.rb
+- lib/sinatra/hijacker/version.rb
+- sample/sinatra.rb
+- sinatra-hijacker.gemspec
+- test/test_sinatra_hijacker.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Register Sinatra::Hijacker and define route by "websocket" method
+test_files:
+- test/test_sinatra_hijacker.rb