rack_format_response 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [maiha@wota.jp]
+
+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

@@ -0,0 +1,94 @@
+Rack::FormatResponse
+====================
+
+  A Rack middleware for automatically formatting response body
+
+
+Install
+=======
+
+  gem install rack_format_response
+
+
+Usage
+=====
+
+    use Rack::FormatResponse
+
+  When non-string value is given in response body,
+  it will be passed to Rack::FormatResponse#format_<OBJECT_CLASS>.
+
+
+Example
+=======
+
+  Let's consider about generating json response.
+
+    get "/ping" do
+      {"message"=>"pong"}
+    end
+
+  This code generates "messagepong" response due to response#to_s.
+  So we must write like following with concern about Content-Type.
+
+    get "/ping" do
+      content_type :json
+      hash = {"message"=>"pong"}
+      JSON.dump(hash)
+    end
+
+  This is a pain and not fun!
+
+  Well, with this module, we can enjoy rack with various objects.
+
+    # use Rack::FormatResponse
+    get "/ping" do
+      {"message"=>"pong"}
+    end
+  ->
+    Content-Type: application/json;charset=utf-8
+    {"message":"pong"}
+
+
+Customize
+=========
+
+  When you want automatic formatter from Hash to XML,
+  It would be like this.
+
+    require "rack/format_response"
+    require "active_suport"
+
+    class Rack::FormatResponse
+      def format_hash(hash)
+        hash.to_xml
+      end
+    end
+    Rack::FormatResponse::MAPPINGS["Hash"] = "format_hash"
+
+  or just write code in block.
+
+    Rack::FormatResponse::MAPPINGS["Hash"] = lambda{|hash| hash.to_xml}
+
+
+NOTE
+====
+
+  In default, this module converts hash to json with Yajl gem.
+  Install it first for json use.
+
+    gem install yajl
+
+  # Yajl is a fastest json library where I know
+
+
+Homepage
+========
+
+ http://github.com/maiha/rack_format_response
+
+
+Author
+======
+Maiha <maiha@wota.jp>
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+GEM_NAME = "rack_format_response"
+AUTHOR = "maiha"
+EMAIL = "maiha@wota.jp"
+HOMEPAGE = "http://github.com/maiha/rack_format_response"
+SUMMARY = "A Rack middleware for automatically formatting response body"
+GEM_VERSION = "0.0.1"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'asakusarb'
+  s.executables = []
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.files = %w(MIT-LICENSE README Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'spec/rake/spectask'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/lib/rack/format_response.rb

@@ -0,0 +1,92 @@
+module Rack
+  #
+  # A Rack middleware for automatically formatting response body
+  #
+  # e.g.
+  #   # in usual case
+  #   get "/ping" do
+  #     {"message"=>"pong"}
+  #   end
+  # ->
+  #   # forced to to_s
+  #   messagepong
+  #
+  #
+  #   # use Rack::FormatResponse # with string response
+  #   get "/ping" do
+  #     "pong"
+  #   end
+  # ->
+  #   # calls Rack::FormatResponse#format_string that effects nothing
+  #   # in short, nothing special
+  #   Content-Type: text/html
+  #   "pong"
+  #
+  #   # use Rack::FormatResponse # with hash response
+  #   get "/ping" do
+  #     {"message"=>"pong"}
+  #   end
+  # ->
+  #   # calls Rack::FormatResponse#format_hash_to_json
+  #   # due to Rack::FormatResponse::MAPPINGS
+  #   Content-Type: application/json;charset=utf-8
+  #   {"message":"pong"}
+  #
+
+  class FormatResponse
+    MAPPINGS = {
+      "Hash" => :format_hash_to_json,
+    }
+
+    class UnknownFormat < RuntimeError; end
+    class InvalidFormat < RuntimeError; end
+
+    def initialize(app, opts = {})
+      @app  = app
+      @opts = opts
+    end
+
+    def call(env)
+      @status, @headers, body = @app.call(env)
+      body = [apply(body)].flatten
+      [@status, @headers, @body || body]
+    end
+
+    private
+      def lookup(body)
+        body = body[0] if body.class == Array and body.size == 1
+        MAPPINGS[body.class.name] or
+          "format_" + body.class.name.gsub(/::/,'_').downcase
+      end
+
+      def apply(data)
+        func = lookup(data)
+        case func
+        when Proc
+          return func.call(data)
+        when Symbol, String
+          return __send__(func, data) if respond_to?(func, true)
+          raise UnknownFormat, "no formatters named `#{func}'"
+        else
+          raise UnknownFormat, "no formatters typed `#{func.class}'"
+        end
+      end
+
+      ######################################################################
+      ### Formatters
+
+      def format_array(ary)
+        ary
+      end
+
+      def format_string(str)
+        str
+      end
+
+      def format_hash_to_json(hash)
+        require 'yajl'
+        @headers['Content-Type'] = "application/json;charset=utf-8"
+        Yajl.dump(hash)
+      end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: rack_format_response
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-08 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: A Rack middleware for automatically formatting response body
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/rack/format_response.rb
+has_rdoc: true
+homepage: http://github.com/maiha/rack_format_response
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: asakusarb
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Rack middleware for automatically formatting response body
+test_files: []
+