rspec-rails-api 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0861008371cafa6cab0cda5c165acda54b5a3047f152713bb684ae0c7c7be0ff'
-  data.tar.gz: d3c8877c5ef1e43c902010b68b9e483feefa6e57251d67aba325394a9682aee7
+  metadata.gz: df99a2088657641a87ec55c6159cdf7973d75863718f94aebef6cc70d7b4ac95
+  data.tar.gz: 4bf341e1fc70d6dfe760a531e43aec6c4c8002b3c1000fe83d1b2ae3cac3f3a0
 SHA512:
-  metadata.gz: e1009f40d78187888e546c74e62e88d7557f45a4a3cfed78a27785d63b401f673ed1796928f1d32823a665694b86761653bb87edc68522418d6117c4b576e362
-  data.tar.gz: 10ffebb4902456c4671b39b7dd707ea8ca870b9a27054c3139cae94bb3dcebfc3f88abd41a298ed870f98d7953c1195171cbf8f077db2dcd6530fe761e354a5a
+  metadata.gz: 42b42ba732de1383324dde829463f6a042289f184a959a9dc1c8ff727d8fd56699f7e97f40d215f184f724249517be826f5de4a66a5e684593a166ee25843624
+  data.tar.gz: 2daa6738912fcf4192e7c155a6744400420cabb5b1422de6dca77d34ece4dee59528d228b85af52fed0e5eaa17aebb4d14b06ca46e913a81c46318c8b11b67da

data/.gitlab-ci.yml

@@ -35,9 +35,10 @@ rspec:
   dependencies:
     - bundle
 
-rspec-dummy:
+dummy:
   stage: test
   script:
     - cd dummy
     - bundle install --path='vendor/bundle'
+    - bundle exec rubocop
     - bundle exec rspec

data/CHANGELOG.md

@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
 
 ## Not released
 
+## 0.2.1/0.2.2 - 2019-11-03
+
+_Version 0.2.1 was released and yanked by mistake. Version 0.2.2 is the exact
+same one, with a version bump_
+
+### Changed
+
+- `for_code` method now have its `description` optional. If none is provided,
+  the description will be set from the status code.
+
 ## 0.2.0 - 2019-11-02
 
 ### Added
@@ -40,7 +50,7 @@ of the fixtures.
 ### Added
 
 - Added ability to document API descriptions, servers, etc... from the RSpec helper files
-  
+
 ## 0.1.2 - 2019-10-22
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
 # RSpec-rails-api
 
-> An RSpec plugin to test Rails api responses and generate swagger
+> An RSpec plugin to test Rails API responses and generate swagger
 > documentation
 
 **This is a work in progress** but you're welcome to help, test, submit
@@ -8,9 +8,6 @@ issues, ...
 
 ## Installation
 
-As the gem is not yet published, you have to specify its git repository
-in order to test it.
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -381,7 +378,7 @@ on_post '/api/items' do
 end
 ```
 
-##### `for_code(http_status, description, doc_only: false &block)`
+##### `for_code(http_status, description = nil, doc_only: false &block)`
 
 Describes the desired output for a precedently defined URL.
 
@@ -392,7 +389,8 @@ the metadatas.
 - `http_status` is an integer representing an
   [HTTP status](https://httpstat.us/)
 - `description` should be some valid
-  [CommonMark](https://commonmark.org/)
+  [CommonMark](https://commonmark.org/). If not defined, a human readable
+  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).
 - `block` where additional tests can be performed. If `visit()` is

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

@@ -74,17 +74,13 @@ module RSpec
             describe("#{action.upcase} #{url}", &block)
           end
 
-          def for_code(status_code, description, doc_only: false, &block)
+          def for_code(status_code, description = nil, doc_only: false, &block)
+            description ||= Rack::Utils::HTTP_STATUS_CODES[status_code]
+
             metadata[:rrad].add_status_code(status_code, description)
 
             describe "-> #{status_code} - #{description}" do
-              if (!ENV['DOC_ONLY'] || ENV['DOC_ONLY'] == 'false' || !doc_only) && block
-                example 'Test and create documentation', caller: block.send(:caller) do
-                  instance_eval(&block) if block_given?
-                end
-              else
-                document_only status_code
-              end
+              execute_for_code_block(status_code, doc_only, block)
             end
           end
 
@@ -98,6 +94,16 @@ module RSpec
               set_request_example parent_example.metadata[:rrad], request_params, status_code
             end
           end
+
+          def execute_for_code_block(status_code, doc_only, callback_block)
+            if (!ENV['DOC_ONLY'] || ENV['DOC_ONLY'] == 'false' || !doc_only) && callback_block
+              example 'Test and create documentation', caller: callback_block.send(:caller) do
+                instance_eval(&callback_block) if callback_block
+              end
+            else
+              document_only status_code
+            end
+          end
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.2.0'
+      VERSION = '0.2.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-02 00:00:00.000000000 Z
+date: 2019-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport