rspec-rails-api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74591eecb7e2b200f536ca31e72097ed9921da563a87490288f536edec32f728
-  data.tar.gz: a5ec7199c37b2bf493eec385b3f294561acfa409c46dac9d744f1d7679a37f30
+  metadata.gz: 5c81756e5b64eb7e5d7363231a498c947377879806b92dac3d8f11c0d28fd7bb
+  data.tar.gz: 728634d884084a356b2f2d29ae410b6a54c70d47a8dfe9f0ac821bc75a80e160
 SHA512:
-  metadata.gz: 4922b2a7257f432048f37cb9d73faf8b0b15a7750760429f3f29b657d282b5e556e9b380813843574d5be116ed040bd71a91ddb2301f0d65df6f38b70981204d
-  data.tar.gz: b82d1c509e096f1ac04bebe56dbed7a4ed9e49a9de47b525cae0bba2355033ed61a727a17fb9691701f10dc0ba36be4c00a9b62531c2621b302910a25d200511
+  metadata.gz: 6b50cb2972931d3a160bd2e3ab7ee73d73d4a762c7ee8e9264fae4903b3a98954d8d34aa6dc1aeecbd1fe40dea99cc6d02bd592e710a9a136b4665dd0285cd03
+  data.tar.gz: 482ab0880d61cf4b709034903a7509b57750bf121dcdab9acba7bc519ef4fd8e9c079f2b263d3c7732db18e8fbb6f333743ccd700ebe286fcb548ca3c1b8cbde

data/README.md

@@ -380,7 +380,7 @@ on_post '/api/items' do
 end
 ```
 
-##### `for_code(http_status, description = nil, doc_only: false &block)`
+##### `for_code(http_status, description = nil, doc_only: false, test_only: false &block)`
 
 Describes the desired output for a precedently defined URL.
 
@@ -388,6 +388,9 @@ Block takes one required argument, that should be passed to `visit`.
 This argument will contain the block context and allow `visit` to access
 the metadatas.
 
+You can have only one documented code per action/url, unless you use
+`test_only`.
+
 - `http_status` is an integer representing an
   [HTTP status](https://httpstat.us/)
 - `description` should be some valid
@@ -395,6 +398,8 @@ the metadatas.
   translation of the `http_status` will be used.
 - `doc_only` can be set to true to temporarily disable block execution
   and only create the documentation (without examples).
+- `test_only` will omit the test from the documentation. Useful when you
+  need to test things _around_ the call (response content, db,...)
 - `block` where additional tests can be performed. If `visit()` is
   called within the block, its output will be used in documentation
   examples, and the response type and code will actually be tested.
@@ -412,6 +417,11 @@ Once again, you have to pass an argument to the block if you use
     visit url
     # ...
   end
+  
+  for_code 200, 'Side test', test_only: true do |url|
+    visit url
+    # ...
+  end
 # ...
 ```
 

data/lib/rspec/rails/api/dsl/example.rb

@@ -6,7 +6,7 @@ module RSpec
       module DSL
         # These methods will be available in examples (i.e.: 'for_code')
         module Example
-          def visit(example, path_params: {}, payload: {}, headers: {}) # rubocop:disable Metrics/AbcSize
+          def visit(example, path_params: {}, payload: {}, headers: {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
             raise 'Missing context. Call visit with for_code context.' unless example
 
             status_code = prepare_status_code example.class.description
@@ -21,6 +21,8 @@ module RSpec
 
             check_response(response, status_code)
 
+            return if example.class.description.match?(/-> test (\d+)(.*)/)
+
             set_request_example example.class.metadata[:rrad], request_params, status_code, response.body
           end
 
@@ -86,7 +88,7 @@ module RSpec
           end
 
           def prepare_status_code(description)
-            code_match = /-> (\d+) - .*/.match description
+            code_match = /->(?: test)? (\d+) - .*/.match description
 
             raise 'Please provide a numerical code for the "for_code" block' unless code_match
 

data/lib/rspec/rails/api/dsl/example_group.rb

@@ -74,12 +74,12 @@ module RSpec
             describe("#{action.upcase} #{url}", &block)
           end
 
-          def for_code(status_code, description = nil, doc_only: false, &block)
+          def for_code(status_code, description = nil, doc_only: false, test_only: false, &block)
             description ||= Rack::Utils::HTTP_STATUS_CODES[status_code]
 
-            metadata[:rrad].add_status_code(status_code, description)
+            metadata[:rrad].add_status_code(status_code, description) unless test_only
 
-            describe "-> #{status_code} - #{description}" do
+            describe "->#{test_only ? ' test' : ''} #{status_code} - #{description}" do
               execute_for_code_block(status_code, doc_only, block)
             end
           end

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.3.0'
+      VERSION = '0.3.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport