Serving Your Chatbot with a RESTful API Using Sinatra

Welcome to the next step in our journey of building a chatbot service with Sinatra . In the previous lesson, we focused on the ChatController, which manages chat sessions and handles messages by interacting with both the model and service layers. Now, we will take a significant step forward by creating a RESTful API for our chatbot service using Sinatra. We'll start by setting up the main Sinatra application, then adapt the ChatController to integrate with Sinatra's session management.

Understanding RESTful APIs and Sinatra

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Next, we define the routes for our chatbot service. These routes will handle requests for creating a new chat session and sending messages.

Ruby

get '/' do
  chat_controller.ensure_user_session(session)
  "Welcome to the Chatbot Service!"
end

post '/api/create_chat' do
  result = chat_controller.create_chat(session)
  result.to_json
end

post '/api/send_message' do
  chat_controller.send_message(session, request).to_json
end

get '/' do
  chat_controller.ensure_user_session(session)
  "Welcome to the Chatbot Service!"
end

post '/api/create_chat' do
  result = chat_controller.create_chat(session)
  result.to_json
end

post '/api/send_message' do
  chat_controller.send_message(session, request).to_json
end

Here's how each route functions within our chatbot service:

Index Route (/): This route acts as the entry point to our chatbot service. When a user accesses this route, it ensures that a user session is established by invoking the ensure_user_session method of the ChatController. After setting up the session, it returns a welcome message to the user, indicating that the service is ready for interaction.
Create Chat Route (/api/create_chat): This route is designed to initiate a new chat session. It listens for POST requests and delegates the task of creating a chat session to the ChatController by calling its create_chat method. The controller handles the session creation and returns a response, which is then sent back to the client.
Send Message Route (/api/send_message): This route facilitates sending messages within an existing chat session. It also listens for POST requests and delegates the message processing to the ChatController by invoking its send_message method. The controller processes the message and returns the AI's response, which is then delivered to the client.

Finally, we set up the Sinatra application to run on a specified port when executed directly.

Ruby

# Run the Sinatra application if this script is executed directly
set :bind, '0.0.0.0'
set :port, 3000

# Run the Sinatra application if this script is executed directly
set :bind, '0.0.0.0'
set :port, 3000

The set method is used to configure the server with the following parameters:

port: Specifies the port on which the server will listen for incoming requests, allowing users to access the application via http://localhost:3000.
bind: Makes the server accessible externally by listening on all available network interfaces, allowing connections from other devices on the network.

To integrate the ChatController with Sinatra, we need to update it to use Sinatra's session management. We start by requiring necessary Sinatra modules and updating the constructor to remove the test session.

Ruby

require 'securerandom'
require 'json'
require_relative 'services/chat_service'

class ChatController
  def initialize
    @chat_service = ChatService.new
  end

require 'securerandom'
require 'json'
require_relative 'services/chat_service'

class ChatController
  def initialize
    @chat_service = ChatService.new
  end

Next, let's break down how to update the ChatController methods to utilize Sinatra's session management.

In the ensure_user_session method, we update the way user sessions are managed by leveraging Sinatra's built-in session object. Previously, we used a test session hash to store user IDs. Now, we check if a user_id exists in the Sinatra session. If it doesn't, we generate a new UUID and store it in the session.

Ruby

def ensure_user_session
  # Check if 'user_id' is already in the session
  unless session[:user_id]
    # Generate a new UUID and store it in the session if not present
    session[:user_id] = SecureRandom.uuid
  end
  # Return the user_id from the session
  session[:user_id]
end

def ensure_user_session
  # Check if 'user_id' is already in the session
  unless session[:user_id]
    # Generate a new UUID and store it in the session if not present
    session[:user_id] = SecureRandom.uuid
  end
  # Return the user_id from the session
  session[:user_id]
end

This change allows us to utilize Sinatra's session management capabilities, providing a more robust and scalable solution for maintaining user sessions.

In the create_chat method, we update the code to now retrieve the user_id directly from the Sinatra session, ensuring that the request is associated with a valid user session.

Ruby

def create_chat(session)
  user_id = session[:user_id]
  return { error: 'Session expired' }, 401 unless user_id

  chat_id = @chat_service.create_chat(user_id)
  {
    chat_id: chat_id,
    message: 'Chat created successfully'
  }
end

def create_chat(session)
  user_id = session[:user_id]
  return { error: 'Session expired' }, 401 unless user_id

  chat_id = @chat_service.create_chat(user_id)
  {
    chat_id: chat_id,
    message: 'Chat created successfully'
  }
end

If the session is expired, it returns an error response. Otherwise, it creates a new chat session using the ChatService and returns a JSON response with the chat ID and a success message.

The send_message method is updated to handle requests using Sinatra's request and session objects. We now extract chat_id and user_message from the incoming request using the request object.

Ruby

# Updated method signature to receive session and request
def send_message(session, request)
  user_id = session[:user_id]
  return { error: 'Session expired' } unless user_id

  begin
    request_payload = JSON.parse(request.body.read)
  rescue JSON::ParserError => e
    return { error: 'Invalid JSON payload' }
  end

  chat_id = request_payload['chat_id']
  user_message = request_payload['message']

  return { error: 'Missing chat_id or message' } unless chat_id && user_message

  begin
    ai_response = @chat_service.process_message(user_id, chat_id, user_message)
    { message: ai_response }
  rescue StandardError => e
    { error: e.message }
  end

# Updated method signature to receive session and request
def send_message(session, request)
  user_id = session[:user_id]
  return { error: 'Session expired' } unless user_id

  begin
    request_payload = JSON.parse(request.body.read)
  rescue JSON::ParserError => e
    return { error: 'Invalid JSON payload' }
  end

  chat_id = request_payload['chat_id']
  user_message = request_payload['message']

  return { error: 'Missing chat_id or message' } unless chat_id && user_message

  begin
    ai_response = @chat_service.process_message(user_id, chat_id, user_message)
    { message: ai_response }
  rescue StandardError => e
    { error: e.message }
  end

If any required data is missing, the method returns an error response. The message is processed using the ChatService, and the AI's response is returned as a JSON object. We've also implemented error handling to provide appropriate JSON responses for different scenarios, ensuring that all interactions with the API are consistent and informative.

To interact with our chatbot service, a client can follow these steps to send a message using the API:

Access the Index Route (/): The client begins by accessing the index route of the API. This step ensures that a user session is established. A user session is a way to keep track of the user's interactions with the service. It is stored using Sinatra's session management, which utilizes cookies to maintain session data on the client side. The server responds with a welcome message, indicating that the service is ready for interaction.
Create a Chat Session (/api/create_chat): Before sending a message, the client needs to create a new chat session. This is done by sending a request to the /api/create_chat route. The server will respond with a unique chat ID, which is essential for identifying the chat session in subsequent interactions. The user session ensures that the chat session is associated with the correct user, allowing for personalized interactions.
Send a Message (/api/send_message): With the chat session established, the client can now send a message to the chatbot. This involves sending a request to the /api/send_message route, including the chat ID and the message content. The server processes the message and responds with the AI's reply, allowing the client to continue the conversation. The user session helps maintain continuity in the conversation by linking the messages to the correct user and chat session.

By following these steps, a client can effectively communicate with the chatbot service, leveraging the RESTful API to manage chat sessions and exchange messages while utilizing user sessions for a seamless experience.

In this lesson, we successfully built a RESTful API for our chatbot service using Sinatra. We set up a Sinatra application, defined routes for chat operations, and updated the ChatController to utilize Sinatra's session management. This lesson marks a significant milestone in our course, as it brings together all the components we've developed so far into a functional web application.

As you move on to the practice exercises, take the opportunity to experiment with the Sinatra API and reinforce the concepts covered in this lesson. This hands-on practice will prepare you for further development and exploration of additional Sinatra features and RESTful API concepts. Keep up the great work, and I look forward to seeing your progress!