jellyfish 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f177b766380820557e01f05b9da4efacc4895984
-  data.tar.gz: 800a25a7fa325e5c0c40c7604b94cbddb32c43a6
+  metadata.gz: be6525f7f0441a5863cd21be6c1e94ef5e9906b2
+  data.tar.gz: 00a83a35b93defbd52d8d4193f0298cc6009fda4
 SHA512:
-  metadata.gz: 288710b695398769a27f730e3a2d2d6fe921b140455a968f57515503628af9f7759506c89c9291b860e862b1eb6ca56d076b9ca01c2429d53626bc021d189904
-  data.tar.gz: 78edee35fbbac6dd332fc9eb9290b1dc26c27b74abd72c57166bb0d429ac6f3d441c3c88f56f014befdeb32825a47bf6d395dae04e21c624b6c52caa986aa589
+  metadata.gz: 9b3020e8a013a1a95057f9c59eb7bc8a9b05dba6a5fed1462838d8edb76b4e1d37c2daa63344b049d658361c1d60c85e603ac6a3609964a7df17f07c83c5cae7
+  data.tar.gz: 6e7e67cd52e5b34c4c9859d2446d42a2c7de2ef5026bdf1bcb8150e0ffa646be740b4f4343a54eb9fe07b1be31e8a5a60a67bc857c50389f74a74b111b0e9f02

data/.travis.yml

@@ -1,11 +1,15 @@
-
+sudo: false
 language: ruby
 rvm:
   - 2.0
   - 2.1
   - 2.2
-  - rbx-2
-  - jruby
+  - rbx
+  - jruby-9
 
+before_install:
+  - rvm get head
+  - rvm reload
+  - rvm use --install $TRAVIS_RUBY_VERSION --binary --latest
 install: 'bundle install --retry=3'
-script: 'ruby -r bundler/setup -S rake test'
+script: 'ruby -vr bundler/setup -S rake test'

data/CHANGES.md

@@ -1,5 +1,12 @@
 # CHANGES
 
+## Jellyfish 1.1.1 -- 2015-12-22
+
+### Enhancements
+
+* Added `Jellyfish::Rewrite` as an extension to `Jellyfish::Builder`.
+  Please check README.md for more detail.
+
 ## Jellyfish 1.1.0 -- 2015-09-25
 
 ### Incompatible changes

data/README.md

@@ -236,7 +236,7 @@ run Tank.new
 GET /yell
 body = case RUBY_ENGINE
        when 'jruby'
-         "No one hears you: (eval):9:in `Tank'\n"
+         "No one hears you: (eval):9:in `block in Tank'\n"
        when 'rbx'
          "No one hears you: kernel/delta/kernel.rb:78:in `yell (method_missing)'\n"
        else
@@ -583,6 +583,117 @@ Comparison:
         Rack::URLMap:     1702.0 i/s - 36.66x slower
 ```
 
+#### Extension: Jellyfish::Rewrite
+
+`Jellyfish::Builder` is mostly compatible with `Rack::Builder`, and
+`Jellyfish::Rewrite` is an extension to `Rack::Builder` which allows
+you to rewrite `env['PATH_INFO']` in an easy way. In an ideal world,
+we don't really need this. But in real world, we might want to have some
+backward compatible API which continues to work even if the API endpoint
+has already been changed.
+
+Suppose the old API was: `/users/me`, and we want to change to `/profiles/me`,
+while leaving the `/users/list` as before. We may have this:
+
+``` ruby
+require 'jellyfish'
+
+users_api    = lambda{ |env| [200, {}, ["users\n"]] }
+profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+
+run Jellyfish::Builder.app{
+  rewrite '/users/me' => '/profiles/me' do
+    run profiles_api
+  end
+  map '/profiles' do
+    run profiles_api
+  end
+  map '/users' do
+    run users_api
+  end
+}
+```
+
+<!---
+GET /users/me
+[200, {}, ["profiles\n"]]
+
+GET /users/list
+[200, {}, ["users\n"]]
+
+GET /profiles/me
+[200, {}, ["profiles\n"]]
+
+GET /profiles/list
+[200, {}, ["profiles\n"]]
+-->
+
+This way, we would rewrite `/users/me` to `/profiles/me` and serve it with
+our profiles API app, while leaving all other paths begin with `/users`
+continue to work with the old users API app.
+
+##### Extension: Jellyfish::Rewrite (`map path, to:`)
+
+Note that you could also use `map path, :to` if you prefer this API more:
+
+``` ruby
+require 'jellyfish'
+
+users_api    = lambda{ |env| [200, {}, ["users\n"]] }
+profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+
+run Jellyfish::Builder.app{
+  map '/users/me', to: '/profiles/me' do
+    run profiles_api
+  end
+  map '/profiles' do
+    run profiles_api
+  end
+  map '/users' do
+    run users_api
+  end
+}
+```
+
+<!---
+GET /users/me
+[200, {}, ["profiles\n"]]
+
+GET /users/list
+[200, {}, ["users\n"]]
+
+GET /profiles/me
+[200, {}, ["profiles\n"]]
+
+GET /profiles/list
+[200, {}, ["profiles\n"]]
+-->
+
+##### Extension: Jellyfish::Rewrite (`rewrite rules`)
+
+Note that `rewrite` takes a hash which could contain more than one rule:
+
+``` ruby
+require 'jellyfish'
+
+profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+
+run Jellyfish::Builder.app{
+  rewrite '/users/me' => '/profiles/me',
+          '/users/fa' => '/profiles/fa' do
+    run profiles_api
+  end
+}
+```
+
+<!---
+GET /users/me
+[200, {}, ["profiles\n"]]
+
+GET /users/fa
+[200, {}, ["profiles\n"]]
+-->
+
 ### Extension: NormalizedParams (with force_encoding)
 
 ``` ruby

data/jellyfish.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: jellyfish 1.1.0 ruby lib
+# stub: jellyfish 1.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "1.1.0"
+  s.version = "1.1.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 = "2015-09-25"
+  s.date = "2015-12-22"
   s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middleware. Around 250 lines of code.\n\nCheck [jellyfish-contrib][] for extra extensions.\n\n[jellyfish-contrib]: https://github.com/godfat/jellyfish-contrib"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
   "lib/jellyfish/public/302.html",
   "lib/jellyfish/public/404.html",
   "lib/jellyfish/public/500.html",
+  "lib/jellyfish/rewrite.rb",
   "lib/jellyfish/test.rb",
   "lib/jellyfish/urlmap.rb",
   "lib/jellyfish/version.rb",
@@ -51,11 +52,12 @@ Gem::Specification.new do |s|
   "test/test_inheritance.rb",
   "test/test_log.rb",
   "test/test_misc.rb",
+  "test/test_rewrite.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.4.8"
+  s.rubygems_version = "2.5.1"
   s.summary = "Pico web framework for building API-centric web applications."
   s.test_files = [
   "test/rack/test_builder.rb",
@@ -68,6 +70,7 @@ Gem::Specification.new do |s|
   "test/test_inheritance.rb",
   "test/test_log.rb",
   "test/test_misc.rb",
+  "test/test_rewrite.rb",
   "test/test_threads.rb",
   "test/test_websocket.rb"]
 end

data/lib/jellyfish/builder.rb

@@ -3,8 +3,8 @@ require 'jellyfish/urlmap'
 
 module Jellyfish
   class Builder
-    def self.app app=nil, &block
-      new(app, &block).to_app
+    def self.app app=nil, to=nil, &block
+      new(app, &block).to_app(to)
     end
 
     def initialize app=nil, &block
@@ -28,23 +28,30 @@ module Jellyfish
       @warmup = lam || block
     end
 
-    def map path, &block
-      (@map ||= {})[path] = block
+    def map path, to: nil, &block
+      (@map ||= {})[path] = [block, to]
     end
 
-    def to_app
+    def rewrite rules, &block
+      rules.each do |path, to|
+        map(path, :to => to, &block)
+      end
+    end
+
+    def to_app to=nil
       run = if @map then generate_map(@map, @run) else @run end
       fail 'missing run or map statement' unless run
       app = @use.inject(run){ |a, m| m.call(a) }
-      @warmup.call(app) if @warmup
-      app
+      rewrite = if to then Rewrite.new(app, to) else app end
+      @warmup.call(rewrite) if @warmup
+      rewrite
     end
 
     private
     def generate_map current_map, app
       mapped = if app then {'' => app} else {} end
-      current_map.each do |path, block|
-        mapped[path.chomp('/')] = self.class.app(app, &block)
+      current_map.each do |path, (block, to)|
+        mapped[path.chomp('/')] = self.class.app(app, to, &block)
       end
       URLMap.new(mapped)
     end

data/lib/jellyfish/rewrite.rb

@@ -0,0 +1,8 @@
+
+module Jellyfish
+  class Rewrite < Struct.new(:app, :to)
+    def call env
+      app.call(env.merge('PATH_INFO' => "#{env['PATH_INFO']}#{to}"))
+    end
+  end
+end

data/lib/jellyfish/version.rb

@@ -1,4 +1,4 @@
 
 module Jellyfish
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/jellyfish.rb

@@ -7,6 +7,7 @@ module Jellyfish
   autoload :NormalizedPath  , 'jellyfish/normalized_path'
 
   autoload :Builder    , 'jellyfish/builder'
+  autoload :Rewrite    , 'jellyfish/rewrite'
   autoload :ChunkedBody, 'jellyfish/chunked_body'
   autoload :WebSocket  , 'jellyfish/websocket'
 

data/test/test_rewrite.rb

@@ -0,0 +1,38 @@
+
+require 'jellyfish/test'
+require 'jellyfish/urlmap'
+
+describe Jellyfish::Rewrite do
+  lam = lambda{ |env| [200, {}, [env['PATH_INFO']]] }
+
+  def call app, env={}
+    app.call({'SCRIPT_NAME' => ''}.merge(env)).last.first
+  end
+
+  would 'map to' do
+    app = Jellyfish::Builder.app do
+      map '/from', to: '/to' do
+        run lam
+      end
+    end
+
+    expect(call(app, 'PATH_INFO' => '/from')).eq '/to'
+  end
+
+  would 'rewrite and fallback' do
+    app = Jellyfish::Builder.app do
+      rewrite '/from/inner' => '/to/inner',
+              '/from/outer' => '/to/outer' do
+        run lam
+      end
+
+      map '/from' do
+        run lam
+      end
+    end
+
+    expect(call(app, 'PATH_INFO' => '/from'      )).eq ''
+    expect(call(app, 'PATH_INFO' => '/from/inner')).eq '/to/inner'
+    expect(call(app, 'PATH_INFO' => '/from/outer')).eq '/to/outer'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jellyfish
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Pico web framework for building API-centric web applications.
@@ -46,6 +46,7 @@ files:
 - lib/jellyfish/public/302.html
 - lib/jellyfish/public/404.html
 - lib/jellyfish/public/500.html
+- lib/jellyfish/rewrite.rb
 - lib/jellyfish/test.rb
 - lib/jellyfish/urlmap.rb
 - lib/jellyfish/version.rb
@@ -62,6 +63,7 @@ files:
 - test/test_inheritance.rb
 - test/test_log.rb
 - test/test_misc.rb
+- test/test_rewrite.rb
 - test/test_threads.rb
 - test/test_websocket.rb
 homepage: https://github.com/godfat/jellyfish
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pico web framework for building API-centric web applications.
@@ -99,5 +101,6 @@ test_files:
 - test/test_inheritance.rb
 - test/test_log.rb
 - test/test_misc.rb
+- test/test_rewrite.rb
 - test/test_threads.rb
 - test/test_websocket.rb