whatup 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391ddb29c708ee7cf37769dc7aa3723d65e420fe08a268862bff6ec7ff5e659f
-  data.tar.gz: b7e349838c88b72f3fbb04258afa114b124f460af40b99d64654bb5b941c04f3
+  metadata.gz: 0ace83a0aa8e24fb44a1f6900f8cdcaf201e7d8d9661883d1bb0ec8fdadf7fd6
+  data.tar.gz: 56b91c405097272ca64cbf9d78b4c6c02fd8749ce883838369b933b618c53552
 SHA512:
-  metadata.gz: 6f8458ee475df4aa40d81cd3c126cea7d0153ba3ab2c3d56ec7ff92e130ae1b2765b5594a7a780584498a74d2808779d7024e412d724acad919665b8b339acf3
-  data.tar.gz: e84e5379f28eec45311b4ab0aeea6ec67b45dadea2240f06f3c7dcc33a4094784ad081e6fc1bffa8e57d0c4cbc30248c7a55e663923d95e73b1de89698355316
+  metadata.gz: 1664ad2e6d346c84d4509fe166744e2f863889d59a968f21db9188989eabf87e4e927045530926a51dc80e2ffdd6734f252642fb0b645139b177319399eb97c6
+  data.tar.gz: 4ee3b633248639ff80215487a2d2820fc7e01a5b6b8923574f464b9255de77443febae039cb9e6cfa8444a2c2e649c7a3597ad82de66127039c6e373a2158168

data/.gitignore

@@ -16,3 +16,6 @@ vagrant/*
 
 # Since this is a gem, don't include the lock file
 Gemfile.lock
+
+# Ignore the database
+db/*.db

data/README.md

@@ -7,6 +7,9 @@ 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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e5356174302d82cf67cb/maintainability)](https://codeclimate.com/github/jethrodaniel/whatup/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/codeclimate/codeclimate/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/whatup.svg)](https://badge.fury.io/rb/whatup)
 
 ## Installation
 

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

@@ -8,7 +8,13 @@ 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
+    COMMANDS = %i[
+      room
+      list
+      exit
+      dmlist
+      dm
+    ].freeze
 
     require 'whatup/cli/commands/interactive/setup'
 
@@ -18,6 +24,9 @@ module Whatup
     class Interactive < Thor
       prepend InteractiveSetup
 
+      Room = Whatup::Server::Room
+      Client = Whatup::Server::Client
+
       attr_accessor *%i[server current_user]
 
       no_commands do
@@ -57,12 +66,13 @@ module Whatup
       desc 'list', 'Show all connected clients'
       def list
         say 'All connected clients:'
-        @server.clients.each { |c| say c.status }
+        @server.clients_except(@current_user).each { |c| say "  #{c.status}" }
+        say "* #{@current_user.status}"
       end
 
       desc 'room [NAME]', 'Create and enter chatroom [NAME]'
       def room name
-        if room = @server.rooms.select { |r| r.name == name }&.first
+        if room = Room.find_by(name: name)
           @current_user.puts <<~MSG
             Entering #{room.name}... enjoy your stay!
 
@@ -73,7 +83,7 @@ module Whatup
                 "- #{client.name}\n"
               end.join}
           MSG
-          @current_user.room = room
+          @current_user.update! room: room
 
           room.broadcast except: @current_user do
             <<~MSG
@@ -94,17 +104,35 @@ module Whatup
         MSG
       end
 
-      # desc 'dm [NAME]', 'Send a direct message to [NAME]'
-      # def dm name
-      #   client = @server.find_client_by name: name
+      desc 'dmlist', 'List your received messages'
+      def dmlist
+        say 'Your direct messages:'
+        msgs = @current_user.received_messages.map do |msg|
+          <<~MSG
+            From: #{msg.sender.name}
+
+            #{msg.content}
+          MSG
+        end.join('-' * 10)
+        say msgs
+      end
+
+      desc 'dm [NAME]', 'Send a direct message to [NAME]'
+      def dm name
+        if recepient = Client.find_by(name: name)
+          say <<~MSG
+            Sending a direct message to #{name}...
 
-      #   if client.nil?
-      #     @current_user.puts "No client named `#{name}` found!"
-      #     return
-      #   end
+            The message can span multiple lines.
 
-      #   client.send_message
-      # end
+            Type `.exit` when you're ready to send it.
+          MSG
+          @current_user.composing_dm = recepient
+          return
+        end
+
+        say "That user doesn't exist!"
+      end
 
       desc 'exit', 'Closes your connection with the server'
       def exit

data/lib/whatup/client/client.rb

@@ -37,7 +37,8 @@ module Whatup
         Thread.new do
           loop do
             input = Readline.readline '~> ', true
-            exit if input.nil?
+            next if input.nil?
+
             @socket.puts input
           end
         end
@@ -52,7 +53,11 @@ module Whatup
           loop do
             response = @socket.gets&.chomp
 
-            exit if response == 'END'
+            if response == 'END'
+              puts
+              kill_all_but_current_thread!
+              exit
+            end
 
             puts response # unless response.nil?
           end
@@ -61,6 +66,12 @@ module Whatup
         puts e.message
         @socket.close
       end
+
+      def kill_all_but_current_thread!
+        Thread.list.each do |thread|
+          thread.exit unless thread == Thread.current
+        end
+      end
     end
   end
 end

data/lib/whatup/server/db_init.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'whatup'
+require 'whatup/server/redirection'
+
+module Whatup
+  module Server
+    module DbInit
+      extend Redirection
+
+      class << self
+        def setup_db!
+          db = "#{Whatup.root}/db/whatup.db"
+          SQLite3::Database.new(db) unless File.exist?(db)
+
+          ActiveRecord::Base.establish_connection adapter: 'sqlite3',
+                                                  database: db
+
+          ActiveRecord::Base.connection.execute <<~SQL
+            DROP TABLE IF EXISTS clients_rooms;
+            DROP TABLE IF EXISTS clients;
+            DROP TABLE IF EXISTS messages;
+            DROP TABLE IF EXISTS rooms;
+          SQL
+
+          redirect(stdout: StringIO.new) { create_tables! }
+        end
+
+        private
+
+        def create_tables!
+          ActiveRecord::Schema.define do
+            create_table :clients, force: true do |t|
+              t.string :name
+              t.references :room
+            end
+            create_table :messages, force: true do |t|
+              t.string :content
+              t.references :sender
+              t.references :recipient
+            end
+            create_table :rooms, force: true do |t|
+              t.string :name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whatup/server/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/whatup/server/models/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'whatup/server/models/application_record'
+
+module Whatup
+  module Server
+    class Client < ApplicationRecord
+      has_many :sent_messages, class_name: 'Message',
+                               foreign_key: 'sender_id'
+      has_many :received_messages, class_name: 'Message',
+                                   foreign_key: 'recipient_id'
+
+      belongs_to :room, optional: true
+
+      validates_uniqueness_of :name
+
+      attr_accessor *%i[socket composing_dm deleted]
+
+      def puts msg
+        socket.puts msg
+      end
+
+      def gets
+        socket.gets
+      end
+
+      def input!
+        loop while (msg = gets).blank?
+        msg.chomp
+      end
+
+      def chatting?
+        !room_id.nil?
+      end
+
+      def composing_dm?
+        !composing_dm.nil?
+      end
+
+      def status
+        "#{name}#{chatting? ? " (#{room.name})" : ''}"
+      end
+
+      def broadcast msg
+        room.broadcast(except: self) { "#{name}> #{msg}" }
+      end
+
+      def leave_room!
+        broadcast 'LEFT'
+        room.drop_client! self
+      end
+
+      def exit!
+        puts 'END'
+        socket.close
+        @deleted = true
+        destroy!
+      end
+    end
+  end
+end

data/lib/whatup/server/models/message.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'whatup/server/models/application_record'
+
+module Whatup
+  module Server
+    class Message < ApplicationRecord
+      belongs_to :recipient, class_name: 'Client'
+      belongs_to :sender, class_name: 'Client', foreign_key: 'sender_id'
+    end
+  end
+end

data/lib/whatup/server/models/room.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'whatup/server/models/application_record'
+
+module Whatup
+  module Server
+    class Room < ApplicationRecord
+      has_many :clients
+
+      validates :name, uniqueness: true
+
+      def drop_client! client
+        client.update! room_id: nil
+      end
+
+      def broadcast except: nil
+        if except
+          clients.where.not id: except.id
+        else
+          clients
+        end.each { |c| c.puts yield }
+      end
+    end
+  end
+end

data/lib/whatup/server/redirection.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Whatup
+  module Server
+    module Redirection
+      # 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
+    end
+  end
+end

data/lib/whatup/server/server.rb

@@ -4,33 +4,40 @@ require 'socket'
 require 'fileutils'
 require 'securerandom'
 
+require 'sqlite3'
+require 'active_record'
 require 'active_support/core_ext/object/blank'
 
-require 'whatup/server/client'
-require 'whatup/server/room'
+require 'whatup/server/db_init'
+require 'whatup/server/redirection'
+require 'whatup/server/models/client'
+require 'whatup/server/models/message'
+require 'whatup/server/models/room'
 require 'whatup/cli/commands/interactive/interactive'
 
 module Whatup
   module Server
-    class Server
+    class Server # rubocop:disable Metrics/ClassLength
       include Thor::Shell
+      include DbInit
+      include Redirection
 
       Client = Whatup::Server::Client
 
-      # Used by the interactive client cli
-      attr_reader *%i[ip port address clients max_id pid pid_file rooms]
+      attr_reader *%i[ip port address clients pid pid_file rooms]
 
-      def initialize port:
-        @ip = 'localhost'
+      def initialize ip: 'localhost', port:
+        @ip = ip
         @port = port
         @address = "#{@ip}:#{@port}"
 
         @clients = []
         @rooms = []
-        @max_id = 1
 
         @pid = Process.pid
         @pid_file = "#{Dir.home}/.whatup.pid"
+
+        DbInit.setup_db!
       end
 
       # Starts the server.
@@ -62,8 +69,12 @@ module Whatup
         @clients.select { |c| c.name == name }&.first
       end
 
+      def clients_except client
+        @clients.reject { |c| c == client }
+      end
+
       def new_room! clients: [], name:
-        room = Room.new name: name, clients: clients
+        room = Room.create! name: name, clients: clients
         @rooms << room
         room
       end
@@ -72,13 +83,21 @@ module Whatup
 
       # Receives a new client, then continuously gets input from that client
       #
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       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?
+          @clients.reject! &:deleted
+
+          Thread.current.exit if client.deleted
+
+          if client.composing_dm?
+            handle_dm client
+          elsif client.chatting?
+            handle_chatting client
+          end
 
           # Wait until we get a valid command. This takes as long as the client
           # takes.
@@ -86,24 +105,11 @@ module Whatup
 
           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]
+              run_thor_command! client: client, msg: msg
             end
           rescue RuntimeError,
                  Thor::InvocationError,
@@ -114,10 +120,29 @@ module Whatup
             puts e.message
             client.puts e.message
           end
-          msg = nil # rubocop:disable Lint/UselessAssignment
+          msg = nil
         end
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      def handle_dm client
+        msg = StringIO.new
+        loop do
+          input = client.input!
+          puts "#{client.name}> #{input}"
+          if input == '.exit'
+            client.puts "Finished dm to `#{client.composing_dm.name}`."
+            break
+          end
+          msg.puts input
+        end
+        client.composing_dm
+              .received_messages << Message.new(
+                sender: client,
+                content: msg.string
+              )
+        client.composing_dm = nil
+      end
 
       def handle_chatting client
         loop do
@@ -126,6 +151,7 @@ module Whatup
           puts "#{client.name}> #{input}"
           if input == '.exit'
             client.leave_room!
+            client.puts "Exited `#{room.name}`."
             break
           end
           room.broadcast except: client do
@@ -147,35 +173,41 @@ module Whatup
 
         if @clients.any? { |c| c.name == name }
           client.puts 'That name is taken! Goodbye.'
-          client.exit!
+          client.puts 'END'
+          client.close
+          Thread.current.exit
         end
 
-        @clients << client = Client.new(
-          id: new_client_id,
+        @clients << client = Client.create!(
           name: name,
           socket: client
         )
 
         puts "#{client.name} just showed up!"
-        client.puts "Hello, #{client.name}!"
-        client
-      end
+        client.puts <<~MSG
+          Hello, #{client.name}!
+
+          Welcome to whatup.
 
-      # @return A new, unique client identification number
-      def new_client_id
-        @max_id += 1
+          To get started, type `help`.
+        MSG
+        client
       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
+      def run_thor_command! client:, 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
+        Whatup::CLI::Interactive.new(cmds, opts).tap do |c|
+          c.server = self
+          c.current_user = client
+
+          # This _should_ achieve the same effect as
+          # `Whatup::CLI::Interactive.start(args)`, but allows us to set
+          # instance variables on the cli class.
+          c.invoke c.args.first, c.args.drop(1)
+        end
       end
 
       def exit_if_pid_exists!

data/lib/whatup/version.rb

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

data/lib/whatup.rb

@@ -7,4 +7,8 @@ module Whatup
   # Whatup-specific error class
   class Error < StandardError
   end
+
+  def self.root
+    Dir.pwd
+  end
 end

data/whatup.gemspec

@@ -49,23 +49,27 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  # rubocop:disable Layout/AlignHash
   {
-    'pry' => '~> 0.12.2',
+    'pry'        => '~> 0.12.2',
     'pry-byebug' => '~> 3.7',
-    'bundler' => '~> 2.0',
-    'rake' => '~> 12.3.2',
-    'rspec' => '~> 3.8',
-    'yard' => '~> 0.9.18',
-    'rubocop' => '~> 0.65.0',
-    'aruba' => '~> 0.14.9',
-    'activesupport' => '~> 5.2'
+    'bundler'    => '~> 2.0',
+    'rake'       => '~> 12.3.2',
+    'rspec'      => '~> 3.8',
+    'yard'       => '~> 0.9.18',
+    'rubocop'    => '~> 0.65.0',
+    'aruba'      => '~> 0.14.9'
   }.each do |gem, version|
     spec.add_development_dependency gem, version
   end
 
   {
-    'thor' => '~> 0.20.3'
+    'activesupport' => '~> 5.2',
+    'thor'          => '~> 0.20.3',
+    'sqlite3'       => '~> 1.4',
+    'activerecord'  => '~> 5.2'
   }.each do |gem, version|
     spec.add_dependency gem, version
   end
+  # rubocop:enable Layout/AlignHash
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -129,7 +129,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -150,6 +150,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 description: |
   whatup is a simple server-based instant messaging application using TCP
   sockets.
@@ -178,6 +206,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- db/.keep
 - docs/hw/assignment.pdf
 - docs/hw/framework.pdf
 - docs/hw/inital_design.md
@@ -190,8 +219,12 @@ files:
 - 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/db_init.rb
+- lib/whatup/server/models/application_record.rb
+- lib/whatup/server/models/client.rb
+- lib/whatup/server/models/message.rb
+- lib/whatup/server/models/room.rb
+- lib/whatup/server/redirection.rb
 - lib/whatup/server/server.rb
 - lib/whatup/version.rb
 - whatup.gemspec

data/lib/whatup/server/client.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Whatup
-  module Server
-    class Client
-      attr_reader :id, :name
-      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
-      end
-
-      def 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
-end

data/lib/whatup/server/room.rb

@@ -1,28 +0,0 @@
-# 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