response_assembler 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+nbproject/*
+.bundle/*
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,5 @@
+gem "rack", "1.2.1"
+gem "rack-test", "0.5.5", :require => "rack/test"
+gem "rspec", "2.0.0.beta.22"
+
+

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  specs:
+    diff-lcs (1.1.2)
+    rack (1.2.1)
+    rack-test (0.5.5)
+      rack (>= 1.0)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack (= 1.2.1)
+  rack-test (= 0.5.5)
+  rspec (= 2.0.0.beta.22)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hubert
+
+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.markdown

@@ -0,0 +1,57 @@
+ResponseAssembler
+=======================
+
+ResponseAssembler is a piece of middleware that is meant to provide a way for quickly and easily assembling HTTP response documents from many "parts" (other responses). Let's say you want to have your pages built from posts, sidebar and menu - each of these can be returned by separate URLs (/posts/1, /sidebar, /menu) and ResponseAssembler will merge it for you into one HTML document.
+
+ResponseAssembler can be used with Rack-Cache. For example, you might want to store your /posts/1 response in cache, and pull interactive (not cached) elements on the page. You can do it in Javascript on the client side, but to make it a bit nicer for google or lynx users (;)) you might want to assemble initial version on server side. We have provided you even a helper that mimicks XMLHttpRequest when you want to replace your current Javascript solution so you don't have to change your controllers! ResponseAssembler won't do caching for you, you need to use Rack-Cache instead and teach your app to use it.
+
+You can use ResponseAssembler with CSS, JavaScript, text or CSV files. Please look at example to find out how to specify response mime types that ResponseAssembler should parse.
+
+Installation
+============
+
+Add this to Gemfile:
+
+    gem "response_assembler"
+
+and run:
+
+    $ bundle install
+
+Usage
+=====
+
+Say, you want to render single Post (/posts/1), and add extra menu, sidebar and comments boxes.
+I assume you are using Rails.
+
+To enable ResponseAssembler::Middleware, plact this line into your config/application.rb:
+    
+    config.middleware.use "ResponseAssembler::Middleware"
+
+Now, you don't have to change your PostsController::index action at all, just edit it's view template to return something like:
+
+    <get>/menu</get>
+    <get>/sidebar</get>
+    <h1><%= @post.title %></h1>
+    <p><%= @post.body %></p>
+    <get><%= post_comments_path @post %></get> // this is /posts/1/comments for example where your comments controller sits
+
+You can see that your response will include what /menu /sidebar and /posts/1/comments returns.
+
+Don't forget to add :layout => false to your /menu /sidebar and /posts/1/comments actions.
+
+If you want to use the same logic for future AJAX requests (say for CommentsController), for example to skip rendering layout, you can mimick XMLHttpRequest by using <xhrget>/some/ajax/controller</xhrget> instead of normal "get".
+
+Options
+-------
+
+In you config.ru file, you can use two extra options to initialize ResponseAssembler::Middleware. 
+
+ResponseAssembler will render <p>Part loading failed...</p> in places where responses from your app had different status code than 200 HTTP OK. If you want to change this message, just use:
+
+    use ResponseAssembler::Middleware, "Oops, can't find part"
+
+and if you want to filter, say - only text/css files for inclusions, use array of content types at end of line:
+
+    use ResponseAssembler::Middleware, "/* Oops, can't find part of this CSS */", ["text/css"]
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "response_assembler"
+    gem.summary = %Q{ResponseAssembler assembles HTTP response documents from many "parts" (other responses)}
+    gem.description = %Q{Could be called parts for Rack...}
+    gem.email = "hubert.lepicki@amberbit.com"
+    gem.homepage = "http://github.com/hubertlepicki/response_assembler"
+    gem.authors = ["Hubert"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "responseassembler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/response_assembler.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "response_assembler", "middleware")

data/lib/response_assembler/middleware.rb

@@ -0,0 +1,96 @@
+#--
+# Copyright (c) 2009 Hubert Lepicki <hubert.lepicki@gmail.com>
+#
+# 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.
+#++
+
+require 'rack'
+
+# This class is piece of Rack middleware that filters responses from your
+# app and finds <get>/some/relative/url</get> or <xhrget>/some/ajax/url</xhrget>
+# and substitutes them with appropriate responses returned by your app.
+# This can be useful if you want to assemble single page with responses returned
+# by many controllers for example.
+# xhrget performs standard GET request as well, and tries to mimick 
+# XMLHTTPRequest so you can use "if request.xhr?; render :layout => false; end"
+# the same way you'd use it with JavaScript, to keep your controllers lean and
+# clean.
+module ResponseAssembler
+  class Middleware
+    # In Rails you could use:
+    # config.middleware.use "Rack::ResponseAssembler", "Yo! Can't load parts!", ["text/html"]
+    # to change error message and content types array that filter gets run on.
+    def initialize(app, 
+                   error_message = "<p>Loading failed...</p>",
+                   content_types = ["text/html", "text/xhtml", "text/css", "text/csv", "text/plain"])
+      @app = app
+      @content_types = content_types
+      @error_message = error_message
+    end
+
+    def call(env)
+      @original_env = env.clone
+      
+      status, headers, response = @app.call(env)
+      return [status, headers, response] unless is_allowed_content_type(headers["Content-Type"].to_s)
+
+      response = [assemble_from_parts(response)]
+      headers["Content-Length"] = response[0].size.to_s
+      [status, headers, response]
+    end
+
+    private
+    
+    def assemble_from_parts(resp_body)
+      join_response(resp_body).gsub(/(<get>|<xhrget>)(.*?)(<\/get>|<\/xhrget>)/) do
+        assemble_from_parts(get($2, $1 != "<get>"))
+      end 
+    end  
+
+    def get(relative_url, ajax=false)
+      path_string, query_string = relative_url.split("?")
+      
+      env = @original_env.merge({
+        "REQUEST_PATH" => path_string,
+        "PATH_INFO" => path_string,
+        "REQUEST_URI" => path_string,
+        "REQUEST_METHOD" => "GET",
+        "QUERY_STRING" => (query_string || '')
+      })
+      
+      env = env.merge({"HTTP_X_REQUESTED_WITH"=>"XMLHttpRequest"}) if ajax 
+      
+      status, headers, response = @app.call(env)
+      return response if status == 200
+      [@error_message] 
+    end
+
+    def is_allowed_content_type(content_type)
+      @content_types.each { |type| return true if content_type =~ Regexp.new(type) }
+      false
+    end
+
+    def join_response(resp)
+      joined = ""
+      resp.each { |element| joined += element }
+      joined
+    end
+  end
+end

data/response_assembler.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{response_assembler}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hubert"]
+  s.date = %q{2010-09-23}
+  s.description = %q{Could be called parts for Rack...}
+  s.email = %q{hubert.lepicki@amberbit.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/response_assembler.rb",
+     "lib/response_assembler/middleware.rb",
+     "response_assembler.gemspec",
+     "spec/response_assembler_spec.rb",
+     "spec/testapp.rb"
+  ]
+  s.homepage = %q{http://github.com/hubertlepicki/response_assembler}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{ResponseAssembler assembles HTTP response documents from many "parts" (other responses)}
+  s.test_files = [
+    "spec/testapp.rb",
+     "spec/response_assembler_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/spec/response_assembler_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "response_assembler", "middleware")
+Bundler.require
+require 'testapp'
+
+describe "ResponseAssembler::Middleware" do
+  include Rack::Test::Methods
+
+  def app
+    ResponseAssembler::Middleware.new(TestApp.new, "Oh, no!")
+  end
+
+  it "pass response returned by application when no recognized tags were found" do
+    get '/'
+    last_response.should be_ok
+    last_response.body.should eql('Hello World')
+  end
+ 
+  it "renders response1 on /response1" do
+    get "/response1"
+    last_response.should be_ok
+    last_response.body.should == "GET_response1"
+  end
+
+  it "renders response2 on /response2" do
+    get "/response2"
+    last_response.should be_ok
+    last_response.body.should == "GET_response2"
+  end
+
+  it "should embed paths wrapped in <get> tags" do
+    get "/embed_two"
+    last_response.should be_ok
+    last_response.body.should == "[GET_response1] [GET_response2]"
+  end
+
+  it "should recognize ajax an non-ajax calls" do
+    get "/get_ajax_and_not_ajax"
+    last_response.should be_ok
+    last_response.body.should == "[Ajax!] [Non-Ajax!]"
+  end
+end

data/spec/testapp.rb

@@ -0,0 +1,26 @@
+class TestApp
+  def call(env)
+    case env["PATH_INFO"]
+      when "/" then
+        [200, { 'Content-Type' => 'text/html' }, ["Hello World"]]
+      when "/response1"
+        [200, { 'Content-Type' => 'text/html' }, ["GET_response1"]]
+      when "/response2"
+        [200, { 'Content-Type' => 'text/html' }, ["GET_response2"]]
+      when "/embed_one"
+        [200, { 'Content-Type' => 'text/html' }, ["<get>/embed_two</get>"]]
+      when "/embed_two"
+        [200, { 'Content-Type' => 'text/html' }, ["[<get>/response1</get>] [<get>/response2</get>]"]]
+      when "/ajax_or_not"
+        if env["HTTP_X_REQUESTED_WITH"]=="XMLHttpRequest"
+          [200, { 'Content-Type' => 'text/html' }, ["Ajax!"]]
+        else
+          [200, { 'Content-Type' => 'text/html' }, ["Non-Ajax!"]]
+        end
+      when "/get_ajax_and_not_ajax"
+        [200, { 'Content-Type' => 'text/html' }, ["[<xhrget>/ajax_or_not</xhrget>] [<get>/ajax_or_not</get>]"]]
+      else
+        [404, { 'Content-Type' => 'text/html' }, ["404 Not found"]]
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: response_assembler
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Hubert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Could be called parts for Rack...
+email: hubert.lepicki@amberbit.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/response_assembler.rb
+- lib/response_assembler/middleware.rb
+- response_assembler.gemspec
+- spec/response_assembler_spec.rb
+- spec/testapp.rb
+has_rdoc: true
+homepage: http://github.com/hubertlepicki/response_assembler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ResponseAssembler assembles HTTP response documents from many "parts" (other responses)
+test_files: 
+- spec/testapp.rb
+- spec/response_assembler_spec.rb