alexander 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sandra.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ronie Uliana
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# Alexander
+
+A Rack middleware to process XML through XSLT to generate HTML.
+
+The process occur only:
+
+1. If the file served is a XML (`mime-type: "application/xml"`);
+2. **and** the XML has a stylesheet processing instruction (`<?xml-stylesheet type="text/xsl" href="/teste.xsl"?>`);
+3. **and** the browser (`HTTP_USER_AGENT` header) has **no** support for XSLT processing.
+
+If *any* of these conditions is *false*, Alexander will do nothing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'alexander'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alexander
+
+## Usage
+
+Add to your Rack stack:
+
+    use Alexander::XslProcessor
+
+## Browsers with XSLT processing support:
+
+* Chrome &gt;= 1.0
+* Firefox &gt;= 3.0
+* Safari &gt;= 3.0
+* Internet Explorer &gt;= 6.0
+* Opera &gt;= 9.0
+
+## TODO
+* Better error handling:
+  * Invalid XML.
+  * Invalid XSL.
+  * XSL page not found.
+* URL parameter to force XSLT processing.
+* Config parameter to force XSLT processing.
+* `Content-Type` control, make it able to produce things other than HTML.
+* Examples of use in README.
+  * Sinatra
+  * Rails
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/alexander.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/alexander/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ronie Uliana"]
+  gem.email         = ["ronie.uliana@gmail.com"]
+  gem.description   = %q{A Rack middleware to compile XML+XSLT into HTML for unsupported browsers only}
+  gem.summary       = %q{Named after the cocktail "Alexander". It will pre-process XML into HTML (using XSLT) only for browsers that are can't do it. Otherwise, it will just sit and watch.}
+  gem.homepage      = "http://github.com/ruliana/alexander"
+
+  gem.add_dependency("nokogiri", "~>1.5")
+  gem.add_dependency("useragent", "~>0.4")
+
+  gem.add_development_dependency("reloader", "~>0.1")
+  gem.add_development_dependency("minitest", "~>2.12")
+  gem.add_development_dependency("minitest-matchers", "~>1.2")
+  gem.add_development_dependency("minitest-colorize", "~>0.0.4")
+  gem.add_development_dependency("guard", "~>1.0")
+  gem.add_development_dependency("guard-minitest", "~>0.5")
+  gem.add_development_dependency("simplecov", "~>0.6")
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "alexander"
+  gem.require_paths = ["lib"]
+  gem.version       = Alexander::VERSION
+end

data/lib/alexander/version.rb

@@ -0,0 +1,3 @@
+module Alexander
+  VERSION = "0.5.0"
+end

data/lib/alexander/xsl_processor.rb

@@ -0,0 +1,74 @@
+require 'rack'
+require 'useragent'
+require 'nokogiri'
+
+module Alexander
+  Browser = Struct.new(:browser, :version)
+
+  XSLT_ENABLE_BROWSERS = [
+    Browser.new("Chrome", "1.0"),
+    Browser.new("Firefox", "3.0"),
+    Browser.new("Internet Explorer", "6.0"),
+    Browser.new("Opera", "9.0"),
+    Browser.new("Safari", "3.0")
+  ]
+
+  class XslProcessor
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      return [status, headers, body] unless xml?(headers)
+      return [status, headers, body] if xlst_enable_browser?(env)
+
+      html_response = to_html(env, body)
+      return [status, headers, body] unless html_response
+
+      headers["Content-type"] = "text/html"
+      Rack::Response.new([html_response], status, headers).finish
+    end
+
+    def xml?(headers)
+      headers["Content-Type"] =~ /\bapplication\/xml\b/
+    end
+
+    def xlst_enable_browser?(env)
+      return false unless env && env["HTTP_USER_AGENT"]
+      user_agent = UserAgent.parse(env["HTTP_USER_AGENT"])
+      XSLT_ENABLE_BROWSERS.detect { |browser| user_agent >= browser }
+    end
+
+    def to_html(env, body)
+      xml = body_to_string(body)
+      xslt_request = detect_xslt_processing_instruction(xml)
+      return unless xslt_request
+
+      ask_xslt = env.dup
+      ask_xslt["PATH_INFO"] = xslt_request
+      ask_xslt["REQUEST_PATH"] = xslt_request
+      ask_xslt["REQUEST_URI"] = xslt_request
+      ask_xslt["QUERY_STRING"] = ""
+      status, headers, xslt = @app.call(ask_xslt)
+      return unless status == 200
+
+      xml_parsed = Nokogiri::XML(xml)
+      xsl_parsed = Nokogiri::XSLT(body_to_string(xslt))
+      xsl_parsed.transform(xml_parsed).to_s
+    end
+
+    def detect_xslt_processing_instruction(xml)
+      match = xml.match(/<\?xml-stylesheet.*href="([^"]+)"/)
+      return match[1] if match
+    end
+
+    def body_to_string(body)
+      result = ""
+      body.each { |it| result << it }
+      body.close if body.respond_to? :close
+      result
+    end
+  end
+end

data/lib/alexander.rb

@@ -0,0 +1,2 @@
+require "alexander/version"
+require "alexander/xsl_processor"

data/spec/alexander/xsl_processor_spec.rb

@@ -0,0 +1,99 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/colorize'
+
+require_relative '../../lib/alexander'
+
+class DummyApp
+  attr_accessor :xml, :xsl
+
+  def initialize
+    self.xml = Rack::MockResponse.new(
+      200, {"Content-Type" => "application/xml;charset=utf-8"}, [<<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<?xml-stylesheet type="text/xsl" href="teste.xsl"?>
+<root />
+      XML
+    ])
+    self.xsl = Rack::MockResponse.new(
+      200, {"Content-type" => "application/xslt+xml"}, [<<-XSL
+<?xml version="1.0" encoding="utf-8"?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+  <xsl:template match="/">
+    <html><body></body></html>
+  </xsl:template>
+</xsl:stylesheet>
+      XSL
+    ])
+  end
+
+  def call(env)
+    if env["REQUEST_PATH"] =~ /.*\.xsl/
+      xsl
+    else
+      xml
+    end
+  end
+end
+
+CHROME_18 = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.19 (KHTML, like Gecko) Ubuntu/11.10 Chromium/18.0.1025.151 Chrome/18.0.1025.151 Safari/535.19"
+CURL = "curl/7.21.6 (x86_64-pc-linux-gnu) libcurl/7.21.6 OpenSSL/1.0.0e zlib/1.2.3.4 libidn/1.22 librtmp/2.3"
+
+describe Alexander::XslProcessor do
+
+  def env_with_chrome
+    {"HTTP_USER_AGENT" => CHROME_18}
+  end
+
+  def env_with_curl
+    {"HTTP_USER_AGENT" => CURL}
+  end
+
+  before do
+    @dummy_app = DummyApp.new
+    @filter = Alexander::XslProcessor.new(@dummy_app)
+  end
+
+  def app
+    @filter
+  end
+
+  describe "when response is NOT XML" do
+    it "should pass the response as is" do
+      @dummy_app.xml = Rack::MockResponse.new(200, {"Content-type" => "text/html"}, ["<html></html>"])
+      status, headers,response = @filter.call(env_with_chrome)
+      response.body.must_equal @dummy_app.xml.body
+    end
+  end
+
+  describe "when response is XML" do
+    describe "when request came from a XSLT enable browser" do
+      it "should let response as is" do
+        status, headers, response = @filter.call(env_with_chrome)
+        response.body.must_equal @dummy_app.xml.body
+      end
+    end
+    describe "when request came from a XSLT NOT enable browser" do
+      it "should parse XML to HTML" do
+        status, headers, response = @filter.call(env_with_curl)
+        status.must_equal 200
+        headers["Content-type"].must_equal "text/html"
+        response.body.must_equal ["<html><body></body></html>\n"]
+      end
+    end
+    describe "when response is a XML without stylesheet" do
+      it "should let response as is" do
+        @dummy_app.xml = Rack::MockResponse.new(200, {"Content-type" => "application/xml"}, [<<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<root />
+        XML
+        ])
+        status, header, response = @filter.call(env_with_curl)
+        response.body.must_equal @dummy_app.xml.body
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: alexander
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Ronie Uliana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: reloader
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: minitest-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A Rack middleware to compile XML+XSLT into HTML for unsupported browsers
+  only
+email:
+- ronie.uliana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- alexander.gemspec
+- lib/alexander.rb
+- lib/alexander/version.rb
+- lib/alexander/xsl_processor.rb
+- spec/alexander/xsl_processor_spec.rb
+homepage: http://github.com/ruliana/alexander
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Named after the cocktail "Alexander". It will pre-process XML into HTML (using
+  XSLT) only for browsers that are can't do it. Otherwise, it will just sit and watch.
+test_files:
+- spec/alexander/xsl_processor_spec.rb