lurker 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb20f62f6736dd539b2feb809ca7604d9dbdae7c
-  data.tar.gz: ff091f8fdb08b2e1e6e804f280f132527aff1d96
+  metadata.gz: 283e1232ba94b0709c578cd9079df7752d246771
+  data.tar.gz: 052b2c171edb907e97c14d33c0e06825525714fc
 SHA512:
-  metadata.gz: 1cb6b580de47bc8d65f1559c41390b9512da9a256ca1fa398e6e334f902b7c0c47d50b3b174db3d4f2fe5b418d133b532071c17348a01b8ec77146f8ded8861b
-  data.tar.gz: 30a5a43b6ba3fe8e3461204b71c047f62b368c65fb470a1141046d1db393757717b9e0b546b472598da627f70507bde13d9c6510cb0604070979e868e0469f79
+  metadata.gz: ef36571fc15bc8b40b083f915a14ce602db250e8ff8d1bdace6d89da88c98a537fec81ced6a3db3cb599044e3a5f93f380a9f695874e4439e7cb4b5792484eb0
+  data.tar.gz: 91fd578c50783ff3f4125e6a2f31bc562054c401bec74698409ce0ede15b7f524a8ee51edfa9a2c7a7c90dcd55af6238d73b363f1dbafcaac7f71deb6b7786bf

checksums.yaml.gz.asc

@@ -2,11 +2,11 @@
 Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTWFrwAAoJENcoxKfNVdjbBFsH/RrX8rityUpM374B+mzfN3d/
-aRu+TTSa33PEIi9SgmlKUBqAn/VFOvBg1DWoW/+WoIEJcmfEct/WBSgHX2eNAmef
-x8bYKeF2ZAPcvKsF3K76q4WlggBGTm9WaeltMpowqtbfNSFH92PFspzPhLijTXLy
-RVAJMyzsJQytx3NW94Qg6vOGrRLG+5eiF8ZQPM/1Sf3dAtMJM5QeDMWVyE/1HvCn
-o+7pMxariUlmx0rtrtLkCw8EfBiECmcQvqj035qI7iGrFkzeppqr+efxKL0zHXQ2
-sIM8T1teL2UNRnkOsDjDWVxAmZCJoA9ehxqSw1KRz3C/yuttpRWz5Um76/ycbQA=
-=gAyH
+iQEcBAABCgAGBQJTXvK5AAoJENcoxKfNVdjb5RoIAMetNDxFZ6KmLPkDpq50xeUt
+HZri9cCVeD+5zk2SqIGTzh8jI1pqg822e1gFOyPpkZaXMUKisA0Lbogc2EWjsjte
+HRjmH+ZL16VqFMhDFBoCX9Q1yXPm4wWhVcKK23fCbnY0x5HY2uHMUim8yDAN2bUO
+/X7KIkNAwMLcihR1sHg8vCkmRWpN+29qaAvAOjjiyLyiND+Z7doweWNVrvxIF5Ei
+L1jqEQouA+yXpSXtxYr4T+uQmwQCuL8TxDDm6EzMF8TuQFhLV2BwE2l8fQ5ZTtWq
+qbysZqac/GxHz47at7+d1ghokp+jQ8uNt90vvNlo+ISfNOCHdP5jMEVTt6m1+HI=
+=77ha
 -----END PGP SIGNATURE-----

data.tar.gz.asc

@@ -2,11 +2,11 @@
 Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTWFrrAAoJENcoxKfNVdjb8HQH/0im2GLtDVlR4bkPz6DpGX1y
-DyWk914EJPaeY4aTxBbUOstWzucrGhuVx3AcUUQ9JOq5RzJlOTwP0in+VcA6Zv3x
-3lEOOmhL1Y3qw/jkcn6H6kJPchnUkkWWlqqexYMYpQUBfSmjXaW8zPPnTtbVY2E3
-a0UhhnLB7K1vHpHqXm+OdpUMkjJ4tGClXZs87D3aDEt7LuQERSHr93BltX6Vts/L
-ijoZzr5V7AEtoK1AU7N2Ob4fd95HFnU3cHWMoDZIsKPAM/5YlLWwnw2PWi94SWMX
-8kfqPa9g9uY7AtVT88rD5015Q4ww7WvsTfCW/wYIvpQ6Zwv1KL8RJBZQ4RQJskw=
-=5tUn
+iQEcBAABCgAGBQJTXvK2AAoJENcoxKfNVdjbkmkIAJPPUMpXPntfkoEtTB4WAgo7
+kFQwMJD5Lrz10tLwf7o8pkZWOEOMmHbZW46v2iLzgEXoXoBF5IOO8hBW0UmplWcK
+s9Jx8ws2BrMt21qI48qYHDLHmn+Wexjvj/pV5X31JgfilzW9BhgV7MSfS//RmDkv
+t5NCGdg84AJidKMGL95r4gxn7Uxp6q7oMZQONx9oaqXTAqLu7x9iuXTH1B3+1gNc
+vJq+By9GseQ+I/TEPkz1wllWM3adMWH2a9iMqCys8DWw13Dpam8xnLRdEO+ZVJSy
+hs2rVOKcGfEFEfI3gbwnd6VI7ItVxnFRlumNlEZ/V3ZkNANNQq+PEgOMBdasbgI=
+=9S7g
 -----END PGP SIGNATURE-----

data/.travis.yml

@@ -1,7 +1,14 @@
 language: ruby
+gemfile: Gemfile.ci
 install: bundle install -j4 --path vendor/bundle
 cache:
   directories:
     - vendor/bundle
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.1.0
+matrix:
+  allow_failures:
+    - rvm: 1.9.3
+    - rvm: 2.0.0

data/Gemfile

@@ -1,4 +1,28 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in lurker.gemspec
 gemspec
+
+# Add any gems and groups that you don't want to keep local
+group :development do
+  # tools
+  gem 'pry-debugger'
+  gem 'pry-stack_explorer'
+  # rspec --format fuubar
+  gem 'fuubar'
+  # cucumber --format fuubar
+  gem 'fuubar-cucumber', github: 'martinciu/fuubar-cucumber', branch: 'master'
+  gem 'selenium-webdriver'
+
+  # deploy site
+  gem 'highline'
+
+  # build template static
+  # run `rake assets:precompile`
+  # to get bundled application.(js|css)
+  gem 'sprockets'
+  gem 'sass-rails'
+  gem 'coffee-rails'
+  gem 'bootstrap-sass', '~> 3.1.1'
+  gem 'jquery-rails'
+  gem 'remotipart'
+  gem "launchy"
+end

data/Gemfile.ci

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lurker.gemspec
+gemspec

data/README.md

@@ -5,12 +5,8 @@ The new de-facto for API testing your Rails application (Rails 3 & 4 both compat
 [![Gem Version][GV img]][Gem Version]
 [![Build Status][BS img]][Build Status]
 [![Dependency Status][DS img]][Dependency Status]
-[![Code Climate][CC img]][Code Climate]
-[![Coverage Status][CS img]][Coverage Status]
-[![Inline docs](http://inch-pages.github.io/github/razum2um/lurker.png)](http://inch-pages.github.io/github/razum2um/lurker)
 [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/87ced56265849ad6386c2ba0a78f8038 "githalytics.com")](http://githalytics.com/razum2um/lurker)
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -61,8 +57,8 @@ Now, you can test your API on-line (for real)
 - [Pretty HTML documentation based on your schemas][html_generation_example]
 - [Pretty submit form to test API endpoints (live) based on schemas][demo_live] (enter a name & press "Submit")
 - [Handling URLs with dynamic segments][nested_controller_spec_example] (such as `api/v1/:user_id/repos`)
+- [JSON-Schema partials][partial_example], also in YAML format ([demo][partial_example_demo])
 - Multiple docs for many test cases
-- JSON-Schema partials (inline reference to other schemas)
 - ERB support inside `.json.yml.erb`
 - HTTP-Auth authorization for your online docs
 - Separate API-services generated within one test suite
@@ -71,42 +67,61 @@ Now, you can test your API on-line (for real)
 - Static site deploy and milti-domain support
 - Builtin Rack middlware `Lurker::Server.to_rack` serves cached digested assets
 
+## Token authentication with sandbox
 
-## Sandbox mode for Live API testing
+`Lurker::Sandbox` allows you to test services with token authentication:
 
     # make sure it's not production!
     # e.g. config/environtents/staging.rb
     config.middleware.use Lurker::Sandbox
 
+E.g. demo application runs with it: when creating, updating repos or users
+ids getting increased, but if you look into GET #index,
+new items are NOT showing up. **This is NOT a bug!** - sequences in postgres
+are increasing notwithstanding ROLLBACK is called. As such:
+
+- run all your specs with **the same** testing token
+- 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
 
 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].
 
+
 ## Contributions
 
-To get new version of bundled `bootstrap` or to use debugger in specs run:
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+[![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!
 
-    bundle --gemfile Gemfile.local
-    export BUNDLE_GEMFILE=$PWD/Gemfile.local
+**NOTICE:** 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 assets
-    cucumber some/feature  # to use pry-debugger
+    rake assets:precompile # to build them
 
-## Todo
+Don't commit them to avoid conflicts.
 
-- More tests
-- More docs
-- Production middleware to validate real input/output
-- Render lurker-app to gh-pages with arbitrary endpoint (my & heroku)
-- Render dosc like these: [gh_api][gh_api]
-- Auto extraction for models into json-schema partials (in responses at least)
-- Auto marking of attributes as required if `strong_params` are used
-- Sinatra support
-- Render to Middleman's markdown -> static site
-- Better Diff expected-schema vs recorded schema
-- XML api testing via .xsd
+**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
+features in a way to generate **new** relevant `lurker/**/*.json.yml` files
+
+To run cucumber in a clean `lurker` & `html` directories run:
+
+    CLEAN=1 cucumber features
+
+**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`
 
 ## Acknoledgements
 
@@ -116,9 +131,13 @@ 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 [React.js][reactjs] for two-way binding.
+
+[waffle]: https://waffle.io/razum2um/lurker
 [gh_api]: https://developer.github.com/v3/meta/
 [rspec]: https://github.com/rspec/rspec-rails
 [api_taster]: https://github.com/fredwu/api_taster
+[reactjs]: http://facebook.github.io/react/
 [fdoc]: https://github.com/square/fdoc
 [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
@@ -129,6 +148,8 @@ This gem is heavily inspirated by them. Thanks, @square & @fredwu
 [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
 [evil_martians]: http://evilmartians.com/
 [demo_app]: http://lurker-app.herokuapp.com/lurker/
 [demo_live]: http://lurker-app.herokuapp.com/lurker/api/v1/users-POST.html

data/Rakefile

@@ -8,6 +8,7 @@ desc 'pry console for gem'
 task :c do
   require 'pry'
   require 'lurker'
+  require 'lurker/cli'
   ARGV.clear
   Pry.start
 end
@@ -34,8 +35,8 @@ namespace :assets do
     FileUtils.mkdir_p(BUILD_DIR)
 
     # raw copy
-    %w[fonts].each do |subdir|
-      FileUtils.cp_r(SOURCE_DIR.join(subdir), BUILD_DIR.join(subdir))
+    %w[fonts bootstrap.css.map].each do |subdir|
+      FileUtils.cp_r(SOURCE_DIR.join(subdir), BUILD_DIR)
     end
 
     sprockets = Sprockets::Environment.new(ROOT) do |env|
@@ -122,6 +123,11 @@ def in_lurker_app(command)
   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}"'}
+end
+
 def needs_generation?
   !File.exists?("#{EXAMPLE_PATH}/Gemfile")
 end
@@ -144,37 +150,97 @@ task :features => [:regenerate, :cucumber]
 
 desc 'convert docs for example app'
 task :build_example_docs => :features do
-  in_lurker_app "bin/lurker convert"
+  in_lurker_app "bin/lurker convert -c #{File.expand_path('../README.md', __FILE__)}"
 end
 
-namespace :heroku do
-  desc 'pushes example lurker_app to heroku'
-  task :push do
+def ask_for_deploy(name, callback)
+  if ENV['FORCE_DEPLOY']
+    puts "Deploy to #{name}"
+    callback.call
+  else
     require_with_help 'highline/import'
-    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/*' >> .gitignore"
-
-
-    in_lurker_app "git add -A"
-    in_lurker_app "git status"
     choose do |menu|
-      menu.prompt = 'Commit & push & deploy?'
+      menu.prompt = "Commit & push & deploy to #{name}?"
       menu.choice(:yes) {
-        in_lurker_app "git commit -a -m 'auto commit: #{`git log --oneline -n 1`.strip}'"
-        in_lurker_app "git push origin master"
-        in_lurker_app "heroku run rake db:import --app lurker-app"
+        ENV['FORCE_DEPLOY'] = '1'
+        callback.call
       }
       menu.choice(:no) { say("Exit") }
     end
   end
+end
+
+namespace :heroku do
+  desc 'pushes example lurker_app to heroku'
+  task :push => :predeploy do
+    do_deploy = Proc.new {
+      in_lurker_app "git commit -a -m 'auto commit: #{`git log --oneline -n 1`.strip}'" rescue nil
+      in_lurker_app "git push origin master"
+      in_lurker_app "heroku run rake db:import --app lurker-app"
+    }
+    ask_for_deploy("heroku", do_deploy)
+  end
 
   desc 'rebuilds & pushes app to heroku'
   task :deploy => [:build_example_docs, 'heroku:push'] do
   end
 end
 
+namespace :razum2um do
+  desc 'pushes example lurker_app to razum2um'
+  task :push => :predeploy do
+    do_deploy = Proc.new {
+      in_lurker_app "git commit -a -m 'auto commit: #{`git log --oneline -n 1`.strip}'" rescue nil
+      in_lurker_app "git push razum2um master"
+      %w[database secrets].each do |fname|
+        on_razum2um_me "cp ~/#{fname}.yml config/#{fname}.yml"
+      end
+      on_razum2um_me "bundle install"
+      on_razum2um_me "RAILS_ENV=production bin/rake db:migrate"
+      on_razum2um_me "RAILS_ENV=production bin/rake db:import"
+      on_razum2um_me "touch tmp/restart.txt"
+    }
+    ask_for_deploy("razum2um.me", do_deploy)
+  end
+
+  desc 'rebuilds & pushes app to razum2um.me'
+  task :deploy => [:build_example_docs, 'razum2um:push'] do
+  end
+end
+
 task :default => [: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"
+end
+
+desc 'deploys everything'
+task :deploy => ["razum2um:deploy", "heroku:deploy"]
+
+desc 'pushes everything'
+task :push => ["razum2um:push", "heroku:push"]
+
+desc 'releases gem & updates docs'
+task :publish do
+  require 'lurker'
+  version = Lurker::VERSION
+
+  Bundler.with_clean_env do
+    system "git tag v#{version}"
+    system "relish versions:add razum2um/lurker:#{version}"
+    system "relish push razum2um/lurker:#{version}"
+    system "gem build lurker.gemspec --sign"
+    system "git push --tags"
+    system "gem push lurker-#{version}.gem"
+  end
+end
+

data/features/docs_generation/html_generation.feature

@@ -64,8 +64,13 @@ Feature: html generation
   Then I should see "user creation"
 
   When I click on "user creation"
-   And I fill in the submit form field "name" with "Jim"
-   And I submit it
+  And I fill in the submit form field "name" with "Jim"
+  Then I should see:
+    """
+    curl -X POST -d "user%5Bname%5D=Jim"
+    """
+
+   And I submit lurk form
 
   Then I should see JSON response with "Jim"
 

data/features/docs_generation/multidomain_support.feature

@@ -1,7 +1,9 @@
 Feature: mutidomain support
 
-  to deploy statically on other domain and be able to send API requests
-  you shouldturn off Access-Control-Allow-Origin restriction
+  In your `.service.yml` list you domains in form `hostname: url`
+
+  To deploy statically on other domain and be able to send API requests
+  you should turn off Access-Control-Allow-Origin restriction
   in config/application.rb (Rails 4)
 
   ```ruby
@@ -20,8 +22,8 @@ Feature: mutidomain support
       basePath: ''
       description: ''
       domains:
-        '/': 'Local'
-        'http://lurker-app.herokuapp.com': 'Heroku'
+        '[Sandbox] Heroku': 'http://lurker-app.herokuapp.com'
+        '[Real] razum2um.me': 'http://lurker.razum2um.me'
       name: LurkerApp
       extensions: {}
       """
@@ -63,10 +65,10 @@ Feature: mutidomain support
     create  api/v1/users/__id-DELETE.html
     """
 
-  When I go to "/lurker"
-  Then I should see "Local"
-  Then I should see "users management"
-
-  When I click on "Local"
-  Then I should see "Heroku"
+  When I go to "/lurker/api/v1/users/__id-DELETE.html"
+  When I select "[Sandbox] Heroku" hostname
+  Then I should see:
+    """
+    curl -X DELETE "http://lurker-app.herokuapp.com/api/v1/users/1"
+    """
 

data/features/docs_generation/partials.feature

@@ -0,0 +1,98 @@
+Feature: partials
+
+  You can use `$ref` to reference to other schemas just like in JSON-Schema documentation
+  Paths must be either `http://` or relative filenames
+
+  Referenced files can be either `.json` files, or `.json.yml` (Same JSON in YAML)
+
+  **NOTE:** to reference `file.json.yml` use `$ref: 'file.json#/'`
+  All YAML preprocessing happens behind the scene.
+
+  Scenario: builds html for "repos/create" in request spec with nested partials
+    Given an empty directory named "html"
+    And a file named "lurker/definitions/user.json.yml" with:
+      """yml
+      ---
+      properties:
+        id:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: razum2um
+      """
+    And a file named "lurker/definitions/repo.json.yml" with:
+      """yml
+      ---
+      properties:
+        id:
+          type: integer
+          example: 1
+        name:
+          type: string
+          example: new-gem
+        user:
+          $ref: '../definitions/user.json#/'
+      """
+    And a file named "lurker/api/v1/users/__user_id/repos-POST.json.yml" with:
+      """yml
+      ---
+      description: repo creation
+      prefix: repos management
+      requestParameters:
+        properties:
+          user_id:
+            type: integer
+            example: 1
+          repo:
+            properties:
+              name:
+                type: string
+                example: new-gem
+      responseCodes:
+      - status: 200
+        successful: true
+      responseParameters:
+        $ref: '../../../../definitions/repo.json#/'
+      extensions:
+        method: POST
+        path_info: "/api/v1/users/1/repos"
+        path_params:
+          action: create
+          controller: api/v1/repos
+          user_id: '1'
+        suffix: ''
+      """
+
+    Given a file named "spec/requests/repo_creation_spec.rb" with:
+      """ruby
+      require "spec_helper"
+
+      describe Api::V1::ReposController, :lurker do
+        let!(:user) do
+          User.where(name: 'razum2um').first_or_create!
+        end
+
+        it "creates a new repo" do
+          expect {
+            post "api/v1/users/#{user.id}/repos", repo: { name: 'new-gem' }
+            expect(response).to be_success
+            expect(JSON.parse(response.body)['user']).to eq JSON.parse(user.to_json)
+          }.to change { Repo.count } .by(1)
+        end
+      end
+      """
+
+  When I run `bin/rspec spec/requests/repo_creation_spec.rb`
+  Then the example should pass
+
+  When I successfully run `bin/lurker convert`
+  Then the output should contain these lines:
+    """
+            Converting lurker to html
+     using  lurker
+
+    create  index.html
+    create  api/v1/users/__user_id/repos-POST.html
+    """
+