jellyfish 0.5.3 → 0.6.0

data/CHANGES.md

@@ -1,5 +1,45 @@
 # CHANGES
 
+## Jellyfish 0.6.0 -- 2012-11-02
+
+### Enhancements for Jellyfish core
+
+* Extracted Jellyfish::Controller#call and Jellyfish::Controller#block_call
+  into Jellyfish::Controller::Call so that you can have modules which can
+  override call and block_call. See Jellyfish::Sinatra and Jellyfish::NewRelic
+  for an example.
+
+* Now you can use `request` in the controller, which is essentially:
+  `@request ||= Rack::Request.new(env)`. This also means you would need
+  Rack installed and required to use it. Other than this, there's no
+  strict requirement for Rack.
+
+### Enhancements for NewRelic
+
+* Added Jellyfish::NewRelic which makes you work easier with NewRelic.
+  Here's an example of how to use it: (extracted from README)
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  class MyController < Jellyfish::Controller
+    include Jellyfish::NewRelic
+  end
+  def controller; MyController; end
+  get '/' do
+    "OK\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+require 'cgi' # newrelic dev mode needs this and it won't require it itself
+require 'new_relic/rack/developer_mode'
+use NewRelic::Rack::DeveloperMode # GET /newrelic to read stats
+run Tank.new
+NewRelic::Agent.manual_start(:developer_mode => true)
+```
+
 ## Jellyfish 0.5.3 -- 2012-10-26
 
 ### Enhancements for Jellyfish core

data/README.md

@@ -201,7 +201,10 @@ Currently support:
 require 'jellyfish'
 class Tank
   include Jellyfish
-  def controller; Jellyfish::Sinatra; end
+  class MyController < Jellyfish::Controller
+    include Jellyfish::Sinatra
+  end
+  def controller; MyController; end
   get %r{^/(?<id>\d+)$} do
     "Jelly ##{params[:id]}\n"
   end
@@ -211,6 +214,29 @@ use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
+### Using NewRelic?
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  class MyController < Jellyfish::Controller
+    include Jellyfish::NewRelic
+  end
+  def controller; MyController; end
+  get '/' do
+    "OK\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+require 'cgi' # newrelic dev mode needs this and it won't require it itself
+require 'new_relic/rack/developer_mode'
+use NewRelic::Rack::DeveloperMode # GET /newrelic to read stats
+run Tank.new
+NewRelic::Agent.manual_start(:developer_mode => true)
+```
+
 ### Jellyfish as a middleware
 
 ``` ruby

data/example/config.ru

@@ -87,8 +87,14 @@ class Heater
     temperature
   end
 
+  get %r{^/sinatra/(?<id>\d+)$} do
+    "#{params[:id]}\n"
+  end
+
   def controller; Controller; end
   class Controller < Jellyfish::Controller
+    include Jellyfish::Sinatra
+    include Jellyfish::NewRelic
     def temperature
       "30\u{2103}\n"
     end
@@ -96,11 +102,17 @@ class Heater
 end
 
 HugeTank = Rack::Builder.new do
-  use Rack::Chunked
+  use Rack::Chunked # order does matter, need to check Content-Length first
   use Rack::ContentLength
   use Rack::ContentType, 'text/plain'
   use Heater
   run Tank.new
 end
 
+require 'cgi' # newrelic needs this
+require 'new_relic/rack/developer_mode'
+use NewRelic::Rack::DeveloperMode
+
 run HugeTank
+
+NewRelic::Agent.manual_start(:developer_mode => true)

data/jellyfish.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "0.5.3"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2012-10-26"
+  s.date = "2012-11-02"
   s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middlewares. Under 200 lines of code."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   "jellyfish.gemspec",
   "jellyfish.png",
   "lib/jellyfish.rb",
+  "lib/jellyfish/newrelic.rb",
   "lib/jellyfish/public/302.html",
   "lib/jellyfish/public/404.html",
   "lib/jellyfish/public/500.html",

data/lib/jellyfish.rb

@@ -1,9 +1,8 @@
 
 module Jellyfish
-  autoload :VERSION, 'jellyfish/version'
-  autoload :Sinatra, 'jellyfish/sinatra'
-
-  # -----------------------------------------------------------------
+  autoload :VERSION , 'jellyfish/version'
+  autoload :Sinatra , 'jellyfish/sinatra'
+  autoload :NewRelic, 'jellyfish/newrelic'
 
   class Response < RuntimeError
     def headers
@@ -28,29 +27,32 @@ module Jellyfish
   # -----------------------------------------------------------------
 
   class Controller
+    module Call
+      def call env
+        @env = env
+        block_call(*dispatch)
+      end
+
+      def block_call argument, block
+        ret = instance_exec(argument, &block)
+        body ret if body.nil? # prefer explicitly set values
+        body ''  if body.nil? # at least give an empty string
+        [status || 200, headers || {}, body]
+      rescue LocalJumpError
+        jellyfish.log("Use `next' if you're trying to `return' or" \
+                      " `break' from the block.", env['rack.errors'])
+        raise
+      end
+    end
+    include Call
+
     attr_reader :routes, :jellyfish, :env
     def initialize routes, jellyfish
       @routes, @jellyfish = routes, jellyfish
       @status, @headers, @body = nil
     end
 
-    def call env
-      @env = env
-      block_call(*dispatch)
-    end
-
-    def block_call argument, block
-      ret = instance_exec(argument, &block)
-      body ret if body.nil? # prefer explicitly set values
-      body ''  if body.nil? # at least give an empty string
-      [status || 200, headers || {}, body]
-    rescue LocalJumpError
-      jellyfish.log(
-        "Use `next' if you're trying to `return' or `break' from the block.",
-        env['rack.errors'])
-      raise
-    end
-
+    def request  ; @request ||= Rack::Request.new(env); end
     def forward  ; raise(Jellyfish::NotFound.new)     ; end
     def found url; raise(Jellyfish::   Found.new(url)); end
     alias_method :redirect, :found

data/lib/jellyfish/newrelic.rb

@@ -0,0 +1,32 @@
+
+require 'jellyfish'
+require 'rack/request'
+
+require 'new_relic/agent/instrumentation/controller_instrumentation'
+
+module Jellyfish
+  module NewRelic
+    include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+    def block_call argument, block
+      path = if argument.respond_to?(:regexp)
+               argument.regexp
+             else
+               argument
+             end.to_s[1..-1]
+      name = "#{env['REQUEST_METHOD']} #{path}"
+        # magic category: NewRelic::MetricParser::WebTransaction::Jellyfish
+      perform_action_with_newrelic_trace(:category => 'Controller/Jellyfish',
+                                         :path     => path                  ,
+                                         :name     => name                  ,
+                                         :request  => request               ,
+                                         :params   => request.params){super}
+    end
+  end
+end
+
+module NewRelic::MetricParser::WebTransaction::Jellyfish
+  include NewRelic::MetricParser::WebTransaction::Pattern
+  def is_web_transaction?;        true; end
+  def category           ; 'Jellyfish'; end
+end

data/lib/jellyfish/sinatra.rb

@@ -3,8 +3,8 @@ require 'jellyfish'
 require 'rack/request'
 
 module Jellyfish
-  class Sinatra < Controller
-    attr_reader :request, :params
+  module Sinatra
+    attr_reader :params
     def block_call argument, block
       initialize_params(argument)
       super
@@ -12,8 +12,7 @@ module Jellyfish
 
     private
     def initialize_params argument
-      @request ||= Rack::Request.new(env)
-      @params  ||= force_encoding(indifferent_params(
+      @params ||= force_encoding(indifferent_params(
       if argument.kind_of?(MatchData)
         # merge captured data from matcher into params as sinatra
         request.params.merge(Hash[argument.names.zip(argument.captures)])

data/lib/jellyfish/version.rb

@@ -1,4 +1,4 @@
 
 module Jellyfish
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jellyfish
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -67,6 +67,7 @@ files:
 - jellyfish.gemspec
 - jellyfish.png
 - lib/jellyfish.rb
+- lib/jellyfish/newrelic.rb
 - lib/jellyfish/public/302.html
 - lib/jellyfish/public/404.html
 - lib/jellyfish/public/500.html