nuri_game-online-proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53693f42f08e666ee38eeb165a0efd35caeefbab337d5ef1e0e94eff0ca819de
+  data.tar.gz: dadaa96a1715c5c8776e16a49b8cef4b2641e616b977524a2ef39cb35ee62975
+SHA512:
+  metadata.gz: bd304071bda6620d1e1e068fa6d236fee393ad1e657c74fe49d74e9291a9d88faed637cb2863f799586dce3873739a47385f7d49945165740406f557ed7ccf98
+  data.tar.gz: 4a8f8e61448d60aa65ea3b2874f7d36aa250dec3fadc83c6445b281e5d5ad911fd851bb50fcd1ae57f8558fd53ff1377b6d84d87c2fab758c382cccf8ae5181f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nuri_game-online-proxy.gemspec
+gemspec

data/README.md

@@ -0,0 +1,26 @@
+# NuriGame::Online::Proxy
+
+Utility module that implement a proxy system to allow online interactions between players
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuri_game-online-proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nuri_game-online-proxy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/NuriYuri/nuri_game-tmx_reader.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/example/client_example.rb

@@ -0,0 +1,42 @@
+require 'nuri_game/online/proxy/client'
+
+client = NuriGame::Online::Proxy::Client.new
+
+is_connected = false
+mutex = true
+puts 'Trying to connect...'
+
+client.connect('127.0.0.1', 3205) do |success, id|
+  is_connected = success
+  if success
+    puts("Your ID is #{id}")
+  end
+  mutex = false
+end
+
+sleep(1) while mutex
+
+if is_connected
+  print('Enter your name : ')
+  name = gets.chomp
+  print('Enter your secret : ')
+  secret = gets.to_i
+  client.register(name, secret)
+  # Register all the listening stuff
+  client.on_user_connect { |id, name| puts "#{name} connected with ID #{id}" }
+  client.on_user_disconnect { |id| puts "#{id} disconnected" }
+  client.on_data_received { |from_id, data| puts "#{from_id} sent #{data}" }
+  
+  while (line = gets.chomp).size > 0
+    args = line.split(',')
+    case args.first
+    when 'find'
+      client.find_user(args[1], args[2].to_i)  { |success, id| puts "User ID : #{id} (#{success})" }
+    when 'send'
+      client.send_data(args[2..-1].join(','), args[1].to_i)
+    end
+  end
+  client.disconnect
+else
+  puts 'Failed to connect :/'
+end

data/example/server_example.rb

@@ -0,0 +1,9 @@
+require 'nuri_game/online/proxy/server'
+
+server = NuriGame::Online::Proxy::Server.new('0.0.0.0', 3205)
+puts "Listening"
+begin
+  server.start # Start listening
+rescue Exception
+  puts "Server got stopped! \n#{$!.class}"
+end

data/lib/nuri_game/online/proxy.rb

@@ -0,0 +1,13 @@
+require 'nuri_game/online/proxy/version'
+require 'nuri_game/online/proxy/server'
+require 'nuri_game/online/proxy/client'
+
+# Nuri Yuri's Game module
+module NuriGame
+  # Module responsive of containing all online related functionalities
+  module Online
+    # Module that holds all the Basic Proxy logic
+    module Proxy
+    end
+  end
+end

data/lib/nuri_game/online/proxy/client.rb

@@ -0,0 +1,259 @@
+require 'nuri_game/online/proxy/version'
+require 'nuri_game/online/proxy/packet'
+require 'socket'
+
+module NuriGame
+  module Online
+    module Proxy
+      # Client that connects to a Proxy Server
+      #
+      # How to use a Client
+      #   client = NuriGame::Online::Proxy::Client.new
+      #   is_connected = nil
+      #   your_id = -1
+      #   client.connect(ip, port) do |success, id|
+      #     is_connected = success
+      #     your_id = id
+      #   end
+      #   # Perform stuff waiting for is_connected being eq to true or false
+      #   client.register(your_name, your_secret_code)
+      #   # Finding a user
+      #   his_id = -1
+      #   user_found = nil
+      #   client.find_user(his_name, his_secret_code) do |success, id|
+      #     user_found = success
+      #     his_id = id
+      #   end
+      #   # Perform stuff waiting for user_found to be eq to true or false
+      #   client.on_data_received { |from_id, data| process_data(from_id, data) }
+      #   # send data to the other user
+      #   client.send_data('Hello there!', his_id)
+      class Client
+        # Error on client function call
+        Error = Class.new(StandardError)
+        # List of allowed packet to proceed
+        PROCESSED_PACKETS = [Packet::ID, Packet::RECEIVED_DATA, Packet::NEW_USER, Packet::LIST_USER_RESPONSE, Packet::FIND_USER_BY_NAME_RESPONSE, Packet::DISCONNECTION]
+        # @return [Integer] the current id of the client on the server
+        attr_reader :id
+        # Create a new client
+        def initialize
+          @id = -1
+          @connected = false
+          @awaiting_response = Mutex.new
+          @request_mutex = false
+          @awaiting_packet_id = -1
+          # @return [TCPSocket]
+          @socket = nil
+        end
+
+        # Disconnect from the server
+        def disconnect
+          raise Error, 'Not connected' unless connected?
+          @connected = false
+          @socket.close
+        end
+
+        # Check if the client is connected
+        # @return [Boolean]
+        def connected?
+          return @connected
+        end
+
+        # Attempts to connect to a proxy server
+        # @param ip_addr [String] IP of the server
+        # @param port [Integer] port of the server
+        # @parma connexion_block [Proc] the block to pass to transmit the connexion success or failure
+        def connect(ip_addr, port, &connexion_block)
+          Thread.start do
+            @awaiting_response.synchronize do
+              proceed_connection(ip_addr, port, &connexion_block)
+              listen if connected?
+            end
+          end
+        end
+
+        # Try to find the id of an user knowing its name and its secret
+        # @example client.find_user('Name', secret_number) { |success, id| do_somethind_with_id_if_success }
+        # @param name [String] name of the user to find
+        # @parma secret [Integer] secret code of the user to find
+        def find_user(name, secret, &block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have two required parameters.' if !block || block.arity != 2
+          raise Error, 'Waiting for an other request' if @request_mutex
+          @on_find_user = block
+          @socket.write(Packet.new(packet_id: Packet::FIND_USER_REQUEST, name: name, secret: secret))
+          mutex_lock(Packet::ID)
+        end
+
+        # Try to list all the user of the server
+        # @example client.list_user { |success, id_list| do_somethind_with_id_list }
+        def list_user(&block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have two required parameters.' if !block || block.arity != 2
+          raise Error, 'Waiting for an other request' if @request_mutex
+          @on_user_list = block
+          @socket.write(Packet.new(packet_id: Packet::LIST_USER_REQUEST))
+          mutex_lock(Packet::LIST_USER_RESPONSE)
+        end
+
+        # Tell what to do when a user connects to the server
+        # @example client.on_user_connect { |id, name| do_somethind_with_id }
+        def on_user_connect(&block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have two required parameters.' if !block || block.arity != 2
+          @on_user_connect = block
+        end
+
+        # Send data to other clients
+        # @example client.send_data('data', his_id)
+        # @param data [String] the data
+        # @param ids [Array<Integer>] list of ids that should receive the data
+        def send_data(data, *ids)
+          raise Error, 'Not connected' unless connected?
+          @socket.write(Packet.new(packet_id: Packet::SEND_DATA_REQUEST, to: ids, data: data))
+        end
+
+        # Do something when the client receive data from someone
+        # @example client.on_data_received { |from_id, data| do_something_with_data }
+        def on_data_received(&block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have two required parameters.' if !block || block.arity != 2
+          @on_data_received = block
+        end
+
+        # Tell what to do when a user disconnects from the server
+        # @example client.on_user_disconnect { |id| do_somethind_with_id }
+        def on_user_disconnect(&block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have one required parameters.' if !block || block.arity != 1
+          @on_user_disconnect = block
+        end
+
+        # Try to list all the user of the server that match a specific name
+        # @example client.list_user_by_name(name) { |success, id_list| do_somethind_with_id_list }
+        def list_user_by_name(name, &block)
+          raise Error, 'Not connected' unless connected?
+          raise Error, 'Invalid block arity. The block should have two required parameters.' if !block || block.arity != 2
+          raise Error, 'Waiting for an other request' if @request_mutex
+          @on_user_list_by_name = block
+          @socket.write(Packet.new(packet_id: Packet::FIND_USER_BY_NAME_REQUEST, name: name))
+          mutex_lock(Packet::FIND_USER_BY_NAME_RESPONSE)
+        end
+
+        # Register the client to the server so the other clients will know
+        # @param name [String] name of the client
+        # @parma secret [Integer] secret code of the client
+        def register(name, secret)
+          raise Error, 'Not connected' unless connected?
+          @socket.write(Packet.new(packet_id: Packet::REGISTER, name: name, secret: secret))
+        end
+
+        private
+
+        # Listen to the incomming packets and call the right blocs
+        def listen
+          raise Error, 'Not connected' unless connected?
+          Thread.start(@socket) { |socket| listen_to(socket) }
+        end
+
+        # Listend to a specific socket
+        # @param socket [TCPSocket]
+        def listen_to(socket)
+          while (packet = read_packet(socket))
+            send(:"proceed_received_packet_#{packet.id}", packet.data) if PROCESSED_PACKETS.include?(packet.id)
+          end
+        ensure
+          @connected = false
+          @request_mutex = false if @request_mutex
+          socket.close
+        end
+
+        # Try to unlock the mutex
+        # @param packet_id [Integer] id of the packet that was expected to be received when locking the mutex
+        def mutex_unlock_attempt(packet_id)
+          @request_mutex = false if @request_mutex && packet_id == @awaiting_packet_id
+        end
+
+        # Lock the mutex with a packet id
+        # @param packet_id [Integer] id of the packet that should be received to unlock the mutex
+        def mutex_lock(packet_id)
+          @request_mutex = true
+          @awaiting_packet_id = packet_id
+        end
+
+        # Perform the real connexion
+        # @param ip_addr [String] IP of the server
+        # @param port [Integer] port of the server
+        def proceed_connection(ip_addr, port)
+          raise Error, 'Already connected' if connected?
+          @socket = TCPSocket.new(ip_addr, port)
+          packet = read_packet(@socket)
+          if packet && packet.id == Packet::ID
+            yield(@connected = true, @id = packet.data[:id]) if block_given?
+          elsif block_given?
+            yield(false, -1)
+          end
+        rescue StandardError
+          yield(false, -1) if block_given?
+        end
+
+        # Try to read a packet from a socket
+        # @param socket [TCPSocket]
+        # @return [Packet, nil]
+        def read_packet(socket)
+          packet = Packet.new(socket.read(5))
+          data = socket.read(size = packet.size)
+          data << socket.read(size - data.size) while data.size < size
+          packet << data
+          return packet
+        rescue StandardError
+          return nil
+        end
+
+        # Proceed an incomming ID packet
+        # @param data [Hash]
+        def proceed_received_packet_1(data)
+          mutex_unlock_attempt(Packet::ID)
+          @on_find_user.call(data[:id] >= 0, data[:id]) if @on_find_user
+        end
+
+        # Proceed an incomming NEW_USER packet
+        # @param data [Hash]
+        def proceed_received_packet_3(data)
+          mutex_unlock_attempt(Packet::NEW_USER)
+          @on_user_connect.call(data[:id], data[:name]) if @on_user_connect
+        end
+
+        # Proceed an incomming LIST_USER_RESPONSE packet
+        # @param data [Hash]
+        def proceed_received_packet_5(data)
+          mutex_unlock_attempt(Packet::LIST_USER_RESPONSE)
+          response = data[:response]
+          @on_user_list.call(!response.empty?, response) if @on_user_list
+        end
+
+        # Proceed an incomming RECEIVED_DATA packet
+        # @param data [Hash]
+        def proceed_received_packet_7(data)
+          mutex_unlock_attempt(Packet::RECEIVED_DATA)
+          @on_data_received.call(data[:from], data[:data]) if @on_data_received
+        end
+
+        # Proceed an incomming DISCONNECTION packet
+        # @param data [Hash]
+        def proceed_received_packet_8(data)
+          mutex_unlock_attempt(Packet::DISCONNECTION)
+          @on_user_disconnect.call(data[:id]) if @on_user_disconnect
+        end
+
+        # Proceed an incomming FIND_USER_BY_NAME_RESPONSE packet
+        # @param data [Hash]
+        def proceed_received_packet_11(data)
+          mutex_unlock_attempt(Packet::FIND_USER_BY_NAME_RESPONSE)
+          response = data[:response]
+          @on_user_list_by_name.call(!response.empty?, response) if @on_user_list_by_name
+        end
+      end
+    end
+  end
+end

data/lib/nuri_game/online/proxy/packet.rb

@@ -0,0 +1,254 @@
+module NuriGame
+  module Online
+    module Proxy
+      # Packet sent or received by the proxy server.
+      # It can decode or construct packet to be sent online.
+      #
+      # How to decode a Packet
+      #   packet = Packet.new socket.read(5)
+      #   packet << socket.read(packet.size)
+      #   print packet.data
+      #
+      # How to encode a Packet
+      #   packet = Packet.new packet_id: Packet::ID, id: value
+      #   socket.write(packet)
+      #
+      # All the packet data :
+      #   - ID, id: Integer
+      #   - REGISTER, secret: Integer, name: String
+      #   - NEW_USER, id: Integer, name: String
+      #   - LIST_USER_REQUEST, {}
+      #   - LIST_USER_RESPONSE, response: {ID => Name} (Integer, String)
+      #   - SEND_DATA_REQUEST, to: Array<Integer>, data: String
+      #   - RECEIVED_DATA, from: Integer, data: String
+      #   - FIND_USER_REQUEST, secret: Integer, name: String (respond a ID packet; id < 0 = not found)
+      #   - FIND_USER_BY_NAME_REQUEST, name: String
+      #   - FIND_USER_BY_NAME_RESPONSE, response: Array<Integer>
+      class Packet < ::String
+        # Packet containing an ID
+        ID = 1
+        # Packet containing a register request (Secret: Int, Name: String)
+        REGISTER = 2
+        # Packet containing the new user connection Info (ID: Int, Name: String)
+        NEW_USER = 3
+        # Packet containing the list user request
+        LIST_USER_REQUEST = 4
+        # Packet containing the list user response (Hash{ID=>Name})
+        LIST_USER_RESPONSE = 5
+        # Packet containing the send data request (Array<IDs>, Data)
+        SEND_DATA_REQUEST = 6
+        # Packet containing the data sent by an other user (ID: Int, Data)
+        RECEIVED_DATA = 7
+        # Packet containing a user disconnection (ID: Int)
+        DISCONNECTION = 8
+        # Packet containing a find user request (Secret: Int, Name: String)
+        FIND_USER_REQUEST = 9
+        # Packet containing a find user by name request (Name: String)
+        FIND_USER_BY_NAME_REQUEST = 10
+        # Packet containing the find user by name response (Array<ID>)
+        FIND_USER_BY_NAME_RESPONSE = 11
+        # Last Packet ID
+        LAST_PACKET_ID = FIND_USER_BY_NAME_RESPONSE
+        # Error during a packet encoding or decoding
+        Error = Class.new(StandardError)
+
+        # @return [Hash] the data of the packet
+        attr_reader :data
+
+        # Create a new packet
+        # @param data [String, Hash] if data is a String, it's a packet to decode, otherwise it's a packet to encode
+        def initialize(data)
+          if data.is_a?(String)
+            @data = {}
+            raise Error, 'Received invalid packet' if data.bytesize != 5
+            super(data)
+          else
+            super()
+            initialize_hash(@data = data)
+          end
+        end
+
+        # Return the size of the packet
+        # @return [Integer]
+        def size
+          unpack('L').first
+        end
+
+        # Return the ID of the packet
+        # @return [Integer]
+        def id
+          unpack('@4C').first
+        end
+
+        # Add data to the packet (also decode new data)
+        # @param string [String]
+        def <<(string)
+          super
+          decode_packet if @data.empty?
+          self
+        end
+
+        private
+
+        # Create a new packet from a Hash
+        # @param data [Hash] hash info
+        def initialize_hash(data)
+          packet_id = data[:packet_id].to_i
+          raise Error, 'Invalid packet id' unless packet_id.between?(ID, LAST_PACKET_ID)
+          send(:"initialize_packet_#{packet_id}", data)
+        end
+
+        # Create a new ID packet
+        # @param data [Hash] hash info
+        def initialize_packet_1(data)
+          self << [4, ID, data[:id].to_i].pack('LCl')
+        end
+
+        # Create a new REGISTER packet
+        # @param data [Hash] hash info
+        def initialize_packet_2(data)
+          name = data[:name].to_s
+          self << [4 + name.bytesize, REGISTER, data[:secret].to_i].pack('LCL') << name
+        end
+
+        # Create a new NEW_USER packet
+        # @param data [Hash] hash info
+        def initialize_packet_3(data)
+          name = data[:name].to_s
+          self << [4 + name.bytesize, NEW_USER, data[:id].to_i].pack('LCL') << name
+        end
+
+        # Create a new LIST_USER_REQUEST packet
+        # @param _data [Hash] hash info
+        def initialize_packet_4(_data)
+          self << [0, LIST_USER_REQUEST].pack('LC')
+        end
+
+        # Create a new LIST_USER_RESPONSE packet
+        # @param data [Hash] hash info
+        def initialize_packet_5(data)
+          response = data[:response]
+          buffer = ''
+          response.each do |id, name|
+            buffer << [id, name.bytesize, name].pack('LSa*')
+          end
+          self << [2 + buffer.bytesize, LIST_USER_RESPONSE, response.size].pack('LCS') << buffer
+        end
+
+        # Create a new SEND_DATA_REQUEST packet
+        # @param data [Hash] hash info
+        def initialize_packet_6(data)
+          to = data[:to]
+          data = data[:data].to_s
+          self << [2 + 4 * to.size + data.bytesize, SEND_DATA_REQUEST, to.size].pack('LCS')
+          self << to.pack('L*') << data
+        end
+
+        # Create a new RECEIVED_DATA packet
+        # @param data [Hash] hash info
+        def initialize_packet_7(data)
+          from = data[:from].to_i
+          data = data[:data].to_s
+          self << [4 + data.bytesize, RECEIVED_DATA, from].pack('LCL') << data
+        end
+
+        # Create a new DISCONNECTION packet
+        # @param data [Hash] hash info
+        def initialize_packet_8(data)
+          self << [4, DISCONNECTION, data[:id].to_i].pack('LCL')
+        end
+
+        # Create a new FIND_USER_REQUEST packet
+        # @param data [Hash] hash info
+        def initialize_packet_9(data)
+          name = data[:name].to_s
+          self << [4 + name.bytesize, FIND_USER_REQUEST, data[:secret].to_i].pack('LCL') << name
+        end
+
+        # Create a new FIND_USER_BY_NAME_REQUEST packet
+        # @param data [Hash] hash info
+        def initialize_packet_10(data)
+          name = data[:name].to_s
+          self << [name.bytesize, FIND_USER_BY_NAME_REQUEST].pack('LC') << name
+        end
+
+        # Create a new FIND_USER_BY_NAME_RESPONSE packet
+        # @param data [Hash] hash info
+        def initialize_packet_11(data)
+          response = data[:response]
+          self << [2 + response.size * 4, FIND_USER_BY_NAME_RESPONSE, response.size].pack('LCS') << response.pack('L*')
+        end
+
+        # Decode the current packet
+        def decode_packet
+          packet_id = id
+          raise Error, 'Invalid packet id' unless packet_id.between?(ID, LAST_PACKET_ID)
+          send(:"decode_packet_#{packet_id}")
+          @data[:packet_id] = packet_id
+        end
+
+        # Decode a ID packet
+        def decode_packet_1
+          @data[:id] = unpack('@5l').first
+        end
+
+        # Decode a REGISTER packet
+        def decode_packet_2
+          @data[:secret], @data[:name] = unpack('@5La*')
+        end
+
+        # Decode a NEW_USER packet
+        def decode_packet_3
+          @data[:id], @data[:name] = unpack('@5La*')
+        end
+
+        # Decode a LIST_USER_REQUEST packet
+        def decode_packet_4; end
+
+        # Decode a LIST_USER_RESPONSE packet
+        def decode_packet_5
+          num_entry = unpack('@5S').first
+          current_index = 7
+          @data[:response] = response = {}
+          num_entry.times do
+            id, name_size = unpack("@#{current_index}LS")
+            response[id] = self[current_index += 6, name_size]
+            current_index += name_size
+          end
+        end
+
+        # Decode a SEND_DATA_REQUEST packet
+        def decode_packet_6
+          num_entry = unpack('@5S').first
+          *@data[:to], @data[:data] = unpack("@7L#{num_entry}a*")
+        end
+
+        # Decode a RECEIVED_DATA packet
+        def decode_packet_7
+          @data[:from], @data[:data] = unpack('@5La*')
+        end
+
+        # Decode a DISCONNECTION packet
+        def decode_packet_8
+          @data[:id] = unpack('@5L').first
+        end
+
+        # Decode a FIND_USER_REQUEST packet
+        def decode_packet_9
+          @data[:secret], @data[:name] = unpack('@5La*')
+        end
+
+        # Decode a FIND_USER_BY_NAME_REQUEST packet
+        def decode_packet_10
+          @data[:name] = unpack('@5a*')
+        end
+
+        # Decode a FIND_USER_BY_NAME_RESPONSE packet
+        def decode_packet_11
+          num_entry = unpack('@5S').first
+          @data[:response] = unpack("@7L#{num_entry}")
+        end
+      end
+    end
+  end
+end

data/lib/nuri_game/online/proxy/server.rb

@@ -0,0 +1,151 @@
+require "nuri_game/online/proxy/version"
+require "nuri_game/online/proxy/packet"
+require "socket"
+
+module NuriGame
+  module Online
+    module Proxy
+      # Server that connects the server together
+      #
+      # How to use a server
+      #   server = NuriGame::Online::Proxy::Server.new("0.0.0.0", 3205)
+      #   server.start # Start listening
+      class Server
+        # List of processed packet from client
+        PROCESSED_PACKETS = [Packet::REGISTER, Packet::SEND_DATA_REQUEST, Packet::LIST_USER_REQUEST, Packet::FIND_USER_REQUEST, Packet::FIND_USER_BY_NAME_REQUEST]
+        # Create a new server
+        # @param ip [String] IP of the server
+        # @param port [Integer] port of the server
+        def initialize(ip, port)
+          @server = TCPServer.new(ip, port)
+          @sockets = Hash.new
+          @users = Hash.new
+          @user_db_mutex = Mutex.new
+        end
+
+        # Start server processing
+        def start
+          loop { Thread.start(@server.accept) { |client| process_client(client) } }
+        end
+
+        private
+
+        # Process the client
+        # @param client [TCPSocket]
+        def process_client(client)
+          id = -1
+          id = connect_user(client)
+          while (packet = read_client_packet(client))
+            send(:"process_packet_#{packet.id}", id, packet.data) if PROCESSED_PACKETS.include?(packet.id)
+          end
+        ensure
+          remove_user(id)
+          client.close
+        end
+
+        # Connect a client and send it its id
+        # @param client [TCPSocket]
+        def connect_user(client)
+          @user_db_mutex.synchronize do
+            begin
+              id = rand(0xFFFFFF)
+            end while @sockets.has_key?(id)
+            @sockets[id] = client
+            client.write(Packet.new(packet_id: Packet::ID, id: id))
+            return id
+          end
+        end
+
+        # Remove a client from the proxy informations
+        # @param id [Integer]
+        def remove_user(id)
+          @user_db_mutex.synchronize do
+            @users.delete(id)
+            @sockets.delete(id)
+            packet = Packet.new(packet_id: Packet::DISCONNECTION, id: id)
+            @sockets.each_value { |client| send_packet_to(client, packet) }
+          end
+        end
+
+        # Safely send a packet to a client
+        # @param client [TCPSocket]
+        # @param packet [Packet]
+        def send_packet_to(client, packet)
+          client.write(packet) if client
+        rescue StandardError
+          # Safety in case the client disconnected during a lock
+        end
+
+        # Try to read a packet from a client
+        # @param client [TCPSocket]
+        # @return [Packet, nil]
+        def read_client_packet(client)
+          packet = Packet.new(client.read(5))
+          data = client.read(size = packet.size)
+          data << client.read(size - data.size) while data.size < size
+          packet << data
+          return packet
+        rescue StandardError
+          return nil
+        end
+
+        # Process REGISTER packet
+        # @param id [Integer] id of the client
+        # @param data [Hash] request info
+        def process_packet_2(id, data)
+          @user_db_mutex.synchronize do
+            unless @users.has_key?(id)
+              packet = Packet.new(packet_id: Packet::NEW_USER, id: id, name: data[:name])
+              @users.each_key { |user_id| send_packet_to(@sockets[user_id], packet) }
+            end
+            @users[id] = { secret: data[:secret], name: data[:name] }
+          end
+        end
+
+        # Process LIST_USER_REQUEST packet
+        # @param id [Integer] id of the client
+        # @param data [Hash] request info
+        def process_packet_4(id, data)
+          @user_db_mutex.synchronize do
+            response = Hash.new
+            @users.each { |user_id, user| response[user_id] = user[:name] }
+            packet = Packet.new(packet_id: Packet::LIST_USER_RESPONSE, response: response)
+            send_packet_to(@sockets[id], packet)
+          end
+        end
+
+        # Process SEND_DATA_REQUEST packet
+        # @param id [Integer] id of the client
+        # @param data [Hash] request info
+        def process_packet_6(id, data)
+          packet = Packet.new(packet_id: Packet::RECEIVED_DATA, from: id, data: data[:data])
+          data[:to].each { |user_id| send_packet_to(@sockets[user_id], packet) }
+        end
+
+        # Process FIND_USER_REQUEST packet
+        # @param id [Integer] id of the client
+        # @param data [Hash] request info
+        def process_packet_9(id, data)
+          @user_db_mutex.synchronize do
+            found_id = @users.key({ secret: data[:secret], name: data[:name] }) || -1
+            packet = Packet.new(packet_id: Packet::ID, id: found_id)
+            send_packet_to(@sockets[id], packet)
+          end
+        end
+
+        # Process FIND_USER_BY_NAME_REQUEST packet
+        # @param id [Integer] id of the client
+        # @param data [Hash] request info
+        def process_packet_10(id, data)
+          @user_db_mutex.synchronize do
+            response = []
+            name = data[:name]
+            @users.each { |user_id, user| response << user_id if user[:name] == name }
+            packet = Packet.new(packet_id: Packet::FIND_USER_BY_NAME_RESPONSE, response: response)
+            send_packet_to(@sockets[id], packet)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nuri_game/online/proxy/version.rb

@@ -0,0 +1,7 @@
+module NuriGame
+  module Online
+    module Proxy
+      VERSION = "0.1.0"
+    end
+  end
+end

data/nuri_game-online-proxy.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nuri_game/online/proxy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nuri_game-online-proxy"
+  spec.version       = NuriGame::Online::Proxy::VERSION
+  spec.authors       = ["Nuri Yuri"]
+  spec.email         = ["hostmaster@pokemonworkshop.com"]
+
+  spec.summary       = %q{Utility module that implement a proxy system to allow online interactions between players}
+  spec.homepage      = "https://gitlab.com/NuriYuri/nuri_game-online-proxy"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: nuri_game-online-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuri Yuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- hostmaster@pokemonworkshop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- example/client_example.rb
+- example/server_example.rb
+- lib/nuri_game/online/proxy.rb
+- lib/nuri_game/online/proxy/client.rb
+- lib/nuri_game/online/proxy/packet.rb
+- lib/nuri_game/online/proxy/server.rb
+- lib/nuri_game/online/proxy/version.rb
+- nuri_game-online-proxy.gemspec
+homepage: https://gitlab.com/NuriYuri/nuri_game-online-proxy
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Utility module that implement a proxy system to allow online interactions
+  between players
+test_files: []