rspec_api_documentation 0.9.2 → 1.0.0

data/lib/rspec_api_documentation/index_writer.rb

@@ -1,14 +0,0 @@
-require "active_support/core_ext/enumerable"
-
-module RspecApiDocumentation
-  module IndexWriter
-    def sections(examples, configuration)
-      resources = examples.group_by(&:resource_name).inject([]) do |arr, (resource_name, examples)|
-        ordered_examples = configuration.keep_source_order ? examples : examples.sort_by(&:description)
-        arr.push(:resource_name => resource_name, :examples => ordered_examples)
-      end
-      configuration.keep_source_order ? resources : resources.sort_by { |resource| resource[:resource_name] }
-    end
-    module_function :sections
-  end
-end

data/lib/rspec_api_documentation/json_iodocs_writer.rb

@@ -1,107 +0,0 @@
-module RspecApiDocumentation
-  class JsonIodocsWriter
-    attr_accessor :index, :configuration, :api_key
-    delegate :docs_dir, :to => :configuration
-
-    def initialize(index, configuration)
-      self.index = index
-      self.configuration = configuration
-      self.api_key = configuration.api_name.parameterize
-    end
-
-    def self.write(index, configuration)
-      writer = new(index, configuration)
-      writer.write
-    end
-
-    def write
-      File.open(docs_dir.join("apiconfig.json"), "w+") do |file|
-        file.write ApiConfig.new(configuration).to_json
-      end
-      File.open(docs_dir.join("#{api_key}.json"), "w+") do |file|
-        file.write JsonIndex.new(index, configuration).to_json
-      end
-    end
-  end
-
-  class JsonIndex
-    def initialize(index, configuration)
-      @index = index
-      @configuration = configuration
-    end
-
-    def sections
-      IndexWriter.sections(examples, @configuration)
-    end
-
-    def examples
-      @index.examples.map { |example| JsonExample.new(example, @configuration) }
-    end
-
-    def to_json
-      sections.inject({:endpoints => []}) do |h, section|
-        h[:endpoints].push(
-          :name => section[:resource_name],
-          :methods => section[:examples].map do |example|
-            example.to_json
-          end
-        )
-        h
-      end.to_json
-    end
-  end
-
-  class JsonExample
-    def initialize(example, configuration)
-      @example = example
-    end
-
-    def method_missing(method, *args, &block)
-      @example.send(method, *args, &block)
-    end
-
-    def parameters
-      params = []
-      if @example.respond_to?(:parameters)
-        @example.parameters.map do |param|
-          params << {
-            "Name" => param[:name],
-            "Description" => param[:description],
-            "Default" => "",
-            "Required" => param[:required] ? "Y" : "N"
-          }
-        end
-      end
-      params
-    end
-
-    def to_json
-       {
-        :MethodName => description,
-        :Synopsis => explanation,
-        :HTTPMethod => http_method,
-        :URI => (requests.first[:request_path] rescue ""),
-        :RequiresOAuth => "N",
-        :parameters => parameters
-      }
-    end
-  end
-
-  class ApiConfig
-    def initialize(configuration)
-      @configuration = configuration
-      @api_key = configuration.api_name.parameterize
-    end
-
-    def to_json
-      {
-        @api_key.to_sym => {
-          :name => @configuration.api_name,
-          :protocol => "http",
-          :publicPath => "",
-          :baseURL => @configuration.curl_host
-        }
-      }.to_json
-    end
-  end
-end

data/lib/rspec_api_documentation/json_writer.rb

@@ -1,111 +0,0 @@
-module RspecApiDocumentation
-  class JsonWriter
-    attr_accessor :index, :configuration
-    delegate :docs_dir, :to => :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(docs_dir.join("index.json"), "w+") do |f|
-        f.write JsonIndex.new(index, configuration).to_json
-      end
-      index.examples.each do |example|
-        json_example = JsonExample.new(example, configuration)
-        FileUtils.mkdir_p(docs_dir.join(json_example.dirname))
-        File.open(docs_dir.join(json_example.dirname, json_example.filename), "w+") do |f|
-          f.write json_example.to_json
-        end
-      end
-    end
-  end
-
-  class JsonIndex
-    def initialize(index, configuration)
-      @index = index
-      @configuration = configuration
-    end
-
-    def sections
-      IndexWriter.sections(examples, @configuration)
-    end
-
-    def examples
-      @index.examples.map { |example| JsonExample.new(example, @configuration) }
-    end
-
-    def to_json
-      sections.inject({:resources => []}) do |h, section|
-        h[:resources].push(
-          :name => section[:resource_name],
-          :examples => section[:examples].map { |example|
-            {
-              :description => example.description,
-              :link => "#{example.dirname}/#{example.filename}",
-              :groups => example.metadata[:document]
-            }
-          }
-        )
-        h
-      end.to_json
-    end
-  end
-
-  class JsonExample
-    def initialize(example, configuration)
-      @example = example
-      @host = configuration.curl_host
-    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}.json"
-    end
-
-    def as_json
-      {
-        :resource => resource_name,
-        :http_method => http_method,
-        :route => route,
-        :description => description,
-        :explanation => explanation,
-        :parameters => respond_to?(:parameters) ? parameters : [],
-        :requests => requests
-      }
-    end
-
-    def to_json
-      as_json.to_json
-    end
-
-    def requests
-      super.map do |hash|
-        if @host
-          hash[:curl] = hash[:curl].output(@host) if hash[:curl].is_a? RspecApiDocumentation::Curl
-        else
-          hash[:curl] = nil
-        end
-        hash
-      end
-    end
-  end
-end

data/lib/rspec_api_documentation/wurl_writer.rb

@@ -1,110 +0,0 @@
-require 'mustache'
-
-module RspecApiDocumentation
-  class WurlWriter
-    attr_accessor :index, :configuration
-
-    def initialize(index, configuration)
-      warn "[DEPRECATED] Wurl output is going to be gone in the next release."
-      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 api_name
-      @configuration.api_name
-    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

@@ -1,250 +0,0 @@
-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});
-  });
-});