Skip to content

Latest commit

 

History

History
376 lines (285 loc) · 7.99 KB

README.md

File metadata and controls

376 lines (285 loc) · 7.99 KB
Raw

Knowledge Challenge Bot

Knowledge Challenge Bot, Telegram üzerinden kullanıcılara soru-cevap oyunu oynatmak için tasarlanmış bir bot uygulamasıdır. Kullanıcılar, bot ile etkileşime geçerek rastgele seçilen sorulara doğru cevaplar vermeye çalışırlar ve puan kazanırlar. Kazandıkları puan ile liderlik tablosunda ilerleyebilir ve bu tabloyu görüntüleyebilir. Belli bir puana erişmiş kullanıcılar soru önerisinde bulunur ve onaylanan sorular yarışmalarda kullanılır.

Getting Started

Firebase Realtime Database Docs

Users

  • id: the user's identification information (string)
  • first_name: the user's first name (string)
  • last_name: the user's last name (string)
  • chat_id: the user's Telegram chat ID (string)
  • remaining_attempts: the number of remaining attempts for the user (integer)
  • score: the user's total score (integer)
  • answered_questions: IDs of the questions answered by the user (list of strings)

Questions

  • id: the question's identification information (string)
  • text: the question's text (string)
  • category: the question's category (string)
  • author: the question's author (string)
  • answers: an array that contains the answers (string)
  • correct_answer: the text of the correct answer (string)

Suggestion

  • id: suggestion ID (string)
  • user_id: ID of the user who made the suggestion (string)
  • name: name of the user who made the suggestion (string)
  • text: suggestion text (string)
  • category: suggestion category (string)
  • status: suggestion status (string, "new", "approved", "rejected")

API Documentation

Create User

  • Endpoint: /create_user
  • Method: POST
  • Description: Creates a new user with the provided Telegram user information and adds them to the database.
  • Request Body:
    {
    "telegram_id": "1234567890",
    "first_name": "John",
    "last_name": "Doe",
    "chat_id": "-1234567890"
    }

  • telegram_id (string, required): The Telegram ID of the user.

  • first_name (string, required): The first name of the user.

  • last_name (string, required): The last name of the user.

  • chat_id (string, required): The chat ID of the user.

  • Response Body:

    {
    "message": "User created successfully!"
    }
  • Example:
    curl -X POST -H "Content-Type: application/json" -d '{"telegram_id": "1234567890", "first_name": "John", "last_name": "Doe", "chat_id": "-1234567890"}' http://localhost:5000/create_user

Check User

  • Endpoint: /check_user/<telegram_id>

  • Method: GET

  • Description: Checks if the user with the provided Telegram ID exists in the database.

  • Parameters:

    • telegram_id (string, required): The Telegram ID of the user.

  • Response Body:

{
    "message": "User exists",
    "exists": true
}

or

{
    "message": "User does not exist",
    "exists": false
    }
  • Example:
    curl -X GET http://localhost:5000/check_user/1234567890

Leaderboard

  • Endpoint: /leaderboard

  • Method: GET

  • Description: Returns the top 10 users with the highest scores.

  • Response Body:

{
    "leaderboard": [
        {
            "name": "John Doe",
            "score": 1000
        },
        {
            "name": "Jane Doe",
            "score": 950
        },
        ...
    ]
}
  • Example:
    curl -X GET http://localhost:5000/leaderboard

Score Add

  • Endpoint: /score/add/<telegram_id>

  • Method: PUT

  • Description: Adds 10 points to the user with the given Telegram ID and returns the updated score.

  • Response Body:

{
    "message": "<telegram_id>'s score has been increased by 10",
    "success": true,
    "score": 50
}
  • Example:
    curl -X PUT http://localhost:5000/score/add/1234567890

Score Subtract

  • Endpoint: /score/subtract/<telegram_id>

  • Method: PUT

  • Description: Subtracts 5 points from the user with the given Telegram ID and returns the updated score.

  • Response Body:

{
    "message": "<telegram_id>'s score has been subtracted by 5",
    "success": true,
    "score": 35
}

Update User

  • Endpoint: /user/update-name/<telegram_id>

  • Method: PUT

  • Description: Updates the name of the user with the given Telegram ID.

  • Response Body:

{
    "first_name": "John",
    "last_name": "Doe"
}
  • Example:
        curl -X PUT -H "Content-Type: application/json" -d '{"first_name": "John", "last_name": "Doe"}' http://localhost:5000/user/update-name/123456
  • Note: The Telegram ID cannot be updated with this endpoint.

Get All Questions

  • Endpoint: /questions/all

  • Method: GET

  • Description: Returns all questions in the database.

  • Response Body:

{
    "questions": [
        {
            "id": "1",
            "text": "What is the capital of France?",
            "category": "Geography",
            "author": "John",
            "answers": ["Paris", "Madrid", "Berlin", "Rome"],
            "correct_answer": "Paris"
        },
        {
            "id": "2",
            "text": "What is the largest planet in our solar system?",
            "category": "Astronomy",
            "author": "Sarah",
            "answers": ["Mars", "Jupiter", "Venus", "Neptune"],
            "correct_answer": "Jupiter"
        },
        ...
    ]
}
  • Example:
       curl -X GET http://localhost:5000/questions/all

Get a Single Questions

  • Endpoint: /questions/id

  • Method: GET

  • Description: Returns a single question with the given ID.

  • Response Body:

{
    "id": "1",
    "text": "What is the capital of France?",
    "category": "Geography",
    "author": "Admin",
    "answers": ["Paris", "Madrid", "Berlin", "Rome"],
    "correct_answer": "Paris"
}
  • Example:
    curl -X GET http://localhost:5000/questions/1

Add a New Question

  • Endpoint: /questions/add

  • Method: POST

  • Description: Adds a new question to the database.

  • Request Body:

{
	"text": "What is the smallest planet in our solar system?",
	"category": "Astronomy",
	"author": "admin",
	"answers": ["Mercury", "Venus", "Mars", "Jupiter"],
	"correct_answer": "Mercury"
}
  • Response Body:
{
	"message": "Question successfully added",
	"question": {
		"answers": [
			"Mercury",
			"Venus",
			"Mars",
			"Jupiter"
		],
		"author": "admin",
		"category": "Astronomy",
		"correct_answer": "Mercury",
		"id": "sPFr0rle173U7gVYLz0W",
		"text": "What is the smallest planet in our solar system?"
	},
	"success": true
}

Delete Question

  • Endpoint: /questions/id

  • Method: DELETE

  • Description: Deletes the question with the given id from the database.

  • Response Body:

{
	"deleted": "sPFr0rle173U7gVYLz0W",
	"success": true
}

Update Question

  • Endpoint: /questions/id

  • Method: PUT

  • Description: Update a question by its ID.

  • Request Body:

{
    "author": "Updated author",
    "text": "Updated question text",
    "category": "Updated category",
    "correctAnswer": "Updated correct answer",
    "answers": ["Updated answer 1", "Updated answer 2", "Updated answer 3", "Updated answer 4"]
}
  • Response Body:
{
    "id": "question_id",
    "author": "Updated author",
    "text": "Updated question text",
    "category": "Updated category",
    "correctAnswer": "Updated correct answer",
    "answers": ["Updated answer 1", "Updated answer 2", "Updated answer 3", "Updated answer 4"]
}

Get Questions by Category

  • Endpoint: /questions/category/{category}

  • Method: GET

  • Description: Returns a list of questions filtered by category.

  • Response Body:

{
    "questions": [
        {
            "author": "string",
            "correct_answer": "string",
            "text": "string",
            "category": "string",
            "answers": ["string", "string", "string", "string"]
        }
    ]
}