Replace apivore with rswag for api tests (#969)

* Replace apivore api tests with rswag
* move to OpenAPI Spec 3.0.1
* a swagger UI is now reachable at http://localhost:3000/api-docs/index.html
*  swagger file is generated by running  `RAILS_ENV=test rails rswag`
    and it was moved from /docs/swagger.v1.yml to /swagger/v1/swagger.yml

---------

Co-authored-by: viehlieb <[email protected]>

.rubocop_todo.yml

@@ -451,6 +451,15 @@ RSpec/DescribedClass:
  - "spec/models/ordergroup_spec.rb"
  - "spec/models/user_spec.rb"
 
+# Offense count: 15
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/EmptyExampleGroup:
+ Exclude:
+ # exclude for rswag tests:
+ - 'spec/requests/api/**/*_spec.rb'
+
+
+
 # Offense count: 65
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
@@ -581,6 +590,14 @@ RSpec/ScatteredSetup:
  - "spec/integration/balancing_spec.rb"
  - "spec/integration/login_spec.rb"
 
+# Offense count: 4
+# Configuration parameters: AllowedPatterns, IgnoredPatterns.
+# SupportedStyles: snake_case, camelCase
+RSpec/VariableName:
+ EnforcedStyle: snake_case
+ AllowedPatterns:
+ - ^Authorization$
+
 # Offense count: 1
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:

Gemfile

@@ -55,6 +55,9 @@ gem 'gaffe'
 gem 'ruby-filemagic'
 gem 'mime-types'
 gem 'midi-smtp-server'
+gem 'hashie', '~> 3.4.6', require: false # https:/westfieldlabs/apivore/issues/114
+gem 'rswag-api'
+gem 'rswag-ui'
 
 # we use the git version of acts_as_versioned, and need to include it in this Gemfile
 gem 'acts_as_versioned', git: 'https:/technoweenie/acts_as_versioned.git'
@@ -116,6 +119,5 @@ group :test do
  gem 'simplecov', require: false
  gem 'simplecov-lcov', require: false
  # api
- gem 'apivore', require: false
- gem 'hashie', '~> 3.4.6', require: false # https:/westfieldlabs/apivore/issues/114
+ gem 'rswag-specs'
 end

Gemfile.lock

@@ -109,13 +109,6 @@ GEM
  activerecord (>= 3.0.0)
  addressable (2.8.1)
  public_suffix (>= 2.0.2, < 6.0)
- apivore (1.6.2)
- actionpack (>= 4, < 6)
- hashie (~> 3.3)
- json-schema (~> 2.5)
- rspec (~> 3)
- rspec-expectations (~> 3.1)
- rspec-mocks (~> 3.1)
  apparition (0.6.0)
  capybara (~> 3.13, < 4)
  websocket-driver (>= 0.6.5)
@@ -430,6 +423,16 @@ GEM
  rspec-rerun (1.1.0)
  rspec (~> 3.0)
  rspec-support (3.11.1)
+ rswag-api (2.7.0)
+ railties (>= 3.1, < 7.1)
+ rswag-specs (2.7.0)
+ activesupport (>= 3.1, < 7.1)
+ json-schema (>= 2.2, < 4.0)
+ railties (>= 3.1, < 7.1)
+ rspec-core (>= 2.14)
+ rswag-ui (2.7.0)
+ actionpack (>= 3.1, < 7.1)
+ railties (>= 3.1, < 7.1)
  rubocop (1.36.0)
  json (~> 2.3)
  parallel (~> 1.10)
@@ -557,7 +560,6 @@ DEPENDENCIES
  active_model_serializers (~> 0.10.0)
  acts_as_tree
  acts_as_versioned!
- apivore
  apparition
  attribute_normalizer
  better_errors
@@ -617,6 +619,9 @@ DEPENDENCIES
  rspec-core
  rspec-rails
  rspec-rerun
+ rswag-api
+ rswag-specs
+ rswag-ui
  rubocop
  rubocop-rails
  rubocop-rspec

config/initializers/rswag_api.rb

@@ -0,0 +1,13 @@
+Rswag::Api.configure do |c|
+ # Specify a root folder where Swagger JSON files are located
+ # This is used by the Swagger middleware to serve requests for API descriptions
+ # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
+ # that it's configured to generate files in the same folder
+ c.swagger_root = Rails.root.to_s + '/swagger'
+
+ # Inject a lambda function to alter the returned Swagger prior to serialization
+ # The function will have access to the rack env for the current request
+ # For example, you could leverage this to dynamically assign the "host" property
+ #
+ # c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

config/initializers/rswag_ui.rb

@@ -0,0 +1,15 @@
+Rswag::Ui.configure do |c|
+ # List the Swagger endpoints that you want to be documented through the
+ # swagger-ui. The first parameter is the path (absolute or relative to the UI
+ # host) to the corresponding endpoint and the second is a title that will be
+ # displayed in the document selector.
+ # NOTE: If you're using rspec-api to expose Swagger files
+ # (under swagger_root) as JSON or YAML endpoints, then the list below should
+ # correspond to the relative paths for those endpoints.
+
+ c.swagger_endpoint '/api-docs/v1/swagger.yaml', 'API V1 Docs'
+
+ # Add Basic Auth in case your API is private
+ # c.basic_auth_enabled = true
+ # c.basic_auth_credentials 'username', 'password'
+end

config/routes.rb

@@ -1,4 +1,7 @@
+# rubocop:disable Metrics/BlockLength
 Rails.application.routes.draw do
+ mount Rswag::Ui::Engine => '/api-docs'
+ mount Rswag::Api::Engine => '/api-docs'
  get "order_comments/new"
 
  get "comments/new"
@@ -290,3 +293,4 @@
  resources :users, only: [:index]
  end # End of /:foodcoop scope
 end
+# rubocop:enable Metrics/BlockLength

doc/API.md

@@ -5,9 +5,11 @@ like listing open orders, updating the ordergroup's order, and listing financial
 transactions. Not all Foodsoft functionality is available through the API, but
 we're open for new additions.
 
-The API is documented using [Open API 2.0](https:/OAI/OpenAPI-Specification)
-/ [Swagger](https://swagger.io/) in [swagger.v1.yml](swagger.v1.yml).
+The API is documented using [Open API 3.0.1](https:/OAI/OpenAPI-Specification)
+/ [Swagger](https://swagger.io/) in [swagger.yaml](/swagger/v1/swagger.yaml).
 This provides a machine-readable reference that is used to provide documentation.
+It is generated by [rswag](https:/rswag) wich also provides api-tests.
+It can be generated running `RAILS_ENV=test rails rswag`.
 
 **Note:** the current OAuth scopes may be subject to change, until the next release of Foodsoft.