lurker 0.6.6 → 0.6.7

data/features/request_nested_schema_scaffolding.feature

@@ -8,7 +8,6 @@ Feature: request nested schema scaffolding
       require "spec_helper"
 
       describe Api::V1::ReposController, :lurker do
-
         let!(:user) do
           User.where(name: 'razum2um').first_or_create!.tap do |u|
             u.repos.first_or_create!(name: 'lurker')
@@ -16,7 +15,7 @@ Feature: request nested schema scaffolding
         end
 
         it "shows a user's repo" do
-          get "api/v1/users/#{user.id}/repos/#{user.repos.first.id}.json"
+          get "/api/v1/users/#{user.id}/repos/#{user.repos.first.id}.json"
           expect(response).to be_success
         end
       end
@@ -62,9 +61,10 @@ Feature: request nested schema scaffolding
       method: GET
       path_info: "/api/v1/users/1/repos/1.json"
       path_params:
-        action: show
         controller: api/v1/repos
+        action: show
         user_id: '1'
         id: '1'
 
     """
+

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.json?limit=1"
+          get "/api/v1/users.json?limit=1"
           expect(response).to be_success
           expect(JSON.parse(response.body).size).to eq 1
         end
@@ -72,9 +72,10 @@ Feature: request schema scaffolding
       method: GET
       path_info: "/api/v1/users.json"
       path_params:
-        action: index
         controller: api/v1/users
+        action: index
       query_params:
         limit: '1'
 
     """
+

data/features/schema_suffixes.feature

@@ -49,8 +49,8 @@ Feature: schema suffixes
         path_info: "/api/v1/users/razum2um/repos/lurker.json"
         method: PATCH
         path_params:
-          action: update
           controller: api/v1/repos
+          action: update
           user_id: razum2um
           id: lurker
       """
@@ -120,8 +120,8 @@ Feature: schema suffixes
         method: PATCH
         suffix: 'failed'
         path_params:
-          action: update
           controller: api/v1/repos
+          action: update
           user_id: razum2um
           id: lurker
       """

data/features/schema_updating_within_test_suite.feature

@@ -54,9 +54,9 @@ Feature: schema updating within test suite
       method: PATCH
       path_info: "/api/v2/users/1"
       path_params:
-        id: '1'
         controller: api/v2/users
         action: update
+        id: '1'
     """
 
   Scenario: json schema tests response parameters and request parameters and show errors from both using "users/update"
@@ -166,8 +166,9 @@ Feature: schema updating within test suite
       method: PATCH
       path_info: "/api/v2/users/1"
       path_params:
-        id: '1'
         controller: api/v2/users
         action: update
+        id: '1'
 
     """
+

data/features/step_definitions/additional_cli_steps.rb

@@ -6,10 +6,16 @@ Given /^a checked file "([^"]*)" with:$/ do |file_name, file_content|
 end
 
 Given /^an empty directory named "([^"]*)"$/ do |dir_name|
-  FileUtils.rm_rf File.expand_path("../../../tmp/lurker_app/#{dir_name}", __FILE__)
+  in_current_dir { _rm_rf(dir_name) }
   create_dir(dir_name)
 end
 
+Given /^a service file with:$/ do |file_content|
+  in_current_dir do
+    write_file("#{Lurker::DEFAULT_SERVICE_PATH}/#{Rails.application.class.parent_name}#{Lurker::Service::SUFFIX}", file_content)
+  end
+end
+
 When /^I go to "([^"]*)"$/ do |url|
   visit(url)
 end

data/features/support/env.rb

@@ -6,6 +6,14 @@ SimpleCov.start do
   end
 end
 
+def example_path
+  if rails_version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_\d\d/)
+    File.expand_path("../../../tmp/lurker_app_#{rails_version}", __FILE__)
+  else
+    raise "Use `appraisal rails-XY cucumber ...` or export BUNDLE_GEMFILE=gemfiles/... explicitly"
+  end
+end
+
 require 'fileutils'
 require 'aruba/cucumber'
 
@@ -16,7 +24,7 @@ require 'capybara'
 require 'capybara/dsl'
 require 'capybara/cucumber'
 require 'capybara/poltergeist'
-require File.expand_path('../../../tmp/lurker_app/config/environment', __FILE__)
+require "#{example_path}/config/environment"
 require 'database_cleaner'
 require 'database_cleaner/cucumber'
 
@@ -34,15 +42,14 @@ Aruba.configure do |config|
 end
 
 Before do
-  @dirs = ["tmp/lurker_app"]
+  @dirs = [example_path]
   @aruba_timeout_seconds = 30
   DatabaseCleaner.start
   if ENV['CLEAN']
     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/requests', __FILE__)
-    FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/controllers', __FILE__)
+    %w[lurker html public/lurker spec/requests spec/controllers].each do |dir_name|
+      in_current_dir { _rm_rf(dir_name) }
+    end
   end
 end
 

data/features/test_endpoint.feature

@@ -48,8 +48,8 @@ Feature: test endpoint
         path_info: "/api/v1/users/1"
         method: PATCH
         path_params:
-          action: update
           controller: api/v1/users
+          action: update
           id: 1
       """
 
@@ -75,35 +75,6 @@ Feature: test endpoint
   When I run `bin/rspec spec/controllers/api/v1/users_controller_spec.rb`
   Then the example should pass
 
-  Scenario: json schema tests request parameters and tell what fails using "users/update"
-    Given a file named "spec/controllers/api/v1/users_controller_spec.rb" with:
-      """ruby
-      require "spec_helper"
-
-      describe Api::V1::UsersController, :lurker do
-        render_views
-
-        let(:user) do
-          User.where(name: 'razum2um').first_or_create!
-        end
-
-        it "updates a user" do
-          patch :update, id: user.id, user: { name: 1 }, format: 'json'
-          expect(response).to be_success
-        end
-      end
-      """
-
-  When I run `bin/rspec spec/controllers/api/v1/users_controller_spec.rb`
-  Then the output should contain failures:
-    """
-    Lurker::ValidationError:
-      Response
-        The property '#/name' of type Fixnum did not match the following type: string
-
-    1 example, 1 failure
-    """
-
   Scenario: json schema tests response parameters and tell what fails using "users/update"
     Given a file named "spec/controllers/api/v1/users_controller_blank_spec.rb" with:
       """ruby
@@ -132,3 +103,4 @@ Feature: test endpoint
 
     1 example, 1 failure
     """
+

data/gemfiles/rails_32.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.21"
+
+group :development do
+  gem "pry-byebug", :platforms => [:mri_20, :mri_21, :mri_22]
+  gem "pry-debugger", :platforms => :mri_19
+  gem "pry-stack_explorer", :platform => :mri
+  gem "pry-session", :platform => :mri
+  gem "fuubar"
+  gem "fuubar-cucumber"
+  gem "selenium-webdriver"
+  gem "highline"
+  gem "appraisal", :github => "razum2um/appraisal", :branch => "master"
+  gem "sprockets"
+  gem "uglifier"
+  gem "sass-rails"
+  gem "coffee-rails"
+  gem "bootstrap-sass", "~> 3.3.3"
+  gem "jquery-rails"
+  gem "remotipart"
+  gem "launchy"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.13"
+
+group :development do
+  gem "pry-byebug", :platforms => [:mri_20, :mri_21, :mri_22]
+  gem "pry-debugger", :platforms => :mri_19
+  gem "pry-stack_explorer", :platform => :mri
+  gem "pry-session", :platform => :mri
+  gem "fuubar"
+  gem "fuubar-cucumber"
+  gem "selenium-webdriver"
+  gem "highline"
+  gem "appraisal", :github => "razum2um/appraisal", :branch => "master"
+  gem "sprockets"
+  gem "uglifier"
+  gem "sass-rails"
+  gem "coffee-rails"
+  gem "bootstrap-sass", "~> 3.3.3"
+  gem "jquery-rails"
+  gem "remotipart"
+  gem "launchy"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.9"
+
+group :development do
+  gem "pry-byebug", :platforms => [:mri_20, :mri_21, :mri_22]
+  gem "pry-debugger", :platforms => :mri_19
+  gem "pry-stack_explorer", :platform => :mri
+  gem "pry-session", :platform => :mri
+  gem "fuubar"
+  gem "fuubar-cucumber"
+  gem "selenium-webdriver"
+  gem "highline"
+  gem "appraisal", :github => "razum2um/appraisal", :branch => "master"
+  gem "sprockets"
+  gem "uglifier"
+  gem "sass-rails"
+  gem "coffee-rails"
+  gem "bootstrap-sass", "~> 3.3.3"
+  gem "jquery-rails"
+  gem "remotipart"
+  gem "launchy"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+group :development do
+  gem "pry-byebug", :platforms => [:mri_20, :mri_21, :mri_22]
+  gem "pry-debugger", :platforms => :mri_19
+  gem "pry-stack_explorer", :platform => :mri
+  gem "pry-session", :platform => :mri
+  gem "fuubar"
+  gem "fuubar-cucumber"
+  gem "selenium-webdriver"
+  gem "highline"
+  gem "appraisal", :github => "razum2um/appraisal", :branch => "master"
+  gem "sprockets"
+  gem "uglifier"
+  gem "sass-rails"
+  gem "coffee-rails"
+  gem "bootstrap-sass", "~> 3.3.3"
+  gem "jquery-rails"
+  gem "remotipart"
+  gem "launchy"
+end
+
+gemspec :path => "../"

data/lib/lurker.rb

@@ -85,10 +85,10 @@ require 'lurker/json/schema/extensions'
 require 'lurker/json/schema/response_codes'
 require 'lurker/json/schema/reference'
 require 'lurker/spy'
+require 'lurker/server'
 require 'lurker/request'
 require 'lurker/response'
 
 if defined? Rails
-  require 'lurker/engine'
   require 'lurker/sandbox'
 end

data/lib/lurker/cli.rb

@@ -1,15 +1,13 @@
 require 'thor'
 require 'execjs'
 require 'digest/sha1'
-require 'lurker/service'
+require 'lurker'
+require 'active_support/inflector'
 
 module Lurker
   # A Thor::Error to be thrown when an lurker directory is not found
   class NotFound < Thor::Error; end
 
-  # A Thor::Error to be thrown when an lurker output destination is unavailable
-  class NotADirectory < Thor::Error; end
-
   # A Thor definition for an lurker to HTML conversion operation
   class Cli < Thor
     include Thor::Actions
@@ -28,8 +26,8 @@ module Lurker
     method_option :rails, :type => :boolean, :desc => "Includes Rails environment"
     method_option :exclude, :aliases => "-e", :desc => "Select endpoints by given regexp, if NOT matching prefix"
     method_option :select, :aliases => "-s", :desc => "Select endpoints by given regexp, matching prefix"
-    method_option :output, :aliases => "-o", :desc => "Output path"
-    method_option :url_base_path, :aliases => "-u", :desc => "URL base path"
+    method_option :output, :aliases => "-o", :desc => "Output path", :default => "public"
+    method_option :url_base_path, :aliases => "-u", :desc => "URL base path", :default => Lurker::DEFAULT_URL_BASE
     method_option :format, :aliases => "-f", :desc => "Format in html or pdf, defaults to html", :default => "html"
     method_option :templates, :aliases => "-t", :desc => "Template overrides path"
     method_option :content, :aliases => "-c", :desc => "Content to be rendered into html-docs main page"
@@ -41,8 +39,7 @@ module Lurker
       raise Lurker::NotFound.new(origin_path) unless has_valid_origin?
       say_status :using, lurker_path
 
-      self.destination_root = output_path
-      raise Lurker::NotADirectory.new(output_path) unless has_valid_destination?
+      FileUtils.mkdir_p(output_path)
       say_status :inside, output_path
 
       if options[:rails]
@@ -60,7 +57,7 @@ module Lurker
       def convert_to_pdf
         Lurker.safe_require('pdfkit')
         css = File.expand_path('application.css', self.class.precompiled_static_root)
-        in_root do
+        inside(output_path) do
           service_presenters.each do |service_presenter|
             html = "<html><body>"
             service_presenter.endpoints.each do |endpoint_prefix_group|
@@ -71,13 +68,14 @@ module Lurker
             html << "</body></html>"
             kit = PDFKit.new(html, :page_size => 'Letter')
             kit.stylesheets << css
-            create_file("#{service_presenter.name}.pdf", kit.to_pdf, force: true)
+            url_name = ActiveSupport::Inflector.parameterize(service_presenter.name, '_')
+            create_file("#{url_name}.pdf", kit.to_pdf, force: true)
           end
         end
       end
 
       def convert_to_html
-        in_root do
+        inside(output_path) do
           # js, css, fonts
           static = []
           Dir["#{self.class.precompiled_static_root}/*"].each do |fname|
@@ -85,11 +83,10 @@ module Lurker
               sha1 = Digest::SHA1.hexdigest(open(fname).read)
               html_options.merge! match[1] => sha1
               static << (new_name = "application-#{sha1}.#{match[1]}")
-              to = destination.join(new_name).to_s
-              FileUtils.cp_r fname, to
-              spawn "cat #{to} | gzip -9 > #{to}.gz"
+              FileUtils.cp_r fname, new_name
+              spawn "cat #{new_name} | gzip -9 > #{new_name}.gz"
             else
-              FileUtils.cp_r fname, destination.to_s
+              FileUtils.cp_r fname, Pathname.new(fname).basename.to_s
             end
           end
 
@@ -117,12 +114,17 @@ module Lurker
       end
 
       def output_path
-        @output_path ||=
-          if options[:output]
-            File.expand_path(options[:output])
-          else
-            File.expand_path("../#{options[:format]}", origin_path)
-          end
+        "#{output_prefix}/#{url_base_path}"
+      end
+
+      def output_prefix
+        if explicit = options[:output]
+          explicit.sub(/\/?#{url_base_path}\/?$/, '')
+        elsif File.exists? "public"
+          "public"
+        else
+          raise "Please, run it from `Rails.root` or pass `-o` option"
+        end
       end
 
       def template_path
@@ -138,10 +140,6 @@ module Lurker
         origin.directory?
       end
 
-      def has_valid_destination?
-        !destination.exist? || destination.directory?
-      end
-
       def service_presenters
         @service_presenters ||= services.map do |service|
           Lurker::ServicePresenter.new(service, html_options, &filtering_block)
@@ -170,9 +168,9 @@ module Lurker
       def html_options
         @html_options ||= {
           :static_html => true,
-          :url_base_path => options[:url_base_path].presence || "/#{Lurker::DEFAULT_URL_BASE}",
+          :url_base_path => url_base_path.prepend('/'),
           :template_directory => template_path,
-          :html_directory => destination_root,
+          :html_directory => output_path,
           :content => self.content,
           :footer => (`git rev-parse --short HEAD`.to_s.strip rescue ""),
           :lurker => gem_info
@@ -182,6 +180,10 @@ module Lurker
 
     private
 
+    def url_base_path
+      options[:url_base_path].presence.try(:strip).try(:sub, /^\/+/, '') || Lurker::DEFAULT_URL_BASE
+    end
+
     def gem_info
       spec = if Bundler.respond_to? :locked_gems
         Bundler.locked_gems.specs.select { |s| s.name == 'lurker' } .first # 1.6
@@ -217,9 +219,5 @@ module Lurker
     def origin
       Pathname.new(origin_path)
     end
-
-    def destination
-      Pathname.new(destination_root)
-    end
   end
 end