whatup 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc66755eaf87be82fc25a0dfa081027979202d7af308f4a84ffb55d7d534bf2
-  data.tar.gz: cbe533848af25657b5989d43168809b5ef5a8e6aa58de06a98a4cbdb3a9c81a8
+  metadata.gz: 205d1b22572393ab8a0fb12bc09edd48576ac740ab484e76e10511afaf080550
+  data.tar.gz: 26648b7a519d2eaeb15149793933d840965c045c6bf911acd6608a365dfa17f8
 SHA512:
-  metadata.gz: 6962ddc17ee091df4405504ee4cbb89941bbd80d7ca6f0c2efa5e8659bb68d44bc38539f7a0fb292c16f33a6f9f6dddfa4518b1eee6e5fa5623b17f4b14c39e8
-  data.tar.gz: 1b5ed8f44195dccf6a4edd6b90251826e0e7ecc546d2d8c74560946829d9534f6f023cb43e071d9733f691c859adfe086df6b81957603a041513d3b6aa7b02eb
+  metadata.gz: 5c0dd6fa2a58e09dd1443527e1c58102060f1f1d5fa224c29772e6a86ee89a2c216c4bf43b22aef85a5a3d18b7ccead298860533487e3ec23e7c2e379ec7f956
+  data.tar.gz: 8ed6007535ff1054232ad3e53e6d26eb758e2ebb7d379fa2046bab4601880309156fc45949e67a3e3c9e3136df6006a499fb7bebb2f5eb138c811e6fe1137f25

data/.rubocop.yml

@@ -3,10 +3,14 @@
 AllCops:
   TargetRubyVersion: 2.4 # Modern Ruby
 
-# Gemspecs are just a giant block, anyway
+# The default is a bit restrictive
+Metrics/AbcSize:
+  Max: 30
+
 Metrics/BlockLength:
   Exclude:
     - 'whatup.gemspec'
+    - 'spec/**/*_spec.rb'
 
 Metrics/MethodLength:
   Max: 20 # 10 is a bit too low

data/docs/hw/inital_design.md

@@ -78,7 +78,7 @@ Commands:
   whatup client connect         # Connects a new client instance to a server
   whatup client help [COMMAND]  # Describe subcommands or one specific subcommand
 
-$ whatup client help start
+$ whatup client help connect
 
 Usage:
   whatup client connect

data/exe/whatup

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'whatup/cli'
+require 'whatup/cli/cli'
 
 require 'thor'
 

data/lib/whatup/cli/cli.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'whatup/cli/commands/client'
+require 'whatup/cli/commands/server'
+
+module Whatup
+  # Thor command classes for the cli.
+  # For usage, see <http://whatisthor.com/>
+  module CLI
+    # Top-level command class
+    class CLI < Thor
+      desc 'hello', 'Says hello'
+      def hello
+        say "Hello!\n", :cyan
+      end
+
+      # Subcommands are defined below, but are implemented in `commands/`
+      desc 'server ...', 'Perform server commands'
+      long_desc <<~DESC
+        Perform server commands.
+
+        See `whatup server help COMMAND` for help on `COMMAND`.
+      DESC
+      subcommand 'server', Server
+
+      desc 'client ...', 'Perform client commands'
+      long_desc <<~DESC
+        Perform client commands.
+
+        See `whatup client help COMMAND` for help on `COMMAND`.
+      DESC
+      subcommand 'client', Client
+    end
+  end
+end

data/lib/whatup/cli/commands/client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'whatup/client/client'
+
+module Whatup
+  module CLI
+    # Client commands
+    class Client < Thor
+      option :ip, type: :string, default: 'localhost'
+      option :port, type: :numeric, default: 9_001
+      long_desc <<~DESC
+        Starts a client instance sending requests to the specified ip and port.
+      DESC
+      desc 'connect', 'Connects a new client instance to a server'
+      def connect
+        config = {ip: options[:ip], port: options[:port]}
+        Whatup::Client::Client.new(config).connect
+      end
+    end
+  end
+end

data/lib/whatup/cli/commands/server.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'whatup/server/server'
+
+module Whatup
+  module CLI
+    # Server commands
+    class Server < Thor
+      option :port, type: :numeric, default: 9_001
+      desc 'start', 'Starts a server instance'
+      long_desc <<~DESC
+        Starts a server instance running locally on the specified port.
+      DESC
+      def start
+        Whatup::Server::Server.new(port: options[:port]).start
+      end
+    end
+  end
+end

data/lib/whatup/client/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+module Whatup
+  module Client
+    class Client
+      include Thor::Shell
+
+      def initialize ip:, port:
+        @dest = {
+          ip: ip,
+          port: port,
+          address: "#{@ip}:#{@port}"
+        }
+      end
+
+      def connect
+        say "Connecting to #{@dest[:ip]}:#{@dest[:port]} ..."
+
+        @socket = TCPSocket.open @dest[:ip], @dest[:port]
+
+        @request = request!
+        @response = listen!
+
+        [@request, @response].each &:join
+      rescue SignalException
+        say 'Exiting ...', :red
+        exit
+      end
+
+      def request!
+        puts 'Please enter your username to establish a connection...'
+        Thread.new do
+          loop do
+            print '> '
+            input = $stdin.gets&.chomp
+            exit if input.nil?
+            @socket.puts input
+          end
+        end
+      rescue IOError => e
+        puts e.message
+        @socket.close
+      end
+
+      def listen!
+        Thread.new do
+          loop do
+            response = @socket.gets&.chomp
+            puts response unless response.nil?
+          end
+        end
+      rescue IOError => e
+        puts e.message
+        @socket.close
+      end
+    end
+  end
+end

data/lib/whatup/server/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Whatup
+  module Server
+    class Client
+      attr_reader :id, :name
+      attr_accessor :socket
+
+      def initialize id:, name:, socket:
+        @id = id
+        @name = name
+        @socket = socket
+      end
+
+      def puts msg
+        @socket.puts msg
+      end
+
+      def gets
+        @socket.gets
+      end
+    end
+  end
+end

data/lib/whatup/server/server.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'fileutils'
+
+require 'whatup/server/client'
+
+module Whatup
+  module Server
+    class Server
+      include Thor::Shell
+
+      Client = Whatup::Server::Client
+
+      def initialize port:
+        @ip = 'localhost'
+        @port = port
+        @address = "#{@ip}:#{@port}"
+
+        @clients = []
+        @max_id = 1
+
+        @pid = Process.pid
+        @pid_file = "#{Dir.home}/.whatup.pid"
+      end
+
+      def start
+        say "Starting a server with PID:#{@pid} @ #{@address} ... \n", :green
+
+        exit_if_pid_exists!
+        connect_to_socket!
+        write_pid!
+
+        # Listen for connections, then accept each in a separate thread
+        loop do
+          Thread.new @socket.accept do |client|
+            handle_client client
+          end
+        end
+      rescue SignalException
+        kill
+      end
+
+      private
+
+      def handle_client client
+        @clients << client = Client.new(
+          id: @max_id += 1,
+          name: client.gets.chomp,
+          socket: client
+        )
+
+        puts "#{client.name} just showed up!"
+        client.puts "Hello, #{client.name}!"
+
+        loop do
+          msg = client.gets&.chomp
+          puts "#{client.name}> #{msg}" unless msg.nil? || msg == ''
+
+          @clients.reject { |c| c.id == client.id }.each do |c|
+            c.puts "\n#{client.name}> #{msg}" unless msg.nil? || msg == ''
+          end
+        end
+      end
+
+      def exit_if_pid_exists!
+        return unless running?
+
+        say <<~EXIT, :cyan
+          A server appears to already be running!
+          Check `#{@pid_file}`.
+        EXIT
+
+        kill
+      end
+
+      def connect_to_socket!
+        @socket = TCPServer.open @port
+      rescue Errno::EADDRINUSE
+        puts 'Address already in use!'
+        kill
+      end
+
+      def write_pid!
+        File.open(@pid_file, 'w') { |f| f.puts Process.pid }
+      end
+
+      def running?
+        File.file? @pid_file
+      end
+
+      def kill
+        say "Killing the server with PID:#{Process.pid} ...", :red
+        FileUtils.rm_rf @pid_file
+      end
+    end
+  end
+end

data/lib/whatup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whatup
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/whatup.gemspec

@@ -11,7 +11,16 @@ Gem::Specification.new do |spec|
   spec.email         = ['jethrodaniel@gmail.com']
 
   spec.summary       = 'A simple server-based instant messaging application'
-  # spec.description   = 'TODO: Write a longer description or delete this line.'
+  spec.description   = <<~DESC
+    whatup is a simple server-based instant messaging application using TCP
+    sockets.
+
+    It was created for educational purposes.
+
+    It is in development, and currently is both simplified and insecure.
+
+    Please be careful.
+  DESC
   spec.homepage      = 'https://github.com/jethrodaniel/whatup'
   spec.license       = 'MIT'
   spec.required_ruby_version = '~> 2.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -122,7 +122,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.3
-description: 
+description: |
+  whatup is a simple server-based instant messaging application using TCP
+  sockets.
+
+  It was created for educational purposes.
+
+  It is in development, and currently is both simplified and insecure.
+
+  Please be careful.
 email:
 - jethrodaniel@gmail.com
 executables:
@@ -147,9 +155,12 @@ files:
 - docs/installing_ruby.md
 - exe/whatup
 - lib/whatup.rb
-- lib/whatup/cli.rb
-- lib/whatup/client.rb
-- lib/whatup/server.rb
+- lib/whatup/cli/cli.rb
+- lib/whatup/cli/commands/client.rb
+- lib/whatup/cli/commands/server.rb
+- lib/whatup/client/client.rb
+- lib/whatup/server/client.rb
+- lib/whatup/server/server.rb
 - lib/whatup/version.rb
 - whatup.gemspec
 homepage: https://github.com/jethrodaniel/whatup

data/lib/whatup/cli.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'thor'
-
-require 'whatup/server'
-require 'whatup/client'
-
-module Whatup
-  # Thor command classes for the cli.
-  # For usage, see <http://whatisthor.com/>
-  module CLI
-    # Client commands
-    class Client < Thor
-      option :ip, type: :string, default: 'localhost'
-      option :port, type: :numeric, default: 9_001
-      long_desc <<~DESC
-        Starts a client instance sending requests to the specified ip and port.
-      DESC
-      desc 'connect', 'Connects a new client instance to a server'
-      def connect
-        Whatup::Client.new(ip: options[:ip], port: options[:port]).connect
-      end
-    end
-
-    # Server commands
-    class Server < Thor
-      option :port, type: :numeric, default: 9_001
-      desc 'start', 'Starts a server instance'
-      long_desc <<~DESC
-        Starts a server instance running locally on the specified port.
-      DESC
-      def start
-        Whatup::Server.new(port: options[:port]).start
-      end
-    end
-
-    # Top-level command class
-    class CLI < Thor
-      desc 'hello', 'Says hello'
-      def hello
-        say "Hello!\n", :cyan
-      end
-
-      desc 'server ...', 'Perform server commands'
-      long_desc <<~DESC
-        Perform server commands.
-
-        See `whatup server help COMMAND` for help on `COMMAND`.
-      DESC
-      subcommand 'server', Server
-
-      desc 'client ...', 'Perform client commands'
-      long_desc <<~DESC
-        Perform client commands.
-
-        See `whatup client help COMMAND` for help on `COMMAND`.
-      DESC
-      subcommand 'client', Client
-    end
-  end
-end

data/lib/whatup/client.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-
-module Whatup
-  class Client
-    include Thor::Shell
-
-    def initialize ip:, port:
-      @dest = {
-        ip: ip,
-        port: port,
-        address: "#{@ip}:#{@port}"
-      }
-    end
-
-    def connect
-      say "Connecting to #{@dest[:ip]}:#{@dest[:port]} ..."
-
-      @socket = TCPSocket.open @dest[:ip], @dest[:port]
-
-      @request = request!
-      @response = listen!
-
-      [@request, @response].each &:join
-    rescue SignalException
-      say 'Exiting ...', :red
-      exit
-    end
-
-    def request!
-      puts 'Please enter your username to establish a connection...'
-      begin
-        Thread.new do
-          loop do
-            message = $stdin.gets.chomp
-            @socket.puts message
-          end
-        end
-      rescue IOError => e
-        puts e.message
-        # e.backtrace
-        @socket.close
-      end
-    end
-
-    def listen!
-      Thread.new do
-        loop do
-          response = @socket.gets.chomp
-          puts response.to_s
-          @socket.close if response.eql? 'quit'
-        end
-      end
-    rescue IOError => e
-      puts e.message
-      # e.backtrace
-      @socket.close
-    end
-  end
-end

data/lib/whatup/server.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-require 'fileutils'
-
-module Whatup
-  class Server
-    include Thor::Shell
-
-    def initialize port:
-      @ip = 'localhost'
-      @port = port
-      @address = "#{@ip}:#{@port}"
-
-      @pid = Process.pid
-
-      @pid_file = "#{Dir.home}/.whatup.pid"
-    end
-
-    def start
-      say "Starting a server with PID:#{@pid} @ #{@address} ... \n", :green
-
-      exit_if_pid_exists!
-      connect_to_socket!
-      write_pid!
-
-      # Listen for connections, then accept each in a separate thread
-      loop do
-        Thread.new @socket.accept do |client|
-          handle_client client
-        end
-      end
-    rescue SignalException
-      kill
-    end
-
-    private
-
-    def handle_client client
-      name = client.gets.chomp
-      puts "#{name} just showed up!"
-      client.puts "Hello, #{name}!"
-
-      client.puts 'Sending you the time ...'
-
-      loop do
-        client.puts Time.now
-        sleep 1
-      end
-    end
-
-    def exit_if_pid_exists!
-      return unless running?
-
-      say <<~EXIT, :cyan
-        A server appears to already be running!
-        Check `#{@pid_file}`.
-      EXIT
-
-      kill
-    end
-
-    def connect_to_socket!
-      @socket = TCPServer.open @port
-    rescue Errno::EADDRINUSE
-      puts 'Address already in use!'
-      kill
-    end
-
-    def write_pid!
-      File.open(@pid_file, 'w') { |f| f.puts Process.pid }
-    end
-
-    def running?
-      File.file? @pid_file
-    end
-
-    def kill
-      say "Killing the server with PID:#{Process.pid} ...", :red
-      FileUtils.rm_rf @pid_file
-    end
-  end
-end