ruby-mud 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9acab5713021f56b21844f932f356c3375fc5b0a
-  data.tar.gz: fae204f94afedf57dbc37a7b832161d589382f0f
+  metadata.gz: 21f775f532d3ecb4f1fe785b2bf43375a333f50d
+  data.tar.gz: c5adb0167b1f4c3e085a523d97b0af5265515f80
 SHA512:
-  metadata.gz: 5c565c5be311e2694a21ad8681a5eb47ddfff26dde8c0034760430c563560fe8e791442f3a617913a3f2485c1a694035eb203ea3a9c66de5f5fffbfe8b0a8a3f
-  data.tar.gz: 85493ba37834c7591bd628148cc274c88036fba0a2ec7f3315b3a86fa12ebc915de0d03cb17700b4bd274ec4cef69a1431689a6b7340b7872b7b149ba915b24d
+  metadata.gz: 9c57d647655acb4d75b3050e8cee7398e6ba6b24b7808e45c4f0462cc04bc51880b7cb84755b935ec4ac44de8f3ddb7f568b0c7ef70c289185eb849993b1009b
+  data.tar.gz: 07c224d01d9d1840e7a1c1d692749a6b1ec0427b36a969b117115de9b9e5c0b350bf6a3246b3fc07b8545671d43d5c9261183dfdda8f941b554b6c216469e339

data/lib/abstract_controller.rb

@@ -0,0 +1,103 @@
+# Transfers input/output from the Telnet world into the Ruby world while
+# abstracting away all the rough spots.
+# All controllers should inherit from here
+class MudServer::AbstractController
+
+  attr_accessor :session, :params
+
+  # Instantiates a new controller instance. It is highly recomended that derived
+  # controller classes either not modify this method, call super, or proxy via a
+  # helper method (such as create() or buil(), etc).
+  #
+  # * +session+ - (Session) The connection session that the controller will
+  # communicate with.
+  def initialize(session)
+    @session = session
+    on_start
+    true
+  end
+
+  # User definable callback called after instantiation.
+  def on_start
+  end
+
+  # Sends a string to remote client over the TCP socket connection.
+  def send_text(command)
+    @session.connection.puts(command)
+  end
+
+  # Void paramaterless controller action that closes TCP socket to client.
+  # You must whitelist this command in allowed_methods() in order for it to be
+  # usable by players.
+  def quit
+    session.connection.close
+  end
+
+  # Parses arbitrary user input into a format usable by the interpreter. Strips
+  # all input after initial command and stores it in `params`.
+  #
+  # * +command+ - (String) A string of space seperated commands and arguments
+  #
+  #    parse_command('login user_x password123')
+  #    # => True
+  #    params() # Note: side effects
+  #    # => 'user_x password123'
+  def get_text(command)
+    command = command.split(' ')
+    head    = command.shift
+    @params = command.join(' ')
+    interpret_command head.to_s.downcase
+  end  
+
+  # Interprets a controller command (first argument of user input)
+  #
+  # * +head+ - (String) The command to execute. Will only execute the command if
+  # it is within the 'allowed_methods' dynamic array.
+  #
+  #    interpret_command('add') # Assumes the current controller has
+  #                             # an add() method defined and within
+  #    # => 10                  # the allowed_methods Array.
+  def interpret_command(head)
+    if allowed_methods.include? head
+      self.send(head)
+    else
+      send_error
+    end
+  rescue => error
+      send_text 'You just broke something. Please tell the admins about this.'
+      send_text error.message
+  end
+
+  # A whimsical way of telling the user they input an unknown /
+  # unauthorized command. Override this if you want a '404 page' on
+  # your controller
+  def send_error
+    send_text funny_responses.sample
+  end
+
+  # Parameterless method used for generating quirky messages when the
+  # user attempts to use a non-existant / forbidden controller action.
+  # Returns String.
+  def funny_responses
+    [
+      'Huh?',
+      "What's that you say?",
+      'come again?',
+      "Sorry, I don't know that command."
+    ]
+  end
+
+  # Dynamically generated list of user accesible controller methods. By default
+  # (and when used in conjugation with +super+ in derived classes), will return
+  # ['quit'] as its only accessible method. Returns Array of Strings.
+  def allowed_methods
+    ['quit']
+  end
+
+  # Transfers control from on controller to another. Eg: Move from login
+  # controler to main game.
+  def transfer_to(controller_name)
+    @session.controller = controller_name.new(@session)
+  end
+
+end

data/lib/default_controller.rb

@@ -0,0 +1,8 @@
+# This is a default implementation and entry point for all Mud activity.
+# Override this controller in Your implementation. See AbstractController for
+# better documentation.
+class MudServer::DefaultController < MudServer::AbstractController
+  def on_start
+    send_text 'It works! Type `quit` to end'
+  end
+end

data/lib/mud_server.rb

@@ -0,0 +1,37 @@
+#The server class creates a single instance of a mud server.
+class MudServer
+
+  attr_accessor :connection_pool, :tcp_socket,
+                :connection_acceptor, :port, :ip, :environment
+
+  def initialize(ip = "0.0.0.0", port = 4000, environment = 'development')
+    bootstrap_settings(ip, port, environment)
+  end
+
+  def bootstrap_settings(ip, port, environment)
+    @port            = port
+    @ip              = ip
+    @environment     = environment
+    @connection_pool = [] # This is where we keep reference to all game
+                          # connections
+  end
+
+  def start
+    @tcp_socket = TCPServer.new @ip , @port
+    @connection_acceptor = Thread.new do
+      while connection = @tcp_socket.accept
+        @connection_pool << MudServer::Session.new(connection)
+      end
+    end
+    return true
+  end
+
+  # You probably won't need this one in production, but it's a must for testing.
+  def stop
+    @tcp_socket.close
+    @connection_acceptor.kill
+    @connection_acceptor = nil
+    return true
+  end
+
+end

data/lib/session.rb

@@ -0,0 +1,24 @@
+class MudServer::Session
+
+  attr_accessor :connection, :ip_addr, :input_thread, :controller
+
+  def initialize(connection, controller = MudServer::DefaultController)
+    bootstrap_settings(connection, controller)
+    start
+  end
+
+  def bootstrap_settings(connection, controller)
+    @connection   = connection
+    @ip_addr      = @connection.peeraddr[-1]
+    @controller   = controller.new(self)
+  end
+
+  def start
+    @input_thread = Thread.new(@connection) do |client|
+      while (client_input = client.gets.chomp)
+        @controller.get_text client_input
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mud
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Rick Carlino
@@ -59,6 +59,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ruby_mud.rb
+- lib/mud_server.rb
+- lib/default_controller.rb
+- lib/abstract_controller.rb
+- lib/session.rb
 homepage: https://github.com/rickcarlino/mud
 licenses:
 - MIT