Merge pull request #12 from tuanle03/develop

Release v17.12.2023

Author: tuanle03

.github/workflows/rspec.yml

@@ -0,0 +1,15 @@
+name: Run RSpec tests
+on: [push]
+jobs:
+  run-rspec-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.0
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rspec

Gemfile

@@ -56,6 +56,7 @@ 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'
+  gem 'factory_bot_rails'
 end
 
 group :development do

Gemfile.lock

@@ -108,6 +108,11 @@ GEM
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
     erubi (1.12.0)
+    factory_bot (6.4.2)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.4.2)
+      factory_bot (~> 6.4)
+      railties (>= 5.0.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.1)
@@ -273,6 +278,7 @@ DEPENDENCIES
   debug
   devise
   devise-jwt
+  factory_bot_rails
   importmap-rails
   jbuilder
   puma (~> 5.0)

README.md

@@ -1,24 +1,69 @@
-# README
+# Awesome Blog API
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Welcome to the Awesome Blog API repository! This project is built using Ruby on Rails, Grape API, JWT (JSON Web Tokens), and Swagger. It provides a robust backend for a web blog application, allowing you to create, retrieve, update, and delete blog posts, comments, and more through a RESTful API.
 
-Things you may want to cover:
+## Table of Contents
 
-* Ruby version
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+- [JWT Authentication](#jwt-authentication)
+- [Swagger Documentation](#swagger-documentation)
+- [Contributing](#contributing)
+- [License](#license)
 
-* System dependencies
+## Features
 
-* Configuration
+- User authentication and authorization using JWT.
+- CRUD operations for blog posts, comments, and user profiles.
+- API documentation using Swagger.
+- Consistent and clean codebase following Ruby on Rails best practices.
 
-* Database creation
+## Prerequisites
 
-* Database initialization
+Before you begin, ensure you have the following prerequisites installed:
 
-* How to run the test suite
+- Ruby (version 3.2.0)
+- Ruby on Rails (version 7.0)
 
-* Services (job queues, cache servers, search engines, etc.)
+## Getting Started
 
-* Deployment instructions
+### Installation
 
-* ...
+1. Clone the repository:
+
+   ```bash
+   git clone [email protected]:tuanle03/code_learn_api.git
+   cd code_learn_api
+   ```
+   
+2. Install dependencies:
+    ```bash
+   bundle install
+   ```
+3. Set up the database:
+   ```bash
+   rails db:create db:migrate
+   ```
+4. Start project
+   ```bash
+   rails server
+   ```
+## JWT Authentication
+This project uses JSON Web Tokens (JWT) for user authentication. Make sure to include the JWT token in the Authorization header of your requests:
+   ```bash
+   Authorization: Bearer YOUR_JWT_TOKEN
+   ```
+
+## Swagger Documentation
+Explore the API endpoints and test them using the Swagger documentation at `http://localhost:3000/doc`.
+
+## Contributing
+We welcome contributions! If you find a bug or have an enhancement in mind, please open an issue or submit a pull request.
+
+## License
+This project is licensed under the MIT License.
+
+Happy coding!
+   

app/controllers/feedbacks_controller.rb

@@ -1,48 +1,2 @@
 class FeedbacksController < ApplicationController
-
-  before_action :authenticate_user!, except: [:index, :show]
-  belongs_to :user
-  belongs_to :post
-
-  def index
-    @feedbacks = Feedback.all
-  end
-
-  def new
-    @feedback = Feedback.new
-  end
-
-  def show
-    @feedback = Feedback.find(params[:id])
-  end
-
-  def create
-    @feedback = Feedback.new(feedback_params)
-    if @feedback.save
-      redirect_to @feedback
-    else
-      render :new
-    end
-  end
-
-  def update
-    @feedback = Feedback.find(params[:id])
-    if @feedback.update(feedback_params)
-      redirect_to @feedback
-    else
-      render :edit
-    end
-  end
-
-  def destroy
-    @feedback = Feedback.find(params[:id])
-    @feedback.destroy
-    redirect_to feedbacks_path
-  end
-
-  private
-
-  def feedback_params
-    params.require(:feedback).permit(:user_id, :post_id, :content)
-  end
 end

app/models/user.rb

@@ -7,6 +7,6 @@ class User < ApplicationRecord
 
   def generate_jwt
     payload = { user_id: id, exp: 1.day.from_now.to_i }
-    JWT::Encoder.encode(payload, Rails.application.credentials.devise_jwt_secret_key)
+    JWT.encode(payload, Rails.application.credentials.devise_jwt_secret_key, 'HS256')
   end
 end

spec/factories/users.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :user do
+    email { '[email protected]' }
+    password { 'password123' }
+  end
+end

spec/models/user_spec.rb

@@ -0,0 +1,14 @@
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  describe 'generate_jwt' do
+    it 'generates a valid JWT token' do
+      user = create(:user) # Use FactoryBot to create a user
+
+      jwt_token = user.generate_jwt
+
+      decoded_token = JWT.decode(jwt_token, Rails.application.credentials.devise_jwt_secret_key, true, algorithm: 'HS256')
+      expect(decoded_token[0]['user_id']).to eq(user.id)
+    end
+  end
+end

spec/rails_helper.rb

@@ -38,6 +38,8 @@
   # instead of true.
   config.use_transactional_fixtures = true
 
+  config.include FactoryBot::Syntax::Methods
+
   # You can uncomment this line to turn off ActiveRecord support entirely.
   # config.use_active_record = false