lurker 0.6.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8710a38d2b594c7b8815088eafb1ff6fc1c6a6e1
-  data.tar.gz: 2268040574bef1e336e18ae8b02b53547bb47762
+SHA256:
+  metadata.gz: 74bcb914a737099b70ce82f674ad54cfa5c0f1e47745a07f0329d2b681023ebb
+  data.tar.gz: 227765d414c360ae6b1e1312d0c5234bf6e6f30b8d09079b347dcbf8c80e90cf
 SHA512:
-  metadata.gz: 95492962813614aa5a269f44332428c0ff2246e7fc4485816090c91607a6c6960ed11db798c3e5b65d5ed9ccd0c4f54ca49c00c01dbb29b96129ba7b6a9c08cb
-  data.tar.gz: 1f9428ffafb6f5bab56b4795956fb021614d192498652e87a3655158d23c7dbf486f5b1f81cdd1f3e5774754dce2920765b80b9082b52f22c48ae487f90bbca3
+  metadata.gz: 90c753d8f6934b63fcff5a9abf62e17e71a1d578d93a9a774cccfa30186d8437f8c40d6adbcda8c24a5bce5105e3c75274292252626193b05a8c6985b5b1ea3f
+  data.tar.gz: 32e85f3c317c41425983bca85a6dd7a53476c1ecb0647897b6897a89f8047fa0419ebd5822f2cdf377d7216b23864ef5178c22f539c5a6e64ab831e8224c0088

data/.rspec

@@ -1,2 +1 @@
---colour
---format Fuubar
+--color

data/.travis.yml

@@ -1,21 +1,31 @@
 language: ruby
-sudo: false
-before_install: gem install bundler
-gemfile:
-  - gemfiles/rails_32.gemfile
-  - gemfiles/rails_40.gemfile
-  - gemfiles/rails_41.gemfile
-  - gemfiles/rails_42.gemfile
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-matrix:
-  exclude:
-    # NOTE : incompatible
-    - rvm: 2.2.0
-      gemfile: gemfiles/rails_32.gemfile
-install: bundle install -j4 --path vendor/bundle
-notifications:
-    slack: evilmartians:3TVEqLTmDrMKUZZqUIy9apFT
+dist: xenial
+group: dev
+cache: bundler
+before_install:
+  - if [ $BUNDLER_VERSION ]; then
+      rm -f $(which bundle);
+      rvm @global do gem uninstall bundler --executables --force;
+      rvm @global do gem install bundler --force -v $BUNDLER_VERSION;
+    else
+      gem install bundler --no-document;
+    fi
+services:
+  - postgresql
+env:
+  - CUCUMBER_PUBLISH_QUIET=true
+jobs:
+  fast_finish: true
+  include:
+    - rvm: 2.6.5
+      env:  BUNDLER_VERSION=1.17.3 CUCUMBER_PUBLISH_QUIET=true
+      gemfile: gemfiles/rails_4.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_5.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_6.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_5.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_6.gemfile
+  

data/Gemfile

@@ -1,34 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-group :development do
-  # tools
-  platforms :mri_20, :mri_21, :mri_22 do
-    gem 'pry-byebug'
-    gem 'pry-stack_explorer'
-    gem 'pry-session'
-  end
-  # rspec --format fuubar
-  gem 'fuubar'
-  # cucumber --format fuubar
-  gem 'fuubar-cucumber'
-  gem 'selenium-webdriver'
-
-  # deploy site
-  gem 'highline'
-  # gem 'coderay', path: '../coderay'
-
-  # multiple rails versions support
-  gem 'appraisal'
-
-  # build template static
-  # run `rake assets:precompile`
-  # to get bundled application.(js|css)
-  gem 'uglifier'
-  gem 'coffee-rails'
-  gem 'bootstrap-sass', '~> 3.3.3'
-  gem 'jquery-rails'
-  gem 'remotipart'
-  gem 'launchy'
-end
-

data/README.md

@@ -3,29 +3,12 @@
 <img align="right" width="94" height="71" src="https://cdn.rawgit.com/razum2um/lurker/master/lurker-bw.svg">
 
 Generates API schemas, validates code against them and creates a handy web interface for testing the API.
-Works on Rails 3.2, 4.0, 4.1, 4.2 & Ruby 1.9.3, 2.0.0, 2.1.5, 2.2.0
+Tested on on Rails 4, 5, 6 and Ruby >= 2.6
 
 [![Gem Version][GV img]][Gem Version]
 [![Build Status][BS img]][Build Status]
 [![Dependency Status][DS img]][Dependency Status]
 
-## Installation
-
-Add my public key:
-
-    gem cert --add <(curl -Ls https://raw.github.com/razum2um/lurker/master/certs/razum2um.pem)
-
-    $ gem install lurker                 # without key
-    $ gem install lurker -P HighSecurity # secure, with key added
-
-Or this line to your application's Gemfile:
-
-    gem 'lurker'
-
-Inject into `test_helper.rb` or `spec_helper.rb`:
-
-    require 'lurker/spec_helper'
-
 ## Usage
 
 Wrap your integration test code, which does request like this
@@ -115,9 +98,10 @@ You can run this to get the demo running locally:
 
     git clone https://github.com/razum2um/lurker.git
     cd lurker
-    bundle exec appraisal rails-42 bundle install
-    bundle exec appraisal rails-42 rake build_example_docs
-    cd tmp/lurker_app_rails_42
+    export BUNDLE_GEMFILE=gemfiles/rails_6.gemfile
+    bundle install
+    rake build_example_docs
+    cd tmp/lurker_app_rails_6
     bin/rails s
 
 Lurker supports multiple domains (usually `staging` and `production`) and can be deployed
@@ -126,8 +110,7 @@ statically everywhere as well as be served by the current `Rails` instance.
 For example:
 
 - [Github Pages][demo_app3] is deployed statically; no API endpoint
-- [Custom domain][demo_app2] HTML deployed under nginx; passenger serves demo api production endpoint
-- [Heroku][demo_app] HTML is served by unicorn as well as staging api endpoint in `Sandbox` mode
+- [Custom domain][demo_app2] static + demo api production endpoint (in `Sandbox` mode)
 
 ## Features
 
@@ -178,17 +161,12 @@ are increasing notwithstanding ROLLBACK is called. As such:
 [![Inline docs](http://inch-pages.github.io/github/razum2um/lurker.png)](http://inch-pages.github.io/github/razum2um/lurker)
 [![Stories in Ready](https://badge.waffle.io/razum2um/lurker.png?label=ready&title=Ready&_=1)][waffle]
 
-I try to use [Waffle][waffle] to develop this gem, if you want to help:
-
-- look on "Ready" section
-- drag an issue to "In Progress" and assign to yourself
-- have fun!
-
 **NOTE:** to get new version of bundled `bootstrap` or update JS/CSS,
 don't touch files under `lib/lurker/templates/public` - they are autogenerated
 and copied to static generated site while `bin/lurker convert`
 
-    bundle exec appraisal rails-42 rake assets:precompile # to build them
+    export BUNDLE_GEMFILE=gemfiles/rails_6.gemfile
+    rake assets:precompile # to build them
 
 Don't commit `lib/lurker/templates/public/**/*` to avoid conflicts.
 
@@ -198,20 +176,6 @@ features in a way to generate **new** relevant `lurker/**/*.json.yml` files
 
 **NOTE:** template partial `submit_form.html.erb` and it's partials is a big `jsx` script for `React`
 so there are `<label htmlFor` instead of `<label for>` and `<div className` instead of `<div class`
-
-### Different Rails versions
-
-We use [`appraisal`](https://github.com/thoughtbot/appraisal) to test the lib with different Rails versions (from 3.2 up to 4.2):
-
-    # run this to install all gems for all the supported rails versions:
-    bundle exec appraisal install
-
-    # then prefix any rake command with `bundle exec appraisal` and rails version
-    bundle exec appraisal rails-42 rake build_example_docs
-
-Test apps are getting generated into their's directory under `tmp/lurker_app...` prefix. They also use
-separate databases for each rails version both dev & test env - all prefixed with `lurker_app`
-
 ### Demo app == Testing app
 
 Currently, the testing application is using PostgreSQL because **the same** testing app is deployed to serve demo purposes.
@@ -219,14 +183,12 @@ Currently, the testing application is using PostgreSQL because **the same** test
 This is also the reason not to delete anything under `lurker` directory between feature tests
 and using **different** API endpoints of the testing app. To run cucumber with clean `lurker` & `public/lurker` directories run:
 
-    CLEAN=1 bundle exec appraisal rails-42 cucumber features
+    CLEAN=1 export BUNDLE_GEMFILE=gemfiles/rails_6.gemfile bundle exec cucumber features
 
 Beware while writing your feature tests for PRs.
 
 ## Acknowledgments
 
-[![Sponsored by Evil Martians](https://evilmartians.com/badges/sponsored-by-evil-martians.svg)](http://evilmartians.com/)
-
 This gem is quite opinionated and relies on rails - if you're
 interested in anything else, please take a look at [api_taster][api_taster] or [fdoc][fdoc],
 This gem is heavily inspired by them. Thanks, @square & @fredwu
@@ -234,6 +196,7 @@ This gem is heavily inspired by them. Thanks, @square & @fredwu
 Also thanks to
 
 - [Andrey Deryabin][aderyabin] for advice
+- [Evil Martians][evil_martians] initial version sponsors
 - [React.js][reactjs] for reactive UI
 - [highlight.js][hljs] for syntax highlighting
 
@@ -247,7 +210,7 @@ Also thanks to
 [json_schema]: http://json-schema.org/
 [json_schema_example]: http://json-schema.org/example2.html
 [json_schema_book]: http://spacetelescope.github.io/understanding-json-schema/
-[evil_martians]: http://evilmartians.com/
+[evil_martians]: https://evilmartians.com/
 [rspec_controller_spec]: https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs
 [rspec_request_spec]: https://www.relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec
 [minitest_around]: https://github.com/splattael/minitest-around
@@ -261,10 +224,9 @@ Also thanks to
 [suffixes_example]: https://www.relishapp.com/razum2um/lurker/docs/request-schema-suffixes
 [minitest_example]: https://www.relishapp.com/razum2um/lurker/docs/minitest
 
-[demo_app]: http://lurker-app.herokuapp.com
-[demo_app2]: http://lurker.razum2um.me
-[demo_app3]: http://razum2um.github.io/lurker/
-[demo_live]: http://lurker.razum2um.me/lurker/api/v1/users-POST.html
+[demo_app2]: https://lurker.razum2um.me
+[demo_app3]: https://razum2um.github.io/lurker/
+[demo_live]: https://lurker.razum2um.me/lurker/api/v1/users-POST.html
 [pdf_example]: http://razum2um.github.io/lurker/lurker_demo_application.pdf
 [partial_example_demo]: http://razum2um.github.io/lurker/api/v1/users/__user_id/repos-POST.html
 

data/Rakefile

@@ -23,7 +23,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 Cucumber::Rake::Task.new(:cucumber) do |t|
-  t.cucumber_opts = "features --format progress --tags ~@wip"
+  t.cucumber_opts = "features --format progress"
 end
 
 task :default => ["clobber:coverage", :spec, :regenerate, :cucumber, 'coveralls:push']
@@ -32,8 +32,8 @@ desc 'releases gem & updates docs'
 task :publish do
   require 'lurker'
   version = Lurker::VERSION
-
-  Bundler.with_clean_env do
+  bundler_method = Bundler.respond_to?(:with_unbundled_env) ? :with_unbundled_env : :with_clean_env
+  Bundler.send(bundler_method) do
     system "git tag v#{version}"
     system "relish versions:add razum2um/lurker:#{version}"
     system "relish push razum2um/lurker:#{version}"

data/cucumber.yml

@@ -1,2 +1 @@
-default: --require features --format fuubar --tags ~@wip
-wip:     --require features --tags @wip
+default: --require features --format progress

data/features/atom_persistent_within_the_same_type.feature

@@ -59,8 +59,6 @@ Feature: atom persistent within test suite
   Scenario: json schema tests response parameters and keep atom unchanged 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
 
@@ -69,13 +67,15 @@ Feature: atom persistent within test suite
         end
 
         it "updates a user surname as string" do
-          patch :update, id: user.id, user: { surname: 'Marley' }
+              puts Thread.list.to_a.inspect
+
+          patch :update, params: { 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`
+  When I run `bin/rspec -b 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:

data/features/controller_nested_schema_scaffolding.feature

@@ -5,8 +5,6 @@ Feature: controller nested schema scaffolding
   Scenario: scaffold a json schema for a "repos/index" in a nested controller spec
     Given a file named "spec/controllers/api/v1/repos_controller_spec.rb" with:
       """ruby
-      require "spec_helper"
-
       describe Api::V1::ReposController, :lurker do
         render_views
 
@@ -18,7 +16,9 @@ Feature: controller nested schema scaffolding
         end
 
         it "lists all the repos of the user" do
-          get :index, user_id: user.id, limit: 1, format: 'json'
+          # rails 4 doesn't stringify values and schema has integers
+          # rails >= 5 have limit as string & proper query_params extension
+          get :index, params: { user_id: user.id, limit: 1, format: 'json' }
           expect(response).to be_success
           expect(JSON.parse(response.body).size).to eq 1
         end
@@ -28,7 +28,7 @@ Feature: controller nested schema scaffolding
   When I run `bin/rspec spec/controllers/api/v1/repos_controller_spec.rb`
   Then the example should pass
   Then a file named "lurker/api/v1/users/__user_id/repos-GET.json.yml" should exist
-  Then the file "lurker/api/v1/users/__user_id/repos-GET.json.yml" should contain exactly:
+  Then the file "lurker/api/v1/users/__user_id/repos-GET.json.yml" should contain:
     """yml
     ---
     description: repo listing
@@ -40,9 +40,9 @@ Feature: controller nested schema scaffolding
       required: []
       properties:
         limit:
-          description: ''
-          type: integer
-          example: 1
+    """
+  Then the file "lurker/api/v1/users/__user_id/repos-GET.json.yml" should contain:
+    """yml
     responseCodes:
     - status: 200
       successful: true
@@ -74,8 +74,5 @@ Feature: controller nested schema scaffolding
         controller: api/v1/repos
         action: index
         user_id: '1'
-      query_params:
-        limit: 1
-
     """
 

data/features/controller_schema_scaffolding.feature

@@ -7,8 +7,6 @@ Feature: controller schema scaffolding
   Scenario: scaffold a json schema for a "users/show" in controller spec
     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
 
@@ -17,7 +15,7 @@ Feature: controller schema scaffolding
         end
 
         it "shows user" do
-          get :show, id: user.id, format: 'json'
+          get :show, params: { id: user.id, format: 'json' }
           expect(response).to be_success
         end
       end

data/features/dereferencing_through_inlining.feature

@@ -55,8 +55,6 @@ Feature: $ref defererencing through inlining
       """
     And a file named "spec/controllers/api/v3/users_controller_spec.rb" with:
       """ruby
-        require "spec_helper"
-
         describe Api::V3::UsersController, :lurker do
           render_views
 
@@ -65,7 +63,7 @@ Feature: $ref defererencing through inlining
           end
 
           it "updates a user surname as string" do
-            patch :update, id: user.id, user: { surname: 'Marley' }
+            patch :update, params: { id: user.id, user: { surname: 'Marley' } }
             expect(response).to be_success
           end
         end

data/features/html_generation.feature

@@ -15,8 +15,7 @@ Feature: html generation
       basePath: ''
       description: ''
       domains:
-        '[Sandbox] Heroku': 'http://lurker-app.herokuapp.com'
-        '[Real] razum2um.me': 'http://lurker.razum2um.me'
+        'razum2um.me': 'https://lurker.razum2um.me'
       consumes:
       - application/x-www-form-urlencoded
       - application/json
@@ -61,8 +60,8 @@ Feature: html generation
             Converting lurker to html
      using  lurker
 
-    create  public/lurker/index.html
-    create  public/lurker/api/v1/users-POST.html
+    public/lurker/index.html
+    public/lurker/api/v1/users-POST.html
     """
 
   When I go to "/lurker"

data/features/minitest.feature

@@ -49,10 +49,8 @@ Feature: minitest
       description: ''
     responseParameters:
       description: ''
-      type: object
-      additionalProperties: false
-      required: []
-      properties: {}
+      type: boolean
+      example: true
     extensions:
       method: DELETE
       path_info: "/api/v1/users/1/repos/1.json"
@@ -112,7 +110,7 @@ Feature: minitest
           assert_equal 1, User.count
 
           Lurker::Spy.on do
-            patch "/api/v1/users/#{user.id}.json", user: { name: '' }
+            patch "/api/v1/users/#{user.id}.json", params: { user: { name: '' } }
           end
 
           assert_equal 200, status

data/features/multidomain_support.feature

@@ -22,8 +22,7 @@ Feature: mutidomain support
       basePath: ''
       description: ''
       domains:
-        '[Sandbox] Heroku': 'http://lurker-app.herokuapp.com'
-        '[Real] razum2um.me': 'http://lurker.razum2um.me'
+        'razum2um.me': 'https://lurker.razum2um.me'
       name: Lurker Demo Application
       extensions: {}
       """
@@ -55,14 +54,14 @@ Feature: mutidomain support
             Converting lurker to html
      using  lurker
 
-    create  public/lurker/index.html
-    create  public/lurker/api/v1/users/__id-DELETE.html
+    public/lurker/index.html
+    public/lurker/api/v1/users/__id-DELETE.html
     """
 
   When I go to "/lurker/api/v1/users/__id-DELETE.html"
-  When I select "[Sandbox] Heroku" hostname
+  When I select "razum2um.me" hostname
   Then I should see:
     """
-    curl -X DELETE 'http://lurker-app.herokuapp.com/api/v1/users/1'
+    curl -X DELETE 'https://lurker.razum2um.me/api/v1/users/1'
     """