whatup 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205d1b22572393ab8a0fb12bc09edd48576ac740ab484e76e10511afaf080550
-  data.tar.gz: 26648b7a519d2eaeb15149793933d840965c045c6bf911acd6608a365dfa17f8
+  metadata.gz: 391ddb29c708ee7cf37769dc7aa3723d65e420fe08a268862bff6ec7ff5e659f
+  data.tar.gz: b7e349838c88b72f3fbb04258afa114b124f460af40b99d64654bb5b941c04f3
 SHA512:
-  metadata.gz: 5c0dd6fa2a58e09dd1443527e1c58102060f1f1d5fa224c29772e6a86ee89a2c216c4bf43b22aef85a5a3d18b7ccead298860533487e3ec23e7c2e379ec7f956
-  data.tar.gz: 8ed6007535ff1054232ad3e53e6d26eb758e2ebb7d379fa2046bab4601880309156fc45949e67a3e3c9e3136df6006a499fb7bebb2f5eb138c811e6fe1137f25
+  metadata.gz: 6f8458ee475df4aa40d81cd3c126cea7d0153ba3ab2c3d56ec7ff92e130ae1b2765b5594a7a780584498a74d2808779d7024e412d724acad919665b8b339acf3
+  data.tar.gz: e84e5379f28eec45311b4ab0aeea6ec67b45dadea2240f06f3c7dcc33a4094784ad081e6fc1bffa8e57d0c4cbc30248c7a55e663923d95e73b1de89698355316

data/.gitignore

@@ -11,7 +11,7 @@
 .rspec_status
 
 # vagrant
-vagrant/.vagrant
+vagrant/*
 **/*.log
 
 # Since this is a gem, don't include the lock file

data/.rubocop.yml

@@ -3,10 +3,32 @@
 AllCops:
   TargetRubyVersion: 2.4 # Modern Ruby
 
+# attr_reader *%i[a b c]
+Lint/UnneededSplatExpansion:
+  Enabled: false
+
+# Needed for the server pid
+Style/GlobalVars:
+  Exclude:
+    - 'spec/system_spec.rb'
+
+# Aruba uses modifiable strings
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'spec/system_spec.rb'
+
 # The default is a bit restrictive
 Metrics/AbcSize:
   Max: 30
 
+# The default is a bit restrictive
+Metrics/ClassLength:
+  Max: 145
+
+# <<~OUTPUT.gsub /^\s+/, ''
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'whatup.gemspec'

data/README.md

@@ -6,6 +6,8 @@ whatup is a simple server-based instant messaging application
 
 Check it out on [rubygems.org](https://rubygems.org/gems/whatup).
 
+[![Build Status](https://travis-ci.com/jethrodaniel/whatup.svg?branch=dev)](https://travis-ci.com/jethrodaniel/whatup)
+
 ## Installation
 
 Assuming you have Ruby 2.4 or greater installed,

data/Rakefile

@@ -3,6 +3,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new :spec
 
 task default: :spec

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+require 'whatup/client/client'
+
+module Whatup
+  module CLI
+    # Any methods of class `Whatup::CLI::Interactive` that rely on instance
+    # variables should be included here
+    COMMANDS = %i[room list exit].freeze
+
+    require 'whatup/cli/commands/interactive/setup'
+
+    # Interactive client commands that are available after connecting
+    #
+    # This class is run on the server
+    class Interactive < Thor
+      prepend InteractiveSetup
+
+      attr_accessor *%i[server current_user]
+
+      no_commands do
+        # Checks whether a given input string is a valid command
+        def self.command? msg
+          cmds, opts = parse_input(msg)
+          parsed_args = new(cmds, opts).args
+          commands.key?(parsed_args.first) || parsed_args.first == 'help'
+        end
+
+        # Parses a client's input into a format suitable for Thor commands
+        #
+        # @param [String] msg - the client's message
+        def self.parse_input msg
+          # Split user input at the first "option"
+          cmds, opts = msg&.split /-|--/, 2
+
+          # Then split each by whitespace
+          cmds = cmds&.split(/\s+/)
+          opts = opts&.split(/\s+/)
+
+          # `Whatup::CLI::Interactive.new(cmds, opts)` expects arrays, and
+          # a final options hash
+          cmds = [] if cmds.nil?
+          opts = [] if opts.nil?
+
+          [cmds, opts]
+        end
+      end
+
+      # Don't show app name in command help, i.e, instead of
+      # `app command desc`, use `command desc`
+      def self.banner task, _namespace = false, subcommand = false
+        task.formatted_usage(self, false, subcommand).to_s
+      end
+
+      desc 'list', 'Show all connected clients'
+      def list
+        say 'All connected clients:'
+        @server.clients.each { |c| say c.status }
+      end
+
+      desc 'room [NAME]', 'Create and enter chatroom [NAME]'
+      def room name
+        if room = @server.rooms.select { |r| r.name == name }&.first
+          @current_user.puts <<~MSG
+            Entering #{room.name}... enjoy your stay!
+
+            Type `.exit` to exit this chat room.
+
+            Currently in this room:
+            #{room.clients.map do |client|
+                "- #{client.name}\n"
+              end.join}
+          MSG
+          @current_user.room = room
+
+          room.broadcast except: @current_user do
+            <<~MSG
+              #{@current_user.name} has arrived! Play nice, kids.
+            MSG
+          end
+
+          room.clients << @current_user
+          return
+        end
+
+        room = @server.new_room! name: name, clients: [@current_user]
+
+        @current_user.puts <<~MSG
+          Created and entered #{room.name}... invite some people or something!
+
+          Type `.exit` to exit this chat room.
+        MSG
+      end
+
+      # desc 'dm [NAME]', 'Send a direct message to [NAME]'
+      # def dm name
+      #   client = @server.find_client_by name: name
+
+      #   if client.nil?
+      #     @current_user.puts "No client named `#{name}` found!"
+      #     return
+      #   end
+
+      #   client.send_message
+      # end
+
+      desc 'exit', 'Closes your connection with the server'
+      def exit
+        @current_user.exit!
+      end
+    end
+  end
+end

data/lib/whatup/cli/commands/interactive/setup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Whatup
+  module CLI
+    # Implements a `before` hook to set the correct instance variables
+    # before any command methods.
+    #
+    # This is needed, since Thor creates another cli class instance when it is
+    # called with `invoke`, and we need to reassign any variables to the new
+    # cli instance.
+    #
+    # TODO: grab commands dynamically
+    module InteractiveSetup
+      Whatup::CLI::COMMANDS.each do |cmd|
+        define_method cmd do |*args|
+          cli = instance_variable_get(:@_initializer).last[:shell].base
+          @server = cli.server
+          @current_user = cli.current_user
+          super *args
+        end
+      end
+    end
+  end
+end

data/lib/whatup/client/client.rb

@@ -20,6 +20,7 @@ module Whatup
 
         @socket = TCPSocket.open @dest[:ip], @dest[:port]
 
+        puts 'Please enter your username to establish a connection...'
         @request = request!
         @response = listen!
 
@@ -29,12 +30,13 @@ module Whatup
         exit
       end
 
+      private
+
+      # Loop and send all input to the server
       def request!
-        puts 'Please enter your username to establish a connection...'
         Thread.new do
           loop do
-            print '> '
-            input = $stdin.gets&.chomp
+            input = Readline.readline '~> ', true
             exit if input.nil?
             @socket.puts input
           end
@@ -44,11 +46,15 @@ module Whatup
         @socket.close
       end
 
+      # Continually listen to the server, and print anything received
       def listen!
         Thread.new do
           loop do
             response = @socket.gets&.chomp
-            puts response unless response.nil?
+
+            exit if response == 'END'
+
+            puts response # unless response.nil?
           end
         end
       rescue IOError => e

data/lib/whatup/server/client.rb

@@ -4,20 +4,52 @@ module Whatup
   module Server
     class Client
       attr_reader :id, :name
-      attr_accessor :socket
+      attr_accessor *%i[socket room]
 
       def initialize id:, name:, socket:
         @id = id
         @name = name
         @socket = socket
+        @room = nil
       end
 
       def puts msg
-        @socket.puts msg
+        socket.puts msg
       end
 
       def gets
-        @socket.gets
+        socket.gets
+      end
+
+      def input!
+        loop while (msg = gets).blank?
+        msg.chomp
+      end
+
+      def room?
+        !room.nil?
+      end
+      alias chatting? room?
+
+      def status
+        "#{name}" \
+        "#{chatting? ? " (#{@room.name})" : ''}"
+      end
+
+      def broadcast msg
+        @room.clients.reject { |c| c == self }
+             .each { |c| c.puts "#{name}> #{msg}" }
+      end
+
+      def leave_room!
+        broadcast 'LEFT'
+        room.drop_client! self
+        @room = nil
+      end
+
+      def exit!
+        puts "END\n"
+        Thread.kill Thread.current
       end
     end
   end

data/lib/whatup/server/room.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Whatup
+  module Server
+    class Room
+      attr_accessor *%i[name clients]
+
+      def initialize name:, clients:
+        @name = name
+        @clients = clients
+
+        @clients.each { |c| c.room = self }
+      end
+
+      def drop_client! client
+        @clients = @clients.reject { |c| c == client }
+      end
+
+      def broadcast except: nil
+        clients = except \
+          ? @clients.reject { |c| c == except }
+          : @clients
+
+        clients.each { |c| c.puts yield }
+      end
+    end
+  end
+end

data/lib/whatup/server/server.rb

@@ -2,8 +2,13 @@
 
 require 'socket'
 require 'fileutils'
+require 'securerandom'
+
+require 'active_support/core_ext/object/blank'
 
 require 'whatup/server/client'
+require 'whatup/server/room'
+require 'whatup/cli/commands/interactive/interactive'
 
 module Whatup
   module Server
@@ -12,18 +17,26 @@ module Whatup
 
       Client = Whatup::Server::Client
 
+      # Used by the interactive client cli
+      attr_reader *%i[ip port address clients max_id pid pid_file rooms]
+
       def initialize port:
         @ip = 'localhost'
         @port = port
         @address = "#{@ip}:#{@port}"
 
         @clients = []
+        @rooms = []
         @max_id = 1
 
         @pid = Process.pid
         @pid_file = "#{Dir.home}/.whatup.pid"
       end
 
+      # Starts the server.
+      #
+      # The server continuously loops, and handle each new client in a separate
+      # thread.
       def start
         say "Starting a server with PID:#{@pid} @ #{@address} ... \n", :green
 
@@ -33,34 +46,136 @@ module Whatup
 
         # Listen for connections, then accept each in a separate thread
         loop do
-          Thread.new @socket.accept do |client|
-            handle_client client
+          Thread.new(@socket.accept) do |client|
+            case handle_client client
+            when :exit
+              client.puts 'bye!'
+              Thread.kill Thread.current
+            end
           end
         end
-      rescue SignalException
+      rescue SignalException # In case of ^c
         kill
       end
 
+      def find_client_by name:
+        @clients.select { |c| c.name == name }&.first
+      end
+
+      def new_room! clients: [], name:
+        room = Room.new name: name, clients: clients
+        @rooms << room
+        room
+      end
+
       private
 
+      # Receives a new client, then continuously gets input from that client
+      #
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def handle_client client
+        client = create_new_client_if_not_existing! client
+
+        # Loop forever to maintain the connection
+        loop do
+          handle_chatting(client) if client.chatting?
+
+          # Wait until we get a valid command. This takes as long as the client
+          # takes.
+          msg = client.input! unless Whatup::CLI::Interactive.command?(msg)
+
+          puts "#{client.name}> #{msg}"
+
+          # Initialize a new cli class using the initial command and options,
+          # and then set any instance variables, since Thor will create a new
+          # class instance when it's invoked.
+          cmds, opts = Whatup::CLI::Interactive.parse_input msg
+          cli = Whatup::CLI::Interactive.new(cmds, opts).tap do |c|
+            c.server = self
+            c.current_user = client
+          end
+
+          begin
+            # Send the output to the client
+            redirect stdin: client.socket, stdout: client.socket do
+              # Invoke the cli using the provided commands and options.
+
+              # This _should_ achieve the same effect as
+              # `Whatup::CLI::Interactive.start(args)`, but allows us to set
+              # instance variables on the cli class.
+              cli.invoke cli.args.first, cli.args[1..cli.args.size - 1]
+            end
+          rescue RuntimeError,
+                 Thor::InvocationError,
+                 Thor::UndefinedCommandError => e
+            puts e.message
+            client.puts 'Invalid input or unknown command'
+          rescue ArgumentError => e
+            puts e.message
+            client.puts e.message
+          end
+          msg = nil # rubocop:disable Lint/UselessAssignment
+        end
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+      def handle_chatting client
+        loop do
+          input = client.input!
+          room = client.room
+          puts "#{client.name}> #{input}"
+          if input == '.exit'
+            client.leave_room!
+            break
+          end
+          room.broadcast except: client do
+            "#{client.name}> #{input}"
+          end
+        end
+      end
+
+      # Receives a username from a client, then creates a new client unless a
+      # client with that username already exists.
+      #
+      # If no username is provided (i.e, blank), it assigns a random, anonymous
+      # username in the format `ANON-xxx`, where `xxx` is a random number upto
+      # 100, left-padded with zeros.
+      def create_new_client_if_not_existing! client
+        name     = client.gets.chomp
+        rand_num = SecureRandom.random_number(100).to_s.rjust 3, '0'
+        name     = name == '' ? "ANON-#{rand_num}" : name
+
+        if @clients.any? { |c| c.name == name }
+          client.puts 'That name is taken! Goodbye.'
+          client.exit!
+        end
+
         @clients << client = Client.new(
-          id: @max_id += 1,
-          name: client.gets.chomp,
+          id: new_client_id,
+          name: name,
           socket: client
         )
 
         puts "#{client.name} just showed up!"
         client.puts "Hello, #{client.name}!"
+        client
+      end
 
-        loop do
-          msg = client.gets&.chomp
-          puts "#{client.name}> #{msg}" unless msg.nil? || msg == ''
+      # @return A new, unique client identification number
+      def new_client_id
+        @max_id += 1
+      end
 
-          @clients.reject { |c| c.id == client.id }.each do |c|
-            c.puts "\n#{client.name}> #{msg}" unless msg.nil? || msg == ''
-          end
-        end
+      # Reroutes stdin and stdout inside a block
+      def redirect stdin: $stdin, stdout: $stdout
+        original_stdin  = $stdin
+        original_stdout = $stdout
+        $stdin  = stdin
+        $stdout = stdout
+        yield
+      ensure
+        $stdin  = original_stdin
+        $stdout = original_stdout
       end
 
       def exit_if_pid_exists!
@@ -92,6 +207,7 @@ module Whatup
       def kill
         say "Killing the server with PID:#{Process.pid} ...", :red
         FileUtils.rm_rf @pid_file
+        exit
       end
     end
   end

data/lib/whatup/version.rb

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

data/whatup.gemspec

@@ -56,7 +56,9 @@ Gem::Specification.new do |spec|
     'rake' => '~> 12.3.2',
     'rspec' => '~> 3.8',
     'yard' => '~> 0.9.18',
-    'rubocop' => '~> 0.65.0'
+    'rubocop' => '~> 0.65.0',
+    'aruba' => '~> 0.14.9',
+    'activesupport' => '~> 5.2'
   }.each do |gem, version|
     spec.add_development_dependency gem, version
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-23 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.65.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.9
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -151,15 +179,19 @@ files:
 - bin/console
 - bin/setup
 - docs/hw/assignment.pdf
+- docs/hw/framework.pdf
 - docs/hw/inital_design.md
 - docs/installing_ruby.md
 - exe/whatup
 - lib/whatup.rb
 - lib/whatup/cli/cli.rb
 - lib/whatup/cli/commands/client.rb
+- lib/whatup/cli/commands/interactive/interactive.rb
+- lib/whatup/cli/commands/interactive/setup.rb
 - lib/whatup/cli/commands/server.rb
 - lib/whatup/client/client.rb
 - lib/whatup/server/client.rb
+- lib/whatup/server/room.rb
 - lib/whatup/server/server.rb
 - lib/whatup/version.rb
 - whatup.gemspec