[BACKEND] - Add JWT authentication solution

.env.example

@@ -1,6 +1,9 @@
 
 # export RAILS_ENV=development
 
+## Host
+export DEFAULT_HOST=example.com
+
 ## Puma
 # export PORT=3000
 # export PIDFILE=tmp/pids/server.pid
@@ -30,3 +33,7 @@ export POSTGRES_DB=baseapp
 ## Sidekiq web
 # export SIDEKIQ_WEB_USERNAME=sidekiq-web-dashboard
 # export SIDEKIQ_WEB_PASSWORD=sidekiq-web-123
+
+## Secret keys
+# You can use `rake secret` command to generate a secret key
+export DEVISE_JWT_SECRET_KEY=my-jwt-secret-key

.env.test

@@ -0,0 +1,25 @@
+
+## Host
+export DEFAULT_HOST=localhost
+
+## Postgres
+export POSTGRES_HOST=localhost
+export POSTGRES_PORT=5432
+export POSTGRES_USER=postgres
+export POSTGRES_PASSWORD=postgres
+export POSTGRES_DB=baseapp_test
+
+## Redis URL
+# export REDIS_URL=redis://redis:6379/1
+# export REDIS_CHANNEL_PREFIX=baseapp
+
+## Action cable
+# export ACTION_CABLE_URL=ws://localhost:28080
+# export ACTION_CABLE_ALLOWED_REQUEST_ORIGINS=http:\/\/localhost*
+# Examples:
+#   http:\/\/localhost*
+#   http:\/\/example.*,https:\/\/example.*
+
+## Secret keys
+# You can use `rake secret` command to generate a secret key
+export DEVISE_JWT_SECRET_KEY=bad60161405df79d927357174573d3ef5f8e1086786e9102cdd39d490cab0d7307150d08f8fa9b3e2ef32031a61df7516c8b44a1c0456d8d98b3a32f17aa439

.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.2 # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install Yarn
+        run: |
+          npm install yarn
+          yarn --version
+          yarn install
+
+      - name: Prepare environment
+        run: |
+          bundle exec overcommit --sign
+          bundle exec overcommit --sign pre-commit
+
+      - name: Run all checks
+        run: SKIP=AuthorName,AuthorEmail bundle exec overcommit --run
+
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      RAILS_ENV: test
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options:
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --entrypoint redis-server
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.2 # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Install dependent libraries
+        run: sudo apt-get install libpq-dev
+
+      - name: Create DB
+        run: |
+          bundle exec rails db:reset
+
+      - name: Run tests
+        run: bundle exec rspec

.gitignore

@@ -42,6 +42,7 @@ yarn-error.log*
 # Ignore env files
 .env*
 !.env.example
+!.env.test
 
 # Vite Ruby
 /public/vite

.rubocop.yml

@@ -12,6 +12,7 @@ AllCops:
   Exclude:
     - "lib/**/*"
     - "bin/**/*"
+    - "db/schema.rb"
 
 Metrics/BlockLength:
   IgnoredMethods:
@@ -24,3 +25,9 @@ Metrics/BlockLength:
     - draw
     - configure
     - group
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

Gemfile

@@ -28,7 +28,7 @@ gem 'redis', '~> 4.0'
 # gem "bcrypt", "~> 3.1.7"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem 'tzinfo-data', platforms: %i( mingw mswin x64_mingw jruby )
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
 
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', require: false
@@ -56,6 +56,14 @@ gem 'jsonapi.rb'
 # Simple, efficient background processing for Ruby
 gem 'sidekiq'
 
+# provides support for Cross-Origin Resource Sharing (CORS)
+gem 'rack-cors'
+
+# a flexible authentication solution
+gem 'devise'
+# a devise extension which uses JWT tokens for user authentication
+gem 'devise-jwt'
+
 # Linting
 gem 'brakeman'
 gem 'bundler-audit'
@@ -65,11 +73,11 @@ gem 'overcommit'
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem 'debug', platforms: %i( mri mingw x64_mingw )
-  gem 'rspec-rails', '~> 5.0.0'
   gem 'annotate'
-  gem 'pry'
+  gem 'debug', platforms: %i[mri mingw x64_mingw]
   gem 'dotenv-rails'
+  gem 'pry'
+  gem 'rspec-rails', '~> 5.0.0'
   gem 'rubocop', require: false
   gem 'rubocop-performance'
   gem 'rubocop-rails', require: false
@@ -90,12 +98,12 @@ end
 group :test do
   # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
   gem 'capybara'
+  gem 'database_cleaner-active_record'
+  gem 'factory_bot_rails'
+  gem 'faker'
   # RSpec matchers for JSON API.
   gem 'jsonapi-rspec'
   gem 'selenium-webdriver'
-  gem 'webdrivers'
-  gem 'factory_bot_rails'
-  gem 'faker'
-  gem 'database_cleaner-active_record'
   gem 'simplecov', require: false
+  gem 'webdrivers'
 end

Gemfile.lock

@@ -72,6 +72,7 @@ GEM
       activerecord (>= 3.2, < 8.0)
       rake (>= 10.4, < 14.0)
     ast (2.4.2)
+    bcrypt (3.1.17)
     bindex (0.8.1)
     bootsnap (1.11.1)
       msgpack (~> 1.2)
@@ -102,14 +103,33 @@ GEM
     debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
+    devise (4.8.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    devise-jwt (0.9.0)
+      devise (~> 4.0)
+      warden-jwt_auth (~> 0.6)
     diff-lcs (1.5.0)
     digest (3.1.0)
     docile (1.4.0)
     dotenv (2.7.6)
     dotenv-rails (2.7.6)
       dotenv (= 2.7.6)
       railties (>= 3.2)
+    dry-auto_inject (0.9.0)
+      dry-container (>= 0.3.4)
     dry-cli (0.7.0)
+    dry-configurable (0.14.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
     erubi (1.10.0)
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
@@ -143,6 +163,7 @@ GEM
     jsonapi.rb (2.0.0)
       jsonapi-serializer
       rack
+    jwt (2.3.0)
     license_finder (7.0.1)
       bundler
       rubyzip (>= 1, < 3)
@@ -180,6 +201,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.13.4-x86_64-linux)
       racc (~> 1.4)
+    orm_adapter (0.5.0)
     overcommit (0.58.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -198,6 +220,8 @@ GEM
       nio4r (~> 2.0)
     racc (1.6.0)
     rack (2.2.3)
+    rack-cors (1.1.1)
+      rack (>= 2.0.0)
     rack-proxy (0.7.2)
       rack
     rack-test (1.1.0)
@@ -234,6 +258,9 @@ GEM
     regexp_parser (2.3.0)
     reline (0.3.1)
       io-console (~> 0.5)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
     rexml (3.2.5)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
@@ -312,6 +339,13 @@ GEM
       dry-cli (~> 0.7.0)
       rack-proxy (~> 0.6, >= 0.6.1)
       zeitwerk (~> 2.2)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    warden-jwt_auth (0.6.0)
+      dry-auto_inject (~> 0.8)
+      dry-configurable (~> 0.13)
+      jwt (~> 2.1)
+      warden (~> 1.2)
     web-console (4.2.0)
       actionview (>= 6.0.0)
       activemodel (>= 6.0.0)
@@ -343,6 +377,8 @@ DEPENDENCIES
   capybara
   database_cleaner-active_record
   debug
+  devise
+  devise-jwt
   dotenv-rails
   factory_bot_rails
   faker
@@ -358,6 +394,7 @@ DEPENDENCIES
   pg (~> 1.1)
   pry
   puma (~> 5.0)
+  rack-cors
   rails (~> 7.0.2.3)
   redis (~> 4.0)
   rspec-rails (~> 5.0.0)