lurker 0.6.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e604c784c2ea3ac2872a5317a5565894f0085fe
-  data.tar.gz: a5d2eb6535c700fe1c0916062b2699b08697af59
+SHA256:
+  metadata.gz: 74bcb914a737099b70ce82f674ad54cfa5c0f1e47745a07f0329d2b681023ebb
+  data.tar.gz: 227765d414c360ae6b1e1312d0c5234bf6e6f30b8d09079b347dcbf8c80e90cf
 SHA512:
-  metadata.gz: ad02702231dd5445dde644e0d98c81302d95d51f6d7e1f90379d942b9b6de03986adcea25a2196817fc817210442808d8244c13f08613ca95454b6fe534680d6
-  data.tar.gz: 13c23cac89fea2961d911d7e5ccaf8d07186949ca57b79ce20571686db1a5a5dde2ebfe82df8562c7200ab01cdfeed63996ab256e1d4ec6b984bc14a538b00a9
+  metadata.gz: 90c753d8f6934b63fcff5a9abf62e17e71a1d578d93a9a774cccfa30186d8437f8c40d6adbcda8c24a5bce5105e3c75274292252626193b05a8c6985b5b1ea3f
+  data.tar.gz: 32e85f3c317c41425983bca85a6dd7a53476c1ecb0647897b6897a89f8047fa0419ebd5822f2cdf377d7216b23864ef5178c22f539c5a6e64ab831e8224c0088

data/.hound.yml

@@ -1,80 +1,6 @@
-AllCops:
-  Exclude:
-    - 'tmp/**/*'
-    - 'templates/rails32_http_patch_support.rb'
+ruby:
+  config_file: .rubocop.yml
 
-TrailingBlankLines:
-  Enabled: false
-
-StringLiterals:
-  Enabled: false
-
-SignalException:
-  Enabled: false
-
-AlignParameters:
-  Enabled: false
-
-MultilineTernaryOperator:
-  Enabled: false
-
-LineLength:
-  Enabled: false
-
-RedundantSelf:
-  Enabled: false
-
-GuardClause:
-  Enabled: false
-
-Next:
-  Enabled: false
-
-SpaceAroundEqualsInParameterDefault:
-  Enabled: false
-
-AssignmentInCondition:
-  Enabled: false
-
-Documentation:
-  Enabled: false
-
-HashSyntax:
-  Enabled: false
-
-PercentLiteralDelimiters:
-  Enabled: false
-
-UnneededPercentQ:
-  Enabled: false
-
-Blocks:
-  Enabled: false
-
-DoubleNegation:
-  Enabled: false
-
-CaseEquality:
-  Enabled: false
-
-SpecialGlobalVars:
-  Enabled: false
-
-UnusedMethodArgument:
-  Enabled: false
-
-UnusedBlockArgument:
-  Enabled: false
-
-CollectionMethods:
-  Enabled: false
-
-TrivialAccessors:
-  Enabled: false
-
-IndentationWidth:
-  Enabled: false
-
-IndentHash:
-  Enabled: false
+javascript:
+  config_file: .jshintrc
 

data/.jshintrc

@@ -0,0 +1,33 @@
+{
+  "asi": false,
+  "bitwise": true,
+  "browser": true,
+  "camelcase": true,
+  "curly": true,
+  "forin": true,
+  "immed": true,
+  "latedef": "nofunc",
+  "maxlen": 120,
+  "newcap": true,
+  "noarg": true,
+  "noempty": true,
+  "nonew": true,
+  "predef": [
+    "$",
+    "jQuery",
+
+    "jasmine",
+    "beforeEach",
+    "describe",
+    "expect",
+    "it",
+
+    "angular",
+    "inject",
+    "module"
+  ],
+  "quotmark": false,
+  "trailing": true,
+  "undef": true,
+  "unused": true
+}

data/.rspec

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

data/.rubocop.yml

@@ -77,4 +77,3 @@ IndentationWidth:
 
 IndentHash:
   Enabled: false
-

data/.travis.yml

@@ -1,20 +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
-
+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,35 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-group :development do
-  # tools
-  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
-  # 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', github: 'razum2um/appraisal', branch: 'master'
-
-  # build template static
-  # run `rake assets:precompile`
-  # to get bundled application.(js|css)
-  gem 'sprockets'
-  gem 'uglifier'
-  gem 'sass-rails'
-  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
@@ -45,6 +28,11 @@ but add `:lurker` mark (like documented [controller example][controler_spec_exam
       get "/api/v1/users.json"
     end
 
+NOTE: If you use `rspec-rails`, it should be required first
+
+    require 'rspec/rails'
+    require 'lurker/spec_helper'
+
 ## Minitest usage
 
 You can use [minitest-around][minitest_around] to wrap your test classes like this:
@@ -92,6 +80,13 @@ The generation of live-documentation is pretty simple:
 
 For different document root or serving URL prefix use `-o` and `-u` options accordingly.
 
+If you want to provide additional documentation for your API (and you probably should),
+you can use separate Markdown files in the schema folder. To generate documentation
+stubs for the current schema:
+
+    bin/lurker init_docs         # generate documentation stubs for the current schema
+
+
 Let's run your `rails s` and visit [http://localhost:3000/lurker/](http://localhost:3000/lurker/)
 (or see [demo][demo_app2] for example)
 
@@ -103,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
@@ -114,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
 
@@ -137,6 +132,11 @@ For example:
 - Builtin Rack middleware `Lurker::Server.to_rack` serves cached digested assets
 - [RSpec][failed_spec_example] & [Minitest][minitest_example] support
 
+## Related gems
+
+- [Swarker](https://github.com/sponomarev/swarker) converts
+  Lurker schemas to [Swagger](http://swagger.io) schema
+
 ## Token authentication with sandbox
 
 `Lurker::Sandbox` allows you to test services with token authentication:
@@ -161,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.
 
@@ -181,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.
@@ -202,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
@@ -217,7 +196,8 @@ This gem is heavily inspired by them. Thanks, @square & @fredwu
 Also thanks to
 
 - [Andrey Deryabin][aderyabin] for advice
-- [React.js][reactjs] for two-way binding
+- [Evil Martians][evil_martians] initial version sponsors
+- [React.js][reactjs] for reactive UI
 - [highlight.js][hljs] for syntax highlighting
 
 [aderyabin]: https://twitter.com/aderyabin
@@ -230,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
@@ -244,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: