[api,webui] move apidocs to webui, so we can get rid of the remaining…

… HTML in api

docs/api/restility/lib/rest_htmlprinter.rb

@@ -83,7 +83,8 @@ def print_request request
   def print_text text
     @html.p do |p|
       text.text.each do |t|
-        p << t << "\n"
+        p.span(t)
+        p.br
       end
     end
   end
@@ -137,7 +138,7 @@ def print_xml_links title, xmlname, schema
   end
 
   def print_contents contents
-    @html.p do |p|
+    @html.div do |p|
       p << create_contents_list( contents.root, 1 )
     end
   end
@@ -155,13 +156,16 @@ def create_contents_list section, min_level
     endresult = ""
     if ( !result.empty? )
       if ( section.level > min_level )
-        endresult = "<li>" + h( section.to_s ) + "</li>\n"
+        endresult = "<li>" + h( section.to_s )
       end
       if ( section.level >= min_level )
-        endresult += "<ul>\n" + result + "</ul>\n"
+        endresult += "<ul>\n" + result + "</ul>"
       else
         endresult = result
       end
+      if ( section.level > min_level )
+        endresult += "</li>"
+      end
     end
     endresult 
   end

src/api/config/deploy.rb

@@ -44,7 +44,6 @@
 before "deploy:update_code", "deploy:test_suite"
 
 # workaround because we are using a subdirectory of the git repo as rails root
-before "deploy:finalize_update", "deploy:apidocs"
 before "deploy:finalize_update", "deploy:use_subdir"
 after "deploy:finalize_update", "deploy:reset_subdir"
 after "deploy:finalize_update", "deploy:notify"
@@ -101,11 +100,6 @@
     run "rm -f #{current_path} && ln -s #{latest_release}#{git_subdir} #{current_path}"
   end
 
-  desc "Create API docs"
-  task :apidocs do
-    run "cd #{release_path}/docs/api && make"
-  end
-
   desc "Send email notification of deployment"
   task :notify do
     #diff = `#{source.local.diff(current_revision)}`

src/api/config/environment.rb

@@ -12,7 +12,6 @@
   CONFIG = Hash.new
 end
 
-CONFIG['apidocs_location'] ||= File.expand_path("../../docs/api/html/")
 CONFIG['schema_location'] ||= File.expand_path("public/schema")+"/"
 CONFIG['download_url'] ||= 'http://download.opensuse.org/repositories'
 

src/api/config/options.yml.example

@@ -44,8 +44,6 @@ source_port: 5352
 
 extended_backend_log: false
 
-#apidocs_location
-
 # Do not allow creating group via API to avoid the conflicts when CONFIG['ldap_group_support'] is :on
 # If you do want to import the group data from LDAP to OBS DB manuallly, please set if to :off
 disallow_group_creation_with_api: :on

src/api/config/routes.rb

@@ -262,11 +262,6 @@
 
     match '/lastevents' => 'public#lastevents'
 
-    ### /apidocs
-
-    match 'apidocs' => 'apidocs#index'
-    match 'apidocs/:filename' => 'apidocs#file', :constraints => cons
-
     ### /distributions
 
     match 'distributions' => 'distribution#index'

src/webui/Gemfile.lock

@@ -104,6 +104,7 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    restility (0.0.5)
     sass (3.2.1)
     sass-rails (3.2.5)
       railties (~> 3.2.0)
@@ -158,6 +159,7 @@ DEPENDENCIES
   pry (>= 0.9.8.4)
   rails (~> 3.2.8)
   rdoc
+  restility (~> 0.0.4)
   sass-rails
   simplecov-rcov
   sqlite3

src/webui/app/controllers/application_controller.rb

@@ -363,7 +363,7 @@ def validate_xhtml
     begin
       document = Nokogiri::XML::Document.parse(xmlbody, nil, nil, Nokogiri::XML::ParseOptions::STRICT)
     rescue Nokogiri::XML::SyntaxError => e
-      errors << e.inspect
+      errors << ("[%s:%s]" % [e.line, e.column]) + e.inspect
       errors << put_body_to_tempfile(xmlbody)
     end
 
@@ -373,7 +373,7 @@ def validate_xhtml
         document = nil
         errors << put_body_to_tempfile(xmlbody) 
         ses.each do |e|
-          errors << e.inspect
+          errors << ("[%s:%s]" % [e.line, e.column]) + e.inspect
         end
       end
     end

src/webui/config/deploy.rb

@@ -50,6 +50,7 @@
 after "deploy:create_symlink", "config:permissions"
 
 # workaround because we are using a subdirectory of the git repo as rails root
+before "deploy:finalize_update", "deploy:apidocs"
 before "deploy:finalize_update", "deploy:use_subdir"
 after "deploy:finalize_update", "deploy:reset_subdir"
 after "deploy:finalize_update", "deploy:notify"
@@ -154,6 +155,11 @@
     end
   end
 
+  desc "Create API docs"
+  task :apidocs do
+    run "cd #{release_path}/docs/api && make"
+  end
+
 end
 
 

src/webui/config/environment.rb

@@ -38,3 +38,6 @@
 end
 CONFIG['proxy_auth_mode'] ||= :off
 CONFIG['frontend_ldap_mode'] ||= :off
+
+CONFIG['apidocs_location'] ||= File.expand_path("../../docs/api/html/")
+

src/webui/config/routes.rb

@@ -259,6 +259,10 @@
     match 'user/autocomplete' => :autocomplete
   end
 
+  ### /apidocs
+  match 'apidocs' => 'apidocs#index'
+  match 'apidocs/:filename' => 'apidocs#file', constraints: { :filename => %r{[^\/]*} }
+
   # Default route matcher:
   #match ':controller(/:action(/:id))(.:format)'
 end

src/webui/test/functional/apidocs_controller_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + "/..") + "/test_helper"
+
+class ApidocsControllerTest < ActionController::IntegrationTest 
+
+  def test_index
+    # rails 3 will always go to #index
+    visit "/apidocs/" 
+    # no interest in comparing with index.html
+  end
+
+  def test_subpage
+    visit "/apidocs/whatisthis"
+    #assert_response 404
+    #assert_xml_tag :attributes => { :code => "unknown_file_type" }
+
+    visit "/apidocs/whatisthis.xml"
+    #assert_response 404
+    #assert_xml_tag :attributes => { :code => "file_not_found" }
+
+    visit "/apidocs/project.xml" 
+    #assert_response :success
+  end
+
+end