sinatra-hijacker 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +11 -0
- data/LICENSE.txt +22 -0
- data/README.md +42 -0
- data/Rakefile +4 -0
- data/lib/rack/hijack_wrapper.rb +6 -0
- data/lib/sinatra/hijacker.rb +39 -0
- data/lib/sinatra/hijacker/version.rb +5 -0
- data/sample/sinatra.rb +35 -0
- data/sinatra-hijacker.gemspec +26 -0
- data/test/test_sinatra_hijacker.rb +36 -0
- metadata +112 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f44232f0de9db5f182cbdf80526545cc85746a03
|
4
|
+
data.tar.gz: 2607a96f0b93e1c4b9e97c4f4ad0d8434083db51
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 416cec18c0b0d4f7194b125f7060e0609fcfee923d928cccf926c8a4a2bc9f1e0250d8f352c146a6f0ab6051d02989b010ac37b7ad7ad479d7b20760b85b4523
|
7
|
+
data.tar.gz: 14e99b96fdca89101c778e14a3bb0d0d116513a122a917cedaf26af95ffb636e0667d3e5bce66350eea8d6b45c201ae373b44798a394f854bcb5d24ca66c47d0
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 minoritea
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Sinatra::Hijacker
|
2
|
+
|
3
|
+
A sinatra plugin to handle websockets by Rack hijacking API.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'sinatra-hijacker'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install sinatra-hijacker
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
Register Sinatra::Hijacker and define route by "websocket" method.
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'sinatra/hijacker'
|
25
|
+
|
26
|
+
class YourApp < Sinatra::Base
|
27
|
+
|
28
|
+
register Sinatra::Hijacker
|
29
|
+
|
30
|
+
websocket '/ws' do
|
31
|
+
ws.onopen{ws.send_data "hello"}
|
32
|
+
end
|
33
|
+
end
|
34
|
+
```
|
35
|
+
|
36
|
+
## Contributing
|
37
|
+
|
38
|
+
1. Fork it
|
39
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
40
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
41
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
42
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
require "sinatra/hijacker/version"
|
2
|
+
require "tubesock"
|
3
|
+
|
4
|
+
module Sinatra
|
5
|
+
module Hijacker
|
6
|
+
|
7
|
+
def call env
|
8
|
+
if websocket? env
|
9
|
+
env['sinatra.hijacker.websocket'] = Tubesock.hijack(env).tap &:listen
|
10
|
+
env['REQUEST_METHOD'] = 'WEBSOCKET'
|
11
|
+
super
|
12
|
+
[101, {}, []]
|
13
|
+
else
|
14
|
+
super
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
# Taken from https://github.com/simulacre/sinatra-websocket/
|
19
|
+
# Originally taken from skinny https://github.com/sj26/skinny and updated to support Firefox
|
20
|
+
def websocket? env
|
21
|
+
env['HTTP_CONNECTION'] && env['HTTP_UPGRADE'] &&
|
22
|
+
env['HTTP_CONNECTION'].split(',').map(&:strip).map(&:downcase).include?('upgrade') &&
|
23
|
+
env['HTTP_UPGRADE'].downcase == 'websocket'
|
24
|
+
end
|
25
|
+
|
26
|
+
def self.registered app
|
27
|
+
app.helpers do
|
28
|
+
def ws
|
29
|
+
env['sinatra.hijacker.websocket']
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
def websocket(path, opts = {}, &bk)
|
35
|
+
route 'WEBSOCKET', path, opts, &bk
|
36
|
+
end
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
data/sample/sinatra.rb
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
require 'sinatra/base'
|
2
|
+
require 'rack/handler/puma'
|
3
|
+
require 'sinatra/hijacker'
|
4
|
+
|
5
|
+
class App < Sinatra::Base
|
6
|
+
register Sinatra::Hijacker
|
7
|
+
|
8
|
+
get '/' do
|
9
|
+
index_html
|
10
|
+
end
|
11
|
+
|
12
|
+
websocket '/ws' do
|
13
|
+
ws.onmessage do |msg|
|
14
|
+
ws.send_data "Hello, #{msg}"
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
helpers do
|
19
|
+
def index_html
|
20
|
+
<<-EOS
|
21
|
+
<html>
|
22
|
+
<body>
|
23
|
+
<script>
|
24
|
+
var ws = new WebSocket('ws://#{env["HTTP_HOST"]}/ws');
|
25
|
+
ws.onmessage = function(msg){console.log(msg.data)};
|
26
|
+
ws.onopen = function(){ws.send("Minoritea")};
|
27
|
+
</script>
|
28
|
+
</body>
|
29
|
+
<html>
|
30
|
+
EOS
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
Rack::Handler::Puma.run App
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'sinatra/hijacker/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "sinatra-hijacker"
|
8
|
+
spec.version = Sinatra::Hijacker::VERSION
|
9
|
+
spec.authors = ["minoritea"]
|
10
|
+
spec.email = ["m.tokuda@aol.jp"]
|
11
|
+
spec.description = %q{sinatra plugin to handle websockets}
|
12
|
+
spec.summary = %q{Register Sinatra::Hijacker and define route by "websocket" method}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
|
24
|
+
spec.add_dependency "rack"
|
25
|
+
spec.add_dependency "tubesock"
|
26
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
require 'minitest/autorun'
|
2
|
+
#require 'rack/test'
|
3
|
+
require 'sinatra'
|
4
|
+
require 'sinatra/hijacker'
|
5
|
+
require 'socket'
|
6
|
+
|
7
|
+
class HijackerTest < MiniTest::Test
|
8
|
+
include Rack::Test::Methods
|
9
|
+
|
10
|
+
class App < Sinatra::Base
|
11
|
+
register Sinatra::Hijacker
|
12
|
+
get '/' do
|
13
|
+
200
|
14
|
+
end
|
15
|
+
websocket '/ws' do
|
16
|
+
ws.onmessage do
|
17
|
+
throw :onmessage
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
def app
|
23
|
+
App
|
24
|
+
end
|
25
|
+
|
26
|
+
def test_get
|
27
|
+
get '/'
|
28
|
+
assert last_response.ok?
|
29
|
+
end
|
30
|
+
|
31
|
+
def test_through_websocket?
|
32
|
+
assert_raises Tubesock::HijackNotAvailable do
|
33
|
+
get '/ws', {}, {'HTTP_CONNECTION' => 'UPGRADE', 'HTTP_UPGRADE' => 'WEBSOCKET' }
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
metadata
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: sinatra-hijacker
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- minoritea
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-08-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rack
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: tubesock
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '>='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: sinatra plugin to handle websockets
|
70
|
+
email:
|
71
|
+
- m.tokuda@aol.jp
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- .gitignore
|
77
|
+
- Gemfile
|
78
|
+
- LICENSE.txt
|
79
|
+
- README.md
|
80
|
+
- Rakefile
|
81
|
+
- lib/rack/hijack_wrapper.rb
|
82
|
+
- lib/sinatra/hijacker.rb
|
83
|
+
- lib/sinatra/hijacker/version.rb
|
84
|
+
- sample/sinatra.rb
|
85
|
+
- sinatra-hijacker.gemspec
|
86
|
+
- test/test_sinatra_hijacker.rb
|
87
|
+
homepage: ''
|
88
|
+
licenses:
|
89
|
+
- MIT
|
90
|
+
metadata: {}
|
91
|
+
post_install_message:
|
92
|
+
rdoc_options: []
|
93
|
+
require_paths:
|
94
|
+
- lib
|
95
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
96
|
+
requirements:
|
97
|
+
- - '>='
|
98
|
+
- !ruby/object:Gem::Version
|
99
|
+
version: '0'
|
100
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - '>='
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
requirements: []
|
106
|
+
rubyforge_project:
|
107
|
+
rubygems_version: 2.0.6
|
108
|
+
signing_key:
|
109
|
+
specification_version: 4
|
110
|
+
summary: Register Sinatra::Hijacker and define route by "websocket" method
|
111
|
+
test_files:
|
112
|
+
- test/test_sinatra_hijacker.rb
|