jellyfish 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cdc77d2745d750685951db77f69943a70cb6f22
-  data.tar.gz: b16b5fb680ff9cf0102b5cb32a79f0d3f6f6ccec
+  metadata.gz: 0902d53ad06a343337f75988ca97c9ec058e0393
+  data.tar.gz: 9a5713043ab28c3e0f57b6498e8cc38f19a4e785
 SHA512:
-  metadata.gz: 67e8a8e8ca2ccfa92e74a19f75a15ab2fd7722bd28be1370a61dec0a304b96700f93977d5db330c3fedd4f3f61a960d1c48b8ee93863aca4b7589bbdefa59003
-  data.tar.gz: efbd49c456bb91e07f1a201c7d7399234d17c44fee34073e010724307b504eaf37662a1c19666e6f8efeb4687ba37048402072c9e3a28698dcc72b07548d3b47
+  metadata.gz: fdcaab8c025ad02e84380e0a5015328267f3a24b90a5df5a7170530a91fcdaf240d3621c7a4da116db5a71dc564ea03c96d13d95e5d3f77d57dbe1a911b3d202
+  data.tar.gz: 164214d46c9396361c1dfe2e4032abb2ed1884ca150159f1f402feb77aaf36b77b8a00e79b49c0691f757e3bb97df1e69a7d98621eb4ecb17c0deb5a71da8d98

data/.travis.yml

@@ -1,9 +1,10 @@
-before_install: 'git submodule update --init'
-script: 'ruby -r bundler/setup -S rake test'
 
+language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby
-  - rbx
+  - 2.0
+  - 2.1
+  - rbx-2
   - jruby
+
+script: 'ruby -r bundler/setup -S rake test'
+sudo: false

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## Jellyfish 1.0.1 -- 2014-11-07
+
+### Enhancements for Jellyfish core
+
+* Now `Jellyfish.handle` could take multiple exceptions as the arguments.
+
+### Other enhancements
+
+* Introduced `Jellyfish::WebSocket` for basic websocket support.
+
 ## Jellyfish 1.0.0 -- 2014-03-17
 
 ### Incompatible changes

data/Gemfile

@@ -4,9 +4,10 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'bacon'
-gem 'muack'
 gem 'rack'
+gem 'pork'
+gem 'muack'
+gem 'websocket_parser'
 
 platform :rbx do
   gem 'rubysl-singleton' # used in rake

data/README.md

@@ -24,6 +24,12 @@ For Rack applications or Rack middlewares. Around 250 lines of code.
 * Don't make things complicated only for _some_ convenience, but for
   _great_ convenience, or simply stay simple for simplicity.
 * More features are added as extensions.
+* Consider use [rack-protection][] if you're not only building an API server.
+* Consider use [websocket_parser][] if you're trying to use WebSocket.
+  Please check example below.
+
+[rack-protection]: https://github.com/rkh/rack-protection
+[websocket_parser]: https://github.com/afcapel/websocket_parser
 
 ## FEATURES:
 
@@ -53,9 +59,9 @@ Because Sinatra is too complex and inconsistent for me.
 
 ## SYNOPSIS:
 
-You could also take a look at [config.ru][] as an example, which also uses
-[Swagger](https://helloreverb.com/developers/swagger) to generate API
-documentation.
+You could also take a look at [config.ru](config.ru) as an example, which
+also uses [Swagger](https://helloreverb.com/developers/swagger) to generate
+API documentation.
 
 ### Hello Jellyfish, your lovely config.ru
 
@@ -262,6 +268,32 @@ GET /
  ["You found nothing."]]
 -->
 
+### Custom error handler for multiple errors
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  handle Jellyfish::NotFound, NameError do |e|
+    status 404
+    "You found nothing."
+  end
+  get '/yell' do
+    yell
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+<!---
+GET /
+[404,
+ {'Content-Length' => '18', 'Content-Type' => 'text/plain'},
+ ["You found nothing."]]
+-->
+
 ### Access Rack::Request and params
 
 ``` ruby
@@ -880,9 +912,53 @@ GET /chunked
   "2\r\n3\n\r\n", "2\r\n4\n\r\n", "0\r\n\r\n"]]
 -->
 
+### Using WebSocket
+
+Note that this only works for Rack servers which support [hijack][].
+You're better off with a threaded server such as [Rainbows!][] with
+thread based concurrency model, or [Puma][].
+
+Event-driven based server is a whole different story though. Since
+EventMachine is basically dead, we could see if there would be a
+[Celluloid-IO][] based web server production ready in the future,
+so that we could take the advantage of event based approach.
+
+[hijack]: http://www.rubydoc.info/github/rack/rack/file/SPEC#Hijacking
+[Rainbows!]: http://rainbows.bogomips.org/
+[Puma]: http://puma.io/
+[Celluloid-IO]: https://github.com/celluloid/celluloid-io
+
+``` ruby
+class Tank
+  include Jellyfish
+  controller_include Jellyfish::WebSocket
+  get '/echo' do
+    switch_protocol do |msg|
+      ws_write(msg)
+    end
+    ws_write('Hi!')
+    ws_start
+  end
+end
+run Tank.new
+```
+
+<!---
+GET /echo
+sock.string.should.eq <<-HTTP.chomp
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: Kfh9QIsMVZcl6xEPYxPHzW8SZ8w=\r
+\r
+\x81\u0003Hi!
+HTTP
+[200, {}, ['']]
+-->
+
 ### Use Swagger to generate API documentation
 
-For a complete example, checkout [config.ru][].
+For a complete example, checkout [config.ru](config.ru).
 
 ``` ruby
 require 'jellyfish'

data/jellyfish.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: jellyfish 1.0.0 ruby lib
+# stub: jellyfish 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-03-17"
+  s.date = "2014-11-07"
   s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middlewares. Around 250 lines of code."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
   "lib/jellyfish/swagger.rb",
   "lib/jellyfish/test.rb",
   "lib/jellyfish/version.rb",
+  "lib/jellyfish/websocket.rb",
   "public/css/screen.css",
   "public/index.html",
   "public/js/shred.bundle.js",
@@ -56,10 +57,11 @@ Gem::Specification.new do |s|
   "test/test_log.rb",
   "test/test_misc.rb",
   "test/test_swagger.rb",
-  "test/test_threads.rb"]
+  "test/test_threads.rb",
+  "test/test_websocket.rb"]
   s.homepage = "https://github.com/godfat/jellyfish"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.2"
   s.summary = "Pico web framework for building API-centric web applications."
   s.test_files = [
   "test/sinatra/test_base.rb",
@@ -72,5 +74,6 @@ Gem::Specification.new do |s|
   "test/test_log.rb",
   "test/test_misc.rb",
   "test/test_swagger.rb",
-  "test/test_threads.rb"]
+  "test/test_threads.rb",
+  "test/test_websocket.rb"]
 end

data/lib/jellyfish.rb

@@ -10,6 +10,7 @@ module Jellyfish
   autoload :NormalizedPath  , 'jellyfish/normalized_path'
 
   autoload :ChunkedBody, 'jellyfish/chunked_body'
+  autoload :WebSocket  , 'jellyfish/websocket'
 
   Cascade  = Object.new
   GetValue = Object.new
@@ -129,7 +130,9 @@ module Jellyfish
   module DSL
     def routes  ; @routes   ||= {}; end
     def handlers; @handlers ||= {}; end
-    def handle exception, █ handlers[exception] = block; end
+    def handle *exceptions, &block
+      exceptions.each{ |exp| handlers[exp] = block }
+    end
     def handle_exceptions value=GetValue
       if value == GetValue
         @handle_exceptions
@@ -187,8 +190,13 @@ module Jellyfish
       cascade(ctrl, env)
     when Response
       handle(ctrl, res, env['rack.errors'])
-    else     # make sure we return rack triple
-      res || ctrl.block_call(nil, lambda{|_|_})
+    when Array
+      res
+    when NilClass # make sure we return rack triple
+      ctrl.block_call(nil, lambda{|_|_})
+    else
+      raise TypeError.new("Expect the response to be a Jellyfish::Response" \
+        " or Rack triple (Array), but got: #{res.inspect}")
     end
   rescue => e
     handle(ctrl, e, env['rack.errors'])

data/lib/jellyfish/test.rb

@@ -1,13 +1,14 @@
 
-require 'bacon'
-require 'rack'
+require 'pork/auto'
+require 'muack'
 require 'jellyfish'
+require 'rack'
 
-Bacon.summary_on_exit
+Pork::Executor.__send__(:include, Muack::API)
 
-shared :jellyfish do
-  %w[options get head post put delete patch].each do |method|
-    instance_eval <<-RUBY
+copy :jellyfish do
+  module_eval(%w[options get head post put delete patch].map{ |method|
+    <<-RUBY
       def #{method} path='/', app=app, env={}
         File.open(File::NULL) do |input|
           app.call({'PATH_INFO'      => path              ,
@@ -20,11 +21,5 @@ shared :jellyfish do
         end
       end
     RUBY
-  end
-end
-
-module Kernel
-  def eq? rhs
-    self == rhs
-  end
+  }.join("\n"))
 end

data/lib/jellyfish/version.rb

@@ -1,4 +1,4 @@
 
 module Jellyfish
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/jellyfish/websocket.rb

@@ -0,0 +1,51 @@
+
+require 'jellyfish'
+require 'websocket_parser'
+require 'digest/sha1'
+
+module Jellyfish
+  module WebSocket
+    ::WebSocket.constants.each do |const|
+      const_set(const, ::WebSocket.const_get(const))
+    end
+
+    attr_reader :sock, :parser
+
+    def switch_protocol &block
+      key = env['HTTP_SEC_WEBSOCKET_KEY']
+      accept = [Digest::SHA1.digest("#{key}#{GUID}")].pack('m0')
+      @sock = env['rack.hijack'].call
+      sock.binmode
+      sock.write(<<-HTTP)
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: #{accept}\r
+\r
+      HTTP
+      @parser = Parser.new
+      parser.on_message(&block)
+    end
+
+    def ws_start
+      while !sock.closed? && IO.select([sock]) do
+        ws_read
+      end
+    end
+
+    def ws_read bytes=8192
+      parser << sock.readpartial(bytes)
+    rescue EOFError
+      sock.close
+    end
+
+    def ws_write msg
+      sock << Message.new(msg).to_data
+    end
+
+    def ws_close
+      sock << Message.close.to_data
+      sock.close
+    end
+  end
+end

data/task/gemgem.rb

@@ -34,7 +34,7 @@ module Gemgem
       s.executables = bin_files
     end
     spec_create.call(spec)
-    spec.homepage = "https://github.com/godfat/#{spec.name}"
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
     self.spec = spec
   end
 
@@ -227,10 +227,6 @@ end # of gem namespace
 desc 'Run tests'
 task :test do
   next if Gemgem.test_files.empty?
-
-  require 'bacon'
-  Bacon.extend(Bacon::TestUnitOutput, Bacon::NewlineErrorDescription)
-  Bacon.summary_on_exit
   Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
 end
 

data/test/sinatra/test_base.rb

@@ -3,9 +3,9 @@ require 'jellyfish/test'
 
 # stolen from sinatra
 describe 'Sinatra base_test.rb' do
-  behaves_like :jellyfish
+  paste :jellyfish
 
-  should 'process requests with #call' do
+  would 'process requests with #call' do
     app = Class.new{
       include Jellyfish
       get '/' do
@@ -18,7 +18,7 @@ describe 'Sinatra base_test.rb' do
     body  .should.eq ['Hello World']
   end
 
-  should 'not maintain state between requests' do
+  would 'not maintain state between requests' do
     app = Class.new{
       include Jellyfish
       get '/state' do
@@ -63,35 +63,35 @@ describe 'Sinatra base_test.rb' do
       end
     }.new(inner_app)
 
-    should 'create a middleware that responds to #call with .new' do
+    would 'create a middleware that responds to #call with .new' do
       app.respond_to?(:call).should.eq true
     end
 
-    should 'expose the downstream app' do
+    would 'expose the downstream app' do
       app.app.object_id.should.eq inner_app.object_id
     end
 
-    should 'intercept requests' do
+    would 'intercept requests' do
       status, _, body = get('/', app)
       status.should.eq 200
       body  .should.eq ['Hello from middleware']
     end
 
-    should 'forward requests downstream when no matching route found' do
+    would 'forward requests downstream when no matching route found' do
       status, headers, body = get('/missing', app)
       status                 .should.eq 210
       headers['X-Downstream'].should.eq 'true'
       body                   .should.eq ['Hello from downstream']
     end
 
-    should 'call the downstream app directly and return result' do
+    would 'call the downstream app directly and return result' do
       status, headers, body = get('/low-level-forward', app)
       status                 .should.eq 210
       headers['X-Downstream'].should.eq 'true'
       body                   .should.eq ['Hello from downstream']
     end
 
-    should 'forward the request and integrate the response' do
+    would 'forward the request and integrate the response' do
       status, headers, body =
         get('/explicit-forward', Rack::ContentLength.new(app))
 

data/test/sinatra/test_chunked_body.rb

@@ -3,9 +3,9 @@ require 'jellyfish/test'
 
 # stolen from sinatra
 describe 'Sinatra streaming_test.rb' do
-  behaves_like :jellyfish
+  paste :jellyfish
 
-  should 'return the concatinated body' do
+  would 'return the concatinated body' do
     app = Class.new{
       include Jellyfish
       get '/' do
@@ -20,7 +20,7 @@ describe 'Sinatra streaming_test.rb' do
     body.to_a.join.should.eq 'Hello World!'
   end
 
-  should 'postpone body generation' do
+  would 'postpone body generation' do
     stream = Jellyfish::ChunkedBody.new{ |out|
       10.times{ |i| out[i] }
     }
@@ -30,7 +30,7 @@ describe 'Sinatra streaming_test.rb' do
     end
   end
 
-  should 'give access to route specific params' do
+  would 'give access to route specific params' do
     app = Class.new{
       include Jellyfish
       get(%r{/(?<name>\w+)}){ |m|