auth-service

README

Authentication Service API

A comprehensive authentication service providing user management, authentication, and authorization capabilities.

Overview

This service provides a RESTful API for managing user accounts, authentication, and authorization. It's built with Go and uses JWT for secure authentication.

Base URL

http://localhost:8080/api/v1

Authentication

The API uses Bearer token authentication. Include the token in the Authorization header:

Authorization: Bearer <your_token>

API Endpoints

Account Management

Create Account

• POST /accounts
• Creates a new user account
• Required fields:
  • email
  • first_name (2-50 characters)
  • last_name (2-50 characters)
  • password (min 8 characters)
  • phone

Authenticate Account

• POST /accounts/authenticate
• Authenticates user and returns JWT token
• Required fields:
  • password (min 8 characters)
• Optional fields:
  • email
  • phone

Get Current Account

• GET /accounts/me
• Returns current user's account details
• Requires authentication

Get Account by ID

• GET /accounts/{id}
• Returns account details for specified ID

Password Management

Request Password Reset

• POST /accounts/set-reset-password-token
• Initiates password reset process
• Accepts either email or phone

Reset Password

• POST /accounts/reset-password
• Resets password using token
• Required fields:
  • token
  • password (min 8 characters)
  • confirm_password (min 8 characters)

Email Verification

Verify Email

• POST /accounts/verify-email
• Verifies email address using token
• Required fields:
  • token

Testing

The project includes comprehensive test coverage with both unit and integration tests.

Test Structure

tests/
├── integration/           # Integration tests
│   └── account_integration_test.go
internal/
└── service/
    └── test/             # Unit tests
        ├── account_auth_test.go
        ├── account_create_test.go
        ├── account_security_test.go
        ├── account_suite_test.go
        └── account_mock.go

Unit Tests

Unit tests are implemented using the testify package and follow these patterns:

• Test suites are organized by feature/component
• Mock implementations for dependencies
• Table-driven tests for comprehensive test cases
• Clear test case naming and organization

Key test areas:

• Account creation and validation
• Authentication flows
• Password management
• Email verification
• Security features

Integration Tests

Integration tests verify the complete flow of features by testing:

• Database interactions
• Service layer integration
• End-to-end workflows
• Error handling and edge cases

Key integration test areas:

• Account creation and authentication flow
• Password reset process
• Email verification process
• Duplicate account handling

Running Tests

To run the tests:

# Run all tests
go test ./...

# Run specific test suite
go test ./tests/integration/...
go test ./internal/service/test/...

# Run with coverage
go test ./... -cover

# Run with verbose output
go test ./... -v

Running Tests with Bash Files

Use the bash scripts in the scripts folder, both unit tests and integration tests can be conducted with them. You may need to provide the necessary permissions to the scripts depending on the os of your choice.

Test Environment

Tests use a separate test environment configuration:

• Test database configuration in .env.test
• Isolated test database to prevent interference with development data
• Automatic database cleanup between tests

Test Coverage

The project maintains high test coverage for critical paths:

• Account management flows
• Authentication processes
• Security features
• Error handling
• Input validation

Response Formats

Success Response

{
"data": {
// Response data
}
}

Error Response

{
"code": 400,
"message": "Error message"
}

Validation Error Response

{
"code": 400,
"message": "Validation error",
"errors": [
{
"field": "field_name",
"message": "validation message"
}
]
}

HTTP Status Codes

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized
• 404 - Not Found
• 500 - Internal Server Error

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

• Developer: Sertan Soydabas
• Email: ssoydabas41@gmail.com
• GitHub: https://github.com/ssoydabas