pomelo-citrus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc960252d9f68592e4bc7a8152333a82d3fa84c2
+  data.tar.gz: 4801ee7597600f2dc7bcab9497503521f0bc99e5
+SHA512:
+  metadata.gz: 833b2b49945dd1623c678ccc0bae9428b36acccb4d6ce4ca031ad142fe02dff5934c0bb0efc31a39bfff4752417241fb1b37c911183e6924d673c13f9cf64c9b
+  data.tar.gz: 770c1e3795f3d5b8dcac4ceb6a412366a0216c99df0eab6dcb24983d77bbbdad335c18723430fc45ed9186ab3d48c090ee6c1b0f0197d649ee71fed4a32cfba9

data/README.md

@@ -0,0 +1,20 @@
+## Welcome to pomelo-citrus
+
+pomelo-citrus is a simple clone of pomelo written in Ruby using EventMachine.
+
+## Motivation
+
+Since NodeJS is influenced by Ruby EventMachine and Python's Twisted model, Ruby should also be able to have its own game server framework like pomelo.
+
+Ruby is a very expressive and eloquent programming language. I was an RoR programmer before and I really like Ruby, When developing this project, I have used many skills like meta-programming and they give me the real pleasures.
+
+Recently, I would focus on my daily work, so I open source this project and hope to have more people participate in this project.
+
+## Todo
+
+This gem is under development now, remaining about 30% of the workload to do including the tests.
+
+## Links
+
+* [EventMachine](https://github.com/eventmachine/eventmachine)
+* [pomelo](https://github.com/NetEase/pomelo)

data/citrus.gemspec

@@ -0,0 +1,35 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'citrus/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'pomelo-citrus'
+  spec.version     = Citrus::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['MinixLi']
+  spec.email       = 'MinixLi1986@gmail.com'
+  spec.description = %q{pomelo-citrus is a simple clone of pomelo, it provides a fast, scalable and distributed game server framework for Ruby}
+  spec.summary     = %q{pomelo clone written in Ruby using EventMachine}
+  spec.homepage    = 'https://github.com/minixli/pomelo-citrus'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('digest-crc', '~> 0')
+  spec.add_dependency('eventmachine', '~> 0')
+  spec.add_dependency('websocket-eventmachine-server', '~> 0')
+
+  spec.add_dependency('pomelo-citrus-admin', '~> 0')
+  spec.add_dependency('pomelo-citrus-loader', '~> 0')
+  spec.add_dependency('pomelo-citrus-logger', '~> 0')
+  spec.add_dependency('pomelo-citrus-protobuf', '~> 0')
+  spec.add_dependency('pomelo-citrus-protocol', '~> 0')
+  spec.add_dependency('pomelo-citrus-rpc', '~> 0')
+  spec.add_dependency('pomelo-citrus-scheduler', '~> 0')
+end

data/lib/citrus.rb

@@ -0,0 +1,18 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'eventmachine'
+
+require 'pomelo-citrus-admin'
+require 'pomelo-citrus-loader'
+require 'pomelo-citrus-protobuf'
+require 'pomelo-citrus-protocol'
+require 'pomelo-citrus-rpc'
+require 'pomelo-citrus-scheduler'
+
+require 'citrus/util/constants'
+require 'citrus/util/utils'
+require 'citrus/citrus'

data/lib/citrus/application.rb

@@ -0,0 +1,237 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+require 'citrus/util/app_util'
+
+module Citrus
+  # Application
+  #
+  #
+  class Application
+    include Utils::AppUtil
+    include Utils::EventEmitter
+
+    attr_reader :env, :base, :type, :start_id
+    attr_reader :cur_server, :server_id, :server_type
+    attr_reader :master, :servers_map
+    attr_reader :components, :modules_registered
+
+    # Initialize the application
+    #
+    # @param [Hash] args Option
+    def initialize args={}
+      @env = nil
+      @type = nil
+      @start_id = nil
+
+      @base = args[:base] || Dir.pwd
+      @settings = {}
+
+      # current server info
+      @cur_server = nil
+      @server_id = nil
+      @server_type = nil
+      @start_time = nil
+
+      # global server info
+      @master = nil
+      @servers = {}
+      @servers_map = {}
+      @server_types = []
+      @server_type_maps = {}
+
+      # lifecycle callbacks
+      @lifecycle_cbs = {}
+
+      @components = {}
+      @modules_registered = {}
+
+      default_configuration
+
+      @state = :state_inited
+
+      # singleton pattern
+      eval %Q{
+        class ::Citrus::Application
+          private_class_method :new
+        end
+      }
+    end
+
+    # Start the application
+    def start &block
+      @start_time = Time.now.to_f
+      if @state != :state_inited
+        block_given? and yield Exception.new 'application double start'
+        return
+      end
+
+      if @start_id
+        if @start_id != 'master'
+          Starter.run_servers self
+          return
+        end
+      else
+        if @type && @type != :all && @type != :master
+          Starter.run_servers self
+          return
+        end
+      end
+
+      load_default_components
+
+      if before_cb = @lifecycle_cbs[:before_startup]
+        before_cb.call self, &proc{
+          start_up &block
+        }
+      else
+        start_up &block
+      end
+    end
+
+    # Start up
+    def start_up &block
+      opt_components(@components.values, :start) { |err|
+        @state = :state_started
+        if err
+          block_given? and yield err
+        else
+          after_start &block
+        end
+      }
+    end
+
+    # Lifecycle callback for after start
+    def after_start &block
+      if @state != :state_started
+        block_given? and yield RuntimeError.new 'application is not running now'
+        return
+      end
+
+      opt_components(@components.values, :after_start) { |err|
+        if after_cb = @lifecycle_cbs[:after_start]
+          after_cb.call self, &proc{
+            block_given? and yield err
+          }
+        else
+          block_given? and yield err
+        end
+      }
+      puts used_time = Time.now.to_f - @start_time
+    end
+
+    # Stop components
+    #
+    #
+    def stop force=false
+    end
+
+    # Assign `setting` to `value`
+    #
+    # @param [Symbol] setting
+    # @param [Object] value
+    def set setting, value
+      @settings[setting] = value
+      return self
+    end
+
+    # Get property from setting
+    #
+    # @param [Symbol] setting
+    def get setting
+      @settings[setting]
+    end
+
+    # Configure callback for the specified env and server type
+    def configure *args, &block
+      args.length > 0 ? env = args[0].to_s : env = 'all'
+      args.length > 1 ? server_type = args[1].to_s : server_type = 'all'
+      if env == 'all' || contains(@env.to_s, env)
+        if server_type == 'all' || contains(@server_type, server_type)
+          instance_eval &block if block
+        end
+      end
+      return self
+    end
+
+    # Get server infos by server type
+    #
+    # @param [String] type
+    def get_servers_by_type type
+      @server_type_maps[type]
+    end
+
+    # Check whether a server is a frontend
+    #
+    # @param [Object] server
+    def frontend? server=nil
+      server ? server[:frontend] == true : @cur_server[:frontend] == true
+    end
+
+    # Check whether a server is a backend
+    #
+    # @param [Object] server
+    def backend? server=nil
+      not frontend? server
+    end
+
+    # Check whether a server is a master
+    def master?
+      @server_type == 'master'
+    end
+
+    # Add new servers at runtime
+    #
+    # @param [Array] sinfos
+    def add_servers sinfos
+      return unless sinfos && !sinfos.empty?
+      sinfos.each { |sinfo|
+        # update global server map
+        @servers[sinfo[:server_id]] = sinfo
+
+        # update global server type map
+        slist = @server_type_maps[sinfo[:server_type]] ||= []
+        replace_server slist, sinfo
+
+        # update global server type list
+        if !@server_types.member? sinfo[:server_type]
+          @server_types << sinfo[:server_type]
+        end
+      }
+      emit 'add_servers', sinfos
+    end
+
+    # Remove servers at runtime
+    #
+    # @param [Array] server_ids
+    def remove_servers server_ids
+    end
+
+    # Replace servers at runtime
+    #
+    # @param [Array] sinfos
+    def replace_servers sinfos
+    end
+
+    # Remove server at runtime
+    #
+    # @param [String] server_id
+    def remove_server server_id
+    end
+
+    # Replace server at runtime
+    #
+    # @param [Array] slist
+    # @param [Hash]  server_info
+    def replace_server slist, sinfo
+      slist.each_with_index { |s, index|
+        if s[:server_id] == sinfo[:server_id]
+          slist[index] = sinfo 
+          return
+        end
+      }
+      slist << sinfo
+    end
+  end
+end

data/lib/citrus/citrus.rb

@@ -0,0 +1,27 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+require 'citrus/application'
+require 'citrus/util/events'
+
+module Citrus
+  # Create a citrus application
+  #
+  # @param [Hash] args
+  def self.create_app args={}
+    app = Application.new args
+
+    Object.class_eval {
+      def app
+        return app
+      end
+    }
+    return app
+  end
+
+  # Load all the components
+  Dir.glob(File.expand_path('../../citrus/components/*.rb', __FILE__)).each { |filepath|
+    require filepath
+  }
+end

data/lib/citrus/common/remote/backend/msg_remote.rb

@@ -0,0 +1,57 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 24 July 2014
+
+module Citrus
+  # Common
+  #
+  #
+  module Common
+    # Remote
+    #
+    #
+    module Remote
+      # Backend
+      #
+      #
+      module Backend
+        # MsgRemote
+        #
+        #
+        class MsgRemote
+          # Create a new remote message service
+          #
+          # @param [Object] app
+          def initialize app
+            @app = app
+          end
+
+          # Forward message from frontend server
+          #
+          # @param [Hash]   msg
+          # @param [Object] session
+          def forwardMessage msg, session, &block
+            server = @app.components['server']
+            session_service = @app.components['backend_session'].service
+
+            unless server
+              block_given? and yield Exception.new 'server component not enabled'
+              return
+            end
+
+            unless session_service
+              block_given? and yield Exception.new 'backend session component not enabled'
+              return
+            end
+
+            backend_session = session_service.create session
+
+            server.handle(msg, backend_session) { |err, resp, args|
+              block_given? and yield err, resp, args
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citrus/common/remote/frontend/channel_remote.rb

@@ -0,0 +1,73 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 24 July 2014
+
+module Citrus
+  # Common
+  #
+  #
+  module Common
+    # Remote
+    #
+    #
+    module Remote
+      # Frontend
+      #
+      #
+      module Frontend
+        # ChannelRemote
+        #
+        #
+        class ChannelRemote
+          # Create a new remote channel service
+          #
+          # @param [Object] app
+          def initialize app
+            @app = app
+          end
+
+          # Push message to client by uids
+          #
+          # @param [String] route
+          # @param [Hash]   msg
+          # @param [Array]  uids
+          # @param [Hash]   args
+          def pushMessage route, msg, uids, args, &block
+            if msg.empty?
+              block_given? and yield Exception.new 'can not send empty message'
+              return
+            end
+
+            connector = @app.components['connector']
+
+            session_service = @app.session_service
+            sids = []; fails = []
+            uids.each { |uid|
+              sessions = session_service.get_by_uid uid
+              if sessions
+                sessions.each { |session|
+                  sids << session.id
+                }
+              else
+                fails << uid
+              end
+            }
+            connector.send(nil, route, msg, sids, args) { |err|
+              block_given? and yield err, fails
+            }
+          end
+
+          # Broadcast to all the clients connected with current frontend server
+          #
+          # @param [String] route
+          # @param [Hash]   msg
+          # @param [Hash]   args
+          def broadcast route, msg, args, &block
+            connector = @app.components['connector']
+            connector.send nil, route, msg, nil, args, &block
+          end
+        end
+      end
+    end
+  end
+end