lurker 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad859d0f48735e26b9982192d403652155d5b24c
-  data.tar.gz: 52923c3207cb795bd749a599ece81ba0d2ac0fc7
+  metadata.gz: 0812edbd0dea8fa5b7e25895f2247af7ae966e4c
+  data.tar.gz: 08abda5c9954e5e59554deb6ca9e38db84bbb71a
 SHA512:
-  metadata.gz: 7270039d305264702ad81589cf632ef42675bf76d32402db628b1c5c9decb0475e84c4bb4b5771653dfb34e5bbe9c95c7290947b88f7d78d3566e821a0938851
-  data.tar.gz: 882a2631d4ff8333774bad0826fda58da98eff73e4df9d238f6bc07c6f96b86ee263433c594e4e104a3ab948ee41e0dad13c59b6cf674a99efcd5a631995d7e5
+  metadata.gz: 53ba7f03739d9b9f7dc35f3a0b727122677b2724699cf7bda2697d00f49d448317e53414fe99895ffd4283b93172e8c4141bf832320b1c80f1b42bd0eaa64d0c
+  data.tar.gz: 4531e95b5c5a0bcdfd632f614c8c908b40304686028c11ae4f23b4126ab0fe921c12133fd51d735df560b7f2d5b62f4bad705d73916846a47b374103b7996e33

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+<H�;"y���ϊ����ר�h�E3eL�d�8��&���wl�@��,M��D��9������1���l	4[d��T��\�����[���.Yd����Dž�-;���ZQ�BC����v�(��&��X�-sֱ�������ω������t�,>��Ʒ$�@�J��{����Aj{�	��V����J�/�} s������>E�
8�.��O�Q5���NՔ��X�Y��,W���Āg>u��W������`

data/README.md

@@ -10,19 +10,53 @@ Works on Rails 3.2, 4.0, 4.1 & Ruby 1.9.3, 2.0.0, 2.1.1.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+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
 
-Write your [RSpec][rspec] [controller][rspec_controller_spec] or [request][rspec_request_spec] specs as usual,
+Wrap your intergation test code, which does request like this
+
+    Lurker::Spy.on do
+      get "/api/v1/users.json"
+    end
+
+And run the specs and commit your schemas. That's all, easy!
+
+## RSpec usage
+
+Write your 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]).
 
-    describe Api::V1::UsersController, :lurker do
-      ...
+    it "lists users", :lurker do
+      get "/api/v1/users.json"
+    end
+
+## Minitest usage
+
+You can use [minitest-around][minitest_around] to wrap your test classes like this:
+
+    class DestroyRepoTest < ActionDispatch::IntegrationTest
+      def around(&block)
+        Lurker::Spy.on(&block)
+      end
+    end
 
-And run the specs. That's all, easy!
+You also can wrap any block with api requests [manually][minitest_example].
+
+## Schemas
 
 Please, commit your files under `Rails.root/lurker` directory.
 Feel free to edit them according to [json-schema][json_schema] standart.
@@ -55,6 +89,20 @@ Let's run your `rails s` and visit [http://localhost:3000/lurker/](http://localh
 
 Now, you can test your API on-line (for real)
 
+## [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.
+
+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
+
 ## Features
 
 - [Autoscaffolding for non-covered API endpoints][controler_spec_example]
@@ -72,6 +120,7 @@ Now, you can test your API on-line (for real)
 - JSON-Schema draft-v4 support
 - Static site deploy and milti-domain support
 - Builtin Rack middlware `Lurker::Server.to_rack` serves cached digested assets
+- [RSpec][failed_spec_example] & [Minitest][minitest_example] support
 
 ## Token authentication with sandbox
 
@@ -90,20 +139,6 @@ 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_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.
-
-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
 
 [![Code Climate][CC img]][Code Climate]
@@ -140,7 +175,7 @@ so there are `<label htmlFor` instead of `<label for>` and `<div className` inst
 
 Sponsored by [Evil Martians][evil_martians], thanks!
 
-This gem is quite opinionated and relies on rails & rspec - if you're
+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 inspirated by them. Thanks, @square & @fredwu
 
@@ -154,16 +189,16 @@ Also thanks to
 [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
 [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
 [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/
+[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
 
 [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
@@ -172,12 +207,13 @@ Also thanks to
 [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
+[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
-[pdf_example]: http://razum2um.github.io/lurker/LurkerApp.pdf
+[pdf_example]: http://razum2um.github.io/lurker/Lurker%20Demo%20Application.pdf
 [partial_example_demo]: http://razum2um.github.io/lurker/api/v1/users/__user_id/repos-POST.html
 
 [Gem Version]: https://rubygems.org/gems/lurker

data/Rakefile

@@ -302,7 +302,7 @@ task :publish 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 "gem build lurker.gemspec"
     system "git push --tags"
     system "gem push lurker-#{version}.gem"
   end

data/certs/razum2um.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApib2tv
+di52bGFkMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMTQwNTIwMjAyOTAyWhcNMTUwNTIwMjAyOTAyWjBBMRMwEQYDVQQDDApi
+b2tvdi52bGFkMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCibrb/aiZX3kWo
+Fmzo3gvGBFS9N18Q5rp9UTJRc4KxZQOay2WcgLjy1oU61r2Urjz3VDT4sg/yw3N3
+YXIPqSTRl+OPIaafe45TVpF4mtMSsc1Gm/O3Sfoz6URiMd9iDtc2sTpaMgatL4pV
+EExER9emjrmElRFknJD65E3gVDX7KXvrZYYAScJR33DADIGUgpuyHm29S7G/4WAy
+ol6XfmPx+x5rM49QytGSNCQDYQ3SMMCo9wKkEm3Zcx0O4qhO8INevl/mvkAWLhOA
++0qldtuUx9wbBQ0D0wVR8LTafqWrIUHQjWXqrhWBqXhYeR3jj5aehBhpPFclHuKU
+5GeILZrFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBSiidH2CEJmkza+NBBJNLcnzQX57TAfBgNVHREEGDAWgRRib2tvdi52bGFkQGdt
+YWlsLmNvbTAfBgNVHRIEGDAWgRRib2tvdi52bGFkQGdtYWlsLmNvbTANBgkqhkiG
+9w0BAQUFAAOCAQEAVEyF63kQT9HKm3YIw1WzLvuOMvEUThzBomMMsTp9CGXWvem6
+wZdMhxykwk1lga0OwsCn+wr1tWZ/cNeWqGSY00vTfLWdriK60xuRW7zT1Z5tmxbD
+dq2ULdhII/qCFQlzDB/+IptO1rJLzfxTckoArmeYtkBV6LaVd7wpaRZnw0Apm93e
+ph03YddPDbB34xTivvu4d6BBbKGxj/YN+1NLD9rMi6FspgcA4P1UlmKqyCluTbZj
+vzKbYclpJ7gENr/xiTjGqA/Md3zJMzmsFrzUXt4RVmo5SaCyZjC6gFfhSr+PODc7
+ZaSbckvH/+m4boAsg0JkGGFcS3j5fgNmdwgA1A==
+-----END CERTIFICATE-----

data/features/controller_nested_schema_scaffolding.feature

@@ -18,7 +18,7 @@ Feature: controller nested schema scaffolding
         end
 
         it "lists all the repos of the user" do
-          get :index, user_id: user.id, limit: 1
+          get :index, user_id: user.id, limit: 1, format: 'json'
           expect(response).to be_success
           expect(JSON.parse(response.body).size).to eq 1
         end
@@ -39,10 +39,6 @@ Feature: controller nested schema scaffolding
       additionalProperties: false
       required: []
       properties:
-        user_id:
-          description: ''
-          type: integer
-          example: 1
         limit:
           description: ''
           type: integer
@@ -73,13 +69,13 @@ Feature: controller nested schema scaffolding
             example: 1
     extensions:
       method: GET
-      path_info: "/api/v1/users/1/repos"
+      path_info: "/api/v1/users/1/repos.json"
       path_params:
-        action: index
-        controller: api/v1/repos
         user_id: '1'
+        controller: api/v1/repos
+        action: index
       query_params:
-        limit: '1'
+        limit: 1
       suffix: ''
 
     """

data/features/controller_schema_scaffolding.feature

@@ -17,7 +17,7 @@ Feature: controller schema scaffolding
         end
 
         it "shows user" do
-          get :show, id: user.id
+          get :show, id: user.id, format: 'json'
           expect(response).to be_success
         end
       end
@@ -36,11 +36,7 @@ Feature: controller schema scaffolding
       type: object
       additionalProperties: false
       required: []
-      properties:
-        id:
-          description: ''
-          type: integer
-          example: 1
+      properties: {}
     responseCodes:
     - status: 200
       successful: true
@@ -61,11 +57,11 @@ Feature: controller schema scaffolding
           example: razum2um
     extensions:
       method: GET
-      path_info: "/api/v1/users/1"
+      path_info: "/api/v1/users/1.json"
       path_params:
-        action: show
-        controller: api/v1/users
         id: '1'
+        controller: api/v1/users
+        action: show
       suffix: ''
 
   """

data/features/html_generation.feature

@@ -36,7 +36,7 @@ Feature: html generation
         required: []
       extensions:
         method: POST
-        path_info: "/api/v1/users"
+        path_info: "/api/v1/users.json"
         path_params:
           action: create
           controller: api/v1/users

data/features/minitest.feature

@@ -0,0 +1,140 @@
+Feature: minitest
+
+  When you're testing your api with `minitest` and
+  `ActionDispatch::IntegrationTest`: you can
+  simply wrap your code in `Lurker::Spy.on do ... end`
+
+  Scenario: scaffold a json schema for a "repos/destroy" in minitest
+    Given a file named "test/integration/destroy_repo_test.rb" with:
+      """ruby
+      require_relative '../test_helper'
+
+      class DestroyRepoTest < ActionDispatch::IntegrationTest
+        def test_destruction
+          user = User.where(name: 'razum2um').first_or_create!
+          repo = user.repos.first_or_create!(name: 'lurker')
+
+          assert_equal 1, Repo.count
+
+          Lurker::Spy.on do
+            delete "/api/v1/users/#{user.id}/repos/#{repo.id}.json"
+          end
+
+          assert_equal 200, status
+          assert_equal 0, Repo.count
+        end
+      end
+      """
+
+  When I run `ruby test/integration/destroy_repo_test.rb`
+  Then the output should contain unescaped these lines:
+    """
+    1 (runs|tests), 3 assertions, 0 failures, 0 errors, 0 skips
+    """
+  Then a file named "lurker/api/v1/users/__user_id/repos/__id-DELETE.json.yml" should exist
+  Then the file "lurker/api/v1/users/__user_id/repos/__id-DELETE.json.yml" should contain exactly:
+    """yml
+    ---
+    description: repo descruction
+    prefix: repos management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties: {}
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties: {}
+    extensions:
+      method: DELETE
+      path_info: "/api/v1/users/1/repos/1.json"
+      path_params:
+        action: destroy
+        controller: api/v1/repos
+        user_id: '1'
+        id: '1'
+      suffix: ''
+
+    """
+
+  Scenario: json schema tests "users/update" in minitest
+    Given a file named "lurker/api/v1/users/__id-PATCH.json.yml" with:
+      """yml
+      ---
+      prefix: 'users management'
+      description: 'user updating'
+      requestParameters:
+        properties:
+          id:
+            type: integer
+            example: 1
+          user:
+            type: object
+            properties:
+              name:
+                type: string
+                example: Bob
+      responseCodes:
+      - status: 400
+        successful: true
+        description: ''
+      - status: 200
+        successful: true
+        description: ''
+      responseParameters:
+        properties:
+          id:
+            type: integer
+            example: 1
+          name:
+            type: string
+            example: Bob
+      extensions:
+        path_info: "/api/v1/users/1"
+        method: PATCH
+        suffix: ''
+        path_params:
+          action: update
+          controller: api/v1/users
+          id: 1
+          """
+
+    And a file named "test/integration/update_user_test.rb" with:
+      """ruby
+      require_relative '../test_helper'
+
+      class UpdateUserTest < ActionDispatch::IntegrationTest
+        def test_updating
+          user = User.where(name: 'razum2um').first_or_create!
+          assert_equal 1, User.count
+
+          Lurker::Spy.on do
+            patch "/api/v1/users/#{user.id}.json", user: { name: '' }
+          end
+
+          assert_equal 200, status
+          assert_equal 'John', user.reload.name
+        end
+      end
+      """
+
+  When I run `ruby test/integration/update_user_test.rb`
+  Then the output should contain failures:
+    """
+    Lurker::ValidationError:
+      Response
+        The property '#/' contains additional properties ["errors"]
+
+    """
+  And the output should contain unescaped these lines:
+    """
+    1 (runs|tests), 1 assertions, 0 failures, 1 errors, 0 skips
+    """

data/features/multidomain_support.feature

@@ -45,7 +45,7 @@ Feature: mutidomain support
         properties: {}
       extensions:
         method: DELETE
-        path_info: "/api/v1/users/1"
+        path_info: "/api/v1/users/1.json"
         path_params:
           action: destroy
           controller: api/v1/users

data/features/partials.feature

@@ -42,7 +42,7 @@ Feature: partials
       requestParameters:
         properties:
           user_id:
-            type: integer
+            type: string
             example: 1
           repo:
             properties:
@@ -56,7 +56,7 @@ Feature: partials
         $ref: '../../../../definitions/repo.json#/'
       extensions:
         method: POST
-        path_info: "/api/v1/users/1/repos"
+        path_info: "/api/v1/users/1/repos.json"
         path_params:
           action: create
           controller: api/v1/repos
@@ -75,7 +75,7 @@ Feature: partials
 
         it "creates a new repo" do
           expect {
-            post "api/v1/users/#{user.id}/repos", repo: { name: 'new-gem' }
+            post "api/v1/users/#{user.id}/repos.json", 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)