lurker 0.6.8 → 1.0.0

data/lib/lurker/rendering_controller.rb

@@ -2,28 +2,30 @@ require 'ostruct'
 require 'abstract_controller'
 require 'action_view'
 require 'action_dispatch/http/mime_type'
+require 'action_dispatch/routing'
 
 module Lurker
   class RenderingController < ::AbstractController::Base
     # Include all the concerns we need to make this work
+    include AbstractController::Logger
     include AbstractController::Helpers
     include AbstractController::Rendering
-    include ActionView::Rendering if defined?(ActionView::Rendering)
-    include ActionView::Layouts if defined?(ActionView::Layouts) # Rails 4.1.x
+    include AbstractController::AssetPaths
     include AbstractController::Layouts if defined?(AbstractController::Layouts) # Rails 3.2.x, 4.0.x
+    include ActionView::Layouts if defined?(ActionView::Layouts) # Rails 4.1.x
+    include ActionView::Rendering if defined?(ActionView::Rendering)
     include ActionView::Context
 
-    self.view_paths = File.join(File.dirname(__FILE__), "templates")
+    attr_writer :service_presenter, :endpoint_presenter
 
     # Define additional helpers, this one is for csrf_meta_tag
-    helper_method :protect_against_forgery?, :tag_with_anchor
+    helper_method :title, :tag_with_anchor, :protect_against_forgery?
 
     # override the layout in your subclass if needed.
     layout 'application'
 
-    # we are not in a browser, no need for this
-    def protect_against_forgery?
-      false
+    def title
+      [@service_presenter.try(:title), @endpoint_presenter.try(:title)].compact.join ' | '
     end
 
     def tag_with_anchor(tag, content, anchor_slug = nil)
@@ -37,6 +39,11 @@ module Lurker
       EOS
     end
 
+    # we are not in a browser, no need for this
+    def protect_against_forgery?
+      false
+    end
+
     # so that your flash calls still work
     def flash
       {}

data/lib/lurker/service.rb

@@ -3,8 +3,17 @@ require 'yaml'
 # Services represent a group of Lurker API endpoints in a directory
 class Lurker::Service
   attr_reader :service_dir, :schema
+  attr_writer :documentation
   attr_accessor :opened_endpoints
   SUFFIX = '.service.yml'
+  DEFAULT_SCHEMA = {
+    'name' => '',
+    'basePath' => '',
+    'description' => '',
+    'domains' => {},
+    'consumes' => %w(application/x-www-form-urlencode application/json),
+    'produces' => %w(application/json)
+  }
 
   def self.default_service
     new(Lurker.service_path)
@@ -15,14 +24,9 @@ class Lurker::Service
     @service_dir = File.expand_path(service_dir)
     @service_filename = service_name
     @schema = if persisted? && (schema = YAML.load_file(service_path)).is_a?(Hash)
-      Lurker::Json::Schema.new(schema)
+      Lurker::Json::Schema.new(schema.stringify_keys, uri: service_path)
     else
-      Lurker::Json::Schema.new(
-        'name'        => service_filename,
-        'basePath'    => '',
-        'description' => '',
-        'domains'     => {}
-      )
+      Lurker::Json::Schema.new(DEFAULT_SCHEMA.merge('name' => service_filename), uri: service_path)
     end
   end
 
@@ -39,7 +43,7 @@ class Lurker::Service
   end
 
   def persist!
-    Lurker::Json::Writter.write(schema, service_path) unless File.exist?(service_path)
+    Lurker::Json::Writer.write(schema, service_path) unless File.exist?(service_path)
     @opened_endpoints.each { |ep| ep.persist! if ep.respond_to?(:persist!) }
   end
 
@@ -97,19 +101,31 @@ class Lurker::Service
     if base_path && !base_path.end_with?('/')
       base_path + '/'
     else
-      base_path
+      base_path || '/'
     end
   end
 
   def description
-    @schema['description']
+    schema['description']
   end
 
   def discussion
-    @schema['discussion']
+    schema['discussion']
   end
 
   def domains
     schema['domains']
   end
+
+  def request_media_types
+    schema['consumes']
+  end
+
+  def response_media_types
+    schema['produces']
+  end
+
+  def documentation
+    @documentation ||= schema.documentation
+  end
 end

data/lib/lurker/spec_helper/rspec.rb

@@ -16,9 +16,5 @@ if defined?(RSpec) && RSpec.respond_to?(:configure)
       end
       Lurker::Spy.on(options, &example)
     end
-
-    unless RSpec::Core::Version::STRING > '3'
-      config.treat_symbols_as_metadata_keys_with_true_values = true
-    end
   end
 end

data/lib/lurker/spy.rb

@@ -16,7 +16,9 @@ module Lurker
       @block = block
 
       @service = if defined?(Rails)
-        Service.new(Rails.root.join(DEFAULT_SERVICE_PATH).to_s, Rails.application.class.parent_name)
+        rails_app_class = Rails.application.class
+        rails_app_name = rails_app_class.respond_to?(:module_parent_name) ? rails_app_class.module_parent_name : rails_app_class.parent_name
+        Service.new(Rails.root.join(DEFAULT_SERVICE_PATH).to_s, rails_app_name)
       else
         Service.default_service
       end

data/lib/lurker/templates/documentation.md.tt

@@ -0,0 +1 @@
+This is an autogenerated documentation stub. You can edit it in: `<%= config[:path] %>`

data/lib/lurker/templates/javascripts/lurker.js

@@ -1,101 +1,143 @@
-var window = this.window;
-var $ = window.$;
-var Lurker = {
-
-  disableSubmitButton: function() {
-    $("#submit-api").attr("disabled", true);
-  },
-
-  enableSubmitButton: function() {
-    $("#submit-api").attr("disabled", false);
-  },
+(function() {
+  var $ = window.jQuery;
+  var hljs = window.hljs;
+
+  var Lurker = {
+    disableSubmitButton: function() {
+      $("#submit-api").attr("disabled", true);
+    },
+
+    enableSubmitButton: function() {
+      $("#submit-api").attr("disabled", false);
+    },
+
+    fillInInfoTab: function($tab, xhr) {
+      $tab.find('.status td.value').text(xhr.status + " " + xhr.statusText);
+      $tab.find('#headers').text(xhr.getAllResponseHeaders());
+
+      var realTimeTaken = Lurker.lastRequest.endTime - Lurker.lastRequest.startTime;
+      $tab.find('.time td.value').text(realTimeTaken + " ms");
+    },
+
+    fillInRawTab: function($tab, xhr) {
+      var content;
+      switch (Lurker.detectContentType(xhr)) {
+        case "json":
+          var json = JSON.stringify(JSON.parse(xhr.responseText), null, 2);
+          content = hljs.highlightAuto(json).value;
+          break;
+        default:
+          content = xhr.responseText;
+      }
+      $tab.html(content);
+    },
+
+    detectContentType: function(response) {
+      var contentType = response.getResponseHeader("Content-Type");
+      var detectedContentType = null;
+
+      if (contentType.match(/application\/json/)) {
+        detectedContentType = 'json';
+      }
+
+      return detectedContentType;
+    },
+
+    buildActionUrl: function(host, template, values) {
+      for (var i = 0; i < values.length; i++) {
+        var placeholder = new RegExp(':' + values[i].label);
+        template = template.replace(placeholder, encodeURIComponent(values[i].value));
+      }
+      return host + template;
+    },
+
+    serializePayload: function(payload, contentType) {
+      if (contentType === 'application/json' || /\+json$/.test(contentType)) {
+        return JSON.stringify(payload);
+      } else {
+        // default to 'application/x-www-form-urlencoded'
+        return jQuery.param(payload);
+      }
+    },
+
+    generateCurlCommand: function(targetUrl, method, payload, contentType) {
+      var serializedPayload = Lurker.serializePayload(payload, contentType);
+      var results = [];
+      results.push('curl');
+      results.push('-X ' + method);
+      if (serializedPayload.length > 0) {
+        if (contentType != 'application/x-www-form-urlencoded') {
+          results.push("-H 'Content-Type: " + contentType + "'");
+        }
+        results.push("-d '" + serializedPayload + "'");
+      }
+      results.push("'" + targetUrl + "'");
+      return results.join(' ');
+    },
+
+    performRequest: function(host, method, template, values, payload, contentType) {
+      Lurker.disableSubmitButton();
+
+      $.ajax({
+        url: Lurker.buildActionUrl(host, template, values),
+        data: Lurker.serializePayload(payload, contentType),
+        method: method,
+        contentType: contentType,
+        processData: false
+      }).complete(Lurker.onComplete);
+
+      Lurker.lastRequest = {};
+      Lurker.lastRequest.startTime = Date.now();
+
+      return false;
+    },
+
+    onComplete: function(xhr) {
+      Lurker.lastRequest.endTime = Date.now();
+      Lurker.enableSubmitButton();
+
+      var $responseDiv = $("#show-api-response-div");
+      $responseDiv.find("[ref^='response']").hide();
+
+      Lurker.fillInInfoTab($responseDiv.showNavTab("info"), xhr);
+      Lurker.fillInRawTab($responseDiv.showNavTab("raw"), xhr);
+    }
+  };
 
-  detectContentType: function(response) {
-    var contentType = response.getResponseHeader("Content-Type");
-    var detectedContentType = null;
+  window.Lurker = Lurker;
 
-    if (contentType.match(/application\/json/)) {
-       detectedContentType = 'json';
+  $(function($) {
+    var activeMenuItem = $('#side-menu').find('a[href="' + window.location.pathname + '"]');
+    if (activeMenuItem.length === 1) {
+      activeMenuItem.addClass('hovered')
+          .parents('.collapse').addClass('in')
+          .parents('.endpoint-group').addClass('active');
     }
 
-    return detectedContentType;
-  },
-
-  fillInInfoTab: function($tab, xhr) {
-    $tab.find('.status td.value').text(xhr.status + " " + xhr.statusText);
-    $tab.find('#headers').text(xhr.getAllResponseHeaders());
-
-    var realTimeTaken = Lurker.lastRequest.endTime - Lurker.lastRequest.startTime;
-    $tab.find('.time td.value').text(realTimeTaken + " ms");
-  },
-
-  fillInRawTab: function($tab, xhr) {
-    switch (Lurker.detectContentType(xhr)) {
-      case "json":
-        var json = JSON.stringify(JSON.parse(xhr.responseText), null, 2);
-        var content = hljs.highlightAuto(json).value;
-        break;
-      default:
-        var content = xhr.responseText;
+    window.domain = window.localStorage.lastDomain || '/';
+    window.domainName = window.localStorage.lastDomainName || 'Local';
+    function currentDomain(domain, domainName) {
+      $('.domains').find('.current')
+          .text(domainName)
+          .data('domain', domain);
     }
-    $tab.html(content);
-  },
-
-  onComplete: function(xhr) {
-    Lurker.lastRequest.endTime = Date.now();
-    Lurker.enableSubmitButton();
-
-    $("#show-api-response-div [ref^='response']").hide();
-
-    Lurker.fillInInfoTab($("#show-api-response-div").showNavTab("info"), xhr);
-    Lurker.fillInRawTab($("#show-api-response-div").showNavTab("raw"), xhr);
-  },
-
-  onSubmit: function($form) {
-    Lurker.disableSubmitButton();
-
-    $.ajax({
-      url: $form.attr('action'),
-      method: $form.attr('method'),
-      data: $form.serialize()
-    }).complete(Lurker.onComplete);
-
-    Lurker.lastRequest = {};
-    Lurker.lastRequest.startTime = Date.now();
-
-    return false;
-  }
-};
-
-$(function($) {
-  var activeMenuItem = $('#side-menu a[href="' + window.location.pathname + '"]');
-  if (activeMenuItem.length === 1) {
-    activeMenuItem.addClass('hovered').parents('.collapse').addClass('in').parents('.endpoint-group').addClass('active');
-  }
-
-  window.domain = window.localStorage.lastDomain || '/';
-  window.domainName = window.localStorage.lastDomainName || 'Local';
-  function currentDomain(domain, domainName) {
-    $('.domains').find('.current')
-      .text(domainName)
-      .data('domain', domain);
-  }
-
-  $('.domains .domain').click(function() {
-    window.domain = window.localStorage.lastDomain = $(this).data('domain');
-    window.domainName = window.localStorage.lastDomainName = $(this).text() + " (" + window.domain + ")";
+
+    $('.domains .domain').click(function() {
+      window.domain = window.localStorage.lastDomain = $(this).data('domain');
+      window.domainName = window.localStorage.lastDomainName = $(this).text() + " (" + window.domain + ")";
+      currentDomain(window.domain, window.domainName);
+    });
+
+    $('.domains .current.btn').click(function() {
+      window.location = $(this).data('domain');
+    });
     currentDomain(window.domain, window.domainName);
   });
 
-  $('.domains .current.btn').click(function() {
-    window.location = $(this).data('domain');
+  $.fn.extend({
+    showNavTab: function(name) {
+      return $(this).find("[ref=response-" + name + "]").show();
+    }
   });
-  currentDomain(window.domain, window.domainName);
-});
-
-$.fn.extend({
-  showNavTab: function(name) {
-    return $(this).find("[ref=response-" + name + "]").show();
-  },
-});
+})();
 

data/lib/lurker/templates/layouts/_sidemenu.html.erb

@@ -5,9 +5,9 @@
           <% endpoints.each do |endpoint| %>
             <li class="<%= (@endpoint_presenter.nil? && 'opened') || (endpoint.url == @endpoint_presenter.url && 'active') %>">
                 <a href="<%= endpoint.url %>">
-                  <span class="btn btn-<%= endpoint.verb_colorname %> btn-xs"><%= endpoint.verb %>&nbsp;<%= endpoint.named_path %></span>
-                  <br>
                   <span><%= endpoint.title %></span>
+                  <br>
+                  <span class="btn btn-<%= endpoint.verb_colorname %> btn-xs"><%= endpoint.verb %>&nbsp;<%= endpoint.named_path %></span>
                 </a>
             </li>
           <% end %>

data/lib/lurker/templates/layouts/application.html.erb

@@ -1,70 +1,67 @@
 <!DOCTYPE html>
 <html>
-
 <head>
-
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-    <title><%= @service_presenter.title %></title>
-    <link href="<%= @service_presenter.html_directory %>/application-<%= @service_presenter.options['css'] %>.css" media="all" rel="stylesheet">
-    <style type="text/css">
-      @font-face {
-        font-family: 'FontAwesome';
-        src: url("<%= @service_presenter.html_directory %>/fonts/fontawesome-webfont.eot?v=4.0.3");
-        src: url("<%= @service_presenter.html_directory %>/fonts/fontawesome-webfont.eot?#iefix&v=4.0.3") format("embedded-opentype"),
-             url("<%= @service_presenter.html_directory %>/fonts/fontawesome-webfont.woff?v=4.0.3") format("woff"),
-             url("<%= @service_presenter.html_directory %>/fonts/fontawesome-webfont.ttf?v=4.0.3") format("truetype"),
-             url("<%= @service_presenter.html_directory %>/fonts/fontawesome-webfont.svg?v=4.0.3#fontawesomeregular") format("svg");
-        font-weight: normal;
-        font-style: normal;
-      }
-    </style>
-
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= title %></title>
+  <link href="<%= @service_presenter.asset_path('application.css') %>" media="all" rel="stylesheet">
+  <style type="text/css">
+    @font-face {
+      font-family: 'FontAwesome';
+      src: url("<%= @service_presenter.asset_path '/fonts/fontawesome-webfont.eot?v=4.0.3' %>");
+      src: url("<%= @service_presenter.asset_path '/fonts/fontawesome-webfont.eot?#iefix&v=4.0.3' %>") format("embedded-opentype"),
+      url("<%= @service_presenter.asset_path '/fonts/fontawesome-webfont.woff?v=4.0.3' %>") format("woff"),
+      url("<%= @service_presenter.asset_path '/fonts/fontawesome-webfont.ttf?v=4.0.3' %>") format("truetype"),
+      url("<%= @service_presenter.asset_path '/fonts/fontawesome-webfont.svg?v=4.0.3#fontawesomeregular' %>") format("svg");
+      font-weight: normal;
+      font-style: normal;
+    }
+  </style>
 </head>
-
 <body>
 
-    <header class="navbar navbar-static-top bs-docs-nav" id="top" role="banner">
-      <div class="container">
-        <div class="navbar-header">
-          <a class="navbar-brand" href="<%= @service_presenter.html_directory %>"><%= @service_presenter.name %></a>
-        </div>
-      </div>
-    </header>
+<header class="navbar navbar-static-top bs-docs-nav" id="top" role="banner">
+  <div class="container">
+    <div class="navbar-header">
+      <a class="navbar-brand" href="<%= @service_presenter.html_directory %>"><%= @service_presenter.name %></a>
+    </div>
+  </div>
+</header>
 
-    <div class="container bs-docs-container">
-      <div class="row">
-        <div class="col-md-9" role="main">
-          <div class="bs-docs-section">
-            <%= yield %>
-          </div>
-        </div>
-        <div class="col-md-3">
-          <div class="bs-docs-sidebar hidden-print" role="complementary">
-            <ul class="nav bs-docs-sidenav">
-              <%= render 'layouts/sidemenu' %>
-            </ul>
-          </div>
-        </div>
+<div class="container bs-docs-container">
+  <div class="row">
+    <div class="col-md-9" role="main">
+      <div class="bs-docs-section">
+        <%= yield %>
       </div>
     </div>
-
-    <footer class="bs-docs-footer" role="contentinfo">
-      <div class="container">
-        <ul class="bs-docs-footer-links muted">
-          <li>·</li>
-          <% if @service_presenter.options[:footer].present? %>
-            <li><%= @service_presenter.name %>&nbsp;<%= @service_presenter.options[:footer] %></li>
-            <li>·</li>
-          <% end %>
-          <% if @service_presenter.options[:lurker].present? %>
-            <li><%= @service_presenter.options[:lurker] %></li>
-            <li>·</li>
-          <% end %>
+    <div class="col-md-3">
+      <div class="bs-docs-sidebar hidden-print" role="complementary">
+        <ul class="nav bs-docs-sidenav">
+          <%= render 'layouts/sidemenu' %>
         </ul>
       </div>
-    </footer>
-    <script src="<%= @service_presenter.html_directory %>/application-<%= @service_presenter.options['js'] %>.js"></script>
+    </div>
+  </div>
+</div>
+
+<footer class="bs-docs-footer" role="contentinfo">
+  <div class="container">
+    <ul class="bs-docs-footer-links muted">
+      <li>·</li>
+      <% if @service_presenter.footer.present? %>
+        <li><%= raw @service_presenter.footer %></li>
+        <li>·</li>
+      <% end %>
+      <% if @service_presenter.lurker.present? %>
+        <li><%= raw @service_presenter.lurker %></li>
+        <li>·</li>
+      <% end %>
+    </ul>
+  </div>
+</footer>
+
+<script src="<%= @service_presenter.asset_path 'application.js' %>"></script>
+
 </body>
 </html>