lurker 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2021103dfcbcc4a3b23e6f2b2a78e440145a7aa7
-  data.tar.gz: 788c8755abc04786c4c19554d3c722cc215bf7b5
+  metadata.gz: 7e601ce25f19a4934646ebdf2ae0444a4ba5d723
+  data.tar.gz: b7618552c90b8a5722c285b159135ac118c38c14
 SHA512:
-  metadata.gz: 10bf2785c51a74fa50b8e5c1df2e0c794d866d77ce0c6bde27d0c0264db1b941192160b16ccbab8f8dbfe5298619898357f236668dec120c068871789a972252
-  data.tar.gz: 3ce60339db44c3ebc2a4d961336070f9a63d3f145d9a1b181e7807e0dd382e7e7dd375d4542cb629139c399846196107b8974c5ce635f691961381f80cb325fe
+  metadata.gz: 0426b14b4b0193db2834219cfc944257c2694c49d86f844fa12778dfc83bb24c78f7f806f0d1df252d24640223062d835e3a62f5b9bd4f953ce5f7ef0104de81
+  data.tar.gz: 69b8ded078f03ccc034797e9602e5fdbe90535e7a98316ea0cdebbf5bd619fb7580786b400cad04329fda9c8537e83977e4e1f3b8bf353c4bfc5453477518626

checksums.yaml.gz.asc

@@ -1,12 +1,12 @@
 -----BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
+Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTDdKbAAoJENcoxKfNVdjbL+8IAK+j2nTsFnpfwgwfiNMfbiRW
-TmVI506l4G6n8F3dtLJluAtvZ2a6nKzKqsmB5QykBS/Rlh9el7G32q+sxb9PLUWl
-q0nTVWj9KEtbAa1NHgWNEv/eU4wbqcxr1trnwbQ/pQj2q2k9/JzuFLkXQHVXBj1I
-7tlgvVcg656FxcnRqfCJt2FLvnLlxzpT/LZo4fJL9al6sMMbb4sn2wlwxO112NxT
-EL18QCXOsDNt02OAyruj9A467PibiXP6Jf1rtbC/PN2zolPuAMhU4BXQKHM7OQxA
-qrXcvicQ8Ei7zkHScNwnjJ0tzEWPAPvt3nTtm9006X6LGccyitIaHdx1m/UrRaI=
-=UNEA
+iQEcBAABCgAGBQJTUFPHAAoJENcoxKfNVdjbOiYH/imY5zbQeBr6hrWkjRXz89Ef
+2+ARZFzUvk5WZ+iejtnx5EczeU2R7spkJ+YK5o/+vUCT8yoIvZTdCZggTVEcQElq
+ee5x3jj5SW4NkvfDfgdgBqyZPKZF/EiOBrsEyR/LS+bacUh5yKD4BOQxwxeMQ7Dh
+jGnyQdpJ4MPxRx2eyuYwi5kVC45sXdmFeYXYW8lyslMbGLzDIrQzzTcyxosRgsze
+Dy9u1wL4SE0y7wm4zpm6DiYaOgi/GRlp223z/SfsGq3bNg8d1deuI3vDKiPTDGus
+2P9W1wtB3xVbL7TYyF/t6T47lGe4jpY30FKtjDHpAPYxKywCCHdRa7A8IePbIIs=
+=p3AX
 -----END PGP SIGNATURE-----

data.tar.gz.asc

@@ -1,12 +1,12 @@
 -----BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.22 (Darwin)
+Version: GnuPG v1
 Comment: GPGTools - http://gpgtools.org
 
-iQEcBAABCgAGBQJTDdKbAAoJENcoxKfNVdjbdTMIAI/w6DW8txsc7RmKCcVcgc14
-fv0beHs8rJPQFqMwu9j78houiYywFVmrAR6XNGISxfgnjw2wtYBeXHUQyvtdSmZR
-AxdW2Ud2OimCduzUKr+aROVew5uljFnj5A7VgQCzF8mvZZij3ulB0RMnWce3Yj9n
-EfO7HziilOipAQ2zRCshVDjl5RQ4JmFnconTYTg2LitldOXh5sZK3CqAADIbMF1M
-UxeEcY2UlD16wnC3gtwajmJsCl3cdphYIO9IEUpx6Itcp6mSJ7oTB8sFtwYyNcsv
-ZCV9xtf+qMk9a/0iBzHs9mnQsU3diqoybG7s0JQdVAoR2j0rRsXSRXgyWS67GsY=
-=/q1u
+iQEcBAABCgAGBQJTUFO8AAoJENcoxKfNVdjbGzcH/jTfrX9MDTo8BtyuvAHbNDoC
+EZycU+mf2Ukm1pdQfDKZxyPcn7OEwxaMikwm3FMGLqo+/plx59mS49wPX46Hjjlj
+yZ7+C1YZTpSUxE+fOn1/afd6alzZ7CTHHprQFOZmPvuq02ewO8OK04iOlQYVVIG/
+yjRQo9nweWGJpz7QtlP9Q5YxUduJwEk5fb2nmZG7c2JeQ7TmezpvO5qI5rrQmzv8
+DqrUGamq4OgtGBU0Z8n7E2mdhTcujhk9ZNEGhfL3C9Wm97ehQkfI/8mRKwQEGD4V
+OuQjzyb9d9CPfrpjbbZMjQLC+U+th91tzUCi2q/oh4C3gBWad2u+771joRspC38=
+=qyaU
 -----END PGP SIGNATURE-----

data/.gitignore

@@ -15,3 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle
+features/support/selenuim.rb
+Gemfile.local.lock
+_site

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "app"]
+	path = tmp/lurker_app
+	url = git@heroku.com:lurker-app.git

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+install: bundle install -j4 --path vendor/bundle
+cache:
+  directories:
+    - vendor/bundle
+rvm:
+  - 2.1.0

data/Gemfile.local

@@ -0,0 +1,28 @@
+# There is no need for these gems on travis and it's up to you whenever you use them
+# See: https://github.com/gerrywastaken/Gemfile.local
+# and GH's issue for bundler: https://github.com/bundler/bundler/issues/183
+eval File.read('Gemfile')
+
+# 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 'bootstrap-sass', '~> 3.1.1'
+  gem 'jquery-rails'
+  gem 'remotipart'
+end

data/README.md

@@ -1,6 +1,15 @@
 # Lurker
 
-TODO: Write a gem description
+The new de-facto for API testing your Rails application (Rails 3 & 4 both compatible)
+
+[![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
 
@@ -8,22 +17,128 @@ Add this line to your application's Gemfile:
 
     gem 'lurker'
 
-And then execute:
+## Usage
 
-    $ bundle
+Write your [RSpec][rspec] [controller][rspec_controller_spec] or [request][rspec_request_spec] specs as usual,
+but add `:lurker` mark (like documented [controller example][controler_spec_example] or [request spec example][request_spec_example]).
 
-Or install it yourself as:
+    describe Api::V1::UsersController, :lurker do
+      ...
 
-    $ gem install lurker
+And run the specs. That's all, easy!
 
-## Usage
+Please, commit your files under `Rails.root/lurker` directory.
+Feel free to edit them according to [json-schema][json_schema] standart.
+It can be very strict and flexible if you wish: see [example][json_schema_example],
+but scaffolded schemas are pretty good by default.
+
+    A  lurker/ExampleApp.service.yml
+    A  lurker/api/v1/users-GET.json.yml
+    A  lurker/api/v1/users/__user_id/repos-GET.json.yml
+
+## Profit!
+
+Now, every test run lurker will look into your requests and [vaditate them][failed_spec_example]
+and it fails if your code changes the api!
+
+    Failure/Error: post :create [...]
+    Lurker::ValidationError:
+      Request
+      - The property '#/' contains additional properties ["social_network"] outside of the schema
+        when none are allowed in schema file:///.../lurker/api/v1/users-POST.json.yml#
+      Response
+      - The property '#/user/last_sign_in_at' of type String did not match the following type:
+        null in schema file:///.../lurker/api/v1/users-POST.json.yml#
+
+Let's run your `rails s` and visit [http://localhost:3000/lurker/](http://localhost:3000/lurker/) (or see [demo][demo_app])
+
+Now, you can test your API on-line (for real)
+
+## Features
+
+- [Autoscaffolding for non-covered API endpoints][controler_spec_example]
+- [Autotesting for covered endpoint once written][failed_spec_example] (both request & response!)
+- [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`)
+- 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
+- Capistrano integration
+- JSON-Schema draft-v4 support
+- Static site deploy and milti-domain support
+
+
+## Sandbox mode for Live API testing
+
+    # make sure it's not production!
+    # e.g. config/environtents/staging.rb
+    config.middleware.use Lurker::Sandbox
+
+## 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:
+
+    bundle --gemfile Gemfile.local
+    export BUNDLE_GEMFILE=$PWD/Gemfile.local
+
+    rake assets:precompile # to build assets
+    cucumber some/feature  # to use pry-debugger
+
+## Todo
+
+- 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
+- Better Diff expected-schema vs recorded schema
+- XML api testing via .xsd
+
+## Acknoledgements
+
+Sponsored by [Evil Martians][evil_martians], thanks!
+
+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
 
-TODO: Write usage instructions here
+[gh_api]: https://developer.github.com/v3/meta/
+[rspec]: https://github.com/rspec/rspec-rails
+[api_taster]: https://github.com/fredwu/api_taster
+[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
+[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
+[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
 
-## Contributing
+[Gem Version]: https://rubygems.org/gems/lurker
+[Build Status]: https://travis-ci.org/razum2um/lurker
+[Dependency Status]: https://gemnasium.com/razum2um/lurker
+[Code Climate]: https://codeclimate.com/github/razum2um/lurker
+[Coverage Status]: https://coveralls.io/r/razum2um/lurker
 
-1. Fork it ( http://github.com/<my-github-username>/lurker/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[GV img]: https://badge.fury.io/rb/lurker.png
+[BS img]: https://travis-ci.org/razum2um/lurker.png
+[DS img]: https://gemnasium.com/razum2um/lurker.png
+[CC img]: https://codeclimate.com/github/razum2um/lurker.png
+[CS img]: https://coveralls.io/repos/razum2um/lurker/badge.png?branch=master

data/Rakefile

@@ -1 +1,180 @@
 require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'coveralls/rake/task'
+
+desc 'pry console for gem'
+task :c do
+  require 'pry'
+  require 'lurker'
+  ARGV.clear
+  Pry.start
+end
+
+namespace :assets do
+  desc 'compiles static css & js for web'
+  task :precompile do
+    require 'pathname'
+    require 'logger'
+    require 'fileutils'
+
+    require 'lurker/cli'
+
+    require_with_help 'sprockets'
+    require_with_help 'sass'
+
+    ROOT        = Pathname(File.dirname(__FILE__))
+    LOGGER      = Logger.new(STDOUT)
+    BUNDLES     = %w( application.css application.js )
+    BUILD_DIR   = Pathname.new Lurker::Cli.precompiled_static_root
+    SOURCE_DIR  = Pathname.new Lurker::Cli.source_root
+
+    FileUtils.rm_rf(BUILD_DIR)
+    FileUtils.mkdir_p(BUILD_DIR)
+
+    # raw copy
+    %w[fonts].each do |subdir|
+      FileUtils.cp_r(SOURCE_DIR.join(subdir), BUILD_DIR.join(subdir))
+    end
+
+    sprockets = Sprockets::Environment.new(ROOT) do |env|
+      env.logger = LOGGER
+    end
+
+    sprockets.context_class.class_eval do
+      def asset_path(path, options = {})
+        '/'
+      end
+    end
+
+    sprockets.append_path(SOURCE_DIR.join('javascripts').to_s)
+    sprockets.append_path(SOURCE_DIR.join('stylesheets').to_s)
+
+    %w[jquery-rails bootstrap-sass remotipart].each do |gem|
+      gem_path = Pathname.new(Bundler.rubygems.find_name(gem).first.full_gem_path)
+      %w[javascripts stylesheets].each do |prefix|
+        sprockets.append_path(gem_path.join('vendor', 'assets', prefix).to_s)
+      end
+    end
+
+    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(".")
+      assets.write_to(BUILD_DIR.join(realname))
+    end
+  end
+end
+
+# testing
+
+Coveralls::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format progress"
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = "features --format progress --tags ~@wip"
+end
+
+EXAMPLE_APP = 'tmp/lurker_app'
+EXAMPLE_PATH = File.expand_path("../#{EXAMPLE_APP}", __FILE__)
+
+namespace :clobber do
+  desc "clobber coverage"
+  task :coverage do
+    rm_rf File.expand_path('../coverage', __FILE__)
+  end
+
+  desc "clobber the generated app"
+  task :app do
+    FileUtils.mkdir_p EXAMPLE_PATH
+    in_lurker_app "bin/spring stop" if File.exist?("#{EXAMPLE_PATH}/bin/spring")
+    Dir.chdir EXAMPLE_PATH do
+      Dir.glob("*", File::FNM_DOTMATCH).each do |fname|
+        next if fname == '.' || fname == '..' || fname == '.git'
+        FileUtils.rm_rf fname
+      end
+    end
+  end
+end
+
+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-sprockets --skip-git --skip-test-unit --skip-keeps --quiet"
+    end
+  end
+
+  desc "generate a bunch of stuff with generators"
+  task :stuff do
+    in_lurker_app "LOCATION='../../templates/generate_stuff.rb' bin/rake rails:template --quiet --silent"
+  end
+end
+
+def in_lurker_app(command)
+  Dir.chdir(EXAMPLE_PATH) do
+    Bundler.with_clean_env do
+      sh command
+    end
+  end
+end
+
+def needs_generation?
+  !File.exists?("#{EXAMPLE_PATH}/Gemfile")
+end
+
+def require_with_help(name)
+  begin
+    require name
+  rescue LoadError
+    puts "Incorrect Gemfile, run: `bundle --gemfile Gemfile.local` and"
+    puts "BUNDLE_GEMFILE=$PWD/Gemfile.local #{$0}"
+    raise
+  end
+end
+
+desc 'destroys & recreates new test app'
+task :regenerate => ["clobber:coverage", "clobber:app", "generate:app", "generate:stuff"]
+
+desc 'run cucumber in a fresh env'
+task :features => [:regenerate, :cucumber]
+
+desc 'convert docs for example app'
+task :build_example_docs => :features do
+  in_lurker_app "bin/lurker convert"
+end
+
+namespace :heroku do
+  desc 'pushes example lurker_app to heroku'
+  task :push do
+    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.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"
+      }
+      menu.choice(:no) { say("Exit") }
+    end
+  end
+
+  desc 'rebuilds & pushes app to heroku'
+  task :deploy => [:build_example_docs, 'heroku:push'] do
+  end
+end
+
+task :default => [:spec, :regenerate, :cucumber, 'coveralls:push']
+