Add RSpec testing framework and Rswag for API documentation. Configure Swagger endpoints and initialize Rswag settings. Create specs for authentication and posts management, including user registration, login, and CRUD operations for posts.

Author: ReddyWish

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -50,4 +50,12 @@ group :development, :test do
 
   # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
   gem "rubocop-rails-omakase", require: false
+
+  # RSpec testing framework
+  gem "rspec-rails"
+
+  # Swagger/OpenAPI documentation
+  gem "rswag-specs"
+  gem "rswag-ui"
+  gem "rswag-api"
 end

Gemfile.lock

@@ -75,6 +75,8 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
     bcrypt (3.1.20)
@@ -96,6 +98,7 @@ GEM
     debug (1.11.1)
       irb (~> 1.10)
       reline (>= 0.3.8)
+    diff-lcs (1.6.2)
     dotenv (3.2.0)
     drb (2.2.3)
     ed25519 (1.4.0)
@@ -122,6 +125,9 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.18.0)
+    json-schema (6.1.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
     jwt (3.1.2)
       base64
     kamal (2.10.1)
@@ -190,6 +196,7 @@ GEM
     psych (5.3.1)
       date
       stringio
+    public_suffix (7.0.2)
     puma (7.1.0)
       nio4r (~> 2.0)
     raabro (1.4.0)
@@ -244,6 +251,34 @@ GEM
     regexp_parser (2.11.3)
     reline (0.6.3)
       io-console (~> 0.5)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (8.0.2)
+      actionpack (>= 7.2)
+      activesupport (>= 7.2)
+      railties (>= 7.2)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.6)
+    rswag-api (2.17.0)
+      activesupport (>= 5.2, < 8.2)
+      railties (>= 5.2, < 8.2)
+    rswag-specs (2.17.0)
+      activesupport (>= 5.2, < 8.2)
+      json-schema (>= 2.2, < 7.0)
+      railties (>= 5.2, < 8.2)
+      rspec-core (>= 2.14)
+    rswag-ui (2.17.0)
+      actionpack (>= 5.2, < 8.2)
+      railties (>= 5.2, < 8.2)
     rubocop (1.82.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -338,6 +373,10 @@ DEPENDENCIES
   puma (>= 5.0)
   rack-cors
   rails (~> 8.1.1)
+  rspec-rails
+  rswag-api
+  rswag-specs
+  rswag-ui
   rubocop-rails-omakase
   solid_cable
   solid_cache

config/initializers/rswag_api.rb

@@ -0,0 +1,14 @@
+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.openapi_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,16 @@
+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 openapi_root) as JSON or YAML endpoints, then the list below should
+  # correspond to the relative paths for those endpoints.
+
+  c.openapi_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,6 @@
 Rails.application.routes.draw do
+  mount Rswag::Ui::Engine => '/api-docs'
+  mount Rswag::Api::Engine => '/api-docs'
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.

spec/rails_helper.rb

@@ -0,0 +1,71 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require_relative '../config/environment'
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+# Uncomment the line below in case you have `--require rails_helper` in the `.rspec` file
+# that will avoid rails generators crashing because migrations haven't been run yet
+# return unless Rails.env.test?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+Rails.root.glob('spec/support/**/*.rb').sort_by(&:to_s).each { |f| require f }
+
+# Ensures that the test database schema matches the current schema file.
+# If there are pending migrations it will invoke `db:test:prepare` to
+# recreate the test database by loading the schema.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  abort e.to_s.strip
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_paths = [
+    Rails.root.join('spec/fixtures')
+  ]
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails uses metadata to mix in different behaviours to your tests,
+  # for example enabling you to call `get` and `post` in request specs. e.g.:
+  #
+  #     RSpec.describe UsersController, type: :request do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://rspec.info/features/8-0/rspec-rails
+  #
+  # You can also this infer these behaviours automatically by location, e.g.
+  # /spec/models would pull in the same behaviour as `type: :model` but this
+  # behaviour is considered legacy and will be removed in a future version.
+  #
+  # To enable this behaviour uncomment the line below.
+  # config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

spec/requests/api/v1/auth_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'swagger_helper'
+
+RSpec.describe 'Auth API', type: :request do
+  path '/api/v1/signup' do
+    post 'Register a new user' do
+      tags 'Authentication'
+      consumes 'application/json'
+      produces 'application/json'
+
+      parameter name: :user, in: :body, schema: {
+        type: :object,
+        properties: {
+          name: { type: :string, example: 'John Doe' },
+          email: { type: :string, format: :email, example: 'john@example.com' },
+          password: { type: :string, minLength: 6, example: 'password123' },
+          password_confirmation: { type: :string, example: 'password123' }
+        },
+        required: %w[name email password]
+      }
+
+      response '201', 'User created successfully' do
+        schema type: :object,
+               properties: {
+                 user: { '$ref' => '#/components/schemas/User' },
+                 message: { type: :string, example: 'Account created successfully' }
+               },
+               required: %w[user message]
+
+        let(:user) { { name: 'John Doe', email: 'john@example.com', password: 'password123' } }
+        run_test!
+      end
+
+      response '422', 'Validation errors' do
+        schema '$ref' => '#/components/schemas/ValidationErrors'
+
+        let(:user) { { name: '', email: 'invalid', password: '123' } }
+        run_test!
+      end
+    end
+  end
+
+  path '/api/v1/login' do
+    post 'Authenticate user and receive token cookie' do
+      tags 'Authentication'
+      consumes 'application/json'
+      produces 'application/json'
+
+      parameter name: :credentials, in: :body, schema: {
+        type: :object,
+        properties: {
+          email: { type: :string, format: :email, example: 'john@example.com' },
+          password: { type: :string, example: 'password123' }
+        },
+        required: %w[email password]
+      }
+
+      response '200', 'Logged in successfully' do
+        schema type: :object,
+               properties: {
+                 user: { '$ref' => '#/components/schemas/User' },
+                 message: { type: :string, example: 'Logged in successfully' }
+               },
+               required: %w[user message]
+
+        let(:existing_user) { User.create!(name: 'John', email: 'john@example.com', password: 'password123') }
+        let(:credentials) { { email: existing_user.email, password: 'password123' } }
+        run_test!
+      end
+
+      response '401', 'Invalid credentials' do
+        schema '$ref' => '#/components/schemas/Error'
+
+        let(:credentials) { { email: 'wrong@example.com', password: 'wrong' } }
+        run_test!
+      end
+    end
+  end
+
+  path '/api/v1/logout' do
+    delete 'Log out current user' do
+      tags 'Authentication'
+      produces 'application/json'
+      security [ cookieAuth: [] ]
+
+      response '200', 'Logged out successfully' do
+        schema type: :object,
+               properties: {
+                 message: { type: :string, example: 'Logged out successfully' }
+               },
+               required: %w[message]
+
+        let(:user) { User.create!(name: 'John', email: 'john@example.com', password: 'password123') }
+        before { sign_in(user) }
+        run_test!
+      end
+    end
+  end
+
+  path '/api/v1/me' do
+    get 'Get current authenticated user' do
+      tags 'Authentication'
+      produces 'application/json'
+      security [ cookieAuth: [] ]
+
+      response '200', 'Current user retrieved' do
+        schema '$ref' => '#/components/schemas/User'
+
+        let(:user) { User.create!(name: 'John', email: 'john@example.com', password: 'password123') }
+        before { sign_in(user) }
+        run_test!
+      end
+
+      response '401', 'Not authenticated' do
+        schema '$ref' => '#/components/schemas/Error'
+        run_test!
+      end
+    end
+  end
+end