t_chatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 444e14ae8b42aaa85766a23314158ed9d6fb0dd7
+  data.tar.gz: 7de15773339d2be2270099b466c733b543eaa056
+SHA512:
+  metadata.gz: cb10d13a791e5e7d20e724a194d9ddb88734db0c7263075b178070b1a3bbe8f6f8db482745f5df3327757043ef835a028303929e7e26cb33d1cca506c5660047
+  data.tar.gz: 6af4107cc8e98fb12b2473e9d456e47dea2cfeee8fe283e578abac78eb3cc3509be5e06bf64950ff76292f6601860d05d60fd905a5fbd2075c0f2644a176c9b7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.chatter.yml
+codesnip
+*/codesnip

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in t_chatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oreoluwa Akinniranye
+
+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.

data/README.md

@@ -0,0 +1,101 @@
+# TChatter
+
+## Installation
+Install with:
+```
+  gem install t_chatter
+```
+May not be useful in your application though, but in case you want to experiment with it
+
+```
+  gem t_chatter
+```
+
+## Setup
+I have written a small setup script which only requires you run:
+```
+  setup_t_chatter
+```
+It takes you through an interactive console to setup the chatter.
+
+All the answers are optional.
+In case you don't want to use the default server the application uses, you can also enter your own server
+Make sure you have a `\receive` route which sends a response in JSON format. The response must contain a
+`message` and `last_message_id` keys.
+And the `\send` route which accepts a post request and returns the `last_message_id` key.
+
+## Usage
+To check it out, simply call type:
+```
+  t_chatter
+```
+on your terminal and watch the message stream in.
+
+If you specified to receive message, you will only see the messages, if to send message you will only be able to send
+However if you specified for both, you can both send an receive messages.
+
+Don't worry if you didn't do it at first though. you can always set it up again.
+
+```
+  PS: To keep the application as slim and compact as possible, there is no database involved in this application nor the server, everything is stored in an array which puts us at the mercy of the hosting provider and updates. Therefore don't expect much in terms of data persistence.
+```
+
+## History
+
+Thanks for wanting to try out TChatter.
+TChatter is just an experiment and a hack on concurrency in Ruby applications.
+So, I was thinking of something crazy I could do while learning something new and
+I thought of a chat messenger. However, there are many chat messengers out there
+And another could easily be spawned if I was using a web framework, therefore not
+much of a learning.
+I then thought of a chatting application on the terminal hence: TChatter(Terminal Chatter)
+The problem I realized I would have encountered which wasn't much of a problem in
+a web application was concurrency:
+`How do I implement an application that would listen for input from the user as well
+as update almost in realtime the content on another terminal.`
+
+### Solutions
+`The first solution may not always be the best solution`
+
+The first solution I thought of was a sort of loop, however this was a blocking solution,
+I could have put it in a Timeout block, however, this still didn't seem to be the best
+
+In came EventMachine, which was awesome.
+Due to a very shallow understanding of EventMachine I used some sort of periodic timer which
+which also didnt appear to be the best solution, as I had to send messages on one terminal
+and receive on another.
+
+Thread to the rescue
+Then I learnt of the Ruby Thread which was no finally used.
+The Thread seem to be the most effecient as it could do many things at the same time.
+
+One major pitfall with Thread is that it may not be stopped even after exiting your
+loop in the application as it 'kinda' freezes my console (I had to depress a key twice
+for the console to respond).
+
+The way I found around that was to use the Ruby trap method as in
+```ruby
+  trap("INT") {
+    puts "Exiting the chat"
+    threads.each{|t|
+      t.exit
+    }
+  }
+```
+Thanks to [SO(stackoverflow)](http://stackoverflow.com/questions/27642943/kill-all-threads-on-terminate?answertab=votes#tab-top).
+
+This is not close to the best application I have and will build, however I seem to be most excited
+about this for now.
+
+Let's see where the future takes me.
+[To know how I feel about this you have to listen to this](http://www.youtube.com/watch?v=ZR0v0i63PQ4)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andela-oakinniranye/t_chatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "pry"
+require "bundler/setup"
+require "t_chatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+def reload!
+  puts "Reloading..."
+  files = $LOADED_FEATURES.select { |feat| feat =~ /\/t_chatter\// }
+  files.each { |file| load file }
+  true
+end
+# reload!
+ARGV.clear
+# Pry.start
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+Pry.start
+
+# require "irb"
+# IRB.start
+# TChatter::Start.chat

data/bin/setup

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here
+
+setup_t_chatter

data/bin/setup_t_chatter

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "t_chatter"
+
+file_root = ENV["HOME"]
+file_name = TChatter::ConfigSetup::CONFIG_FILE
+file_location = "#{file_root}/#{file_name}"
+
+unless File.exists? file_location
+  puts <<-EOS
+    Thanks for installing TChatter.
+    A small Ruby application that allows you to chat with a your friends on a particular network
+
+    This is the last process which basically sets up your application for you.
+    Let us begin
+  EOS
+else
+  print <<-EOS
+    You seem to have this application configured already at: #{file_location}
+    Do you want to overwrite your old configuration?(Y or N) :
+  EOS
+  exit if gets.chomp.downcase == 'n'
+end
+
+config = Hash.new(nil)
+
+print "What is your name?(optional) : "
+config[:user] = gets.chomp.strip
+
+puts ""
+
+print "Would you like to just send message?(optional) : "
+config[:send] = gets.chomp.strip
+
+puts ""
+
+print "Would you like to receive messages?(optional) : "
+config[:receive] = gets.chomp.strip
+
+print "Enter your URL for the Server?(optional) : "
+config[:host] = gets.chomp.strip
+
+true_cmd = {
+  'true' => true,
+  'yes' => true,
+  'y' => true,
+  '' => true,
+  'false' => false,
+  'no' => false,
+  'n' => false
+}
+
+real_config = Hash.new(nil)
+config.each{ |x, y|
+  if [:send, :receive].include? x
+    real_config[x] = true_cmd[y]
+    real_config[x] = true unless true_cmd.keys.include? y
+  else
+    real_config[x] = y if !y.blank?
+  end
+}
+
+real_config[:host] = TChatter::DEFAULT_URL unless real_config[:host]
+
+File.open(file_location, 'w') do |f|
+  ::YAML.dump real_config, f
+end
+
+puts <<-EOS
+  Congratulations you have completed the basic setup. The file can be found at: #{file_location}
+EOS

data/bin/t_chatter

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "t_chatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# require "irb"
+# IRB.start
+TChatter::Start.chat

data/lib/t_chatter/chat.rb

@@ -0,0 +1,58 @@
+module TChatter
+  class Chat
+    attr_reader :connection, :messages, :response, :last_message_id, :user, :config
+    # attr_accessor :url
+
+    def initialize(username, config_class)
+      @user = username
+      @messages = []
+      @last_message_id = 0
+      @config = config_class.configuration
+      set_url
+      connect
+    end
+
+    def set_url
+      begin
+        @url = URI.parse(@config[:host])
+      rescue URI::InvalidURIError
+        puts <<-EOS
+        You dont seem to have a valid URL in your .chatter.yml file\n
+        You may run ``setup_t_chatter`` to set a default url which will be
+        used everytime you try to connect. However you are now being connected
+        to the global chatter stream
+        EOS
+        @url = URI.parse(TChatter::DEFAULT_URL)
+      end
+    end
+
+    def unknown_url
+      puts "The URL doesn't appear to be valid a URL"
+    end
+
+
+    def connect
+      @connection = Faraday::Connection.new(@url)
+    end
+
+    def send_message(message)
+      response = connection.post('/send', {message: message, user: user})
+      response = JSON.parse(response.body)
+      @last_message_id = response["last_message_id"]
+      @last_message = message
+    end
+
+    def receive_message
+      sleep 2
+      response = connection.get('/receive', { last_message_id: @last_message_id })
+      @response = JSON.parse(response.body)
+      last_id = @response["last_message_id"]
+      unless last_id == last_message_id
+        message = @response["message"]
+        @last_message_id = @response["last_message_id"]
+        @messages << message if message
+        puts message
+      end
+    end
+  end
+end

data/lib/t_chatter/config_setup.rb

@@ -0,0 +1,32 @@
+module TChatter
+  class ConfigSetup
+    include Singleton
+
+    CONFIG_FILE = '.chatter.yml'
+    CONFIG_FILE_SOURCES = ['.', '..', ENV["HOME"]]
+
+    def self.set_configuration
+      config_file = nil
+      CONFIG_FILE_SOURCES.each{ |file_source|
+          config_file = "#{file_source}/#{CONFIG_FILE}"
+          break if File.exists? config_file
+      }
+       if File.exists? config_file
+         @@config_data = load_config(config_file)
+       else
+         @@config_data = Hash.new(nil)
+       end
+    end
+
+    def self.load_config(file_path)
+      ::YAML.load_file(file_path)
+    end
+
+    def configuration
+      @@config_data
+    end
+
+    set_configuration
+  end
+
+end

data/lib/t_chatter/start.rb

@@ -0,0 +1,53 @@
+module TChatter
+  class Start
+
+    def self.chat
+      config = ConfigSetup.instance
+      user = config.configuration[:user]
+
+      # host = config[:host]
+      unless user
+        print "Would you mind telling me your name? > "
+        user = gets.chomp
+      end
+
+      chat = Chat.new(user, config)
+
+      want_to_receive = config.configuration.blank? ? true : config.configuration[:receive]
+      want_to_send = config.configuration.blank? ? true : config.configuration[:send]
+
+      threads = []
+
+
+      if want_to_receive
+        #response object
+        threads << Thread.new do
+          loop{
+            chat.receive_message
+          }
+        end
+      end
+
+      if want_to_send
+        #request object
+        threads << Thread.new do
+          loop{
+            message = gets.chomp
+            chat.send_message(message) if message
+          }
+        end
+      end
+
+      trap("INT") {
+        puts "Exiting the chat"
+        threads.each{|t|
+          t.exit
+        }
+      }
+
+      threads.each{ |thread|
+        thread.join
+      }
+  end
+  end
+end

data/lib/t_chatter/version.rb

@@ -0,0 +1,3 @@
+module TChatter
+  VERSION = "0.1.0"
+end

data/lib/t_chatter.rb

@@ -0,0 +1,24 @@
+require "t_chatter/version"
+# gem 'faraday'
+require 'json'
+require 'faraday'
+require 'yaml'
+require 'singleton'
+require 'uri'
+
+module TChatter
+  DEFAULT_URL = "https://tchatter.herokuapp.com"
+  # Your code goes here...
+end
+
+Object.class_eval do
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+end
+
+
+APP_ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+Dir[APP_ROOT.join('lib', 't_chatter', '*.rb')].each { |f| require f }
+CS = TChatter::ConfigSetup
+TC = TChatter::Chat

data/t_chatter.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 't_chatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "t_chatter"
+  spec.version       = TChatter::VERSION
+  spec.authors       = ["Oreoluwa Akinniranye"]
+  spec.email         = ["oreoluwa.akinniranye@andela.com"]
+
+  spec.summary       = %q{Allows you to chat on your terminal}
+  spec.description   = %q{TChatter allows you to chat with your friends on your terminal. You can extend it further though to chat your friends on Slack and other applications.}
+  spec.homepage      = "http://github.com/andela-oakinniranye/t_chatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ['t_chatter', 'setup_t_chatter']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+
+  spec.post_install_message = "Thanks for trying out my interesting gem.\nTo complete the installation, run `setup_t_chatter` to create a .chatter.yml configuration file.\nThis allows you to use your own url and set defaults for your version of TChatter"
+
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: t_chatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oreoluwa Akinniranye
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: TChatter allows you to chat with your friends on your terminal. You can
+  extend it further though to chat your friends on Slack and other applications.
+email:
+- oreoluwa.akinniranye@andela.com
+executables:
+- t_chatter
+- setup_t_chatter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/setup_t_chatter
+- bin/t_chatter
+- lib/t_chatter.rb
+- lib/t_chatter/chat.rb
+- lib/t_chatter/config_setup.rb
+- lib/t_chatter/start.rb
+- lib/t_chatter/version.rb
+- t_chatter.gemspec
+homepage: http://github.com/andela-oakinniranye/t_chatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: |-
+  Thanks for trying out my interesting gem.
+  To complete the installation, run `setup_t_chatter` to create a .chatter.yml configuration file.
+  This allows you to use your own url and set defaults for your version of TChatter
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Allows you to chat on your terminal
+test_files: []