restility 0.0.3

data/lib/rest_htmlprinter.rb

@@ -0,0 +1,191 @@
+#!/usr/bin/ruby
+
+require "rest"
+require 'active_support/builder' unless defined?(Builder)
+
+class HtmlPrinter < Printer
+
+  attr_accessor :output_dir
+
+  def initialize
+    super()
+    @output_dir = "html"
+    @xml_examples = Hash.new
+    @xml_schemas = Hash.new
+
+    @docbook_tag_mapping = {
+      "command" => "tt",
+      "filename" => "tt",
+      "emphasis" => "em",
+      "replaceable" => "em",
+    }
+
+  end
+
+  def do_prepare
+    unless File.exists? @output_dir
+      Dir.mkdir @output_dir
+    end
+    @index = File.new( @output_dir + "/index.html", "w" )
+    @html = Builder::XmlMarkup.new( :target => @index, :indent => 2 )
+    @html.comment! "This file was generated by restility at #{Time.now}"
+  end
+
+  def do_finish
+    puts "Written #{@index.path}"
+    
+    @xml_examples.each do |f,b|
+      if !XmlFile.exist?( f )
+        STDERR.puts "XML Example '#{f}' is missing."
+      else
+        XmlFile.copy f, @output_dir
+      end
+    end
+    @xml_schemas.each do |f,b|
+      if !XmlFile.exist?( f )
+        STDERR.puts "XML Schema '#{f}' is missing."
+      else
+        XmlFile.copy f, @output_dir
+      end
+    end
+    
+    @index.close
+  end
+
+  def print_section section
+    if ( !section.root? )
+      tag = "h#{section.level}"
+      @html.tag!( tag, section )
+    end
+    section.print_children self
+  end
+
+  def print_request request
+    @html.div( "class" => "request" ) do
+
+      @html.p do
+        @html.a( "name" => request.id ) do
+          @html.b request.to_s
+        end
+      end
+
+      if false
+        host = request.host
+        if ( host )
+          @html.p "Host: " + host.name
+        end
+      end
+
+      if request.parameters.size > 0
+        @html.p "Arguments:"
+        @html.ul do
+          request.parameters.each do |p|
+            @html.li p.to_s
+          end
+        end
+      end
+      request.print_children self
+
+    end
+  end
+
+  def replace_docbook_tags text
+    @docbook_tag_mapping.each do |docbook, html|
+      text.gsub! "<#{docbook}>", "<#{html}>"
+      text.gsub! "</#{docbook}>", "</#{html}>"
+    end
+  end
+
+  def print_text text
+    @html.p do |p|
+      text.text.each do |t|
+        replace_docbook_tags t
+        p << t << "\n"
+      end
+    end
+  end
+
+  def print_parameter parameter
+  end
+
+  def print_host host
+    @html.p "Host: " + host.name
+  end
+
+  def print_result result
+    @html.p "Result: " + result.name
+  end
+  
+  def print_body body
+    @html.p "Body: " + body.name
+  end
+
+  def print_xmlresult result
+    print_xml_links "Result", result.name, result.schema
+  end
+
+  def print_xmlbody body
+    print_xml_links "Body", body.name, body.schema
+  end
+
+  def print_xml_links title, xmlname, schema
+    example = xmlname + ".xml"
+    if ( !schema || schema.empty? )
+      schema = xmlname + ".xsd"
+    end
+    @xml_examples[ example ] = true
+    @xml_schemas[ schema ] = true
+    @html.p do |p|
+      p << title
+      p << ": "
+      has_example = XmlFile.exist? example
+      has_schema = XmlFile.exist? schema
+      if has_example
+        @html.a( "Example", "href" => example )
+      end
+      if has_schema
+        p << " ";
+        @html.a( "Schema", "href" => schema )
+      end
+      if( !has_example && !has_schema )
+        p << xmlname
+      end
+    end
+  end
+
+  def print_contents contents
+    @html.tag! "h#{contents.level}", "Table of Contents"
+    @html.p do |p|
+      p << create_contents_list( contents.root, 1 )
+    end
+  end
+
+  def create_contents_list section, min_level
+    result = ""
+    section.children.each do |s|
+      if ( s.is_a? Section )
+        result += create_contents_list s, min_level      
+      end
+      if ( s.is_a? Request )
+        result += "<li><a href=\"##{s.id}\">" + h( s.to_s ) + "</a></li>\n"
+      end
+    end
+    endresult = ""
+    if ( !result.empty? )
+      if ( section.level > min_level )
+        endresult = "<li>" + h( section.to_s ) + "</li>\n"
+      end
+      if ( section.level >= min_level )
+        endresult += "<ul>\n" + result + "</ul>\n"
+      else
+        endresult = result
+      end
+    end
+    endresult 
+  end
+
+  def print_version version
+    @html.p "Version: " + version.to_s
+  end
+
+end

data/lib/rest_test.rb

@@ -0,0 +1,351 @@
+require "net/https"
+require "tempfile"
+
+class ParameterError < Exception
+end
+
+class TestContext
+
+  attr_writer :show_xmlbody, :request_filter, :show_passed, :output_html
+
+  def initialize requests
+    @host_aliases = Hash.new
+
+    @output = ""
+
+    @requests = requests
+    start
+  end
+
+  def start
+    @tested = 0
+    @unsupported = 0
+    @failed = 0
+    @passed = 0
+    @error = 0
+    @skipped = 0
+  end
+
+  def bold str
+    if @output_html
+      str.gsub! /</, "&lt;"
+      str.gsub! />/, "&gt;"
+      "<b>#{str}</b>"
+    else
+      "\033[1m#{str}\033[0m"
+    end
+  end
+  
+  def red str
+    bold str
+#    "\E[31m#{str}\E[30m"
+  end
+  
+  def green str
+    bold str
+  end
+
+  def magenta str
+    bold str
+  end
+
+  def get_binding
+    return binding()
+  end
+
+  def unsupported
+    out magenta( "  UNSUPPORTED" )
+    @unsupported += 1
+    out_flush
+  end
+
+  def failed
+    out red( "  FAILED" )
+    @failed += 1
+    out_flush
+  end
+
+  def passed
+    out green( "  PASSED" )
+    @passed += 1
+    if ( @show_passed )
+      out_flush
+    else
+      out_clear
+    end
+  end
+
+  def skipped
+#    out magenta( "  SKIPPED" )
+    @skipped += 1
+    out_flush
+  end
+
+  def error str = nil
+    error_str = "  ERROR"
+    if ( str )
+      error_str += ": " + str
+    end
+    out red( error_str )
+    @error += 1
+    out_flush
+  end
+
+  def alias_host old, new
+    @host_aliases[ old ] = new
+  end
+
+  def out str
+    @output += str + "\n";
+  end
+  
+  def out_clear
+    @output = ""
+  end
+  
+  def out_flush
+    print @output
+    out_clear
+  end
+
+  def request arg, return_code = nil, xml_check_wanted = true
+    @tested += 1
+
+    if ( @request_filter && arg !~ /#{@request_filter}/ )
+      skipped
+      return nil
+    end
+
+    out bold( "REQUEST: " + arg )
+
+    request = @requests.find { |r|
+      r.to_s == arg
+    }
+
+    if ( !request )
+      STDERR.puts "  Request not defined"
+      return nil
+    end
+
+    xml_bodies = request.all_children XmlBody
+    if ( !xml_bodies.empty? )
+      xml_body = xml_bodies[0]
+      out "  XMLBODY: " + xml_body.name
+    end
+    
+    xml_results = request.all_children XmlResult
+    if ( !xml_results.empty? )
+      xml_result = xml_results[0]
+      out "  XMLRESULT: " + xml_result.name
+    end
+
+    out "  host: '#{request.host}'"
+
+    host = request.host.to_s
+    if ( !host || host.empty? )
+      error "No host defined"
+      return nil
+    end
+
+    if @host_aliases[ host ]
+      host = @host_aliases[ host ]
+    end
+
+    out "  aliased host: #{host}"
+
+    begin
+      path = substitute_parameters request
+    rescue ParameterError
+      error
+      return nil
+    end
+
+    out "  Path: " + path
+
+    splitted_host = host.split( ":" )
+    
+    host_name = splitted_host[0]
+    host_port = splitted_host[1]
+
+    out "  Host name: #{host_name} port: #{host_port}"
+
+    if ( request.verb == "GET" )
+      req = Net::HTTP::Get.new( path )
+      if ( true||@user )
+        req.basic_auth( @user, @password )
+      end
+      response = Net::HTTP.start( host_name, host_port ) do |http|
+        http.request( req )
+      end
+      if ( response.is_a? Net::HTTPRedirection )
+        location = URI.parse response["location"]
+        out "  Redirected to #{location}, scheme is #{location.scheme}"
+        http = Net::HTTP.new( location.host, location.port )
+        if location.scheme == "https"
+          http.use_ssl = true
+        end
+        http.start do |http|
+          req = Net::HTTP::Get.new( location.path )
+
+          if ( @user )
+            out "  setting user #{@user}"
+            req.basic_auth( @user, @password )
+          end
+        
+          out "  calling #{location.host}, #{location.port}"
+          response = http.request( req )
+        end
+      end
+    elsif( request.verb == "POST" )
+      req = Net::HTTP::Post.new( path )
+      if ( @user )
+        req.basic_auth( @user, @password )
+      end
+      response = Net::HTTP.start( host_name, host_port ) do |http|
+        http.request( req, "" )
+      end
+    elsif( request.verb == "PUT" )
+      if ( !@data_body )
+        error "No body data defined for PUT"
+        return nil
+      end
+      
+      if ( xml_body && @show_xmlbody )
+        out "Request body:"
+        out @data_body
+      end
+
+      req = Net::HTTP::Put.new( path )
+      if ( @user )
+        req.basic_auth( @user, @password )
+      end
+      response = Net::HTTP.start( host_name, host_port ) do |http|
+        http.request( req, @data_body )
+      end
+    else
+      STDERR.puts "  Test of method '#{request.verb}' not supported yet."
+      unsupported
+      return nil
+    end
+
+    if ( response )
+      out "  return code: #{response.code}"
+      if ( xml_result && @show_xmlbody )
+        out "Response body:"
+        out response.body
+      end
+
+      if ( ( return_code && response.code == return_code.to_s ) ||
+           ( response.is_a? Net::HTTPSuccess ) )
+        if ( xml_check_wanted && xml_result )
+          if ( xml_result.schema )
+            schema_file = xml_result.schema
+          else
+            schema_file = xml_result.name + ".xsd"
+          end
+          if ( validate_xml response.body, schema_file )
+            out "  Response validates against schema '#{schema_file}'"
+            passed
+          else
+            failed
+          end
+        else
+          passed
+        end
+      else
+        failed
+      end
+    end
+
+    response
+
+  end
+
+  def substitute_parameters request
+    path = request.path.clone
+    
+    request.parameters.each do |parameter|
+      p = parameter.name
+      arg = eval( "@arg_#{parameter.name}" )
+      if ( !arg )
+        out "  Can't substitute parameter '#{p}'. " +
+          "No variable @arg_#{p} defined."
+        raise ParameterError
+      end
+      path.gsub! /<#{p}>/, arg
+    end
+    
+    path
+  end
+
+  def validate_xml xml, schema_file
+    tmp = Tempfile.new('rest_test_validator')
+    tmp.print xml
+    tmp_path = tmp.path
+    tmp.close
+
+    found_schema_file = XmlFile.find_file schema_file
+
+    if ( !found_schema_file )
+      out "  Unable to find schema file '#{schema_file}'"
+      return false
+    end
+
+    cmd = "/usr/bin/xmllint --noout --schema #{found_schema_file} #{tmp_path} 2>&1"
+#    puts "CMD: " + cmd
+    output = `#{cmd}`
+    if $?.exitstatus > 0
+      out "xmllint return value: #{$?.exitstatus}"
+      out output
+      return false
+    end
+    return true
+  end
+
+  def print_summary
+    undefined = @tested - @unsupported - @failed - @passed - @error - @skipped
+  
+    puts "#tester passed #{@passed}"
+    puts "#tester failed #{@failed}"
+    puts "#tester error #{@error}"
+    puts "#tester skipped #{@unsupported + @skipped + undefined}"
+
+    puts
+
+    puts "Total #{@tested} tests"
+    puts "  #{@passed} passed"
+    puts "  #{@failed} failed"
+    if ( @unsupported > 0 )
+      puts "  #{@unsupported} unsupported"
+    end
+    if ( @error > 0 )
+      puts "  #{@error} errors"
+    end
+    if ( @skipped > 0 )
+      puts "  #{@skipped} skipped"
+    end
+    if ( undefined > 0 )
+      puts "  #{undefined} undefined"
+    end
+
+  end
+
+end
+
+class TestRunner
+
+  attr_reader :context
+
+  def initialize requests
+    @context = TestContext.new requests
+  end
+
+  def run testfile
+    File.open testfile do |file|
+      eval( file.read, @context.get_binding )
+    end
+
+    @context.print_summary
+  end
+
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/restility'

data/test/test_restility.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRestility < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end