Feature/rspec api documentation integration

.reek.yml

@@ -117,7 +117,8 @@ detectors:
       - _
   UnusedParameters:
     enabled: true
-    exclude: []
+    exclude:
+      - DeviseTokenAuth::TokenFactory#self.create
   UnusedPrivateMethod:
     enabled: false
   UtilityFunction:

.rubocop.yml

@@ -18,6 +18,10 @@ Metrics/AbcSize:
     - db/migrate/20161011151353_devise_create_users.rb
     - db/migrate/20181102142200_create_active_storage_tables.active_storage.rb
 
+Lint/UnusedMethodArgument:
+  Exclude:
+    - spec/support/devise_token_auth_overrides.rb
+
 Layout/LineLength:
   Exclude:
     - db/migrate/20161011184702_devise_create_admin_users.rb

Gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 6.0.0'
 gem 'activeadmin', '~> 2.8'
 gem 'active_storage_base64', '~> 1.0.0'
 gem 'arctic_admin', '~> 3.2'
-gem 'aws-sdk-s3', '~> 1', require: false
+gem 'aws-sdk-s3', '~> 1.75', require: false
 gem 'bootsnap', '~> 1.4', '>= 1.4.5'
 gem 'delayed_job_active_record', '~> 4.1', '>= 4.1.4'
 gem 'devise', '~> 4.7', '>= 4.7.2'
@@ -39,6 +39,7 @@ group :development, :test do
   gem 'factory_bot_rails', '~> 5.1', '>= 5.1.1'
   gem 'pry-byebug', '~> 3.9', platform: :mri
   gem 'pry-rails', '~> 0.3.9'
+  gem 'rspec_api_documentation', '~> 6.1.0'
   gem 'rspec-rails', '~> 3.9'
 end
 

Gemfile.lock

@@ -86,21 +86,21 @@ GEM
       font-awesome-sass (~> 5.0)
       jquery-rails
     ast (2.4.1)
-    aws-eventstream (1.0.3)
-    aws-partitions (1.239.0)
-    aws-sdk-core (3.77.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.379.0)
+    aws-sdk-core (3.109.0)
+      aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.36.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-kms (1.39.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.74.0)
-      aws-sdk-core (~> 3, >= 3.102.1)
+    aws-sdk-s3 (1.82.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.1)
+    aws-sigv4 (1.2.2)
       aws-eventstream (~> 1, >= 1.0.2)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
@@ -246,6 +246,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.14.2)
     msgpack (1.3.1)
+    mustache (1.1.1)
     nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
@@ -340,6 +341,10 @@ GEM
       actionpack (>= 5.0)
       railties (>= 5.0)
     rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
     rspec-core (3.9.2)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
@@ -357,6 +362,10 @@ GEM
       rspec-mocks (~> 3.9.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rspec_api_documentation (6.1.0)
+      activesupport (>= 3.0.0)
+      mustache (~> 1.0, >= 0.99.4)
+      rspec (~> 3.0)
     rubocop (0.89.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
@@ -450,7 +459,7 @@ DEPENDENCIES
   activeadmin (~> 2.8)
   annotate (~> 3.0, >= 3.0.3)
   arctic_admin (~> 3.2)
-  aws-sdk-s3 (~> 1)
+  aws-sdk-s3 (~> 1.75)
   better_errors (~> 2.5, >= 2.5.1)
   binding_of_caller (~> 0.8.0)
   bootsnap (~> 1.4, >= 1.4.5)
@@ -480,6 +489,7 @@ DEPENDENCIES
   rails_best_practices (~> 1.19.4)
   reek (~> 5.5)
   rspec-rails (~> 3.9)
+  rspec_api_documentation (~> 6.1.0)
   rubocop-rails (~> 2.3, >= 2.3.2)
   rubocop-rootstrap (~> 0.1.2)
   sendgrid (~> 1.2.4)

README.md

@@ -26,6 +26,7 @@ This template comes with:
 - API documentation following https://apiblueprint.org/
 - Docker support
 - Exception Tracking
+- RSpec API Doc Generator
 
 ## How to use
 
@@ -86,6 +87,7 @@ This template comes with:
 - [Rails Best Practices](https://github.com/flyerhzm/rails_best_practices) for rails linting
 - [Reek](https://github.com/troessner/reek) for ruby linting
 - [RSpec](https://github.com/rspec/rspec) for testing
+- [Rspec API Doc Generator](https://github.com/zipmark/rspec_api_documentation) for API documentation
 - [Rubocop](https://github.com/bbatsov/rubocop/) for ruby linting
 - [Sendgrid](https://github.com/stephenb/sendgrid) for sending mails
 - [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) adds other testing matchers
@@ -103,6 +105,15 @@ This template comes with:
 
 http://docs.railsapibase.apiary.io
 
+With [Rspec API Doc Generator](https://github.com/zipmark/rspec_api_documentation) you can generate the docs after writing the acceptance specs.
+
+Just run:
+
+`./bin/docs `
+
+An `apiary.apib` file will be generated at the root directory of the project.
+
+
 ## Code quality
 
 With `rake code_analysis` you can run the code analysis tool, you can omit rules with: