lurker 0.6.0 → 0.6.1

data/features/schema_updating_within_test_suite.feature

@@ -0,0 +1,138 @@
+Feature: schema updating within test suite
+
+  If your API is stable and the new code isn't breaking it
+  you'll see nothing special, just passing specs
+
+  Background:
+    Given a file named "lurker/api/v2/users/__id-PATCH.json.yml" with:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            name:
+              description: ''
+              type: string
+              example: 'Bob'
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 1
+        name:
+          description: ''
+          type: string
+          example: razum2um
+        surname:
+          description: ''
+          type: string
+          example: Unknown
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/1"
+      path_params:
+        id: '1'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+    """
+
+  Scenario: json schema tests response parameters and update request parameters using "users/update"
+  Given a file named "spec/controllers/api/v2/users_controller_spec.rb" with:
+    """ruby
+      require "spec_helper"
+
+      describe Api::V2::UsersController, :lurker do
+        render_views
+
+        let(:user) do
+          User.where(name: 'razum2um', surname: 'Unknown').first_or_create!
+        end
+
+        it "updates a user surname as string" do
+          patch :update, id: user.id, user: { surname: 'Marley' }
+          expect(response).to be_success
+        end
+      end
+    """
+
+  When I run `bin/rspec spec/controllers/api/v2/users_controller_spec.rb`
+  Then the example should pass
+  Then a file named "lurker/api/v2/users/__id-PATCH.json.yml" should exist
+  Then the file "lurker/api/v2/users/__id-PATCH.json.yml" should contain exactly:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            name:
+              description: ''
+              type: string
+              example: Bob
+            surname:
+              description: ''
+              type: string
+              example: Marley
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 1
+        name:
+          description: ''
+          type: string
+          example: razum2um
+        surname:
+          description: ''
+          type: string
+          example: Unknown
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/1"
+      path_params:
+        id: '1'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+
+    """

data/features/test_endpoint.feature

@@ -3,7 +3,7 @@ Feature: test endpoint
   If your API is stable and the new code isn't breaking it
   you'll see nothing special, just passing specs
 
-  **NOTE:** the second request example is expecting a nonsuccessful response and it is,
+  **NOTE:** the second request example is expecting a successful response and it is,
   but specs are NOT passing because of nonsufficient `name` parameter
 
   **NOTE:** the third response example is expecting a successful response and it is,
@@ -41,6 +41,9 @@ Feature: test endpoint
           name:
             type: string
             example: Bob
+          surname:
+            type: string
+            example: Marley
       extensions:
         path_info: "/api/v1/users/1"
         method: PATCH
@@ -96,8 +99,8 @@ Feature: test endpoint
   Then the output should contain failures:
     """
     Lurker::ValidationError:
-      Request
-        The property '#/user/name' of type Fixnum did not match the following type: string
+      Response
+        The property '#/name' of type Fixnum did not match the following type: string
 
     1 example, 1 failure
     """

data/lib/lurker.rb

@@ -1,10 +1,23 @@
 $:.unshift(File.dirname(__FILE__))
 
 module Lurker
-  DEFAULT_SERVICE_PATH = DEFAULT_URL_BASE = "lurker"
+  DEFAULT_SERVICE_PATH = DEFAULT_URL_BASE = "lurker".freeze
+  LURKER_UPGRADE = "LURKER_UPGRADE".freeze
 
-  def self.scaffold_mode?
-    ENV['LURKER_SCAFFOLD']
+  def self.safe_require(gem, desc=nil)
+    begin
+      require gem
+    rescue LoadError => e
+      $stderr.puts(e.message)
+      $stderr.puts(desc) if desc
+      $stderr.puts("Please, bundle `gem #{gem}` in your Gemfile")
+      exit 1 unless block_given?
+    end
+    yield if block_given?
+  end
+
+  def self.upgrade?
+    !!ENV[LURKER_UPGRADE]
   end
 
   def self.service_path=(service_path)
@@ -35,6 +48,10 @@ module Lurker
 end
 
 require 'lurker/schema'
+require 'lurker/schema_modifier'
+require 'lurker/schema_modifier/hash'
+require 'lurker/schema_modifier/array'
+require 'lurker/schema_modifier/atom'
 require 'lurker/ref_object'
 require 'lurker/erb_schema_context'
 require 'lurker/service'
@@ -42,7 +59,6 @@ require 'lurker/jaml_descriptor'
 require 'lurker/validator'
 require 'lurker/validation_error'
 require 'lurker/endpoint'
-require 'lurker/endpoint_scaffold'
 require 'lurker/rendering_controller'
 require 'lurker/form_builder'
 require 'lurker/presenters/json_presenter'

data/lib/lurker/cli.rb

@@ -1,7 +1,5 @@
 require 'thor'
 require 'execjs'
-require 'pdfkit'
-# require 'coderay'
 require 'digest/sha1'
 require 'lurker/service'
 
@@ -60,6 +58,7 @@ module Lurker
 
     no_tasks do
       def convert_to_pdf
+        Lurker.safe_require('pdfkit')
         css = File.expand_path('application.css', self.class.precompiled_static_root)
         in_root do
           service_presenters.each do |service_presenter|
@@ -204,7 +203,7 @@ module Lurker
       return unless content_fname
       content_fname = File.expand_path(content_fname)
       if content_fname.ends_with? 'md'
-        require 'kramdown'
+        Lurker.safe_require('kramdown')
         Kramdown::Document.new(open(content_fname).read).to_html
       else
         ''

data/lib/lurker/endpoint.rb

@@ -12,20 +12,15 @@ class Lurker::Endpoint
   def initialize(endpoint_path, extensions={}, service=Lurker::Service.default_service)
     @endpoint_path = endpoint_path
     @extensions = extensions
-    @schema = Lurker::Schema.new(
-      load_file(@endpoint_path),
-      stringify_keys(extensions)
-    )
     @service = service
     @errors = []
-    @current_scaffold = Lurker::EndpointScaffold.new(
-      "#{endpoint_path}.new", extensions, service
-    )
+    @persisted = false
+    @schema = File.exist?(endpoint_path) ? load_schema : build_schema
   end
 
   def persist!
-    return unless ENV['LURKER_UPGRADE']
-    schema.write_to(endpoint_path)
+    schema.ordered!.write_to(endpoint_path)
+    @persisted = true
   end
 
   def indexed?
@@ -40,32 +35,25 @@ class Lurker::Endpoint
 
   def consume_request(params, successful=true)
     if successful
-      unless validate(request_parameters, params, 'Request')
-        current_scaffold.consume_request(params, successful)
-      end
+      Lurker::SchemaModifier.merge!(request_parameters, stringify_keys(params))
     end
   end
 
   def consume_response(params, status_code, successful=true)
-    response_code = response_codes.find do |rc|
-      rc["successful"] == successful && (
-        rc["status"]      == status_code || # 200
-        rc["status"].to_i == status_code    # "200 OK"
-      )
+    return validate_response(params, status_code, successful) if persisted?
+
+    if successful
+      Lurker::SchemaModifier.merge!(response_parameters, stringify_keys(params))
     end
 
+    if !status_code_exists?(status_code, successful)
+      response_code = {
+        "status" => status_code,
+        "successful" => successful,
+        "description" => ""
+      }
 
-    if !response_code
-      raise Lurker::UndocumentedResponseCode,
-        'Undocumented response: %s, successful: %s' % [
-          status_code, successful
-        ]
-    elsif successful
-      unless validate(response_parameters, params, 'Response')
-        current_scaffold.consume_response(params, status_code, successful)
-      end
-    else
-      true
+      Lurker::SchemaModifier.append!(response_codes, response_code)
     end
   end
 
@@ -116,6 +104,32 @@ class Lurker::Endpoint
 
   protected
 
+  def persisted?
+    !!@persisted
+  end
+
+  def load_schema
+    @persisted = true
+
+    Lurker::Schema.new(
+      load_file(endpoint_path),
+      stringify_keys(extensions)
+    )
+  end
+
+  def build_schema
+    @persisted = false
+
+    Lurker::Schema.new(
+      {
+        "prefix" => "",
+        "description" => "",
+        "responseCodes" => []
+      },
+      stringify_keys(extensions)
+    )
+  end
+
   def load_file(fname)
     if fname.match(/\.erb$/)
       context = Lurker::ErbSchemaContext.new
@@ -137,6 +151,27 @@ class Lurker::Endpoint
     true
   end
 
+  def validate_response(params, status_code, successful)
+    if !status_code_exists?(status_code, successful)
+      raise Lurker::UndocumentedResponseCode,
+        'Undocumented response: %s, successful: %s' % [
+          status_code, successful
+        ]
+    elsif successful
+      validate(response_parameters, params, 'Response')
+    else
+      true
+    end
+  end
+
+  def status_code_exists?(status_code, successful)
+    !!response_codes.detect do |code|
+      code["successful"] == successful &&
+        (code["status"] == status_code ||    # 200
+         code["status"].to_i == status_code) # "200 OK"
+    end
+  end
+
   def raise_errors!
     unless errors.empty?
       raise Lurker::ValidationError.new(word_wrap((

data/lib/lurker/presenters/endpoint_presenter.rb

@@ -84,14 +84,20 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     return if endpoint.response_parameters.empty?
     response = example_from_schema(endpoint.response_parameters, endpoint.schema)
     @example_response = response.to_json
-    if defined? ExecJS
+    @highlighted = false
+    Lurker.safe_require("execjs", "to get samples highlighted") do
       jsfile = File.expand_path('javascripts/highlight.pack.js', Lurker::Cli.source_root)
       source = open(jsfile).read
       context = ExecJS.compile(source)
       @example_response = context.exec("return hljs.highlightAuto(JSON.stringify(#{@example_response}, null, 2)).value")
-    elsif defined? CodeRay
-      @example_response = ::CodeRay.scan(@example_response, :json).html(wrap: nil, css: :class)
-      #::CodeRay.scan(response.to_json, :jjson).html(wrap: nil, css: :class)
+      @highlighted = true
+    end
+    unless @highlighted
+      Lurker.safe_require("coderay", "to get samples highlighted") do
+        #::CodeRay.scan(response.to_json, :jjson).html(wrap: nil, css: :class) # forked compatible version
+        @example_response = ::CodeRay.scan(@example_response, :json).html(wrap: nil, css: :class)
+        @highlighted = true
+      end
     end
     @example_response
   end

data/lib/lurker/schema.rb

@@ -1,9 +1,8 @@
-require 'diffy'
 require 'yaml'
 
 module Lurker
   class Schema
-    KEY = 'extensions'
+    EXTENSIONS = "extensions".freeze
     DESCRPTIONS = {
       'index' => 'listing',
       'show' => '',
@@ -14,13 +13,11 @@ module Lurker
     }
     attr_reader :extensions
 
-    def initialize(json_schema_hash, extensions={})
+    def initialize(json_schema_hash, extensions = {})
       @hash = json_schema_hash
-      @extensions = if extensions.blank? && @hash.has_key?(KEY)
-        @hash.delete(KEY) || {}
-      else
-        extensions
-      end
+
+      existing_extensions = @hash.delete(EXTENSIONS) || {}
+      @extensions = select_extensions(existing_extensions, extensions)
     end
 
     def respond_to_missing?(method, include_private = false)
@@ -31,13 +28,6 @@ module Lurker
       @hash.send method, *args, &block
     end
 
-    def diff(schema)
-      ::Diffy::Diff.new(
-        schema.serialized_for_diff,
-        serialized_for_diff,
-        context: 1).to_s(:color)
-    end
-
     def write_to(path)
       if @hash['prefix'].blank?
         @hash['prefix'] = "#{default_subject} management"
@@ -56,7 +46,7 @@ module Lurker
 
     def to_yaml
       YAML.dump(@hash.merge(
-        KEY => @extensions
+        EXTENSIONS => @extensions
       ))
     end
 
@@ -76,6 +66,14 @@ module Lurker
 
     private
 
+    def select_extensions(existing, given)
+      if Lurker.upgrade? || (existing.blank? && given.present?)
+        given
+      else
+        existing
+      end
+    end
+
     def default_descrption
       "#{default_subject.singularize} #{DESCRPTIONS[path_params['action']]}"
     end