lurker 0.6.1 → 0.6.2

data/lib/lurker/endpoint/http_parameters.rb

@@ -0,0 +1,77 @@
+module Lurker
+  class Endpoint
+    class HttpParameters
+      extend Forwardable
+      include Lurker::Utils
+
+      ID = 'id'.freeze
+      TYPE = 'type'.freeze
+      OBJECT = 'object'.freeze
+      PROPERTIES = 'properties'.freeze
+      ADDITIONAL_PROPERTIES = 'additionalProperties'.freeze
+
+      delegate [:[], :key?, :keys, :empty?] => :http_parameters
+
+      attr_reader :errors
+
+      def initialize(schema, options = {})
+        @schema = schema
+
+        @schema_key = options.fetch(:schema_key)
+        @schema_id = options.fetch(:schema_id)
+        @human_name = options.fetch(:human_name, @schema_key)
+
+        @schema[@schema_key] ||= {}
+        @errors = []
+      end
+
+      def add(parameters)
+        @schema[@schema_key] = Lurker::SchemaModifier.merge!(
+          Lurker::JsonSchemaHash.new(http_parameters, @schema_id), stringify_keys(parameters)
+        ).to_h
+      end
+
+      # TODO : Split the collecting of errors and representations of errors
+      def validate(parameters)
+        errors = Lurker::Validator.new(schemify(http_parameters), stringify_keys(parameters),
+          record_errors: true).validate
+
+        @errors = errors.map { |error| "- #{error}" }
+        @errors.unshift(@human_name) unless @errors.empty?
+      end
+
+      private
+
+      def http_parameters
+        @schema[@schema_key]
+      end
+
+      def schemify(object)
+        set_additional_properties_false_on(object).tap do |schema|
+          schema[ID] = "file://#{@schema_id}"
+        end
+      end
+
+      def set_additional_properties_false_on(object)
+        if object.is_a? Hash
+          copy = object.dup
+
+          if object[TYPE] == OBJECT || object.key?(PROPERTIES)
+            copy[ADDITIONAL_PROPERTIES] ||= false
+          end
+
+          object.each do |key, value|
+            next if key == ADDITIONAL_PROPERTIES
+            copy[key] = set_additional_properties_false_on(value)
+          end
+
+          copy
+        elsif object.is_a? Array
+          copy = object.map { |value| set_additional_properties_false_on(value) }
+        else
+          object
+        end
+      end
+    end
+  end
+end

data/lib/lurker/endpoint/response_codes.rb

@@ -0,0 +1,42 @@
+module Lurker
+  class Endpoint
+    class ResponseCodes
+      RESPONSE_CODES = 'responseCodes'.freeze
+      DESCRIPTION = 'description'.freeze
+      SUCCESSFUL = 'successful'.freeze
+      STATUS = 'status'.freeze
+
+      def initialize(schema)
+        @schema = schema
+        @schema[RESPONSE_CODES] ||= []
+      end
+
+      def add(status_code, successful, options = {})
+        response_code = {
+          STATUS => status_code,
+          SUCCESSFUL => successful,
+          DESCRIPTION => options.fetch(:description, '')
+        }
+
+        Lurker::SchemaModifier.append!(@schema[RESPONSE_CODES], response_code)
+      end
+
+      def validate!(status_code, successful)
+        return if exists?(status_code, successful)
+
+        raise Lurker::UndocumentedResponseCode,
+          'Undocumented response: %s, successful: %s' % [
+            status_code, successful
+          ]
+      end
+
+      def exists?(status_code, successful)
+        !!@schema[RESPONSE_CODES].detect do |response_code|
+          response_code[SUCCESSFUL] == successful &&
+            (response_code[STATUS] == status_code ||    # 200
+             response_code[STATUS].to_i == status_code) # "200 OK"
+        end
+      end
+    end
+  end
+end

data/lib/lurker/erb_schema_context.rb

@@ -1,9 +1,11 @@
-class Lurker::ErbSchemaContext
-  def allowed(*names)
-    "Allowed values: #{names.join(', ')}"
-  end
+module Lurker
+  class ErbSchemaContext
+    def allowed(*names)
+      "Allowed values: #{names.join(', ')}"
+    end
 
-  def get_binding
-    binding
+    def get_binding
+      binding
+    end
   end
 end

data/lib/lurker/jaml_descriptor.rb

@@ -2,6 +2,14 @@
 # readed as dumped JSON
 # to hack `open('...json').read`
 class Lurker::JamlDescriptor
+  module Rescue
+    def open(uri)
+      Kernel.open(uri)
+    rescue Errno::ENOENT
+      Lurker::JamlDescriptor.new(uri)
+    end
+  end
+
   def initialize(uri)
     @uri = uri.gsub(/\#$/, '').gsub(/\.json/, '.json.yml')
     @fd = open(@uri)
@@ -11,4 +19,3 @@ class Lurker::JamlDescriptor
     @read ||= JSON.dump(YAML.load(@fd.read))
   end
 end
-

data/lib/lurker/json_schema_hash.rb

@@ -0,0 +1,48 @@
+module Lurker
+  class JsonSchemaHash
+    attr_accessor :schema_hash
+    include JamlDescriptor::Rescue
+
+    def initialize(schema_hash, uri)
+      @to_s = uri
+      @uri = URI.parse(uri)
+      @uri = URI.parse("file://#{uri}") if @uri.relative?
+
+      @schema_hash = Hash[schema_hash.map do |k, v|
+        if k == '$ref' && v.is_a?(String)
+          uri = @uri.merge(v)
+          schema_hash = JSON.parse(open(uri.to_s).read)
+          [k, JsonSchemaHash.new(schema_hash, uri.to_s)]
+        elsif v.is_a?(Hash)
+          [k, JsonSchemaHash.new(v, @to_s)]
+        else
+          [k, v]
+        end
+      end]
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @schema_hash.send(:respond_to_missing?, method, include_private)
+    end
+
+    def method_missing(method, *args, &block)
+      @schema_hash.send method, *args, &block
+    end
+
+    def is_a?(*args)
+      @schema_hash.is_a?(*args)
+    end
+
+    def to_h
+      Hash[@schema_hash.map do |k, v|
+        if JsonSchemaHash === v
+          [k, v.to_h]
+        elsif v.is_a?(Array)
+          [k, v.map { |i| JsonSchemaHash === i ? i.to_h : i }]
+        else
+          [k, v]
+        end
+      end]
+    end
+  end
+end

data/lib/lurker/presenters/base_presenter.rb

@@ -3,7 +3,6 @@ require 'json'
 require 'forwardable'
 
 class Lurker::BasePresenter
-
   attr_reader :options
 
   def initialize(options = {})
@@ -61,7 +60,7 @@ class Lurker::BasePresenter
   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.exists?(template_path)
+    if template_path.nil? || !File.exist?(template_path)
       template_path = File.join(File.dirname(__FILE__), "../templates", filename)
     end
     template_path

data/lib/lurker/presenters/endpoint_presenter.rb

@@ -2,9 +2,6 @@
 class Lurker::EndpointPresenter < Lurker::BasePresenter
   attr_accessor :service_presenter, :endpoint, :endpoint_presenter
 
-  extend Forwardable
-  def_delegators :endpoint, :description
-
   def initialize(endpoint, options = {})
     super(options)
     @endpoint = endpoint
@@ -21,7 +18,7 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def relative_path(extension = ".html")
-    '%s%s-%s%s' % [ options[:prefix], endpoint.path, endpoint.verb, extension ]
+    '%s%s-%s%s' % [options[:prefix], endpoint.path, endpoint.verb, extension]
   end
 
   def url(extension = ".html")
@@ -29,7 +26,7 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def title
-    '%s %s - %s' % [ endpoint.verb, endpoint.path, endpoint.service.name ]
+    description_parts.first.to_s
   end
 
   def prefix
@@ -38,10 +35,14 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
 
   def zws_ify(str)
     # zero-width-space, makes long lines friendlier for breaking
-    #str.gsub(/\//, '&#8203;/') if str
+    # str.gsub(/\//, '&#8203;/') if str
     str
   end
 
+  def description
+    description_parts[1..-1].join("\n")
+  end
+
   def root_path
     URI.parse("file://#{endpoint.endpoint_path}")
   end
@@ -75,7 +76,7 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     return if endpoint.request_parameters.empty?
     Lurker::JsonPresenter.new(
       example_from_schema(endpoint.request_parameters, endpoint.schema)
-        .reject { |k,_| endpoint.url_params.keys.include? k }
+        .reject { |k, _| endpoint.url_params.keys.include? k }
     )
   end
 
@@ -208,20 +209,26 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def example_from_array(array, parent=nil)
-    if array["items"].kind_of? Array
+    if array["items"].is_a? Array
       example = []
       array["items"].each do |item|
         example << example_from_schema(item, parent)
       end
       example
-    elsif (array["items"] || {})["type"].kind_of? Array
+    elsif (array["items"] || {})["type"].is_a? Array
       example = []
       array["items"]["type"].each do |item|
         example << example_from_schema(item, parent)
       end
       example
     else
-      [ example_from_schema(array["items"], parent) ]
+      [example_from_schema(array["items"], parent)]
     end
   end
+
+  private
+
+  def description_parts
+    endpoint.description.to_s.strip.split(/\n+/)
+  end
 end

data/lib/lurker/presenters/json_presenter.rb

@@ -8,14 +8,14 @@ class Lurker::JsonPresenter
   end
 
   def to_html
-    if json.kind_of? String
+    if json.is_a? String
       '<tt>&quot;%s&quot;</tt>' % json.gsub(/\"/, 'quot;')
-    elsif json.kind_of?(Numeric) ||
-          json.kind_of?(TrueClass) ||
-          json.kind_of?(FalseClass)
+    elsif json.is_a?(Numeric) ||
+          json.is_a?(TrueClass) ||
+          json.is_a?(FalseClass)
       '<tt>%s</tt>' % json
-    elsif json.kind_of?(Hash) ||
-          json.kind_of?(Array)
+    elsif json.is_a?(Hash) ||
+          json.is_a?(Array)
       '<pre><code>%s</code></pre>' % JSON.pretty_generate(json)
     end
   end

data/lib/lurker/presenters/schema_presenter.rb

@@ -1,6 +1,8 @@
 # An BasePresenter for a JSON Schema fragment. Like most JSON
 # schema things, has a tendency to recurse.
 class Lurker::SchemaPresenter < Lurker::BasePresenter
+  attr_reader :schema
+
   FORMATTED_KEYS = %w(
     description
     type
@@ -29,7 +31,7 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
     options[:nested] > 0
   end
 
-  def to_html
+  def to_html(parent_key=nil)
     html = StringIO.new
 
     html << '<span class="deprecated">Deprecated</span>' if deprecated?
@@ -39,21 +41,20 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
 
     html << '<ul>'
     begin
-      html << '<li>Required: %s</li>' % required? if nested?
+      html << '<li>Required: %s</li>' % required?(parent_key) if nested?
       html << '<li>Type: %s</li>' % type if type
       html << '<li>Format: %s</li>' % format if format
       html << '<li>Example: %s</li>' % example.to_html if example
       html << enum_html
 
       (@schema.keys - FORMATTED_KEYS).each do |key|
-        html << '<li>%s: %s</li>' % [ key, @schema[key] ]
+        html << '<li>%s: %s</li>' % [key, @schema[key]]
       end
 
       html << items_html
       html << properties_html
     end
 
-
     html << '</ul>'
     html << '</div>'
 
@@ -62,10 +63,10 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
 
   def type
     t = @schema["type"]
-    if t.kind_of? Array
+    if t.is_a? Array
       types = t.map do |type|
-        if type.kind_of? Hash
-          '<li>%s</li>' % self.class.new(type, options).to_html
+        if type.is_a? Hash
+          '<li>%s</li>' % self.class.new(type, options.merge(parent: self)).to_html
         else
           '<li>%s</li>' % type
         end
@@ -82,17 +83,17 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
   end
 
   def example
-    return unless e = @schema["example"]
+    return unless @schema.key?("example")
 
-    Lurker::JsonPresenter.new(e)
+    Lurker::JsonPresenter.new(@schema["example"])
   end
 
   def deprecated?
     @schema["deprecated"]
   end
 
-  def required?
-    @schema["required"] ? "yes" : "no"
+  def required?(parent_key=nil)
+    ((options[:parent].schema['required'] || []).include?(parent_key)) ? "yes" : "no"
   end
 
   def enum_html
@@ -116,9 +117,9 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
     html = ""
     html << '<li>Items'
 
-    sub_options = options.merge(:nested => options[:nested] + 1)
+    sub_options = options.merge(:nested => options[:nested] + 1, :parent => self)
 
-    if items.kind_of? Array
+    if items.is_a? Array
       item.compact.each do |item|
         html << self.class.new(item, sub_options).to_html
       end
@@ -153,7 +154,7 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
         '<tt>%s</tt>' % key,
         schema_slug(key, property)
       )
-      html << self.class.new(property, options.merge(:nested => options[:nested] + 1)).to_html
+      html << self.class.new(property, options.merge(:nested => options[:nested] + 1, :parent => self)).to_html(key)
       html << '</li>'
     end
 

data/lib/lurker/presenters/service_presenter.rb

@@ -5,7 +5,6 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   extend Forwardable
   def_delegators :service, :description, :discussion, :name, :service_dir
 
-
   def initialize(service, options = {}, &block)
     super(options)
     @service = service
@@ -24,7 +23,7 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
 
   def domains
     return service.domains if service.domains.present?
-    { '/' => 'Local'}
+    { '/' => 'Local' }
   end
 
   def default_domain
@@ -34,7 +33,7 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
 
   def name_as_link(options = {})
     path = index_path
-    '<a href="%s">%s %s</a>' % [ path, options[:prefix], service.name ]
+    '<a href="%s">%s %s</a>' % [path, options[:prefix], service.name]
   end
 
   def slug_name
@@ -42,11 +41,11 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   end
 
   def url(extension = ".html")
-    '%s-%s%s' % [ @endpoint.path, @endpoint.verb, extension ]
+    '%s-%s%s' % [@endpoint.path, @endpoint.verb, extension]
   end
 
   def endpoints
-    if !@endpoints
+    unless @endpoints
       @endpoints = []
       prefix = nil
 
@@ -73,7 +72,7 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
 
   def endpoints_by_prefix
     @endpoints_by_prefix ||= begin
-      hash = Hash.new { |h,k| h[k] = Array.new }
+      hash = Hash.new { |h, k| h[k] = Array.new }
       service.endpoints.sort_by(&:endpoint_path).each do |endpoint|
         presenter = Lurker::EndpointPresenter.new(endpoint, options)
         presenter.service_presenter = self