rack-stereoscope 1.0.0

data/.document

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

data/.gitignore

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

data/LICENSE

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

@@ -0,0 +1,17 @@
+= rack-stereoscope
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Avdi Grimm. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-stereoscope"
+    gem.summary = %Q{Bringing a new dimension to your RESTful API}
+    gem.description = %Q{Rack::Stereoscope puts an HTML face on RESTful APIs.}
+    gem.email = "avdi@avdi.org"
+    gem.homepage = "http://github.com/avdi/rack-stereoscope"
+    gem.authors = ["Avdi Grimm"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-stereoscope #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/example.rb

@@ -0,0 +1,83 @@
+require 'sinatra'
+require 'json'
+require 'addressable/uri'
+require 'rest_client'
+require File.expand_path('rack_stereoscope.rb', File.dirname(__FILE__))
+
+configure do
+  use Rack::Reloader;
+  use Rack::Lint;
+  use Rack::Stereoscope;
+end
+
+helpers do
+  def rel(path)
+    host = request.host
+    port = request.port
+    Addressable::URI.join("http://#{host}:#{port}", path).to_s
+  end
+end
+
+get '/' do
+  content_type 'application/json'
+  {
+    :explanation  => "A fake API to demonstrate Stereoscope",
+    :twitter      => rel('/twitter'),
+    :list         => rel('/list'),
+    :assocations  => rel('/associations'),
+    :uri_template => rel('/uri_template'),
+    :tabular      => rel('/tabular')
+  }.to_json
+end
+
+get '/foo/*' do 
+  content_type 'application/json'
+  params.to_json
+end
+
+get '/list' do
+  content_type 'application/json'
+  [
+    "Item 1",
+    "Item 2",
+    "Item 3"
+  ].to_json
+end
+
+get '/associations' do
+  content_type 'application/json'
+  {
+    "foo"  => "bar",
+    "baz"  => "buz"
+  }.to_json
+end
+
+get '/tabular' do
+  content_type 'application/json'
+  [
+    {
+      :id             => 1,
+      :name           => "Plan 9 from Outer Space",
+      :date           => "1959-07-01"
+    },
+    {
+      :id             => 2,
+      :name           => "Bride of the Monster",
+      :date           => "1956-05-11"
+    },
+    { :id             => 3,
+      :name           => "Glen or Glenda",
+      :date           => "1953-01-01"
+    }
+  ].to_json
+end
+
+get '/uri_template' do
+  content_type 'application/json'
+  {:uri => rel('/foo/{subpath}?param1={param1}&param2={param2}')}.to_json
+end
+
+get '/twitter' do
+  content_type 'application/json'
+  RestClient.get('http://twitter.com/statuses/public_timeline.json')
+end

data/lib/rack/stereoscope.rb

@@ -0,0 +1,227 @@
+require 'markaby'
+require 'json'
+require 'nokogiri'
+require 'rack/accept_media_types'
+require 'addressable/template'
+
+# Rack::Stereoscope - bringing a new dimension to your RESTful API
+#
+# Stereoscope is inspired by the idea that software should be explorable. Put
+# stereoscope in front of your RESTful API, and you get an interactive,
+# explorable HTML interface to your API for free. Use it to manually test your
+# API from a browser. Use it to make your API self-documenting. Use it to
+# quickly prototype new API features and get a visual feel for the data
+# structures.
+#
+# Stereoscope is designed to be unobtrusive. It will not interpose itself unless
+# the request asks for HTML (i.e. it comes from a browser). If the request
+# requests no explicit content type; or if it requests a content-type other than
+# HTML, Stereoscope stays out of the way.
+#
+# This middleware is especially well-suited to presenting APIs that are heavily
+# hyperlinked (and if your API doesn't have hyperlinks, why
+# not?[1]). Stereoscope does it's best to recognize URLs and make them
+# clickable. What's more, Stereoscope supports URI Templates[2]. If your data
+# includes URL templates such as the following:
+# 
+#     http://example.org/{foo}?bar={bar}
+#
+# Stereoscope will render a form which enables the user to experiment with
+# different expansions of the URI template.
+#
+# Limitations:
+#   * Currently only supports JSON data
+#   * Only link-ifies fully-qualified URLs; relative URLs are not supported
+#   * Read-only exploration; no support for POSTs, PUTs, or DELETEs.
+#
+# [1] http://www.theamazingrando.com/blog/?p=107
+# [2] http://bitworking.org/projects/URI-Templates/
+module Rack
+  class Stereoscope
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if Rack::AcceptMediaTypes.new(env['HTTP_ACCEPT']).include?('text/html')
+        status, headers, body = @app.call(env)
+        if request.path == '/__stereoscope_expand_template__'
+          expand_template(request)
+        else
+          present_data(request, status, headers, body)
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    def present_data(request, status, headers, body)
+      response = Rack::Response.new("", status, headers)
+      response.write(build_page(body, request, response))
+      response['Content-Type'] = 'text/html'
+      response.finish
+    end
+
+    def expand_template(request)
+      template = Addressable::Template.new(request['__template__'])
+      url      = template.expand(request.params)
+      response = Rack::Response.new
+      response.redirect(url.to_s)
+      response.finish
+    end
+
+    def build_page(content, request, response)
+      this = self
+      mab = Markaby::Builder.new
+      mab.html do 
+        head do 
+          title request.path
+        end
+        body do
+          
+          h1 "#{response.status} #{request.url}"
+          if !content.to_s.empty?
+            h2 "Response:"
+            case response.content_type
+            when 'application/json' then
+              div do
+                this.data_to_html(JSON.parse(content.join), mab)
+              end
+            when 'text/plain' then
+              p content.join
+            else
+              text Nokogiri::HTML(content.join).css('body').inner_html
+            end
+          else
+            p "(No content)"
+          end
+          h2 "Raw:"
+          tt do
+            raw_content = case response.content_type
+                          when 'application/json'
+                            JSON.pretty_generate(JSON.parse(content.join))
+                          else
+                            content.join
+                          end
+            pre raw_content
+          end
+        end
+      end
+      mab.to_s
+    end
+
+    def data_to_html(data, builder)
+      this = self
+      case data
+      when Hash
+        builder.dl do
+          data.each_pair do |key, value|
+            dt do 
+              this.data_to_html(key, builder)
+            end
+            dd do
+              this.data_to_html(value, builder)
+            end
+          end
+        end
+      when Array
+        if tabular?(data)
+          table_to_html(data, builder)
+        else
+          list_to_html(data, builder)
+        end
+      when String
+        if url?(data)
+          if url_template?(data)
+            template_to_html(data, builder)
+          else
+            url_to_html(data, builder)
+          end
+        else
+          builder.div do
+            data.split("\n").each do |line|
+              builder.span line
+              builder.br
+            end
+          end
+        end
+      else
+        builder.span do data end
+      end
+    end
+
+    def url?(text)
+      Addressable::URI.parse(text.to_s).ip_based?
+    end
+
+    def url_template?(text)
+      !Addressable::Template.new(text.to_s).variables.empty?
+    end
+
+    def tabular?(data)
+      data.kind_of?(Array) &&
+        data.all?{|e| e.kind_of?(Hash)} &&
+        data[1..-1].all?{|e| e.keys == data.first.keys}
+    end
+
+    def url_to_html(url, builder)
+      builder.a(url.to_s, :href => url.to_s)      
+    end
+
+    def template_to_html(text, builder)
+      template = Addressable::Template.new(text)
+      builder.div(:class => 'url-template-form') do
+        p text
+        form(:method => 'GET', :action => '/__stereoscope_expand_template__') do
+          input(:type => 'hidden', :name => '__template__', :value => text)
+          template.variables.each do |variable|
+            div(:class => 'url-template-variable') do
+              label do
+                text "#{variable}: "
+                input(:type => 'text', :name => variable)
+              end
+            end
+          end
+          input(:type => 'submit')
+        end
+      end
+    end
+
+    def list_to_html(data, builder)
+      this = self
+      builder.ol do
+        data.each do |value|
+          li do
+            this.data_to_html(value, builder)
+          end
+        end
+      end
+    end
+
+    def table_to_html(data, builder)
+      this = self
+      builder.table do
+        headers = data.first.keys
+        thead do 
+          headers.each do |header| 
+            th do
+              this.data_to_html(header, builder) 
+            end
+          end
+        end
+        tbody do
+          data.each do |row|
+            tr do
+              row.each do |key, value|
+                td do
+                  this.data_to_html(value, builder)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rack-stereoscope_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RackStereoscope" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack-stereoscope'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rack-stereoscope
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Avdi Grimm
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Rack::Stereoscope puts an HTML face on RESTful APIs.
+email: avdi@avdi.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- example.rb
+- lib/rack/stereoscope.rb
+- spec/rack-stereoscope_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/avdi/rack-stereoscope
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Bringing a new dimension to your RESTful API
+test_files: 
+- spec/rack-stereoscope_spec.rb
+- spec/spec_helper.rb