lurker 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c6082ee72faafa413ba71d30980598f2524c41d
-  data.tar.gz: e17f9251086892abc27a9621f53ac2ec17527e47
+  metadata.gz: a914bcb615ccfdd4b68d8596ddf908d406003045
+  data.tar.gz: 0914a12a0879b48ee724accf0e574ee52c4de24c
 SHA512:
-  metadata.gz: 8f5053abff9bfbd14b87307d89004deafc64396a6f9270ad06b54015f955699d75505136dfdc3763811f0b059f1d137d36bbd0fc079710268f84e8989f79ce37
-  data.tar.gz: 09c1cc7157084b90a9880cde056244d14b01687aa859f3b0050fef4337ebb694840776ad50b48852b6433f5fb0989968bb656cb520ac95b70e28bdccb5f765cd
+  metadata.gz: 0a2e411348e7c483a2d9984dabd476a6136bfcad6c9cef8b42afa7288149f447505e86d0fe77fbb578f70bd414a65057c6a8a1f1b5cd23871393d70b88cd8a06
+  data.tar.gz: 81e866b271eb19fd2550865e4b6998c20f3717237060ca24b55343b90adc4e65e1e1ea445cad32dd32b20e020fd1b4b1b5cc4a1c4806c52d7846aef88f5b110d

data/.hound.yml

@@ -0,0 +1,15 @@
+StringLiterals:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+MultilineTernaryOperator:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+

data/.rubocop.yml

@@ -0,0 +1,15 @@
+StringLiterals:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+MultilineTernaryOperator:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+

data/README.md

@@ -10,11 +10,18 @@ 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'
 
-Add to `test_helper.rb` or `spec_helper.rb`:
+Inject into `test_helper.rb` or `spec_helper.rb`:
 
     require 'lurker/spec_helper'
 
@@ -77,6 +84,12 @@ and it fails if your code changes the api!
       - 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#
 
+The generation of live-documentation is pretty simple:
+
+    bin/lurker convert                   # builds html under `Rails.root/html`
+    bin/lurker convert -o public/lurker  # builds html under `Rails.root/public/lurker`
+    bin/lurker convert -f pdf -o html    # builds `ServiceName.pdf` under `Rails.root/html`
+
 Let's run your `rails s` and visit [http://localhost:3000/lurker/](http://localhost:3000/lurker/)
 (or see [demo][demo_app2] for example)
 
@@ -104,10 +117,12 @@ For 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])
-- [Generation PDF documentation][pdf_example]
+- [Generation PDF documentation][pdf_example] (add `gem 'pdfkit'` to Gemfile)
 - [Multiple docs for many usecases][suffixes_example] (e.g `:lurker => '...'`)
 - ERB support inside `.json.yml.erb`
-- HTTP-Auth authorization for your online docs
+- Insert custom content in Markdown into `index.html` (add `gem 'kramdown'` to Gemfile)
+- Syntax highlighting for sample response (add `gem 'execjs'` to Gemfile)
+- HTTP-Auth authorization for docs (`mount Lurker::Server.to_rack username: '...', password: '...'`)
 - Separate API-services generated within one test suite
 - Capistrano integration
 - JSON-Schema draft-v4 support

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/atom_persistent_within_the_same_type.feature

@@ -0,0 +1,138 @@
+Feature: atom persistent within test suite
+  Background:
+    Given a file named "lurker/api/v2/users/__id-PATCH.json.yml" with:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            name:
+              description: ''
+              type: string
+              example: NameIsPersistentInExaple
+            surname:
+              description: ''
+              type: string
+              example: SurnameIsPersistentInExaple
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 100
+        name:
+          description: ''
+          type: string
+          example: NameIsPersistentInExaple
+        surname:
+          description: ''
+          type: string
+          example: SurnameIsPersistentInExaple
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/100"
+      path_params:
+        id: '100'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+    """
+
+  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
+
+        let(:user) do
+          User.where(name: 'razum2um', surname: 'Unknown').first_or_create!
+        end
+
+        it "updates a user surname as string" do
+          patch :update, 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`
+  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:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            name:
+              description: ''
+              type: string
+              example: NameIsPersistentInExaple
+            surname:
+              description: ''
+              type: string
+              example: SurnameIsPersistentInExaple
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 100
+        name:
+          description: ''
+          type: string
+          example: NameIsPersistentInExaple
+        surname:
+          description: ''
+          type: string
+          example: SurnameIsPersistentInExaple
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/100"
+      path_params:
+        id: '100'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+
+    """

data/features/controller_schema_scaffolding.feature

@@ -13,7 +13,7 @@ Feature: controller schema scaffolding
         render_views
 
         let!(:user) do
-          User.where(name: 'razum2um').first_or_create!
+          User.where(name: 'razum2um', surname: 'Marley').first_or_create!
         end
 
         it "shows user" do
@@ -55,6 +55,10 @@ Feature: controller schema scaffolding
           description: ''
           type: string
           example: razum2um
+        surname:
+          description: ''
+          type: string
+          example: Marley
     extensions:
       method: GET
       path_info: "/api/v1/users/1.json"

data/features/multitype_request_support.feature

@@ -0,0 +1,139 @@
+Feature: multitype request support
+
+  If your API add new type for the same request parameter
+  and the new code isn't breaking it
+  you'll see nothing special, just passing specs
+
+  Background:
+    Given a file named "lurker/api/v2/users/__id-PATCH.json.yml" with:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            surname:
+              description: ''
+              type: integer
+              example: 42
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 1
+        name:
+          description: ''
+          type: string
+          example: razum2um
+        surname:
+          description: ''
+          type: string
+          example: Marley
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/1"
+      path_params:
+        id: '1'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+    """
+
+  Scenario: json schema tests response parameters and update request parameters 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
+
+          let(:user) do
+            User.where(name: 'razum2um', surname: 'Unknown').first_or_create!
+          end
+
+          it "updates a user surname as string" do
+            patch :update, 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`
+  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:
+    """yml
+    ---
+    description: user updating
+    prefix: users management
+    requestParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        user:
+          description: ''
+          type: object
+          additionalProperties: false
+          required: []
+          properties:
+            surname:
+              anyOf:
+              - description: ''
+                type: integer
+                example: 42
+              - description: ''
+                type: string
+                example: Marley
+    responseCodes:
+    - status: 200
+      successful: true
+      description: ''
+    responseParameters:
+      description: ''
+      type: object
+      additionalProperties: false
+      required: []
+      properties:
+        id:
+          description: ''
+          type: integer
+          example: 1
+        name:
+          description: ''
+          type: string
+          example: razum2um
+        surname:
+          description: ''
+          type: string
+          example: Marley
+    extensions:
+      method: PATCH
+      path_info: "/api/v2/users/1"
+      path_params:
+        id: '1'
+        controller: api/v2/users
+        action: update
+      suffix: ''
+
+    """

data/features/request_schema_scaffolding.feature

@@ -11,11 +11,11 @@ Feature: request schema scaffolding
 
       describe Api::V1::UsersController, :lurker do
         let!(:user) do
-          User.where(name: 'razum2um').first_or_create!
+          User.where(name: 'razum2um', surname: 'Marley').first_or_create!
         end
 
         let!(:bot) do
-          User.where(name: 'bot').first_or_create!
+          User.where(name: 'bot', surname: 'google').first_or_create!
         end
 
         it "lists all the users" do
@@ -64,6 +64,10 @@ Feature: request schema scaffolding
             description: ''
             type: string
             example: razum2um
+          surname:
+            description: ''
+            type: string
+            example: Marley
     extensions:
       method: GET
       path_info: "/api/v1/users.json"
@@ -75,5 +79,3 @@ Feature: request schema scaffolding
       suffix: ''
 
     """
-
-