Loyalty Campaign Service

The Loyalty Campaign Service manages loyalty campaigns.

Table of Contents

• Description
• Features
• User Stories
• Prerequisites
• Technologies
• Installation
  • Clone Repository
  • Set Environment Variables
  • Build and Run
• Usage
  • Example API Requests
• Tests
  • Integration Tests
  • Component Tests
• Running in Docker, Podman, or Kubernetes
• Contributing
• Contact

Description

The Loyalty Campaign Service enables businesses to effectively manage and execute loyalty campaigns, enhancing customer retention, boosting sales, and deepening brand engagement through personalized rewards and strategic initiatives.

Features

• Create and manage loyalty campaigns in draft and active states
• Search campaigns by metadata/date/id
• View detailed campaign information
• Integration with a rules engine to define and evaluate campaign conditions
• Activate a campaign and delete draft Campaign

User Stories

As a Loyalty Manager, I want to:

1. Create loyalty campaigns in a draft state.
2. Search created campaigns by their metadata.
3. View all details about a particular campaign.
4. Change the state of a loyalty campaign:
   • Move from draft to active state (activate)
   • Close an active campaign (set end date)
   • Delete a campaign in draft state
5. Find active Campaigns by Date

Prerequisites

Before you begin, ensure you have the following installed:

• Java 21 or higher
• Maven 3.9.5 or higher
• PostgreSQL 15.4

  Technologies

• Spring Boot: Simplifies the development of Java applications by providing a powerful framework for stand-alone Spring-based applications.
• Spring JPA: Enables easy and efficient data access using the Java Persistence API within the Spring ecosystem.
• Lombok: Reduces boilerplate code in Java classes, enhancing readability and maintainability.
• Yavi Validation: Provides lightweight and expressive validation for Java objects, ensuring data integrity and consistency.
• Jackson Core: Facilitates JSON data binding and manipulation in Java applications, simplifying serialization and deserialization tasks.
• Flyway: Simplifies database schema migration, ensuring smooth and consistent updates across environments.
• PostgreSQL: Offers a powerful, open-source relational database management system for storing and managing your application's data.
• Test Frameworks: Includes JUnit, AssertJ,and IntegrationTests for comprehensive testing coverage, ensuring the reliability and correctness of application
• Pact-Provider Tests: Ensures compatibility and contract adherence between services in a distributed system.
• DbRider , Test Containers:Enables efficient database testing through tools that provide lightweight, disposable database instances for testing scenarios.
• Azure Database for PostgreSQL Flexible Server is a fully managed database service provided by Microsoft Azure for hosting PostgreSQL databases
• Clean architecture. https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html
• Domain Driven Design (DDD): Aligns software design with the business domain, fostering modular, maintainable codebases.
• Hexagonal Architecture: Ensures clean separation of concerns by organizing code around the core domain logic, promoting flexibility and testability.
• Multi-Module Application: Facilitates modular development, enhancing code organization and reusability.
• Docker and Podman: Streamlines application deployment by containerizing your services, ensuring consistency across environments.
• Kubernetes is an open-source container orchestration platform for automating the deployment, scaling, and management of containerized applications
• Grafana + Prometheus: Grafana is a visualization tool, while Prometheus is a monitoring solution for collecting metrics. Together, they provide robust monitoring capabilities for applications.
• Maven and Jib for Containerization: Automates the packaging and deployment of your application into containers with Maven and Jib, respectively.
• GitHub and GitHub Workflows Actions leverage version control and automated workflows to enhance collaboration and streamline development.
• WSL and Hyper-V: Enhances development experience on Windows systems by providing compatibility layers and virtualization capabilities.
• ELK (Elasticsearch, Logstash, Kibana): ELK is a stack used for centralized logging. Elasticsearch is a search engine, Logstash is a log pipeline tool, and Kibana is a visualization dashboard for Elasticsearch data. Together, they provide a comprehensive logging solution.

Installation

Follow these steps to install and run the Loyalty Campaign Service:

Clone Repository

1. Clone the repository:

   git clone https://github.com/your-username/loyalty-campaign-service.git
   cd loyalty-campaign-service

Set Environment Variables

2. Set environment variables for database configuration:

   export SPRING_DATASOURCE_URL=jdbc:postgresql://${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DATABASE}
   export SPRING_DATASOURCE_USERNAME=${POSTGRESQL_APPLICATION_USERNAME}
   export SPRING_DATASOURCE_PASSWORD=${POSTGRESQL_APPLICATION_PASSWORD}

Build and Run

3. Build and run the application:

   ./mvnw clean install

   Health

• liveness curl localhost:8080/livez
• readiness curl localhost:8080/readyz

Usage

Once the service is running, you can access it at: https://loyalty-campaign-service.bluewave-4dfdf337.westus2.azurecontainerapps.io (deployed on an Azure instance).

Tests

To run tests for the Loyalty Campaign Service:

Integration Tests

Run integration tests:

./mvnw clean -Dgroups=integration test

Component Tests

Run Component Tests:

./mvnw clean -Dgroups=component test

Example API Requests

Here are some example API requests you can use with the Loyalty Campaign Service:

• Create a new campaign:

  curl -X POST "localhost:8080/campaigns" -H "Content-Type: application/json" -d {campaign(json)}

• Get all campaigns:

  curl -X GET "localhost:8080/campaigns/listAll"

• Search campaigns by metadata:

  curl -X GET "localhost:8080/campaigns/{key}/{value}"

• Get details of a particular campaign:

  curl -X GET "localhost:8080/campaigns/{campaignId}"

• Activate a campaign:

  curl -X POST "localhost:8080/campaigns/activate/{campaignId}"

• Delete a draft campaign:

  curl -X DELETE "localhost:8080/campaigns/{campaignId}"

  • Find active campaigns by date

  curl -X GET "localhost:8080/campaigns/date/{date}"

Running in Docker, Podman, or Kubernetes

Building and running the service as a Docker image is the preferred way:

1. Build the Docker image:

   docker build -t loyalty-campaign-service .

2. Run the Docker container:

   docker run -p 8080:8080 -e SPRING_DATASOURCE_URL=jdbc:postgresql://${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DATABASE} -e SPRING_DATASOURCE_USERNAME=${POSTGRESQL_APPLICATION_USERNAME} -e SPRING_DATASOURCE_PASSWORD=${POSTGRESQL_APPLICATION_PASSWORD} loyalty-campaign-service

3. Deploying to Kubernetes:

   Create a Kubernetes deployment file (e.g., deployment.yaml) with the necessary configuration, and apply it:

   kubectl apply -f deployment.yaml

Contributing

Contributions are welcome! Please fork this repository and submit a pull request for any features, bug fixes, or enhancements.

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin feature/your-feature-name
5. Open a pull request

Please make sure to update tests as appropriate.

Contact

If you have any questions or suggestions, feel free to contact me at tudorcoretchi119@gmail.com.