127 lines
5.1 KiB
Ruby
127 lines
5.1 KiB
Ruby
module JamRuby
|
|
# creates messages (implementation: protocol buffer) objects cleanly
|
|
class MessageFactory
|
|
|
|
CLIENT_TARGET = "client"
|
|
SERVER_TARGET = "server"
|
|
SESSION_TARGET_PREFIX = "session:"
|
|
USER_TARGET_PREFIX = "user:"
|
|
|
|
|
|
|
|
def initialize()
|
|
@type_values = {}
|
|
|
|
Jampb::ClientMessage::Type.constants.each do |constant|
|
|
@type_values[Jampb::ClientMessage::Type.const_get(constant)] = constant
|
|
end
|
|
|
|
end
|
|
|
|
# given a string (bytes) payload, return a client message
|
|
def parse_client_msg(payload)
|
|
return Jampb::ClientMessage.parse(payload)
|
|
end
|
|
|
|
# create a login message using user/pass
|
|
def login_with_user_pass(username, password)
|
|
login = Jampb::Login.new(:username => username, :password => password)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LOGIN, :target => SERVER_TARGET, :login => login)
|
|
end
|
|
|
|
# create a login message using token (a cookie or similiar)
|
|
def login_with_token(token)
|
|
login = Jampb::Login.new(:token => token)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LOGIN, :target => SERVER_TARGET, :login => login)
|
|
end
|
|
|
|
# create a login ack (login was successful)
|
|
def login_ack(public_ip)
|
|
login_ack = Jampb::LoginAck.new(:public_ip => public_ip)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LOGIN_ACK, :target => CLIENT_TARGET, :login_ack => login_ack)
|
|
end
|
|
|
|
# create a jam session login message
|
|
def login_music_session(music_session)
|
|
login_music_session = Jampb::LoginMusicSession.new(:music_session => music_session)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LOGIN_MUSIC_SESSION, :target => SERVER_TARGET, :login_music_session => login_music_session)
|
|
end
|
|
|
|
# create a jam session login message ack (success or on failure)
|
|
def login_music_session_ack(error, error_reason)
|
|
login_music_session_ack = Jampb::LoginMusicSessionAck.new(:error => error, :error_reason => error_reason)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LOGIN_JAM_SESSION_ACK, :target => CLIENT_TARGET, :login_music_session_ack => login_music_session_ack)
|
|
end
|
|
|
|
# create a jam session 'leave session' message
|
|
def leave_music_session(music_session)
|
|
leave_music_session = Jampb::LeaveMusicSession.new(:music_session => music_session)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LEAVE_JAM_SESSION, :target => SERVER_TARGET, :leave_music_session => leave_music_session)
|
|
end
|
|
|
|
# create a jam session leave message ack (success or on failure)
|
|
def leave_music_session_ack(error, error_reason)
|
|
leave_music_session_ack = Jampb::LeaveMusicSessionAck.new(:error => error, :error_reason => error_reason)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::LEAVE_JAM_SESSION_ACK, :target => CLIENT_TARGET, :leave_music_session_ack => leave_music_session_ack)
|
|
end
|
|
|
|
# create a server error
|
|
def server_generic_error(error_msg)
|
|
error = Jampb::ServerGenericError.new(:error_msg => error_msg)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::SERVER_GENERIC_ERROR, :target => CLIENT_TARGET, :server_generic_error => error)
|
|
end
|
|
|
|
# create a server rejection error
|
|
def server_rejection_error(error_msg)
|
|
error = Jampb::ServerRejectionError.new(:error_msg => error_msg)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::SERVER_REJECTION_ERROR, :target => CLIENT_TARGET, :server_rejection_error => error)
|
|
end
|
|
|
|
# create a user-joined session messag
|
|
def user_joined_music_session(user_id, username)
|
|
joined = Jampb::UserJoinedMusicSession.new(:user_id => user_id, :username => username)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::USER_JOINED_JAM_SESSION, :target => CLIENT_TARGET, :user_joined_music_session => joined)
|
|
end
|
|
|
|
# create a test message to send in session
|
|
def test_session_message(session_id, msg)
|
|
test = Jampb::TestSessionMessage.new(:msg => msg)
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::TEST_SESSION_MESSAGE, :target => SESSION_TARGET_PREFIX + session_id, :test_session_message => test)
|
|
end
|
|
|
|
# create a heartbeat
|
|
def heartbeat()
|
|
heartbeat = Jampb::Heartbeat.new
|
|
return Jampb::ClientMessage.new(:type => ClientMessage::Type::HEARTBEAT, :target => SERVER_TARGET, :heartbeat => heartbeat)
|
|
end
|
|
|
|
# is this message directed to the server?
|
|
def server_directed? msg
|
|
return msg.target == MessageFactory::SERVER_TARGET
|
|
end
|
|
|
|
# is this message directed to the client?
|
|
def client_directed? msg
|
|
return msg.target == MessageFactory::CLIENT_TARGET
|
|
end
|
|
|
|
# is this message directed to a (jam) session?
|
|
def session_directed? msg
|
|
return msg.target.start_with? MessageFactory::SESSION_TARGET_PREFIX
|
|
end
|
|
|
|
# is this message directed to a user?
|
|
def user_directed? msg
|
|
return msg.target.start_with? MessageFactory::USER_TARGET_PREFIX
|
|
end
|
|
|
|
def extract_session(msg)
|
|
return msg.target[MessageFactory::SESSION_TARGET_PREFIX..-1]
|
|
end
|
|
|
|
def get_message_type msg
|
|
return @type_values[msg.type]
|
|
end
|
|
end
|
|
end
|