whatup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5d98008826bd20d3088df444c0cd91b4449ab048b67efe806c1c829095dd54a
-  data.tar.gz: 2143dc7a73a297d8fa6a2d9eb70f11ea85d7cefe2c9344af078e48a2a3436ad8
+  metadata.gz: e77a298339294647aca70949faf47f51c2202fe5ebf00ced22bdace460796ad5
+  data.tar.gz: 9974c515c6aedfa6e93017d73ed6d31955fdfd796f602332240f23e99f03d73e
 SHA512:
-  metadata.gz: 64c338348c2c3c952dd8f0266a8301d18d49b3af235bc0078f4a39cdb60158789a5093f9313b93ed9b73ea60a3d662fdcfbf80a1cc4605ffeecc1cc39143748b
-  data.tar.gz: 52639d8eed9c14fa787c8f9a58e9246dbc82685bd80335ad9995c252dca642a4f6ed6346d60514a0df683be05b3ec02d1fe1f63e522e581b38539511c8126138
+  metadata.gz: d4a32f88d88ae37728137e99f269b5a9d0ef8e775f975c08b778c363077c98001fcf72a07bf7c1195400023ce602cdddb969e45c613292faf4fb20b166d6110e
+  data.tar.gz: 4c61c89b2afaf46df082868521a7d6a09e27e7f91e129169308679783a2a4327aeb2e497a4918e29a9e7da2ff6d0e045000faa01e4de37b342da28908c561b8b

data/.git_hooks/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Ensures that before commiting:
+# - there are no rubocop style violations
+
+bundle exec rubocop

data/.gitignore

@@ -9,3 +9,10 @@
 
 # rspec failure tracking
 .rspec_status
+
+# vagrant
+vagrant/.vagrant
+**/*.log
+
+# Since this is a gem, don't include the lock file
+Gemfile.lock

data/.rubocop.yml

@@ -1,3 +1,42 @@
+# Rubocop linting options
+
+AllCops:
+  TargetRubyVersion: 2.4 # Modern Ruby
+
+# Gemspecs are just a giant block, anyway
 Metrics/BlockLength:
   Exclude:
     - 'whatup.gemspec'
+
+Metrics/MethodLength:
+  Max: 20 # 10 is a bit too low
+
+# Don't type unneccesary ()
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+# { } for blocks, {} for hashes
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# while line = gets do
+#   ...
+# end
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# outcome = some_really_long_event \
+#   ? choice_a
+#   : choice_a
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+# Encouraging a comment above every single module or class oftentimes leads to
+# redundant comments that are odds with the design principle of writing
+# simple, readable code
+Style/Documentation:
+  Enabled: false
+
+# [a, b, c].map &:to_f
+Lint/AmbiguousOperator:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/Gemfile

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-ruby '2.5.3'
+ruby '2.6.1'
 
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
-

data/README.md

@@ -2,24 +2,53 @@
 
 whatup is a simple server-based instant messaging application
 
+**Note**: this is very much a work-in-progress, and will be until version `1.0.0`
+
 ## Installation
 
+Assuming you have Ruby `2.6.1` installed,
+
 ```
-gem install whatup
+$ gem install whatup
 ```
 
+If you don't have Ruby `2.6.1` installed, see [here](docs/installing_ruby.md)
+for some brief instructions.
+
 ## Usage
 
 ```
 $ whatup
 
 Commands:
+  whatup client ...      # Perform client commands
   whatup hello           # Says hello
   whatup help [COMMAND]  # Describe available commands or one specific command
+  whatup server ...      # Perform server commands
 ```
 
 ## Development
 
+To run the program's command line interface
+
+```
+$ ruby -I./lib ./exe/whatup
+```
+
+To run the tests
+
+```
+$ bundle exec rspec
+```
+
+We have a git hook to automatically run the code linter before committing.
+
+Set it up as follows
+
+```
+$ git config core.hooksPath '.git_hooks'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/jethrodaniel/whatup>.
@@ -32,3 +61,9 @@ Free as in beer - our [license](https://github.com/jethrodaniel/whatup/blob/mast
 
 This was part of a school project - see the [course site](http://www.cs.memphis.edu/~kanyang/COMP3825-sp19.html) for details.
 
+## Citations
+
+The following were instrumental in understanding the usage of threads for socket input:
+
+- [Socket Programming in Ruby](https://code.likeagirl.io/socket-programming-in-ruby-f714131336fd),Chopra, Neha. Code Like A Girl. (19 Sept. 2017)
+- [Ruby TCP Chat](www.sitepoint.com/ruby-tcp-chat/), Benitez, Simon. Sitepoint. (13 Jan. 2014)

data/docs/hw/inital_design.md

@@ -0,0 +1,138 @@
+# Inital Design
+
+whatup is a simple server-based instant messaging application utilizing TCP sockets.
+
+## Language
+
+It is written in [Ruby](https://www.ruby-lang.org/en/), a general purpose OOP
+programming language, similar to Python.
+
+## Packaging, Installation
+
+It is packaged as a [gem](https://guides.rubygems.org/), which is the idiomatic Ruby way to publish code.
+
+This allows for a very simple setup (as follows):
+
+```
+$ gem install whatup
+```
+
+## Command Line Interface
+
+While the code is written in Ruby, the program interacts with the user via a
+command line interface.
+
+```
+$ whatup
+Commands:
+  whatup client ...      # Perform client commands
+  whatup hello           # Says hello
+  whatup help [COMMAND]  # Describe available commands or one specific command
+  whatup server ...      # Perform server commands
+```
+
+## Server
+
+The server implements a basic TCP socket, and listens on port 9001 (or another
+optional port) for requests, which will be routed to TCP sockets.
+
+When the server recieves a client connection, it starts a new thread and assigns a unique id
+to the client by a random number and a user provided name.
+
+Multiple clients can connect, since the server starts a new thread for each connection.
+
+```
+$ whatup server
+
+Commands:
+  whatup server help [COMMAND]  # Describe subcommands or one specific subcommand
+  whatup server start           # Starts a server instance
+
+$ whatup server help start
+
+Usage:
+  whatup server start
+
+Options:
+  [--port=N]
+              # Default: 9001
+
+Description:
+  Starts a server instance on the specified port.
+```
+
+## Client
+
+A client connects to the server via one of the server's TCP sockets.
+
+When the client connects, it is asked to provide a username, which will be
+combined with a random number to produce a unique identifier for the client.
+
+The client, when connected, can ask the server for a list of other connected
+clients, and can then choose to chat with any other client.
+
+```
+$ whatup client
+
+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
+
+Usage:
+  whatup client connect
+
+Options:
+  [--ip=IP]
+              # Default: localhost
+  [--port=N]
+              # Default: 9001
+
+Description:
+  Starts a client instance sending requests to the specified ip and port.
+```
+
+For example,
+
+```
+$ whatup client connect --ip 12.345.67.890 --port 9001
+
+Connecting to ...
+Connected successfully to ..
+
+Please enter your username:
+
+> john_doe
+
+Congrats, your username is `john_doe#123`!
+
+Type `help` for a list of available commands.
+
+> help
+
+  list  # See a list of clients you can chat with
+  chat  # Starts a chat with the specified client
+  exit  # Closes your connection with the server
+
+> list
+
+  1. jane_doe#123
+  2. mary#321
+
+>  chat 1
+
+You're now chatting with `jane_doe#123`. Say hi! See `.help` for help.
+
+john_doe#123> hi
+jane_doe#123> hey, I'm jane doe!
+john_doe#123> .exit
+
+Diconnected from `jane_doe#123`.
+
+> exit
+
+Goodbye!
+```
+
+

data/docs/installing_ruby.md

@@ -0,0 +1,23 @@
+# Installing Ruby
+
+There are a variety of ways to download Ruby, see
+[their download](https://www.ruby-lang.org/en/downloads/) page for some
+suggestions.
+
+**Note**:
+
+We're using the newest, fanciest Ruby (`2.6.1`), so be sure to install it.
+
+Many OS package managers don't have it yet, though, so you're encouraged to
+use [rbenv](https://github.com/rbenv/rbenv), a Ruby version manager.
+
+
+[TL;DR - use rbenv](https://github.com/rbenv/rbenv-installer#rbenv-installer).
+
+If you're using rbenv (or followed the above link)
+
+To install Ruby
+
+```
+$ rbenv install 2.6.1
+```

data/exe/whatup

@@ -5,4 +5,4 @@ require 'whatup/cli'
 
 require 'thor'
 
-CLI.start ARGV
+Whatup::CLI::CLI.start ARGV

data/lib/whatup/cli.rb

@@ -2,10 +2,60 @@
 
 require 'thor'
 
-# Thor command class for the cli
-class CLI < Thor
-  desc 'hello', 'Says hello'
-  def hello
-    Thor::Shell::Basic.new.say "Hello!", :cyan
+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

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

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

data/lib/whatup/version.rb

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

data/lib/whatup.rb

@@ -2,7 +2,9 @@
 
 require 'whatup/version'
 
+# Main module for whatup
 module Whatup
-  class Error < StandardError; end
-  # Your code goes here...
+  # Whatup-specific error class
+  class Error < StandardError
+  end
 end

data/whatup.gemspec

@@ -40,12 +40,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   {
-    'pry'     => '~> 0.12.2',
+    'pry' => '~> 0.12.2',
+    'pry-byebug' => '~> 3.7',
     'bundler' => '~> 2.0',
-    'rake'    => '~> 10.0',
-    'rspec'   => '~> 3.8',
-    'thor'    => '~> 0.20.3'
+    'rake' => '~> 12.3.2',
+    'rspec' => '~> 3.8',
+    'yard' => '~> 0.9.18',
+    'rubocop' => '~> 0.65.0'
   }.each do |gem, version|
     spec.add_development_dependency gem, version
   end
+
+  {
+    'thor' => '~> 0.20.3'
+  }.each do |gem, version|
+    spec.add_dependency gem, version
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +115,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.3
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -88,22 +130,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".git_hooks/pre-commit"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docs/assignment.pdf
+- docs/hw/assignment.pdf
+- docs/hw/inital_design.md
+- docs/installing_ruby.md
 - exe/whatup
 - lib/whatup.rb
 - lib/whatup/cli.rb
+- lib/whatup/client.rb
+- lib/whatup/server.rb
 - lib/whatup/version.rb
 - whatup.gemspec
 homepage: https://github.com/jethrodaniel/whatup
@@ -128,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A simple server-based instant messaging application

data/Gemfile.lock

@@ -1,46 +0,0 @@
-PATH
-  remote: .
-  specs:
-    whatup (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thor (0.20.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  pry (~> 0.12.2)
-  rake (~> 10.0)
-  rspec (~> 3.8)
-  thor (~> 0.20.3)
-  whatup!
-
-RUBY VERSION
-   ruby 2.5.3p105
-
-BUNDLED WITH
-   2.0.1

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Mark Delk
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.