kermit 1.0.0

data/lib/model/USMF/USMF.rb

@@ -0,0 +1,98 @@
+require_relative './user'
+require_relative '../../logging'
+
+# @author Daniel Machado Fernandez
+# @version 1.0
+# 
+# USMF standard message from Tawlk
+# @see https://github.com/Tawlk/hyve/wiki/Unified-Social-Media-Format-(USMF)
+class USMF
+	
+  include Logging
+
+  attr_accessor :service,:user,:to_users,:links,:id,:geo,:application,:location,:date,:source,:text,:description,:keywords,
+  :category,:duration,:likes,:dislikes,:favorites,:comments,:rates,:rating,:min_rating,:max_rating 
+
+  # Unify the fields into a string
+  #
+  # @return [String] resultant string
+  def to_s
+
+  	res = "\nservice: " + service.to_s + "\nid: " + id.to_s + "\ngeo: " + geo.to_s + "\napplication: " + application.to_s + "\nlocation: " + location.to_s + "\ndate: " + date.to_s + "\nsource: " + source.to_s + "\ntext: " + text.to_s + "\ndescription: " + description.to_s + "\nkeywords: " + keywords.to_s + "\ncategory: " + category.to_s + "\nduration: " + duration.to_s + "\nlikes: " + likes.to_s + "\ndislikes: " + dislikes.to_s + "\nfavorites: " + favorites.to_s + "\ncomments: " + comments.to_s + "\nrates: " + rates.to_s + "\nrating: " + rating.to_s + "\nmin_rating: " + min_rating.to_s + "\nmax_rating: " + max_rating.to_s + "\n[USER]: " + user.to_s + "\n[TO_USERS]: " + to_users.to_s + "\n[LINKS]: " + links.to_s
+  	res
+
+  end
+
+  # Unify the fields into a hash
+  #
+  # @return [Hash] resultant hash
+  def to_hash
+
+  	res = { 
+            "service" => service, 
+      		  "id" => id,
+      			"geo" => geo,
+      			"application" => application,
+      			"location" => location,
+      			"date" => date,
+      			"source" => source,
+      			"text" => text,
+      			"description" => description,
+      			"keywords" => keywords,
+      			"category" => category,
+      			"duration" => duration,
+      			"likes" => likes,
+      			"dislikes" => dislikes,
+      			"favorites" => favorites,
+      			"comments" => comments,
+      			"rates" => rates,
+      			"rating" => rating,
+      			"min_rating" => min_rating,
+      			"max_rating" => max_rating
+  		    }
+    begin
+    
+      unless :user == nil
+        res["user"] = user.to_hash
+      end
+    
+    rescue
+    
+      res["user"] = nil
+      logger.error("A corrupt user was found")
+    
+    end
+
+      l = []
+    
+      unless :links == nil
+
+        links.each do |link|
+
+          l << link.to_hash
+
+        end
+    
+        res["links"] = l
+    
+      end
+
+      tu = []
+    
+      unless :to_users == nil
+
+        to_users.each do |us|
+
+          tu << us.to_hash
+
+        end
+    
+        res["to_users"] = tu
+    
+      end      
+
+  	res
+
+  end
+
+end

data/lib/model/USMF/link.rb

@@ -0,0 +1,30 @@
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# A Link model
+class Link
+
+	attr_accessor :service,:title,:thumbnail,:href
+
+	# Unify the fields into a string
+  	#
+  	# @return [String] resultant string
+	def to_s
+		res = "\nservice: " + service.to_s + "\ntitle: " + title.to_s + "\nthumbnail: " + thumbnail.to_s + "\nhref: " + href.to_s
+		res
+	end
+
+  	# Unify the fields into a hash
+  	#
+  	# @return [Hash] resultant hash
+	def to_hash
+		res = {  
+				"service" => service,
+				"title" => title,
+				"thumbnail" => thumbnail,
+				"href" => href
+			  }
+		res
+	end
+
+end

data/lib/model/USMF/to_user.rb

@@ -0,0 +1,32 @@
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Models the ToUser relation
+class ToUser
+
+	attr_accessor :name,:id,:service,:title,:thumbnail,:href
+
+	# Unify the fields into a string
+  	#
+  	# @return [String] resultant string
+	def to_s
+		res = "\nname: " + name.to_s + "\nid: " + id.to_s + "\nservice: " + service.to_s + "\ntitle: " + title.to_s + "\nthumbnail: " + thumbnail.to_s + "\nhref: " + href.to_s
+		res
+	end
+	
+	# Unify the fields into a hash
+	#
+	# @return [Hash] resultant hash
+	def to_hash
+		res = {
+				"name" => name,
+				"id" => id,
+				"service" => service,
+				"title" => title,
+				"thumbnail" => thumbnail,
+				"href" => href
+			  }
+		res
+	end
+
+end

data/lib/model/USMF/user.rb

@@ -0,0 +1,41 @@
+# @author Daniel Machado Fernandez
+# @version 1.0
+#
+# Models a User into USMF standard
+class User
+
+	attr_accessor :name,:real_name,:id,:language,:utc,:geo,:description,:avatar,:location,:subscribers,:subscriptions,
+	:postings,:profile,:website
+	
+	# Unify the fields into a string
+  	#
+  	# @return [String] resultant string
+	def to_s
+		res = "\nname: " + name.to_s + "\nreal_name: " + real_name.to_s + "\nid: " + id.to_s + "\nlanguage: " + language.to_s + "\nutc: " + utc.to_s + "\ngeo: " + geo.to_s + "\ndescription: " + description.to_s + "\navatar: " + avatar.to_s + "\nlocation: " + location.to_s + "\nsubscribers: " + subscribers.to_s + "\nsubscriptions: " + subscriptions.to_s + "\npostings: " + postings.to_s + "\nprofile: " + profile.to_s + "\nwebsite: " + website.to_s
+		res
+	end
+	
+	# Unify the fields into a hash
+	#
+	# @return [Hash] resultant hash
+	def to_hash
+		res = {
+				"name" => name,
+				"real_name" => real_name,
+				"id" => id,
+				"language" => language,
+				"utc" => utc,
+				"geo" => geo,
+				"description" => description,
+				"avatar" => avatar,
+				"location" => location,
+				"subscribers" => subscribers,
+				"subscriptions" => subscriptions,
+				"postings" => postings,
+				"profile" => profile,
+				"website" => website
+			  }
+		res
+	end
+
+end

data/lib/model/templates/USMF

@@ -0,0 +1,56 @@
+{
+    "service" : "",           # Service Name.
+    "user" : {                # User Info 
+        "name" : "",              # User Name
+        "real_name" : ""          # Real name of user
+        "id" : "",                # Unique User ID
+        "language": "",           # Spoken language of user
+        "utc" : "",               # UTC time offset of user
+        "geo" : "",               # Latitude/Logitude User location
+        "description" : ""        # User profile description
+        "avatar" : "",            # Direct href to avatar image
+        "location": "",           # Plain Language User location
+        "subscribers": "",        # Number of subscribers
+        "subscriptions": "",      # Number of subscriptions
+        "postings": "",           # Number of postings made
+        "profile": "",            # Href to user profile
+        "website": "",            # Href to user website
+    }
+    "to_users" {              # Attached link(s)
+       "0": {                     # Index of link
+          "name" : "",                # User Name
+          "id" : "",                  # Unique User ID
+          "service"                   # Name of service/Domain hosting link 
+          "title" : "",               # Title of item
+          "thumbnail" : "",           # Direct href to thumbnail for item
+          "href" : "",                # Direct href to item
+       },
+    },       
+    "links" {                 # Attached link(s)
+       "0": {                     # Index of link
+          "service"                   # Name of service/Domain hosting link 
+          "title" : "",               # Title of item
+          "thumbnail" : "",           # Direct href to thumbnail for item
+          "href" : "",                # Direct href to item
+       },
+    },       
+    "id" : "",                # Unique ID
+    "geo" : "",               # Latitude/Logitude content creation location
+    "application" : "",       # Application used to create this posting
+    "location" : "",          # Plain Language content creation location
+    "date" : "",              # Date posted
+    "source" : "",            # User friendly link to content
+    "text" : "",              # Microblog text / Video Title / Etc
+    "description" : "",       # Full post text / Decription 
+    "keywords" : "",          # Related Keywords
+    "category" : "",          # Category of content
+    "duration" : "",          # Duration of content (if video)
+    "likes" : "",             # Number of users who "liked" this
+    "dislikes" : "",          # Number of users who "disliked" this
+    "favorites": "",          # Number of users who "favorited" this
+    "comments": "",           # Number of users who "commented" this
+    "rates": "",              # Number of users who "rated" this
+    "rating": "",             # Average "rating" of content
+    "min_rating": "",         # Minimum "rating" of content
+    "max_rating": "",         # Maximum "rating" of content
+}

data/lib/model/templates/atom.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+   <feed xmlns="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss">
+
+     <title>KermitPFC-Core</title>
+     <link href="https:\/\/github.com\/danielmachado\/kermitpfc-core"/>
+     <updated>to-date</updated>
+     <author>
+       <name>KermitPFC</name>
+     </author>
+     <id>¿id del stream que servimos?(p.ej)</id>
+
+     <entry>
+       <title></title> <!-- título para cada message que enviemos.. -->
+       <link href="http://www.twitter.com/id_str"/>
+       <id>id_str</id>
+       <updated>created_at</updated>
+       <summary>
+        text
+       </summary>
+       {
+          "service" : "Twitter",           # Service Name.
+          "user" : {                # User Info 
+              "name" : "screen_name",              # User Name
+              "real_name" : "name"          # Real name of user
+              "id" : "id_str",                # Unique User ID
+              "language": "lang",           # Spoken language of user
+              "utc" : "time_zone + utc_offset",               # UTC time offset of user
+              "geo" : "",               # Latitude/Logitude User location
+              "description" : "description"        # User profile description
+              "avatar" : "profile_image_url_https",            # Direct href to avatar image
+              "location": "location",           # Plain Language User location
+              "subscribers": "followers_count",        # Number of subscribers
+              "subscriptions": "friends_count",      # Number of subscriptions
+              "postings": "statuses_count",           # Number of postings made
+              "profile": "http://www.twitter.com/name",            # Href to user profile
+              "website": "url",            # Href to user website
+          }
+          "to_users" {              # Attached link(s) // // Tantos como UserMentions tenga entities 0...N
+             "0": {                     # Index of link
+                "name" : "screen_name",                # User Name
+                "id" : "id_str",                  # Unique User ID
+                "twitter/instagram/..."                   # Name of service/Domain hosting link 
+                "title" : "mention/reply/retweet",               # Title of item
+                "thumbnail" : "?",           # Direct href to thumbnail for item
+                "href" : "http://www.service.com/name",                # Direct href to item
+             },
+          },       
+          "links" {                 # Attached link(s) //Media del status
+             "0": {                     # Index of link // Tantos como entities se necesiten 0...N
+                "instagram/lockerz/youtube/..."                   # Name of service/Domain hosting link 
+                "photo/video/url.." : "",               # Title of item
+                "thumbnail" : "url",           # Direct href to thumbnail for item
+                "href" : "media_url",                # Direct href to item
+             },
+          },       
+          "id" : "id_str",                # Unique ID
+          "geo" : "coordinates",               # Latitude/Logitude content creation location
+          "application" : "source",       # Application used to create this posting
+          "location" : "full_name+country",          # Plain Language content creation location
+          "date" : "created_at",              # Date posted
+          "source" : "http://www.twitter.com/id_str",            # User friendly link to content
+          "text" : "text",              # Microblog text / Video Title / Etc
+          "description" : "",       # Full post text / Decription 
+          "keywords" : "hashtags",          # Related Keywords
+          "likes" : "retweet_count",             # Number of users who "liked" this
+          "dislikes" : "",          # Number of users who "disliked" this
+          "favorites": "favourites_count",          # Number of users who "favorited" this
+        }
+       <georss:polygon>coordinates</georss:polygon>
+       <georss:featureTypeTag>place_type</georss:featureTypeTag>
+       <georss:featureName>name</georss:featureName>
+     </entry>
+     <!-- tantos entry como tweets se envíen -->
+   </feed>

data/lib/model/templates/example

@@ -0,0 +1,59 @@
+sending message: {
+  "service":"Twitter",
+  "id":"209236208210022401",
+  "geo":null,
+  "application":"web",
+  "location":"A Pobra de Trives, Ourense , Spain",
+  "date":"Sun Jun 03 10:52:55 +0000 2012",
+  "source":"https://twitter.com/KermitPFC/status/209236208210022401",
+  "text":"#TestingKermitPFC @Minikisto @nataliagm888 echando a andar el experimento... http://t.co/LHsLea6s",
+  "description":null,
+  "keywords":"TestingKermitPFC, ",
+  "category":null,
+  "duration":null,
+  "likes":0,
+  "dislikes":null,
+  "favorites":null,
+  "comments":null,
+  "rates":null,
+  "rating":null,
+  "min_rating":null,
+  "max_rating":null,
+  "user":{
+    "name":"KermitPFC",
+    "real_name":"KermitPFC",
+    "id":"401402484",
+    "language":"es",
+    "utc":"Madrid + 3600",
+    "geo":null,
+    "description":"Soy una rana.",
+    "avatar":"https://si0.twimg.com/profile_images/1616971308/kermit_normal.jpg",
+    "location":"Oviedo, Asturias",
+    "subscribers":0,
+    "subscriptions":4,
+    "postings":3,
+    "profile":"https://twitter.com/#!/KermitPFC",
+    "website":"https://github.com/danielmachado/kermitpfc-core"},
+  "links":[{
+      "service":null,
+      "title":"photo",
+      "thumbnail":"http://p.twimg.com/AudbOQjCEAAMRKq.jpg",
+      "href":"http://t.co/LHsLea6s"}
+    ],
+  "to_users":[{
+      "name":"Minikisto",
+      "id":"105619316",
+      "service":"mention",
+      "title":null,
+      "thumbnail":null,
+      "href":null},
+    {
+      "name":"nataliagm888",
+      "id":"289913868",
+      "service":"mention",
+      "title":null,
+      "thumbnail":null,
+      "href":null
+    }
+  ]
+}

data/lib/model/templates/rss.xml

@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<rss version="2.0" xmlns:georss="http://www.georss.org/georss">
+  <channel>
+    <title>KermitPFC - Core - Stream</title>
+    <link>https:\/\/github.com\/danielmachado\/kermitpfc-core</link>
+    <description>Stream served by KermitPFC</description>
+    <pubDate>created_at</pubDate>
+    <item>
+      <title>text</title>
+      <link>http://www.twitter.com/id_str</link>
+      <description>
+        {
+          "service" : "Twitter",           # Service Name.
+          "user" : {                # User Info 
+              "name" : "screen_name",              # User Name
+              "real_name" : "name"          # Real name of user
+              "id" : "id_str",                # Unique User ID
+              "language": "lang",           # Spoken language of user
+              "utc" : "time_zone + utc_offset",               # UTC time offset of user
+              "geo" : "",               # Latitude/Logitude User location
+              "description" : "description"        # User profile description
+              "avatar" : "profile_image_url_https",            # Direct href to avatar image
+              "location": "location",           # Plain Language User location
+              "subscribers": "followers_count",        # Number of subscribers
+              "subscriptions": "friends_count",      # Number of subscriptions
+              "postings": "statuses_count",           # Number of postings made
+              "profile": "http://www.twitter.com/name",            # Href to user profile
+              "website": "url",            # Href to user website
+          }
+          "to_users" {              # Attached link(s) // // Tantos como UserMentions tenga entities 0...N
+             "0": {                     # Index of link
+                "name" : "screen_name",                # User Name
+                "id" : "id_str",                  # Unique User ID
+                "twitter/instagram/..."                   # Name of service/Domain hosting link 
+                "title" : "mention/reply/retweet",               # Title of item
+                "thumbnail" : "?",           # Direct href to thumbnail for item
+                "href" : "http://www.service.com/name",                # Direct href to item
+             },
+          },       
+          "links" {                 # Attached link(s) //Media del status
+             "0": {                     # Index of link // Tantos como entities se necesiten 0...N
+                "instagram/lockerz/youtube/..."                   # Name of service/Domain hosting link 
+                "photo/video/url.." : "",               # Title of item
+                "thumbnail" : "url",           # Direct href to thumbnail for item
+                "href" : "media_url",                # Direct href to item
+             },
+          },       
+          "id" : "id_str",                # Unique ID
+          "geo" : "coordinates",               # Latitude/Logitude content creation location
+          "application" : "source",       # Application used to create this posting
+          "location" : "full_name+country",          # Plain Language content creation location
+          "date" : "created_at",              # Date posted
+          "source" : "http://www.twitter.com/id_str",            # User friendly link to content
+          "text" : "text",              # Microblog text / Video Title / Etc
+          "description" : "",       # Full post text / Decription 
+          "keywords" : "hashtags",          # Related Keywords
+          "likes" : "retweet_count",             # Number of users who "liked" this
+          "dislikes" : "",          # Number of users who "disliked" this
+          "favorites": "favourites_count",          # Number of users who "favorited" this
+        }
+      </description>
+      <georss:polygon>coordinates</georss:polygon>
+      <georss:featureTypeTag>place_type</georss:featureTypeTag>
+      <georss:featureName>name</georss:featureName>
+      <pubDate>created_at</pubDate>
+    </item>
+  </channel>
+</rss>