chatr 0.3.5 → 0.4.6

data/README.md

@@ -1,2 +1,20 @@
-chatr
-=====
+# chatr
+
+[![Build Status](https://travis-ci.org/benwoody/chatr.png)](https://travis-ci.org/benwoody/chatr)
+
+## Chatr Library
+Chatr helps facilitate messages across socket connections.  When a new Chatr::Host object is created, it creates a TCPServer to marshal messaging to and from the connecting clients.
+
+## chatr_host
+This binary sets up a Chatr host connection.  Clients may then open connections to that hosts IP and Chatr port (default 4242)
+
+Run host:
+
+    chatr_host 3333
+
+Connect to host:
+
+    telnet 192.168.1.1 3333
+
+The Host will accept the new connection and route incoming socket messages to the Host and other connected clients.
+Clients are designated by their machines IP Address and the incoming Socket ID.

data/bin/chatr_host

@@ -1,32 +1,36 @@
 #!/usr/bin/env ruby
 
-require 'chatr'
+require_relative '../lib/chatr.rb'
 
 # grab the first arguement from chatr_host
 port = ARGV[0]
 
-chatr = Chatr::Host.new port
+chatr = Chatr::Host.new(port=4242)
 
 puts "Chat server initiated at #{chatr.local_ip} on port #{port}"
 
-host = chatr.instance_variable_get(:@host)
-connections = chatr.instance_variable_get(:@connections)
-
-while true
-  session = select(connections,nil, nil,nil)
+loop do
+  session = select(chatr.connections)
   if session != nil
     session[0].each do |socket|
-      if socket == host
+      if socket == chatr.host
         chatr.accept_new_connection
+        new_socket = chatr.connections.last
+        join_msg = sprintf "Client #{new_socket.peeraddr[2]}:#{new_socket.peeraddr[1]} joined.\n"
+        chatr.broadcast_string(join_msg,new_socket)
       else
         input = socket.gets
         if input.chomp == "QUIT"
+          quit_msg = sprintf "Client #{socket.peeraddr[2]}:#{socket.peeraddr[1]} disconnected\n"
+          chatr.broadcast_string(quit_msg,socket)
           chatr.client_quit socket
         else
-          chatr.write_out input, socket
+          output = sprintf "[#{socket.peeraddr[2]}|#{socket.peeraddr[1]}]: #{input}"
+          chatr.broadcast_string(output,socket)
         end
       end
     end
   end
 end
 
+

data/chatr_version

@@ -1 +1 @@
-0.3.5
+0.4.6

data/lib/chatr/host.rb

@@ -1,14 +1,17 @@
 module Chatr
   class Host
 
+    attr_reader :host, :connections
+
     def initialize(port=4242)
       @host = build_connection local_ip, port
       @connections = grab_connections
     end
 
     # Find local ip
+    # This attempts an open connection to google.com and checks the local address used to attempt the request
     def local_ip
-      Socket.ip_address_list.last.ip_address
+      UDPSocket.open {|s| s.connect("64.233.187.99", 1); s.addr.last}
     end
 
     # Start Socket connection
@@ -22,28 +25,24 @@ module Chatr
       connections << @host
     end
 
+    # Gives the number of connected clients
+    # Subtracts 1 to account for the host
+    def room_size
+      @connections.size - 1
+    end
+
     # Take new socket from remote connection.
     # This will write out new information to the client and output this to the host as well
     def accept_new_connection
       new_socket = @host.accept
-      @connections.push(new_socket)
-      newsock.write("Write QUIT to disconnect\n")
-      str = sprintf "Client #{newsock.peeraddr[2]}:#{newsock.peeraddr[1]} joined.\n"
-      broadcast_string(str,newsock)
-    end
-
-    # Writes out the clients information and chat string to both host and connected clients
-    def write_out(string,sock)
-      str = sprintf "[#{sock.peeraddr[2]}|#{sock.peeraddr[1]}]: #{string}"
-      broadcast_string(str,sock)
+      @connections << new_socket
+      new_socket.write("Write QUIT to disconnect\n")
     end
 
     # Writes out when a client writes EOF and then outputs that information to host and clients
-    def client_quit(sock)
-      str = sprintf "Client #{sock.peeraddr[2]}:#{sock.peeraddr[1]} disconnected\n"
-      broadcast_string(str,sock)
-      sock.close
-      @connections.delete(sock)
+    def client_quit(socket)
+      @connections.delete(socket)
+      socket.close
     end
 
     # Print the string to the open connected sockets

data/spec/lib/host_spec.rb

@@ -7,23 +7,35 @@ describe 'Host' do
 	end
 
 	it 'should find local ip address' do
-		ip_from_google = UDPSocket.open {|s| s.connect("64.233.187.99", 1); s.addr.last}
-		@chatr.local_ip.should == ip_from_google
+		ip_regex = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/
+		@chatr.local_ip.should match ip_regex
 	end
 
-	it 'should build a Socket connection' do
+	it 'should build an Array of socket connections' do
+		@chatr.grab_connections.class.should be Array
 	end
 
-	it 'should accept new connections' do
+	it 'should show the number of clients in chat' do
+		@chatr.room_size.class.should be Fixnum
 	end
 
-	it 'should broadcast information accross connections' do
+	# Tests that a TCPServer connection is built
+	it 'should build a Socket connection' do
+		@chatr.host.class.should be TCPServer
 	end
 
-	it 'should write chat lines accross connections' do
+	it 'should accept new connections' do
+		client = TCPSocket.new(@chatr.local_ip,'4242')
+		@chatr.accept_new_connection
+		@chatr.room_size.should eq(1)
+		@chatr.client_quit @chatr.connections.last
 	end
 
 	it 'should close a connection when a client quits' do
+		client = TCPSocket.new(@chatr.local_ip,'4242')
+		@chatr.accept_new_connection
+		@chatr.client_quit @chatr.connections.last
+		@chatr.room_size.should eq(0)
 	end
 
 end

data/spec/spec_helper.rb

@@ -1,8 +1,4 @@
 require 'rubygems'
 require 'rspec'
 
-RSpec.configure do |config|
-  config.order = 'random'
-end
-
 require File.expand_path("../../lib/chatr", __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatr
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies: []
 description: This gem is for my final project for UW Ruby Certificate course
 email: mail@benwoodall.com
@@ -52,11 +52,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple chat interface using Sockets
-test_files:
-- spec/lib/host_spec.rb
-- spec/spec_helper.rb
+test_files: []
 has_rdoc: