lurker 0.5.6 → 0.5.7

data/features/request_nested_schema_scaffolding.feature

@@ -11,12 +11,12 @@ Feature: request nested schema scaffolding
 
         let!(:user) do
           User.where(name: 'razum2um').first_or_create!.tap do |u|
-            u.repos.create!(name: 'lurker')
+            u.repos.first_or_create!(name: 'lurker')
           end
         end
 
         it "shows a user's repo" do
-          get "api/v1/users/#{user.id}/repos/#{user.repos.first.id}"
+          get "api/v1/users/#{user.id}/repos/#{user.repos.first.id}.json"
           expect(response).to be_success
         end
       end
@@ -60,7 +60,7 @@ Feature: request nested schema scaffolding
           example: 1
     extensions:
       method: GET
-      path_info: "/api/v1/users/1/repos/1"
+      path_info: "/api/v1/users/1/repos/1.json"
       path_params:
         action: show
         controller: api/v1/repos

data/features/request_schema_scaffolding.feature

@@ -19,7 +19,7 @@ Feature: request schema scaffolding
         end
 
         it "lists all the users" do
-          get "api/v1/users?limit=1"
+          get "api/v1/users.json?limit=1"
           expect(response).to be_success
           expect(JSON.parse(response.body).size).to eq 1
         end
@@ -66,7 +66,7 @@ Feature: request schema scaffolding
             example: razum2um
     extensions:
       method: GET
-      path_info: "/api/v1/users"
+      path_info: "/api/v1/users.json"
       path_params:
         action: index
         controller: api/v1/users

data/features/schema_suffixes.feature

@@ -46,7 +46,7 @@ Feature: schema suffixes
             example: 1
         required: []
       extensions:
-        path_info: "/api/v1/users/razum2um/repos/lurker"
+        path_info: "/api/v1/users/razum2um/repos/lurker.json"
         method: PATCH
         suffix: ''
         path_params:
@@ -71,7 +71,7 @@ Feature: schema suffixes
 
         it "updates a repo name" do
           expect {
-            patch "/api/v1/users/#{user.name}/repos/#{repo.name}", repo: { name: 'updated-name' }
+            patch "/api/v1/users/#{user.name}/repos/#{repo.name}.json", repo: { name: 'updated-name' }
             expect(response).to be_success
           }.to change { repo.reload.name } .from('lurker').to('updated-name')
         end
@@ -117,7 +117,7 @@ Feature: schema suffixes
                   type: string
                   example: can't be blank
       extensions:
-        path_info: "/api/v1/users/razum2um/repos/lurker"
+        path_info: "/api/v1/users/razum2um/repos.json"
         method: PATCH
         suffix: 'failed'
         path_params:
@@ -142,7 +142,7 @@ Feature: schema suffixes
 
         it "fails to update a repo with a blank name", lurker: 'failed' do
           expect {
-            patch "/api/v1/users/#{user.name}/repos/#{repo.name}", repo: { name: '' }
+            patch "/api/v1/users/#{user.name}/repos/#{repo.name}.json", repo: { name: '' }
             expect(response).not_to be_success
           }.not_to change { repo.reload.name }
         end

data/features/step_definitions/additional_cli_steps.rb

@@ -69,6 +69,15 @@ Then /^the output should contain (failures|these lines):$/ do |_, lines|
   end
 end
 
+Then /^the output should contain unescaped (failures|these lines):$/ do |_, lines|
+  out = all_output.dup
+  lines.split(/\n/).map(&:strip).each do |line|
+    next if line.blank?
+    expect(out).to match /#{line}/
+    out.gsub!(/.*?#{line}/m, '')
+  end
+end
+
 Then(/^I should see JSON response with "([^"]*)"$/) do |name|
   within(find(:xpath, "//*[@id='show-api-response-div']")) do
     expect(page).to have_content name

data/features/support/env.rb

@@ -41,7 +41,7 @@ Before do
     system "bin/spring stop"
     FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/lurker', __FILE__)
     FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/html', __FILE__)
-    FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/request', __FILE__)
+    FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/requests', __FILE__)
     FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/controllers', __FILE__)
   end
 end

data/features/test_endpoint.feature

@@ -86,8 +86,8 @@ Feature: test endpoint
         end
 
         it "updates a user" do
-          patch :update, id: user.id, user: { name: 1 }
-          expect(response).not_to be_success
+          patch :update, id: user.id, user: { name: 1 }, format: 'json'
+          expect(response).to be_success
         end
       end
       """
@@ -103,7 +103,7 @@ Feature: test endpoint
     """
 
   Scenario: json schema tests response parameters and tell what fails using "users/update"
-    Given a file named "spec/controllers/api/v1/users_controller_spec.rb" with:
+    Given a file named "spec/controllers/api/v1/users_controller_blank_spec.rb" with:
       """ruby
       require "spec_helper"
 
@@ -115,13 +115,13 @@ Feature: test endpoint
         end
 
         it "updates a user" do
-          patch :update, id: user.id, user: { name: '' }
+          patch :update, id: user.id, user: { name: '' }, format: 'json'
           expect(response).not_to be_success
         end
       end
       """
 
-  When I run `bin/rspec spec/controllers/api/v1/users_controller_spec.rb`
+  When I run `bin/rspec spec/controllers/api/v1/users_controller_blank_spec.rb`
   Then the output should contain failures:
     """
     Lurker::ValidationError:

data/lib/lurker.rb

@@ -3,6 +3,18 @@ $:.unshift(File.dirname(__FILE__))
 module Lurker
   DEFAULT_SERVICE_PATH = DEFAULT_URL_BASE = "lurker"
 
+  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.scaffold_mode?
     ENV['LURKER_SCAFFOLD']
   end
@@ -51,6 +63,9 @@ require 'lurker/presenters/service_presenter'
 require 'lurker/presenters/endpoint_presenter'
 require 'lurker/presenters/schema_presenter'
 require 'lurker/presenters/response_code_presenter'
+require 'lurker/spy'
+require 'lurker/request'
+require 'lurker/response'
 
 if defined? Rails
   require 'lurker/engine'

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/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/request.rb

@@ -0,0 +1,41 @@
+require 'hashie/dash'
+
+module Lurker
+  class Request < Hashie::Dash
+    PREFIX = 'action_dispatch.request'
+
+    property :verb, required: true
+    property :endpoint_path, required: true
+    property :payload, default: {}
+
+    # ext
+    property :path_info, required: true
+    property :path_params, default: {}
+    property :query_params, default: {}
+
+    def self.build_from_action_dispatch(request)
+      new(
+        verb: request.method,
+        endpoint_path: route_name(request),
+        path_info: request.path_info,
+        path_params: request.env["#{PREFIX}.path_parameters"].stringify_keys.except('format'),
+        query_params: request.env["#{PREFIX}.query_parameters"],
+        payload: request.env["#{PREFIX}.request_parameters"].merge(
+          request.env["#{PREFIX}.query_parameters"]
+        ).stringify_keys.except('action', "controller", 'format', '_method')
+      )
+    end
+
+    def self.reject_internal(hash)
+
+    end
+
+    def self.route_name(request)
+      if defined? Rails
+        Rails.application.routes.router.recognize(request) do |route, _|
+          return route.path.spec.to_s.sub('(.:format)', '')
+        end
+      end
+    end
+  end
+end

data/lib/lurker/response.rb

@@ -0,0 +1,16 @@
+require 'json'
+require 'hashie/dash'
+
+module Lurker
+  class Response < Hashie::Dash
+    property :status, required: true
+    property :body, default: {}
+
+    def self.build_from_action_dispatch(response)
+      new(
+        status: response.status,
+        body: (JSON.parse(response.body) rescue {})
+      )
+    end
+  end
+end

data/lib/lurker/schema.rb

@@ -1,4 +1,3 @@
-require 'diffy'
 require 'yaml'
 
 module Lurker
@@ -31,13 +30,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"

data/lib/lurker/service.rb

@@ -43,8 +43,8 @@ class Lurker::Service
     @opened_endpoints.each { |e| e.persist! if e.respond_to? :persist! }
   end
 
-  def verify!(verb, path, extensions, request_params, response_params,
-                   response_status, successful)
+  def verify!(verb, path, request_params,
+              extensions, response_status, response_params, successful=true)
     endpoint = open(verb, path, extensions)
     endpoint.consume!(request_params, response_params, response_status, successful)
   end

data/lib/lurker/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'lurker/spec_helper/rails'
+require 'lurker/spec_helper/rspec'

data/lib/lurker/spec_helper/rails.rb

@@ -0,0 +1,40 @@
+require 'lurker/spy'
+
+module Lurker
+  module SpecHelper
+    module Rails
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        module LurkerSession
+          def process(*)
+            super.tap do
+              if Lurker::Spy.enabled?
+                [:@request, :@response].each do |iv_name|
+                  if !instance_variable_defined?(iv_name) || instance_variable_get(iv_name).nil?
+                    raise Lurker::Spy::BlindError.new("#{iv_name} is nil: make sure you set it in your test's setup method.")
+                  end
+                end
+
+                Lurker::Spy.current.request  = Lurker::Request.build_from_action_dispatch(@request)
+                Lurker::Spy.current.response = Lurker::Response.build_from_action_dispatch(@response)
+              end
+            end
+          end
+        end
+
+        def new(*)
+          super.extend(LurkerSession)
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActionDispatch::Integration::Session)
+  ActionDispatch::Integration::Session.send :include, Lurker::SpecHelper::Rails
+end
+
+if defined?(ActionController::TestCase::Behavior)
+  ActionController::TestCase::Behavior.send :include, Lurker::SpecHelper::Rails
+end

data/lib/lurker/spec_helper/rspec.rb

@@ -0,0 +1,66 @@
+require 'lurker/spy'
+
+module Lurker
+  module SpecHelper
+    module Rspec
+      extend ActiveSupport::Concern
+      ACTIONS = [:get, :post, :put, :delete, :patch].freeze
+
+      included do
+        ACTIONS.each do |verb|
+          send(:define_method, "#{verb}_with_lurker") do |*params|
+            action, request_params, env = params
+
+            request_params ||= {}
+            env ||= {}
+
+            # obsolete, support controller -> request migration
+            # supports `get :index` in request specs
+            if @_example && @_example.metadata[:type] == :request && action.is_a?(Symbol)
+              unless @_example.metadata.described_class.is_a?(Class)
+                raise 'cannot determine request url: provide proper described class like: "describe MyController do"'
+              end
+              controller_name = @_example.metadata.described_class.name.tableize.gsub(/_controllers$/, '')
+              action = URI.parse(url_for({ controller: controller_name, action: action }.merge(request_params))).path
+            end
+
+            send("#{verb}_without_lurker", action, request_params, env)
+          end
+
+          begin
+            send :alias_method_chain, verb, :lurker
+          rescue NameError
+            # no patch in Rails3.2
+            if verb == :patch
+              alias_method :patch_without_lurker, :put_without_lurker
+              alias_method :patch, :patch_with_lurker
+            else
+              raise
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if defined?(RSpec) && RSpec.respond_to?(:configure)
+  RSpec.configure do |config|
+    config.include Lurker::SpecHelper::Rspec, type: :controller
+    config.include Lurker::SpecHelper::Rspec, type: :request
+
+    lurker = ->(example) {
+      # RSpec::Core::ExampleGroup::Nested_1 === self
+      @_example = example
+
+      if (metadata = example.metadata[:lurker]).present?
+        Lurker::Spy.on(suffix: metadata, &example)
+      else
+        example.call
+      end
+    }
+
+    config.around(:each, type: :controller, &lurker)
+    config.around(:each, type: :request, &lurker)
+  end
+end

data/lib/lurker/spy.rb

@@ -0,0 +1,88 @@
+require 'json'
+
+module Lurker
+  class Spy
+    class BlindError < StandardError; end
+
+    attr_reader :block, :service
+    attr_accessor :request, :response
+
+    extend Forwardable
+    delegate [:verb, :payload] => :request
+    delegate [:status, :body] => :response
+
+    def initialize(options={}, &block)
+      @options = options
+      @block = block
+
+      @service = if defined?(Rails)
+        Service.new(Rails.root.join(DEFAULT_SERVICE_PATH).to_s, Rails.application.class.parent_name)
+      else
+        Service.default_service
+      end
+    end
+
+    def call
+      @request = @response = nil # fill in while test
+      @block.call.tap do |result|
+        if @request && @response
+          @service.verify!(
+            verb, endpoint_path, payload,
+            extensions, status, body
+          )
+
+          @service.persist! if success?(result)
+        end
+      end
+    end
+
+    def endpoint_path
+      [request.endpoint_path, suffix].compact.join('-')
+    end
+
+    def extensions
+      extensions = {
+        path_params: request.path_params,
+        path_info: request.path_info,
+        method: request.verb,
+        suffix: suffix.to_s,
+      }
+      unless request.query_params.empty?
+        extensions[:query_params] = request.query_params
+      end
+      extensions
+    end
+
+    def suffix
+      if (suffix = @options[:suffix]).is_a?(String)
+        suffix.gsub(/[^[[:alnum:]]]/, '_')
+      end
+    end
+
+    def success?(result)
+      if defined?(::Minitest::Test) && result.is_a?(::Minitest::Test)
+        result.failure.nil?
+      elsif result.is_a?(Exception)
+        false
+      else
+        result
+      end
+    end
+    private :success?
+
+    def self.on(options={}, &block)
+      require 'lurker/spec_helper' unless defined? Lurker::SpecHelper
+      (Thread.current[:lurker_spy] ||= new(options, &block)).tap do |spy|
+        spy.call
+      end
+    end
+
+    def self.enabled?
+      current.present?
+    end
+
+    def self.current
+      Thread.current[:lurker_spy]
+    end
+  end
+end