RubyGems - kermit - Versions diffs - 1.0.0 - Mend

kermit 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

data/Gemfile +18 -0
data/LICENSE.txt +20 -0
data/README.md +54 -0
data/Rakefile +31 -0
data/VERSION +1 -0
data/bin/kermit +24 -0
data/config/config.example.yml +24 -0
data/doc/Adapter.html +533 -0
data/doc/Converter.html +348 -0
data/doc/DAO.html +1047 -0
data/doc/KermitPFC.html +927 -0
data/doc/Link.html +667 -0
data/doc/Logging.html +401 -0
data/doc/Logging/Settings.html +170 -0
data/doc/RandomAdapter.html +501 -0
data/doc/RandomConverter.html +359 -0
data/doc/RandomPhraseGenerator.html +317 -0
data/doc/ToUser.html +815 -0
data/doc/TwitterAdapter.html +550 -0
data/doc/TwitterConverter.html +598 -0
data/doc/USMF.html +2188 -0
data/doc/User.html +1407 -0
data/doc/WebSocketClient.html +316 -0
data/doc/WebSocketServer.html +427 -0
data/doc/_index.html +270 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +328 -0
data/doc/file.LICENSE.html +73 -0
data/doc/file.README.html +123 -0
data/doc/file_list.html +58 -0
data/doc/frames.html +28 -0
data/doc/index.html +123 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +764 -0
data/doc/top-level-namespace.html +138 -0
data/lib/business/adapter/adapter.rb +39 -0
data/lib/business/adapter/random_adapter.rb +50 -0
data/lib/business/adapter/twitter_adapter.rb +75 -0
data/lib/business/converter/converter.rb +24 -0
data/lib/business/converter/random_converter.rb +42 -0
data/lib/business/converter/twitter_converter.rb +164 -0
data/lib/business/random_phrase_generator.rb +39 -0
data/lib/helper/DAO.rb +94 -0
data/lib/helper/settings.rb +11 -0
data/lib/helper/websocket_client.rb +37 -0
data/lib/helper/websocket_server.rb +65 -0
data/lib/kermitpfc.rb +164 -0
data/lib/logging.rb +31 -0
data/lib/model/USMF/USMF.rb +98 -0
data/lib/model/USMF/link.rb +30 -0
data/lib/model/USMF/to_user.rb +32 -0
data/lib/model/USMF/user.rb +41 -0
data/lib/model/templates/USMF +56 -0
data/lib/model/templates/atom.xml +74 -0
data/lib/model/templates/example +59 -0
data/lib/model/templates/rss.xml +68 -0
data/lib/model/templates/template +49 -0
data/lib/model/templates/tweet +116 -0
data/spec/DAO_spec.rb +64 -0
data/spec/random_adapter_spec.rb +24 -0
data/spec/random_converter_spec.rb +115 -0
data/spec/random_phrase_generator_spec.rb +15 -0
data/spec/twitter_adapter_spec.rb +24 -0
data/spec/twitter_converter_spec.rb +132 -0
data/websocket_client.html +20 -0
metadata +253 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,138 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.2.1
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Logging.html" title="Logging (module)">Logging</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Adapter.html" title="Adapter (class)">Adapter</a></span>, <span class='object_link'><a href="Converter.html" title="Converter (class)">Converter</a></span>, <span class='object_link'><a href="DAO.html" title="DAO (class)">DAO</a></span>, <span class='object_link'><a href="KermitPFC.html" title="KermitPFC (class)">KermitPFC</a></span>, <span class='object_link'><a href="Link.html" title="Link (class)">Link</a></span>, <span class='object_link'><a href="RandomAdapter.html" title="RandomAdapter (class)">RandomAdapter</a></span>, <span class='object_link'><a href="RandomConverter.html" title="RandomConverter (class)">RandomConverter</a></span>, <span class='object_link'><a href="RandomPhraseGenerator.html" title="RandomPhraseGenerator (class)">RandomPhraseGenerator</a></span>, <span class='object_link'><a href="ToUser.html" title="ToUser (class)">ToUser</a></span>, <span class='object_link'><a href="TwitterAdapter.html" title="TwitterAdapter (class)">TwitterAdapter</a></span>, <span class='object_link'><a href="TwitterConverter.html" title="TwitterConverter (class)">TwitterConverter</a></span>, <span class='object_link'><a href="USMF.html" title="USMF (class)">USMF</a></span>, <span class='object_link'><a href="User.html" title="User (class)">User</a></span>, <span class='object_link'><a href="WebSocketClient.html" title="WebSocketClient (class)">WebSocketClient</a></span>, <span class='object_link'><a href="WebSocketServer.html" title="WebSocketServer (class)">WebSocketServer</a></span>
+</p>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="SOCKETS-constant" class="">SOCKETS =
+          <div class="docstring">
+  <div class="discussion">
+    <p>
+WebSocket clients array
+</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='lbracket'>[</span><span class='rbracket'>]</span></pre></dd>
+    </dl>
+</div>
+    <div id="footer">
+  Generated on Sat Aug 18 16:24:07 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.2.1 (ruby-1.9.2).
+</div>
+  </body>
+</html>

data/lib/business/adapter/adapter.rb ADDED

@@ -0,0 +1,39 @@
+require_relative '../../logging'
+# @author Daniel Machado Fernandez
+# @version 1.0
+# @abstract
+#
+# You must implement this class to adapt your data stream in our framework
+class Adapter
+	include Logging
+	# Initializes the Adapter to run the logger
+	#
+	# @raise [Exception] if the method hasn't been implemented yet
+	def initialize
+		logger.fatal('The method initialize in Adapter must be implemented')
+		raise 'This method must be implemented'
+	end
+	# Connects to a particular data stream
+	#
+	# @raise [Exception] if the method hasn't been implemented yet
+	# @param stream [Integer] the number of the stream to identify it
+	def connect_stream (stream=1)
+		logger.fatal('The method connect_stream in Adapter must be implemented')
+		raise 'This method must be implemented'
+	end
+	# Persist the status retrieved from the data stream
+	#
+	# @raise [Exception] if the method hasn't been implemented yet
+	# @param status [String] the status retrieved from the data stream
+	def persist status
+		logger.fatal('The method persist in Adapter must be implemented')
+		raise 'This method must be implemented'
+	end
+end

data/lib/business/adapter/random_adapter.rb ADDED

@@ -0,0 +1,50 @@
+require_relative "../random_phrase_generator"
+require_relative "./adapter"
+require_relative "../../helper/DAO"
+require_relative "../../logging"
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Self implementation from Adapter class to make it works with a Random Phrase Generator
+class RandomAdapter < Adapter
+	include Logging
+	# Initializes the Random Adapter class with the dao parameters
+	def initialize
+		@dao = DAO.new 'rpg'
+		logger.debug('Starting RandomAdapter...')
+	end
+	# Connects to a Random Phrase Generator and retrieves phrases
+	#
+	# @param stream [Integer] number of the stream
+	def connect_stream (stream=1)
+		random = RandomPhraseGenerator.new
+		i=0
+		while true
+			persist random.generate
+			logger.debug('retrieving...')
+			i = i+1
+			if i%10 == 0
+				sleep 10
+			end
+		end
+	end
+	# Save the status in a database to release the execution charge of threat that info in real time
+	#
+	# @param status [String] the status to persist
+	def persist status
+		@dao.save_status status
+	end
+end

data/lib/business/adapter/twitter_adapter.rb ADDED

@@ -0,0 +1,75 @@
+require 'json'
+require 'twitter/json_stream'
+require_relative "./adapter"
+require_relative "../../helper/DAO"
+require_relative "../../logging"
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Self implementation from Adapter class to make it works with Twitter Streaming API
+class TwitterAdapter < Adapter
+	include Logging
+	# Configures the dao with the apropiates params
+	def initialize
+		logger.info('Starting TwitterAdapter...')
+		@dao = DAO.new 'twitter'
+	end
+	# Connects to the Twitter Streaming API and retrieves statuses with a track word previously defined
+	#
+	# @param stream [Integer] the number of the stream to identify it (use it when you have got more than one)
+	def connect_stream (stream=1)
+		logger.debug('retrieving...')
+		puts 'retrieving... '
+		track = Settings.twitter.track.send("track#{stream}")
+		EventMachine::run {
+			stream = Twitter::JSONStream.connect(
+			   	:path    => "/1/statuses/filter.json?track=#{track}",
+		    	:auth    => "#{Settings.twitter.login}:#{Settings.twitter.pass}",
+		    	:ssl     => true,
+		    	:port    => Settings.twitter.port
+		  	)
+		  	stream.each_item do |status|
+		  		persist status
+		  	end
+			stream.on_error do |message|
+			    logger.error("#{message}")
+			end
+			stream.on_reconnect do |timeout, retries|
+			    logger.warn("reconnecting in: #{timeout} seconds\n")
+			end
+			stream.on_max_reconnects do |timeout, retries|
+			    logger.fatal("Failed after #{retries} failed reconnects\n")
+			end
+		  	trap('TERM') {
+		    	stream.stop
+		  	}
+		}
+	end
+	# Saves the tweet into the database
+	#
+	# @param status [String] tweet retrieved previously
+	def persist status
+		@dao.save_status status
+	end
+end

data/lib/business/converter/converter.rb ADDED

@@ -0,0 +1,24 @@
+require_relative '../../logging'
+# @author Daniel Machado Fernandez
+# @version 1.0
+# @abstract
+#
+# Abstract class that must be implemented to transform a specifical status from a Stream into a USMF standard message
+class Converter
+	include Logging
+	# Parses a status into a USMF message
+	#
+	# @raise [Exception] if the method hasn't been implemented yet
+	# @param status [String] status retrieved and saved previously in the Adapter
+	# @return [USMF] the resultant USMF message
+	def to_usmf status
+		logger.fatal('The method to_usmf in Converter must be implemented')
+		raise 'This method must be implemented'
+	end
+end

data/lib/business/converter/random_converter.rb ADDED

@@ -0,0 +1,42 @@
+require_relative './converter'
+require_relative '../../model/USMF/USMF'
+require_relative '../../model/USMF/link'
+require_relative '../../model/USMF/to_user'
+require_relative '../../model/USMF/user'
+require_relative '../../logging'
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Self implementation from the Converter to work it with the Random Phrase Generator
+class RandomConverter < Converter
+      include Logging
+	# Field to field parsing from status to a USMF message
+	#
+      # @param status [String] the phrase from the Random Phrase Generator
+      # @return [USMF] the resultant message
+      def to_usmf status
+            logger.debug("Start the random parse")
+		usmf = USMF.new
+		user = User.new
+		x = status.split('@')
+		usmf.service = 'Random'
+      	usmf.id = x[0]
+      	usmf.text = x[2]
+      	user.name = x[1]
+      	usmf.user = user
+      	usmf.links = []
+      	usmf.to_users = []
+            logger.debug("Finish the random parse")
+		usmf
+	end
+end

data/lib/business/converter/twitter_converter.rb ADDED

@@ -0,0 +1,164 @@
+require 'json'
+require_relative './converter'
+require_relative '../../model/USMF/USMF'
+require_relative '../../model/USMF/link'
+require_relative '../../model/USMF/to_user'
+require_relative '../../model/USMF/user'
+require_relative '../../logging'
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Twitter Specification from Converter
+class TwitterConverter < Converter
+	include Logging
+    # Field to field parsing to become a tweet into a USMF message
+    #
+    # @param status [String] the tweet previously retrieved
+    # @return [USMF] the resultant message
+	def to_usmf status
+		logger.debug("Starting tweet parse")
+		usmf = USMF.new
+		user = User.new
+		status = JSON.parse(status)
+		if status.has_key? 'Error'
+			logger.error("tweet malformed")
+			raise "status malformed"
+		end
+		#Retrieving a status from Twitter
+		usmf.service = "Twitter"
+		usmf.id = status["id_str"]
+		x = status["coordinates"]
+		unless x==nil
+			usmf.geo = x["coordinates"]
+		end
+		usmf.application = status["source"]
+		x = status["place"]
+		unless x == nil
+			usmf.location = x["full_name"] + " , " + x["country"]
+		end
+		usmf.date = status["created_at"]
+		usmf.text = status["text"]
+		usmf.description = status["in_reply_to_status_id_str"]
+		usmf.likes = status["retweet_count"]
+		#Retrieving user
+		x = status["user"]
+		unless x == nil
+			user.name = x["screen_name"]
+			user.real_name = x["name"]
+			user.id = x["id_str"]
+			user.language = x["lang"]
+			unless x["time_zone"] == nil and x["utc_offset"] == nil
+				user.utc = x["time_zone"].to_s + " + " + x["utc_offset"].to_s
+			end
+			user.description = x["description"]
+			user.avatar = x["profile_image_url_https"]
+			user.location = x["location"]
+			user.subscribers = x["followers_count"]
+			user.subscriptions = x["friends_count"]
+			user.postings = x["statuses_count"]
+			user.profile = "https://twitter.com/#!/#{user.name}"
+			user.website = x["url"]
+			usmf.user = user
+			usmf.source = "https://twitter.com/#{usmf.user.name}/status/#{usmf.id}"
+		end
+		usmf.to_users = []
+		usmf.links = []
+		#Retrieving entities
+		entities = status["entities"]
+		unless entities == nil
+		#Retrieving URLs
+			x = entities["urls"]
+			unless x == nil
+				x.each do |item|
+					l = Link.new
+					l.href = item["url"]
+					usmf.links << l
+				end
+			end
+		#Retrieving all media content
+			x = entities["media"]
+			unless x == nil
+				x.each do |item|
+					l = Link.new
+					l.title = item["type"]
+					l.thumbnail = item["media_url"]
+					l.href = item["url"]
+					usmf.links << l
+				end
+			end
+			#Retrieving hashtags
+			x = entities["hashtags"]
+			unless x == nil
+				usmf.keywords = ""
+				x.each do |h|
+					usmf.keywords += h["text"] + ", "
+				end
+			end
+			#Retrieving mentions
+			x = entities["user_mentions"]
+			unless x == nil
+				x.each do |item|
+					tu = ToUser.new
+					tu.name = item["screen_name"]
+					tu.id = item["id_str"]
+					if item["id_str"] == status["in_reply_to_user_id_str"]
+						tu.service = "reply"
+					else
+						tu.service = "mention"
+					end
+					unless status["in_reply_to_status_id_str"] == nil
+						tu.title = status["in_reply_to_status_id_str"]
+						tu.href = "https://twitter.com/#{tu.name}/status/#{tu.title}"
+					end
+					usmf.to_users << tu
+				end
+			end
+		end
+		logger.debug("Finished tweet parse")
+		usmf
+	end
+end