lurker 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 952b043f8da8f4b196d52d6d24fb05aa4e1a5766
-  data.tar.gz: 19afcf3e67b54a0536e071f36ff99a3f8b76083e
+  metadata.gz: ad859d0f48735e26b9982192d403652155d5b24c
+  data.tar.gz: 52923c3207cb795bd749a599ece81ba0d2ac0fc7
 SHA512:
-  metadata.gz: 17062f274191d624db5bfd6c3cc953744abd7474d53aa8ef5355b2578eec769514618fd3f26ffceb42993d8cc419a61e280578d5976a1948cd26bc7e1b28dad8
-  data.tar.gz: db85104a0f2e96a7a8a781ebbd672fb7493759d6ee500eebbc6eff9216919d2b47b140dd74527db8de570a4fc558970416a1acd0ee9f9860bc96f131c12c582a
+  metadata.gz: 7270039d305264702ad81589cf632ef42675bf76d32402db628b1c5c9decb0475e84c4bb4b5771653dfb34e5bbe9c95c7290947b88f7d78d3566e821a0938851
+  data.tar.gz: 882a2631d4ff8333774bad0826fda58da98eff73e4df9d238f6bc07c6f96b86ee263433c594e4e104a3ab948ee41e0dad13c59b6cf674a99efcd5a631995d7e5

checksums.yaml.gz.asc

@@ -2,11 +2,11 @@
 Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTa7ALAAoJENcoxKfNVdjbmXMIAIoAFZuoZELYYnXJqf1jXdfe
-7ZLYhPoI/J5TmxYoJ8D7pzJSw1IK00kmKitFsMmIRjDO5WlaOJoJJWKoQ4KFbo5K
-rCmRfwdOMNyWSK1dtdwpQkJHs1l/s/VQc9qydyRocjhFeDGh0QWlWyaOOwNXw6Wd
-Z5lMJRQIGF9AydjhQJxkQ8N7p675rnJanRtbZdWaO0QlYgSjDXYwmwnhmWfCHAIY
-obGKYXX6vEuUDvHkVpgmn/F33VCLOrsKv4GNh0VWZFmKxgeb937u06GxJawd+m+t
-XlHCtubTPwHx4quUNgo1/UARfsQqS8bMIHZgp7gADK4olz8iJY6MzMrtIdiyzbQ=
-=3uqV
+iQEcBAABCgAGBQJTccHbAAoJENcoxKfNVdjb6/IH/R1XMxCti1sKez8IUMA4eY2d
+u9QxT+0Z4lEkGNPs1ycqngH7fMnrN1qYnRK6KW+8HJAteUECdEOZ1qaQSpRXBC+c
+ugXow6Kei6TIO4432/AjApk00mDCsv3YosNMUOj6lXyt8K3GCh8PNt8L1bPhk3CV
+6/mDw33hv9rKU0mCvzursiOxHpEsSQZ8lgi8O6q9YwouyHtEsrVMNEJPYIgU20sX
+TUmNSxBFwX0/1orF64egekpT5zxcHUB8BRz4VsVD50evtYCBqLAaMZLZIf6J8rQM
+cnHqMV2tS4SBKr4Tq7YKItTWGafIK3F1F6jeIgrzxWjNpVxt/wC0lCw9NHm+2Nc=
+=dHhQ
 -----END PGP SIGNATURE-----

data.tar.gz.asc

@@ -2,11 +2,11 @@
 Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTa7AIAAoJENcoxKfNVdjbojcIAOHRH9llFujEsRcOVizaQ2Sb
-DydmPntKMNLqRrkyR9xlLqrL5ybfDGMvd7gpHnpXLzeoKA07nnQk7MNyqUl71cps
-TJ+A6o5bY+DGL4/WTyrzEpNFlkOwi9pEXUUCgYik2JOTZ+xK+2m0J72eh1zXO+fp
-o4v/+g8crVqgOLMIK+VNABJCWH7rvP/7oJooRs46v2Av5u7HCgc9iQA0+uu9ry3d
-HNo3sFqRq3cFiYVVz8GXngcgQAv44ageYRXi1xXKAcXMKDgK0seZ+yuLbI/OKiNx
-ED1rbJavgA/mhp8mCsdhk74SwRyWDo2TvJCK96D7iSmb5FapBqByKK1JkFX3Vd4=
-=dJ5L
+iQEcBAABCgAGBQJTccHYAAoJENcoxKfNVdjbFuAIANv5LvoJolrzbd5jBPqb/u4u
+PqveFsfu/9//EVq9sB+vZQ1av7Hrn7OYXkibhmvrvHwqO9l8Ve3/V0dQeAztk9qK
+Xf9hA8hUBbP7uqbbhm+SfvL3I0oVE9nFYdG+eP853v2XqwNHcJSNb4D6vXWah1XU
+6jiUSkaUZH2appqQRZfA5xLM9E+ZMq9iRktUWkKXSWUeRKOdizNSs+HtbCTiblqy
+IWwpSR2yJAg4/fHAC25X7DoOSCs6ENfl2ZuhOIISLykZHsT17ni22dqdCMnUDDl6
+YWsQcygfxDezC9WiIGrEJJwYv1KelMvGszHWyyqOT5R/v219KN4XjTdTuYLeNL8=
+=lqHA
 -----END PGP SIGNATURE-----

data/.gitignore

@@ -20,3 +20,4 @@ features/support/selenuim.rb
 Gemfile.local.lock
 _site
 gemfiles/*lock
+gh-pages

data/Gemfile

@@ -20,6 +20,7 @@ group :development do
   # run `rake assets:precompile`
   # to get bundled application.(js|css)
   gem 'sprockets'
+  gem 'uglifier'
   gem 'sass-rails'
   gem 'coffee-rails'
   gem 'bootstrap-sass', '~> 3.1.1'

data/README.md

@@ -33,6 +33,9 @@ but scaffolded schemas are pretty good by default.
     A  lurker/api/v1/users-GET.json.yml
     A  lurker/api/v1/users/__user_id/repos-GET.json.yml
 
+I also advise you to look on [Understanding JSON Schema][json_schema_book] book,
+it is up-to-date with draft4 and contains lot's of examples.
+
 ## Profit!
 
 Now, every test run lurker will look into your requests and [vaditate them][failed_spec_example]
@@ -87,12 +90,19 @@ are increasing notwithstanding ROLLBACK is called. As such:
 - ensure the same token to be accepted on your demo application
 - insert `Lurker::Sandbox` and the recorded examples should be ok to submit again
 
-## Demo application
+## [Demo application][demo_app3]
+
+You can clone the repo & run `rake build_example_docs && cd tmp/lurker_app && bin/rails s`
+to get your running demo.
+
+Lurker supports multiple domains (usually `staging` and `production`) and can be deployed
+statically everywhere as well as be served by current `Rails` instance.
 
-You can clone the repo & run `rake build_example_docs`.
-It will generate testing rails application under `tmp/lurker_app`.
-Currently it is deployed [here][demo_app] within sandbox mode and [here][demo_app2].
+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
 
 ## Contributions
 
@@ -107,13 +117,13 @@ I try to use [Waffle][waffle] to develop this gem, if you want to help:
 - drag an issue to "In Progress" and assign to yourself
 - have fun!
 
-**NOTICE:** to get new version of bundled `bootstrap` or update js/css,
+**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`
 
     rake assets:precompile # to build them
 
-Don't commit them to avoid conflicts.
+Don't commit `lib/lurker/templates/public/**/*` to avoid conflicts.
 
 **NOTE:** if you write features keep in mind to generate different files with aruba,
 because they are kept in `lurker_app` directory to be deployed as a demo. Please, write
@@ -134,9 +144,14 @@ This gem is quite opinionated and relies on rails & rspec - if you're
 interested in anything else, please take a look at [api_taster][api_taster] or [fdoc][fdoc],
 This gem is heavily inspirated by them. Thanks, @square & @fredwu
 
-Also thanks to [Andrey Deryabin][aderyabin] for advice and [React.js][reactjs] for two-way binding.
+Also thanks to
+
+- [Andrey Deryabin][aderyabin] for advice
+- [React.js][reactjs] for two-way binding
+- [highlight.js][hljs] for syntax highlighting
 
 [aderyabin]: https://twitter.com/aderyabin
+[hljs]: http://highlightjs.org/
 [waffle]: https://waffle.io/razum2um/lurker
 [gh_api]: https://developer.github.com/v3/meta/
 [rspec]: https://github.com/rspec/rspec-rails
@@ -147,19 +162,23 @@ Also thanks to [Andrey Deryabin][aderyabin] for advice and [React.js][reactjs] f
 [rspec_request_spec]: https://www.relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec
 [json_schema]: http://json-schema.org/
 [json_schema_example]: http://json-schema.org/example2.html
-[failed_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/controller-specs/test-endpoint
-[controler_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/controller-specs/schema-scaffolding
-[nested_controller_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/controller-specs/nested-schema-scaffolding
-[request_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/request-specs/schema-scaffolding
-[html_generation_example]: https://www.relishapp.com/razum2um/lurker/docs/docs-generation/html-generation
-[partial_example]: https://www.relishapp.com/razum2um/lurker/docs/docs-generation/partials
-[partial_example_demo]: http://lurker-app.herokuapp.com/lurker/api/v1/users/__user_id/repos-POST.html
+[json_schema_book]: http://spacetelescope.github.io/understanding-json-schema/
 [evil_martians]: http://evilmartians.com/
+
+[failed_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/test-endpoint
+[controler_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/controller-schema-scaffolding
+[nested_controller_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/controller-nested-schema-scaffolding
+[request_spec_example]: https://www.relishapp.com/razum2um/lurker/docs/request-schema-scaffolding
+[html_generation_example]: https://www.relishapp.com/razum2um/lurker/docs/html-generation
+[partial_example]: https://www.relishapp.com/razum2um/lurker/docs/partials
+[suffixes_example]: https://www.relishapp.com/razum2um/lurker/docs/request-schema-suffixes
+
 [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
-[pdf_example]: http://lurker.razum2um.me/lurker/LurkerApp.pdf
-[suffixes_example]: https://www.relishapp.com/razum2um/lurker/docs/request-specs/schema-suffixes
+[pdf_example]: http://razum2um.github.io/lurker/LurkerApp.pdf
+[partial_example_demo]: http://razum2um.github.io/lurker/api/v1/users/__user_id/repos-POST.html
 
 [Gem Version]: https://rubygems.org/gems/lurker
 [Build Status]: https://travis-ci.org/razum2um/lurker

data/Rakefile

@@ -59,6 +59,9 @@ namespace :assets do
       end
     end
 
+    sprockets.js_compressor  = :uglify
+    sprockets.css_compressor  = :scss
+
     BUNDLES.each do |bundle|
       assets = sprockets.find_asset(bundle)
       realname = (assets.pathname.basename.to_s.split(".").take_while { |s| !s.match /^(js|css)$/ } + [$~.to_s]).join(".")
@@ -81,6 +84,7 @@ Cucumber::Rake::Task.new(:cucumber) do |t|
 end
 
 EXAMPLE_APP = 'tmp/lurker_app'
+GH_PAGES    = 'gh-pages'
 EXAMPLE_PATH = File.expand_path("../#{EXAMPLE_APP}", __FILE__)
 
 namespace :clobber do
@@ -95,7 +99,7 @@ namespace :clobber do
     in_lurker_app "bin/spring stop" rescue nil
     Dir.chdir EXAMPLE_PATH do
       Dir.glob("*", File::FNM_DOTMATCH).each do |fname|
-        next if fname == '.' || fname == '..' || fname == '.git'
+        next if fname == '.' || fname == '..' || fname == '.git' || fname == '.bundle'
         FileUtils.rm_rf fname
       end
     end
@@ -106,18 +110,17 @@ namespace :generate do
   desc "generate a fresh app with rspec installed"
   task :app do |t|
     if needs_generation?
-      sh "bundle exec rails new #{EXAMPLE_APP} -d postgresql -m #{File.expand_path '../templates/lurker_app.rb', __FILE__} --skip-javascript --skip-git --skip-test-unit --skip-keeps --quiet"
+      sh "bundle exec rails new #{EXAMPLE_APP} -d postgresql -m #{File.expand_path '../templates/lurker_app.rb', __FILE__} --skip-javascript --skip-git --skip-test-unit --skip-keeps --skip-bundle --quiet"
+      in_lurker_app "bundle config --local local.lurker $PWD/../.." unless ENV['TRAVIS']
+      in_lurker_app "bundle install"
+      %w[rake rspec-core spring].each do |gem|
+        in_lurker_app "bundle binstubs #{gem}"
+      end
     end
   end
 
   desc "generate a bunch of stuff with generators"
   task :stuff do
-    in_lurker_app "bundle install"
-    if ENV['BUNDLE_GEMFILE'].to_s.match(/Gemfile(32|40)\.ci$/)
-      %w[rake rspec-core spring].each do |gem|
-        in_lurker_app "bundle binstubs #{gem}"
-      end
-    end
     in_lurker_app "LOCATION='../../templates/generate_stuff.rb' bin/rake rails:template --quiet --silent"
 
     unless ENV['TRAVIS']
@@ -136,6 +139,14 @@ def in_lurker_app(command)
   end
 end
 
+def in_gh_pages(command)
+  Dir.chdir(GH_PAGES) do
+    Bundler.with_clean_env do
+      sh command
+    end
+  end
+end
+
 def on_razum2um_me(command)
   puts "About to run: #{command}"
   system %Q{ssh lurker@razum2um.me 'bash -l -c "source ~/.bashrc; cd ~/lurker; rvm use 2.1.1; #{command}"'}
@@ -161,10 +172,19 @@ task :regenerate => ["clobber:coverage", "clobber:app", "generate:app", "generat
 desc 'run cucumber in a fresh env'
 task :features => [:regenerate, :cucumber]
 
-desc 'convert docs for example app'
+desc 'convert docs for example app, prepages gh-pages'
 task :build_example_docs => :features do
-  in_lurker_app "bin/lurker convert -c #{File.expand_path('../README.md', __FILE__)}"
+  if File.exists?(readme = File.expand_path('../README.md', __FILE__))
+    in_lurker_app "bin/lurker convert -c #{readme}"
+  else
+    in_lurker_app "bin/lurker convert"
+  end
+
   in_lurker_app "bin/lurker convert -f pdf -o html"
+
+  if File.exists?(pages = File.expand_path('../gh-pages', __FILE__))
+    in_lurker_app "cp -R html/* #{pages}"
+  end
 end
 
 def ask_for_deploy(name, callback)
@@ -222,26 +242,56 @@ namespace :razum2um do
   end
 end
 
+namespace :github do
+  desc 'pushes example lurker_app to gh-pages'
+  task :push do
+    do_deploy = Proc.new {
+      in_gh_pages "git commit -a -m 'auto commit: #{`git log --oneline -n 1`.strip}'" rescue nil
+      in_gh_pages "git push origin gh-pages"
+    }
+    in_gh_pages "git add -A"
+    in_gh_pages "git status"
+    ask_for_deploy("gh-pages", do_deploy)
+  end
+
+  desc 'rebuilds & pushes app to gh-pages'
+  task :deploy => [:build_example_docs, 'github:push'] do
+  end
+end
+
 task :default => ["clobber:coverage", :spec, :regenerate, :cucumber, 'coveralls:push']
 
 desc 'commits lurker app'
 task :predeploy do
-  in_lurker_app "echo 'bin/lurker' > .gitignore"
-  in_lurker_app "echo 'log' >> .gitignore"
-  # commit migration and deploy by hand first time
-  in_lurker_app "echo 'db/*' >> .gitignore"
-  in_lurker_app "echo 'tmp/*log' >> .gitignore"
-  in_lurker_app "echo '.bundle/*' >> .gitignore"
-
-  in_lurker_app "git add -A"
-  in_lurker_app "git status"
+  do_predeploy = Proc.new {
+    in_lurker_app "echo 'bin/lurker' > .gitignore"
+    in_lurker_app "echo 'log' >> .gitignore"
+    # commit migration and deploy by hand first time
+    in_lurker_app "echo 'db/*' >> .gitignore"
+    in_lurker_app "echo 'tmp/*log' >> .gitignore"
+    in_lurker_app "echo '.bundle/*' >> .gitignore"
+
+    in_lurker_app "git add -A"
+    in_lurker_app "git status"
+  }
+
+  if (stage = `git log @{u}..`).lines.size > 0
+    puts stage
+    do_push_and_predeploy = Proc.new {
+      sh "git push origin master"
+      do_predeploy.call
+    }
+    ask_for_deploy("push master", do_push_and_predeploy)
+  else
+    do_predeploy.call
+  end
 end
 
 desc 'deploys everything'
-task :deploy => ["razum2um:deploy", "heroku:deploy"]
+task :deploy => ["razum2um:deploy", "heroku:deploy", "github:deploy"]
 
 desc 'pushes everything'
-task :push => ["razum2um:push", "heroku:push"]
+task :push => ["razum2um:push", "heroku:push", "github:push"]
 
 desc 'releases gem & updates docs'
 task :publish do

data/features/README.md

@@ -8,7 +8,7 @@ This is the official documentation site for [Lurker][Github]
 [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/87ced56265849ad6386c2ba0a78f8038 "githalytics.com")](http://githalytics.com/razum2um/lurker)
 
 
-[Github]: https://github.com/razum2um/lurker
+[Github]: https://razum2um.github.io/lurker
 [Gem Version]: https://rubygems.org/gems/lurker
 [Build Status]: https://travis-ci.org/razum2um/lurker
 [Dependency Status]: https://gemnasium.com/razum2um/lurker

data/features/{controller_specs/nested_schema_scaffolding.feature → controller_nested_schema_scaffolding.feature}

@@ -1,4 +1,4 @@
-Feature: nested schema scaffolding
+Feature: controller nested schema scaffolding
 
   If your API endpoint has some dynamic segment - Lurker can handle it as well!
 
@@ -34,6 +34,10 @@ Feature: nested schema scaffolding
     description: repo listing
     prefix: repos management
     requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
       properties:
         user_id:
           description: ''
@@ -43,7 +47,6 @@ Feature: nested schema scaffolding
           description: ''
           type: integer
           example: 1
-      required: []
     responseCodes:
     - status: 200
       successful: true
@@ -53,6 +56,8 @@ Feature: nested schema scaffolding
       items:
         description: ''
         type: object
+        additionalProperties: false
+        required: []
         properties:
           id:
             description: ''
@@ -66,7 +71,6 @@ Feature: nested schema scaffolding
             description: ''
             type: integer
             example: 1
-        required: []
     extensions:
       method: GET
       path_info: "/api/v1/users/1/repos"

data/features/{controller_specs/schema_scaffolding.feature → controller_schema_scaffolding.feature}

@@ -1,4 +1,8 @@
-Feature: schema scaffolding
+Feature: controller schema scaffolding
+
+  When you prefer to test controller not in a unit-test fashion,
+  but including `render_views` - you can add `:lurker` metadata
+  to get a json schema for your api-documented endpoint
 
   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:
@@ -28,17 +32,24 @@ Feature: schema scaffolding
     description: user
     prefix: users management
     requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
       properties:
         id:
           description: ''
           type: integer
           example: 1
-      required: []
     responseCodes:
     - status: 200
       successful: true
       description: ''
     responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
       properties:
         id:
           description: ''
@@ -48,7 +59,6 @@ Feature: schema scaffolding
           description: ''
           type: string
           example: razum2um
-      required: []
     extensions:
       method: GET
       path_info: "/api/v1/users/1"

data/features/{docs_generation/html_generation.feature → html_generation.feature}

@@ -1,6 +1,8 @@
 Feature: html generation
 
-  When testing your api ensure that CSRF protection is handled properly
+  Lurker generates pretty info pages based on schema information
+  and form which allow you to test live api.
+  When testing your api ensure that CSRF protection is handled properlya
   with `protect_from_forgery :null_session`
 
   @javascript
@@ -14,15 +16,11 @@ Feature: html generation
       requestParameters:
         properties:
           user:
-            description: ''
             type: object
             properties:
               name:
-                description: ''
                 type: string
                 example: Bob
-            required: []
-        required: []
       responseCodes:
       - status: 200
         successful: true
@@ -30,11 +28,9 @@ Feature: html generation
       responseParameters:
         properties:
           id:
-            description: ''
             type: integer
             example: 1
           name:
-            description: ''
             type: string
             example: Bob
         required: []