lurker 0.6.9 → 0.6.10

data/lib/lurker/json/schema.rb

@@ -21,6 +21,16 @@ module Lurker
         parse_schema(schema)
       end
 
+      def documentation_uri(extension = 'md')
+        @uri.to_s.sub(%r{^file:(//)?}, '').sub(/(\.json)?(\.yml)?(\.erb)?$/, ".#{extension}")
+      end
+
+      def documentation
+        open(documentation_uri).read
+      rescue
+        @schema['description']
+      end
+
       def root?
         root_schema.blank?
       end
@@ -40,8 +50,7 @@ module Lurker
       end
 
       def replace!(property, property_schema)
-        @schema[property] = Lurker::Json::Parser.plain(subschema_options)
-          .parse_property(property, property_schema)
+        @schema[property] = @parser.plain.parse_property(property, property_schema)
       end
 
       def reorder!
@@ -54,7 +63,7 @@ module Lurker
       end
 
       def to_json(options = {})
-        hashify(@schema, options).to_json
+        to_hash(options).to_json
       end
 
       def to_yaml(options = {})

data/lib/lurker/json/{writter.rb → writer.rb}

@@ -1,6 +1,6 @@
 module Lurker
   module Json
-    class Writter
+    class Writer
       class << self
         def write(schema, path)
           new(path).write(schema)
@@ -16,7 +16,7 @@ module Lurker
         write_to_file(schema)
 
         extract_references(schema).each do |reference|
-          Lurker::Json::Writter.write(reference, reference.original_uri.path)
+          Lurker::Json::Writer.write(reference, reference.original_uri.path)
         end
       end
 

data/lib/lurker/presenters/base_presenter.rb

@@ -9,16 +9,6 @@ class Lurker::BasePresenter
     @options = options
   end
 
-  def render_erb(erb_name, binding = get_binding)
-    template_path = path_for_template(erb_name)
-    template = ERB.new(File.read(template_path), nil, '-')
-    template.result(binding)
-  end
-
-  def get_binding
-    binding
-  end
-
   def html_directory
     options[:url_base_path] || options[:html_directory] || ""
   end
@@ -27,8 +17,12 @@ class Lurker::BasePresenter
     options[:url_base_path] || '/'
   end
 
-  def css_path
-    File.join(html_directory, "styles.css")
+  def assets
+    options[:assets] || {}
+  end
+
+  def asset_path(asset)
+    "#{html_directory}/#{assets[asset] || asset}"
   end
 
   def index_path(subdirectory = "")
@@ -51,27 +45,8 @@ class Lurker::BasePresenter
     EOS
   end
 
-  def render(*args)
-    rendering_controller.render_to_string(*args)
-  end
-
-  protected
-
-  def path_for_template(filename)
-    template_dir  = options[:template_directory]
-    template_path = File.join(template_dir, filename) if template_dir
-    if template_path.nil? || !File.exist?(template_path)
-      template_path = File.join(File.dirname(__FILE__), "../templates", filename)
-    end
-    template_path
-  end
-
-  def rendering_controller
-    return @rendering_controller if @rendering_controller
-    @rendering_controller = Lurker::RenderingController.new
-    instance_variables.each do |var|
-      @rendering_controller.instance_variable_set(var, instance_variable_get(var))
-    end
-    @rendering_controller
+  def markup(content)
+    Lurker.safe_require 'kramdown'
+    defined?(Kramdown) ? Kramdown::Document.new(content).to_html : content
   end
 end

data/lib/lurker/presenters/endpoint_presenter.rb

@@ -2,6 +2,9 @@
 class Lurker::EndpointPresenter < Lurker::BasePresenter
   attr_accessor :service_presenter, :endpoint, :endpoint_presenter
 
+  extend Forwardable
+  def_delegators :endpoint, :url_params
+
   def initialize(endpoint, options = {})
     super(options)
     @endpoint = endpoint
@@ -10,12 +13,15 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def to_html(options={})
-    @service_presenter = service_presenter
-    @endpoint_presenter = self
-    @url_params = endpoint.url_params
-    @post_params = example_request.json
-    @title = "#{service_presenter.title} | #{title}"
-    render('show', options)
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = service_presenter
+    controller.endpoint_presenter = self
+    controller.instance_variable_set :@title, "#{service_presenter.title} | #{title}"
+    controller.render_to_string 'show', options
+  end
+
+  def documentation
+    markup @endpoint.documentation
   end
 
   def relative_path(extension = ".html")
@@ -34,6 +40,10 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     endpoint.prefix || endpoint.path.split("/").first
   end
 
+  def post_params
+    example_request.json
+  end
+
   def zws_ify(str)
     # zero-width-space, makes long lines friendlier for breaking
     # str.gsub(/\//, '&#8203;/') if str

data/lib/lurker/presenters/service_presenter.rb

@@ -1,3 +1,5 @@
+require 'active_support/inflector'
+
 # An BasePresenter for Lurker::Service
 class Lurker::ServicePresenter < Lurker::BasePresenter
   attr_reader :service
@@ -11,10 +13,20 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
     @filtering_block = block
   end
 
-  # TODO move to controller
-  def to_html(&block)
-    @service_presenter = self
-    render('index')
+  def to_html(options={}, &block)
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = self
+    controller.render_to_string 'index', options
+  end
+
+  def to_print(options = {})
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = self
+    controller.render_to_string 'all', { layout: 'print' }.merge(options)
+  end
+
+  def documentation
+    markup @service.documentation
   end
 
   def title
@@ -46,13 +58,25 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   end
 
   def slug_name
-    service.name.downcase.gsub(/[ \/]/, '_')
+    @slug_name ||= service.name.downcase.gsub(/[ \/]/, '_')
+  end
+
+  def url_name
+    @url_name ||= ActiveSupport::Inflector.parameterize(name, '_')
   end
 
   def url(extension = ".html")
     '%s-%s%s' % [@endpoint.path, @endpoint.verb, extension]
   end
 
+  def footer
+    @footer ||= options[:footer].present? ? "Revision&nbsp;#{options[:footer]}".html_safe : ''
+  end
+
+  def lurker
+    @lurker ||= options[:lurker] || ''
+  end
+
   def endpoints
     unless @endpoints
       @endpoints = []

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,16 +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, uri: service_path)
     else
-      Lurker::Json::Schema.new(
-        'name' => service_filename,
-        'basePath' => '',
-        'description' => '',
-        'domains' => {},
-        'consumes' => %w(application/x-www-form-urlencode application/json),
-        'produces' => %w(application/json)
-      )
+      Lurker::Json::Schema.new(DEFAULT_SCHEMA.merge(name: service_filename), uri: service_path)
     end
   end
 
@@ -41,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
 
@@ -104,11 +106,11 @@ class Lurker::Service
   end
 
   def description
-    @schema['description']
+    schema['description']
   end
 
   def discussion
-    @schema['discussion']
+    schema['discussion']
   end
 
   def domains
@@ -122,4 +124,8 @@ class Lurker::Service
   def response_media_types
     schema['produces']
   end
+
+  def documentation
+    @documentation ||= schema.documentation
+  end
 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

@@ -46,7 +46,7 @@
     buildActionUrl: function(host, template, values) {
       for (var i = 0; i < values.length; i++) {
         var placeholder = new RegExp(':' + values[i].label);
-        template = template.replace(placeholder, values[i].value);
+        template = template.replace(placeholder, encodeURIComponent(values[i].value));
       }
       return host + template;
     },

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><%= @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>