Skip to content

Feature/rspec api documentation integration #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JuannFerrari merged 13 commits into from
Oct 6, 2020
Merged

Feature/rspec api documentation integration #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
847eb42
Initial commit
JuannFerrari Oct 2, 2020
1a2ef20
Add acceptance specs
JuannFerrari Oct 2, 2020
72ff5f2
Finish acceptance specs
JuannFerrari Oct 5, 2020
92d917f
Merge branch 'master' into feature/rspec-api-documentation-integration
JuannFerrari Oct 5, 2020
79f5b05
Missing new line
JuannFerrari Oct 5, 2020
1ba8411
Update README.md
JuannFerrari Oct 5, 2020
c27ceaa
Add token auth overrides
JuannFerrari Oct 5, 2020
aa6debe
Update README.md
JuannFerrari Oct 5, 2020
46dad81
Remove unneeded empty newline
JuannFerrari Oct 5, 2020
1453ca5
Merge branch 'feature/rspec-api-documentation-integration' of github.…
JuannFerrari Oct 5, 2020
b168185
Update README.md
JuannFerrari Oct 5, 2020
c6348d2
Merge branch 'feature/rspec-api-documentation-integration' of github.…
JuannFerrari Oct 5, 2020
9a109f0
Add executable permissions to /bin/docs file
JuannFerrari Oct 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .reek.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ detectors:
- _
UnusedParameters:
enabled: true
exclude: []
exclude:
- DeviseTokenAuth::TokenFactory#self.create
UnusedPrivateMethod:
enabled: false
UtilityFunction:
Expand Down
4 changes: 4 additions & 0 deletions .rubocop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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

Expand Down
30 changes: 20 additions & 10 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down
Loading