kermit 1.0.0

data/lib/business/random_phrase_generator.rb

@@ -0,0 +1,39 @@
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Self implementation from a Data Stream
+class RandomPhraseGenerator
+
+	# Generates a random phrase
+	#
+	# @return [String] a random phrase
+	def generate
+
+		@phrase = ["12453243@juanito@Poesia es la union de dos palabras que uno nunca supuso que pudieran juntarse, y que forman algo asi como un misterio.",
+					"1243654@francisco@La poesia huye, a veces, de los libros para anidar extramuros, en la calle, en el silencio, en los suenos, en la piel, en los escombros, incluso en la basura. Donde no suele cobijarse nunca es en el verbo de los subsecretarios, de los comerciantes o de los lechuginos de television.",
+					"1288803@david@Al contacto del amor todo el mundo se vuelve poeta.",
+					"12388943@lucas@La poesia es el sentimiento que le sobra al corazon y te sale por la mano.",
+					"1987343@maria@Los poetas inmaduros imitan; los poetas maduros roban; los malos estropean lo que roban, y los buenos lo convierten en algo mejor.",
+					"12243@ana@Digamos que existen dos tipos de mentes poeticas: una apta para inventar fabulas y otra dispuesta a creerlas.",
+					"1232453243@lucia@No digais que, agotado su tesoro, de asuntos falta, enmudecio la lira: podra no haber poetas pero siempre habra poesia.",
+					"16853243@luisa@Cada poema es unico. En cada obra late, con mayor o menor grado, toda la poesia. Cada lector busca algo en el poema. Y no es insolito que lo encuentre: Ya lo llevaba dentro.",
+					"1288653243@mariana@La poesia es el eco de la melodia del universo en el corazon de los humanos.",
+					"12445543@kermit@Hacer versos malos depara mas felicidad que leer los versos mas bellos.",
+					"12488843@juanjose@En el fondo, un poema no es algo que se ve, sino la luz que nos permite ver. Y lo que vemos es la vida.",
+					"1245676543@aaron@El mes que es abundante de poesia, suele serlo de hambre.",
+					"12453675673@leticia@La poesia se escribe cuando ella quiere.",
+					"124532457673@beatriz@Los poetas son hombres que han conservado sus ojos de nino.",
+					"124532435@angel@La poesia no tiene tiempo, el que la lee la rescata, la hace presente y luego la regresa a su eternidad.",
+					"124537333@laura@Hay que saber que no existe pais sobre la tierra donde el amor no haya convertido a los amantes en poetas.",
+					"1245456093@rita@El vino siembra poesia en los corazones.",
+					"1245377993@juanluis@El poeta es un mentiroso que siempre dice la verdad.",
+					"1245567533@lorena@Ante la poesia, tanto da temblar como comprender.",
+					"124532969@jesus@Cuando un poeta canta estamos en sus manos: el es el que sabe despertar en nosotros aquellas fuerzas secretas; sus palabras nos descubren un mundo maravilloso que antes no conociamos.",
+					"124575673223@agustin@En mi propia casa como en la ajena, he creido sentir que la poesia, al penetrar en la palabra, la descompone, la abre como un capullo a todos los matices de significacion."]
+
+		return @phrase.shuffle.first
+
+	end
+
+
+end

data/lib/helper/DAO.rb

@@ -0,0 +1,94 @@
+require 'redis'
+require_relative '../logging'
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Data Access Object to manage the persistence layer of the app
+class DAO
+
+	include Logging
+
+	# @!attribute type
+	# @return [String] Type of the stream to identify the database
+	attr_accessor :type
+	
+	# @!attribute db
+	# @return [Redis] An instance from a Redis DB with the redis gem
+	# @see http://rubydoc.info/gems/redis/3.0.1/frames
+	attr_accessor :db
+
+	# Config the DAO defining the Data Stream
+	#
+	# @param type [String] type of the Data Stream to choose the correct database
+	def initialize (type = 'twitter')
+
+		@type = type
+
+		logger.debug('Starting DAO...')
+		
+		logger.info(type + " DAO in " + type.to_s + " type")
+
+		logger.info("config loaded OK")
+		connect_database
+
+	end
+
+	# Connects to a redis database
+	def connect_database
+		@db = Redis.new
+
+		logger.debug("New instance for Redis")
+
+		@db = Redis.connect(
+			:db   => "#{Settings.redis.db}",
+			:host => "#{Settings.redis.host}",
+			:port => Settings.redis.port,
+			:password => Settings.redis.password
+		)
+		
+		logger.info("Redis connect OK")
+	end
+
+	# Retrieves the next status that were saved in the database
+	#
+	# @return [String] the status from the Adapter
+	def get_status 
+		logger.debug("getting status")
+		status = @db.rpop @type
+		status
+	end
+
+	# Deletes the keys in the  database to starts the FW empty
+	# @note if the user develops more Streams, add the new keys like the existing ones
+	def clean
+		logger.debug("cleaning the db")
+		@db.del 'twitter'
+		@db.del 'rpg'
+	end
+
+	# Persists the status into the database
+	#
+	# @param status [String] the status to persist it
+	def save_status status
+		@db.rpush @type, status
+		logger.info("Status saved")
+	end
+
+	# Returns the size of the database
+	#
+	# @return [Integer] the size (items) of the database
+	def size
+		logger.debug("getting size")
+		@db.llen @type
+	end
+
+	# Publish a message in the websocket server
+	#
+	# @param usmf [USMF] a message to publish 
+	def publish usmf
+		logger.info("Publishing")
+		@db.publish 'ws', usmf
+	end
+
+end

data/lib/helper/settings.rb

@@ -0,0 +1,11 @@
+#settings.rb
+require 'settingslogic'
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+# Implements the SettingsLogic gem Class to load the properties defined in the config.yml file
+class Logging::Settings < Settingslogic
+
+  source "config/config.yml"
+
+end

data/lib/helper/websocket_client.rb

@@ -0,0 +1,37 @@
+require 'em-http'
+require_relative '../logging'
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# A WebSocket client to help testing the WebSocket Server
+class WebSocketClient
+
+  include Logging
+
+  # Starts the WebSocket client to consume the published info in the WebSocket Server
+  def start
+
+    EventMachine.run do
+
+      puts '='*80, "Connecting to websockets server at ws://#{Settings.websocket.host}:#{Settings.websocket.port}", '='*80
+
+      http = EventMachine::HttpRequest.new("ws://#{Settings.websocket.host}:#{Settings.websocket.port}/websocket").get :timeout => 0
+
+      http.errback do
+        logger.error "something was wrong in the websocket_client"
+      end
+
+      http.callback do
+        puts "#{Time.now.strftime('%H:%M:%S')} : Connected to server"
+      end
+
+      http.stream do |msg|
+        puts msg
+      end
+
+    end
+    
+  end
+
+end

data/lib/helper/websocket_server.rb

@@ -0,0 +1,65 @@
+require 'redis'
+require 'em-websocket'
+
+require_relative '../logging'
+
+# WebSocket clients array
+SOCKETS = []
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# WebSocket Server where the USMF messages will be published
+class WebSocketServer
+
+  include Logging
+
+  # Configures the WebSocket to works in test mode (path controversia)
+  def initialize
+
+    logger.info("Starting WebSocketServer...")
+  
+  end
+  
+  # Starts the Websocket server and listen the new clients to broadcast the messages
+  def start
+    @redis = Redis.new(:host => "#{Settings.redis.host}", :port => Settings.redis.port)
+
+    
+    Thread.new do
+      EventMachine.run do
+      	puts '='*80, "Starting websockets server at ws://#{Settings.websocket.host}:#{Settings.websocket.port}", '='*80
+        
+        EventMachine::WebSocket.start(:host => "#{Settings.websocket.host}", :port => Settings.websocket.port) do |ws|
+          ws.onopen do
+            
+            puts "#{Time.now.strftime('%H:%M:%S')} : Client connected", '-'*80
+            SOCKETS << ws
+          end
+
+          ws.onclose do
+            
+            puts "#{Time.now.strftime('%H:%M:%S')} : Client disconnected", '-'*80
+            SOCKETS.delete ws
+          end
+        end
+      end
+    end
+
+    
+    Thread.new do
+      @redis.subscribe('ws') do |on|
+        
+        on.message do |chan, msg|
+        
+         puts "#{msg}"
+         SOCKETS.each {|s| s.send msg} 
+        
+        end
+      end
+    end
+
+    sleep
+    
+  end
+end  

data/lib/kermitpfc.rb

@@ -0,0 +1,164 @@
+require_relative 'business/adapter/twitter_adapter'
+require_relative 'business/converter/twitter_converter'
+require_relative 'business/converter/random_converter'
+require_relative 'business/adapter/random_adapter'
+require_relative 'helper/DAO'
+require_relative 'helper/websocket_server'
+require_relative './logging'
+require 'json'
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Masterclass that adapts the rakefile into a class to use the commander gem
+# @see http://rubydoc.info/gems/commander/4.1.2/frames
+class KermitPFC
+
+  # Load the config file
+  def initialize
+    
+    begin
+
+      cleaning_the_house
+      
+      puts 'pooling'
+      
+      pool = []
+      pool << Thread.new { initialize_websocket_server }
+      
+      puts 'websocket started'
+
+      for i in 1..Logging::Settings.twitter.streams
+
+        puts "adding twitter adapter ##{i}"
+        pool << Thread.new { twitter_adapter i }
+        sleep 1
+
+      end
+
+      puts 'twitter adapters added'
+
+      if Logging::Settings.rpg
+      
+        pool << Thread.new { random_adapter }
+        puts 'random adapter added'
+      
+        pool << Thread.new { random_converter }
+        puts 'random converter added'
+      
+      end
+
+      pool << Thread.new { twitter_converter }
+      puts 'twitter converter added'
+
+      pool.each do |thread|
+        thread.join
+      end
+
+    rescue Exception => e
+      
+      Logging::logger.error(e)
+
+      pool.each do |thread|
+        Thread.kill(thread)
+      
+      end
+
+    end
+
+  end
+
+  # Deletes the db keys previously used
+  def cleaning_the_house
+
+    dao = DAO.new
+    dao.clean
+
+  end
+
+  # Starts the WebSocket Server
+  def initialize_websocket_server
+
+    ws = WebSocketServer.new
+    ws.start
+
+  end
+
+  # Starts the Twitter Adapter
+  #
+  # @param stream [Integer] the number of the stream
+  def twitter_adapter stream
+
+    ta = TwitterAdapter.new
+    ta.connect_stream stream
+
+  end
+
+  # Starts the Random Adapter
+  #
+  # @param stream [Integer] the number of the stream
+  def random_adapter stream=1
+
+    ra = RandomAdapter.new
+    ra.connect_stream stream
+
+  end
+
+  # Starts the Twitter Converter
+  def twitter_converter
+
+    dao = DAO.new 'twitter'
+
+    while true
+
+      status = dao.get_status
+      puts 'Status retrieved'
+
+      while status != nil
+
+        tc = TwitterConverter.new
+        usmf = tc.to_usmf status
+
+        dao.publish usmf.to_hash.to_json
+        puts 'Published'
+
+        status = dao.get_status
+
+      end
+
+      puts 'All the statuses were been sent'
+      sleep 2
+
+    end
+
+  end
+
+  # Starts the Random Converter
+  def random_converter
+
+    dao = DAO.new 'rpg'
+
+    while true
+
+      status = dao.get_status
+      puts 'Status retrieved'
+
+      while status != nil
+
+        rc = RandomConverter.new
+        usmf = rc.to_usmf status
+
+        dao.publish usmf.to_hash.to_json
+        puts 'Published'
+
+        status = dao.get_status
+
+      end
+
+      puts 'All the statuses were been sent'
+      sleep 2
+
+    end
+
+  end
+end

data/lib/logging.rb

@@ -0,0 +1,31 @@
+# @author Daniel Machado Fernandez
+# @version 1.0
+# 
+# Loads the config file, the logger and the KermitPFC masterclass
+module Logging
+
+  require 'yaml'
+  require 'logger'
+  require_relative './kermitpfc'
+  require_relative './helper/settings'
+
+  # its neccessary to build the gem and make it run
+  KermitPFC = ::KermitPFC
+
+  # offers the logger to the app
+  # @return [Logger] the logger 
+  def logger
+    Logging.logger
+  end
+
+  # solve the problem with path controversia in the log file
+  # @return [Logger] the logger with the correct path of log.txt
+  def self.logger 
+    begin
+	   @logger ||= Logger.new('../log/log.txt','monthly')
+    rescue
+      @logger ||= Logger.new('./log/log.txt','monthly')
+    end
+  end
+  
+end