rspec_api_documentation 0.5.2 → 0.6.0

data/lib/rspec_api_documentation.rb

@@ -18,7 +18,6 @@ module RspecApiDocumentation
     autoload :Index
     autoload :ClientBase
     autoload :Headers
-    autoload :Syntax
   end
 
   autoload :DSL
@@ -26,6 +25,7 @@ module RspecApiDocumentation
   autoload :OAuth2MACClient, "rspec_api_documentation/oauth2_mac_client"
   autoload :TestServer
   autoload :HtmlWriter
+  autoload :WurlWriter
   autoload :JsonWriter
   autoload :IndexWriter
   autoload :Curl

data/lib/rspec_api_documentation/api_documentation.rb

@@ -14,6 +14,7 @@ module RspecApiDocumentation
         FileUtils.rm_rf(docs_dir, :secure => true)
       end
       FileUtils.mkdir_p(docs_dir)
+      FileUtils.cp_r(File.join(configuration.template_path, "assets"), docs_dir)
     end
 
     def document_example(rspec_example)

data/lib/rspec_api_documentation/client_base.rb

@@ -1,7 +1,6 @@
 module RspecApiDocumentation
   class ClientBase < Struct.new(:context, :options)
     include Headers
-    include Syntax
 
     delegate :example, :app, :to => :context
     delegate :metadata, :to => :example
@@ -40,13 +39,15 @@ module RspecApiDocumentation
 
       request_metadata[:request_method] = method
       request_metadata[:request_path] = path
-      request_metadata[:request_body] = highlight_syntax(request_body, content_type, true)
-      request_metadata[:request_headers] = format_headers(request_headers)
-      request_metadata[:request_query_parameters] = format_query_hash(query_hash)
+      request_metadata[:request_body] = request_body.empty? ? nil : request_body
+      request_metadata[:request_headers] = request_headers
+      request_metadata[:request_query_parameters] = query_hash
+      request_metadata[:request_content_type] = request_content_type
       request_metadata[:response_status] = status
       request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[status]
-      request_metadata[:response_body] = highlight_syntax(response_body, response_headers['Content-Type'])
-      request_metadata[:response_headers] = format_headers(response_headers)
+      request_metadata[:response_body] = response_body.empty? ? nil : response_body
+      request_metadata[:response_headers] = response_headers
+      request_metadata[:response_content_type] = response_content_type
       request_metadata[:curl] = Curl.new(method, path, request_body, request_headers)
 
       metadata[:requests] ||= []
@@ -56,18 +57,12 @@ module RspecApiDocumentation
     def query_hash
       strings = query_string.split("&")
       arrays = strings.map do |segment|
-        segment.split("=")
+        k,v = segment.split("=")
+        [k, CGI.unescape(v)]
       end
       Hash[arrays]
     end
 
-    def format_query_hash(query_hash)
-      return if query_hash.blank?
-      query_hash.map do |key, value|
-        "#{key}: #{CGI.unescape(value)}"
-      end.join("\n")
-    end
-
     def headers(method, path, params)
       if options && options[:headers]
         options[:headers]

data/lib/rspec_api_documentation/curl.rb

@@ -10,19 +10,19 @@ module RspecApiDocumentation
     end
 
     def post
-      "curl #{url} #{post_data} -X POST #{headers}"
+      "curl \"#{url}\" #{post_data} -X POST #{headers}"
     end
 
     def get
-      "curl #{url}#{get_data} -X GET #{headers}"
+      "curl \"#{url}#{get_data}\" -X GET #{headers}"
     end
 
     def put
-      "curl #{url} #{post_data} -X PUT #{headers}"
+      "curl \"#{url}\" #{post_data} -X PUT #{headers}"
     end
 
     def delete
-      "curl #{url} -X DELETE #{headers}"
+      "curl \"#{url}\" #{post_data} -X DELETE #{headers}"
     end
 
     def url

data/lib/rspec_api_documentation/html_writer.rb

@@ -39,6 +39,10 @@ module RspecApiDocumentation
       IndexWriter.sections(examples, @configuration)
     end
 
+    def url_prefix
+      @configuration.url_prefix
+    end
+
     def examples
       @index.examples.map { |example| HtmlExample.new(example, @configuration) }
     end
@@ -70,6 +74,9 @@ module RspecApiDocumentation
 
     def requests
       super.map do |hash|
+        hash[:request_headers_text] = format_hash(hash[:request_headers])
+        hash[:request_query_parameters_text] = format_hash(hash[:request_query_parameters])
+        hash[:response_headers_text] = format_hash(hash[:response_headers])
         if @host
           hash[:curl] = hash[:curl].output(@host) if hash[:curl].is_a? RspecApiDocumentation::Curl
         else
@@ -82,5 +89,13 @@ module RspecApiDocumentation
     def url_prefix
       configuration.url_prefix
     end
+
+    private
+    def format_hash(hash = {})
+      return nil unless hash.present?
+      hash.collect do |k, v|
+        "#{k}: #{v}"
+      end.join("\n")
+    end
   end
 end

data/lib/rspec_api_documentation/oauth2_mac_client.rb

@@ -32,10 +32,14 @@ module RspecApiDocumentation
       last_response.body
     end
 
-    def content_type
+    def request_content_type
       last_request.content_type
     end
 
+    def response_content_type
+      last_response.content_type
+    end
+
     protected
 
     def do_request(method, path, params)

data/lib/rspec_api_documentation/rack_test_client.rb

@@ -24,10 +24,14 @@ module RspecApiDocumentation
       last_response.body
     end
 
-    def content_type
+    def request_content_type
       last_request.content_type
     end
 
+    def response_content_type
+      last_response.content_type
+    end
+
     protected
 
     def do_request(method, path, params)

data/lib/rspec_api_documentation/test_server.rb

@@ -1,7 +1,6 @@
 module RspecApiDocumentation
   class TestServer < Struct.new(:context)
     include Headers
-    include Syntax
 
     delegate :example, :to => :context
     delegate :metadata, :to => :example
@@ -18,10 +17,10 @@ module RspecApiDocumentation
 
       request_metadata = {}
 
-      request_metadata[:request_method] = request_method
+      request_metadata[:request_method] = @request_method
       request_metadata[:request_path] = env["PATH_INFO"]
-      request_metadata[:request_body] = highlight_syntax(request_body, request_headers["Content-Type"], true)
-      request_metadata[:request_headers] = format_headers(@request_headers)
+      request_metadata[:request_body] = @request_body
+      request_metadata[:request_headers] = @request_headers
 
       metadata[:requests] ||= []
       metadata[:requests] << request_metadata

data/lib/rspec_api_documentation/wurl_writer.rb

@@ -0,0 +1,105 @@
+require 'mustache'
+
+module RspecApiDocumentation
+  class WurlWriter
+    attr_accessor :index, :configuration
+
+    def initialize(index, configuration)
+      self.index = index
+      self.configuration = configuration
+    end
+
+    def self.write(index, configuration)
+      writer = new(index, configuration)
+      writer.write
+    end
+
+    def write
+      File.open(configuration.docs_dir.join("index.html"), "w+") do |f|
+        f.write WurlIndex.new(index, configuration).render
+      end
+      index.examples.each do |example|
+        html_example = WurlExample.new(example, configuration)
+        FileUtils.mkdir_p(configuration.docs_dir.join(html_example.dirname))
+        File.open(configuration.docs_dir.join(html_example.dirname, html_example.filename), "w+") do |f|
+          f.write html_example.render
+        end
+      end
+    end
+  end
+
+  class WurlIndex < Mustache
+    def initialize(index, configuration)
+      @index = index
+      @configuration = configuration
+      self.template_path = configuration.template_path
+    end
+
+    def sections
+      IndexWriter.sections(examples, @configuration)
+    end
+
+    def url_prefix
+      @configuration.url_prefix
+    end
+
+    def examples
+      @index.examples.map { |example| WurlExample.new(example, @configuration) }
+    end
+  end
+
+  class WurlExample < Mustache
+    def initialize(example, configuration)
+      @example = example
+      @host = configuration.curl_host
+      self.template_path = configuration.template_path
+    end
+
+    def method_missing(method, *args, &block)
+      @example.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      super || @example.respond_to?(method, include_private)
+    end
+
+    def dirname
+      resource_name.downcase.gsub(/\s+/, '_')
+    end
+
+    def filename
+      basename = description.downcase.gsub(/\s+/, '_').gsub(/[^a-z_]/, '')
+      "#{basename}.html"
+    end
+
+    def requests
+      super.collect do |hash|
+        hash[:request_headers_hash] = hash[:request_headers].collect { |k, v| {:name => k, :value => v} }
+        hash[:request_headers_text] = format_hash(hash[:request_headers])
+        hash[:request_path_no_query] = hash[:request_path].split('?').first
+        hash[:request_query_parameters_text] = format_hash(hash[:request_query_parameters])
+        hash[:request_query_parameters_hash] = hash[:request_query_parameters].collect { |k, v| {:name => k, :value => v} } if hash[:request_query_parameters].present?
+        hash[:response_headers_text] = format_hash(hash[:response_headers])
+        hash[:response_status] = hash[:response_status].to_s + " " + Rack::Utils::HTTP_STATUS_CODES[hash[:response_status]].to_s
+        if @host
+          hash[:curl] = hash[:curl].output(@host) if hash[:curl].is_a? RspecApiDocumentation::Curl
+        else
+          hash[:curl] = nil
+        end
+        hash
+      end
+    end
+
+    def url_prefix
+      configuration.url_prefix
+    end
+
+    private
+    def format_hash(hash = {})
+      return nil unless hash.present?
+      hash.collect do |k, v|
+        "#{k}: #{v}"
+      end.join("\n")
+    end
+  end
+end

data/templates/assets/javascripts/application.js

@@ -0,0 +1,250 @@
+var headers = ["Accept",
+  "Accept-Charset",
+  "Accept-Encoding",
+  "Accept-Language",
+  "Authorization",
+  "Cache-Control",
+  "Connection",
+  "Cookie",
+  "Content-Length",
+  "Content-MD5",
+  "Content-Type",
+  "Date",
+  "Expect",
+  "From",
+  "Host",
+  "If-Match",
+  "If-Modified-Since",
+  "If-None-Match",
+  "If-Range",
+  "If-Unmodified-Since",
+  "Max-Forwards",
+  "Pragma",
+  "Proxy-Authorization",
+  "Range",
+  "Referer",
+  "TE",
+  "Upgrade",
+  "User-Agent",
+  "Via",
+  "Warning"];
+
+function mirror(textarea, contentType, options) {
+  $textarea = $(textarea);
+  if ($textarea.val() != '') {
+    if(contentType.indexOf('json') >= 0) {
+      $textarea.val(JSON.stringify(JSON.parse($textarea.val()), undefined, 2));
+      options.json = true;
+      options.mode = 'javascript';
+    } else if (contentType.indexOf('javascript') >= 0) {
+      options.mode = 'javascript';
+    } else if (contentType.indexOf('xml') >= 0) {
+      options.mode = 'xml';
+    } else {
+      options.mode = 'htmlmixed';
+    }
+  }
+  return CodeMirror.fromTextArea(textarea, options);
+};
+
+function Wurl(wurlForm) {
+  this.$wurlForm = $(wurlForm);
+  var self = this;
+
+  this.requestBodyMirror = mirror(this.$wurlForm.find('.post_body textarea')[0], $('.request.content_type', this.$wurlForm).val(), {})
+  this.responseBodyMirror = mirror(this.$wurlForm.find('.response.body textarea')[0], $('.response.content_type', this.$wurlForm).val(), { "readOnly": true, "lineNumbers":true});
+
+  $('.give_it_a_wurl', this.$wurlForm).click(function (event) {
+    event.preventDefault();
+    self.sendWurl();
+  });
+  $('.add_header', this.$wurlForm).click(function () {
+    self.addInputs('header');
+  });
+
+  $('.add_param', this.$wurlForm).click(function () {
+    self.addInputs('param');
+  });
+
+  $('.delete_header', this.$wurlForm).live('click', function (e) {
+    self.deleteHeader(this);
+  });
+
+  $('.delete_param', this.$wurlForm).live('click', function (e) {
+    self.deleteParam(this);
+  });
+
+  $(".trash_headers", this.$wurlForm).click(function () {
+    self.trashHeaders();
+  });
+
+  $(".trash_queries", self.$wurlForm).click(function () {
+    self.trashQueries();
+  });
+
+  $('.header_pair input.value', this.$wurlForm).live('focusin', (function () {
+    if ($('.header_pair:last input', self.$wurlForm).val() != "") {
+      self.addInputs('header');
+    }
+  }));
+
+  $('.param_pair input.value', this.$wurlForm).live('focusin', (function () {
+    if ($('.param_pair:last input', self.$wurlForm).val() != "") {
+      self.addInputs('param');
+    }
+  }));
+
+  $('.url select', this.$wurlForm).change(function () {
+    self.updateBodyInput();
+  });
+
+  $(".header_pair input.key", this.$wurlForm).livequery(function () {
+    $(this).autocomplete({source:headers});
+  });
+
+  $(".clear_fields", this.$wurlForm).click(function () {
+    $("input[type=text], textarea", self.$wurlForm).val("");
+    self.trashHeaders();
+    self.trashQueries();
+  });
+
+  this.addInputs = function (type) {
+    var $fields = $('.' + type + '_pair', this.$wurlForm).first().clone();
+    $fields.children('input').val("").attr('disabled', false);
+    $fields.hide().appendTo(this.$wurlForm.find('.' + type + 's')).slideDown('fast');
+  };
+
+  this.deleteHeader = function (element) {
+    var $fields = $(element).closest(".header_pair");
+    $fields.slideUp(function () {
+      $fields.remove();
+    });
+  };
+
+  this.deleteParam = function (element) {
+    var $fields = $(element).closest(".param_pair");
+    $fields.slideUp(function () {
+      $paramFields.remove();
+    });
+  };
+
+  this.trashHeaders = function () {
+    $(".header_pair:visible", self.$wurlForm).each(function (i, element) {
+      $(element).slideUp(function () {
+        $(element).remove();
+      });
+    });
+    this.addInputs('header');
+  };
+
+  this.trashQueries = function () {
+    $(".param_pair:visible", self.$wurlForm).each(function (i, element) {
+      $(element).slideUp(function () {
+        $(element).remove();
+      });
+    });
+    this.addInputs('param');
+  };
+
+  this.updateBodyInput = function () {
+    var method = $('#wurl_request_method', self.$wurlForm).val();
+    if ($.inArray(method, ["PUT", "POST", "DELETE"]) > -1) {
+      $('#wurl_request_body', self.$wurlForm).attr('disabled', false).removeClass('textarea_disabled');
+    } else {
+      $('#wurl_request_body', self.$wurlForm).attr('disabled', true).addClass('textarea_disabled');
+    }
+  };
+  this.updateBodyInput();
+
+  this.makeBasicAuth = function () {
+    var user = $('#wurl_basic_auth_user', this.$wurlForm).val();
+    var password = $('#wurl_basic_auth_password', this.$wurlForm).val();
+    var token = user + ':' + password;
+    var hash = $.base64.encode(token);
+    return "Basic " + hash;
+  };
+
+  this.queryParams = function () {
+    var toReturn = [];
+    $(".param_pair:visible", self.$wurlForm).each(function (i, element) {
+      paramKey = $(element).find('input.key').val();
+      paramValue = $(element).find('input.value').val();
+      if (paramKey.length && paramValue.length) {
+        toReturn.push(paramKey + '=' + paramValue);
+      }
+    });
+    return toReturn.join("&");
+  };
+
+  this.getData = function () {
+    var method = $('#wurl_request_method', self.$wurlForm).val();
+    if ($.inArray(method, ["PUT", "POST", "DELETE"]) > -1) {
+      self.requestBodyMirror.save();
+      return self.requestBodyMirror.getValue();
+    } else {
+      return self.queryParams();
+    }
+  };
+
+  this.url = function () {
+    var url = $('#wurl_request_url', self.$wurlForm).val();
+    var method = $('#wurl_request_method', self.$wurlForm).val();
+    var params = self.queryParams();
+    if ($.inArray(method, ["PUT", "POST", "DELETE"]) > -1 && params.length) {
+      url += "?" + params;
+    }
+    return url[0] == '/' ? url : '/' + url;
+  };
+
+  this.sendWurl = function () {
+    $.ajax({
+      beforeSend:function (req) {
+        $(".header_pair:visible", self.$wurlForm).each(function (i, element) {
+          headerKey = $(element).find('input.key').val();
+          headerValue = $(element).find('input.value').val();
+          req.setRequestHeader(headerKey, headerValue);
+        });
+        req.setRequestHeader('Authorization', self.makeBasicAuth());
+      },
+      type:$('#wurl_request_method', self.$wurlForm).val(),
+      url:this.url(),
+      data:this.getData(),
+      complete:function (jqXHR) {
+        var $status = $('.response.status', self.$wurlForm);
+        $status.html(jqXHR.status + ' ' + jqXHR.statusText);
+
+        $('.response.headers', self.$wurlForm).html(jqXHR.getAllResponseHeaders());
+
+        contentType = jqXHR.getResponseHeader("content-type");
+        if (contentType.indexOf('json') >= 0 && jqXHR.responseText.length > 1) {
+          self.responseBodyMirror.setValue(JSON.stringify(JSON.parse(jqXHR.responseText), undefined, 2));
+          self.responseBodyMirror.setOption('mode', 'javascript');
+          self.responseBodyMirror.setOption('json', true);
+        } else if (contentType.indexOf('javascript') >= 0) {
+          self.responseBodyMirror.setValue(jqXHR.responseText);
+          self.responseBodyMirror.setOption('mode', 'javascript');
+        } else if (contentType.indexOf('xml') >= 0) {
+          self.responseBodyMirror.setValue(jqXHR.responseText);
+          self.responseBodyMirror.setOption('mode', 'xml');
+        } else {
+          self.responseBodyMirror.setValue(jqXHR.responseText);
+          self.responseBodyMirror.setOption('mode', 'htmlmixed');
+        }
+        $('.response', self.$wurlForm).effect("highlight", {}, 3000);
+        $('html,body').animate({ scrollTop:$('a.response_anchor', self.$wurlForm).offset().top }, { duration:'slow', easing:'swing'});
+      }
+    });
+  };
+}
+
+$(function () {
+  $('.wurl_form').each(function (index, wurlForm) {
+    wurl = new Wurl(wurlForm);
+  });
+
+  var $textAreas = $('.request.body textarea');
+  $textAreas.each(function(i, textarea) {
+    var contentType = $(textarea).parents('div.request').find('.request.content_type').val();
+    mirror(textarea, contentType, {"readOnly":true, "lineNumbers": true});
+  });
+});