cathodic 0.0.3 → 0.1.0

data/.gitignore

@@ -1,4 +1,4 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+# uncomment this line if your project needs to run something other than `rake`:
+script: gem build cathodic.gemspec

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in cathodic.gemspec
-gemspec
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cathodic.gemspec
+gemspec

data/Rakefile

@@ -1 +1 @@
-require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'

data/Readme.md

@@ -1,60 +1,61 @@
-Cathodic
-================================
-
-Cathodic was at first a module created for one of the websites I worked on. 
-I needed a way to easily access the data tied to a twitch.tv stream, such as the state of the stream (online or offine, thus the boolean), the number of viewers, the stream's status, etc.
-
-Cathodic is now a standalone gem, and it's pretty easy to use, as you can see below.
-
-Installing Cathodic
------------------------------
-
-If you're working on a ruby project, you just have to run the following command : 
-```ruby
-	gem install cathodic
-```
-
-However, if you're using rails, you might want to use bundler (if you don't, you should, it's awesome), therefore add the following line to your Gemfile
-```ruby
-	gem cathodic
-```
-
-And run the following command : 
-```console
-	bundle install
-```
-
-To install the gem, and correctly add it to your rails project.
-
-Using Cathodic
-------------------------------
-
-Cathodic is a very easy to use gem. Once you've installed it, you only need to instanciate a TwitchData object (contained in the Cathodic module) by calling the following constructor :
-```ruby
-	Cathodic::TwitchData.new(url)
-```
-Where url is the url of the twitch.tv channel (http://twitch.tv/kustomgames/ for example). This url can be provided by one of your users, or fetched from the twitch.tv api.
-
-The data tied to the stream can now be accessed by using the accessors : if you want to retreive the number of viewers on the stream and put it on the console output you just have to call the viewers accessor : 
-```ruby
-	data = Cathodic::TwitchData.new(url)
-	puts data.viewers
-```
-Here are all the data you can access at the moment : 
-
-* online : boolean - True if the stream is online, false otherwise
-* account_name : string - Contains the account name from the provided url
-* thumbnail_address : string - Contains the url of the stream's preview thumbnail (will soon change to a new thumbnail object)
-* embed : string - Contains the html embed code for the twitch tv player which will play the stream's livestream
-* viewers : integer - Contains the number of people currently watching the stream (when the TwitchData object was created!)
-* entry_point : string - Contains the entry point to the api (for future upgrades of the gem, to support multiple providers)
-* url : string - Contains the url to the twitch.tv stream page
-* game : string - Contains the game currently played on the stream (updated by the streamer, might not be accurate)
-* status : string - Contains the status of the stream, a title displayed on top of the embed which describes the current activity on screen (updated by the streamer, might not be accurate)
-* logo : string - Contains the url of the stream's logo
-* banner : string - Contains the url of the stream's banner
-* stream_name : string - The casse sensitive stream name (example : account_name is kustomgames and stream_name is KustomGames)
-* chat_embed : string - Conatains the html code used to pop out the stream's chat (incoming)
-
-
-
+Cathodic
+================================
+[![Dependency Status](https://gemnasium.com/kustom666/cathodic.png)](https://gemnasium.com/kustom666/cathodic)  [![Build Status](https://travis-ci.org/kustom666/cathodic.png?branch=master)](https://travis-ci.org/kustom666/cathodic)
+
+Cathodic was at first a module created for one of the websites I worked on. 
+I needed a way to easily access the data tied to a twitch.tv stream, such as the state of the stream (online or offine, thus the boolean), the number of viewers, the stream's status, etc.
+
+Cathodic is now a standalone gem, and it's pretty easy to use, as you can see below.
+
+Installing Cathodic
+-----------------------------
+
+If you're working on a ruby project, you just have to run the following command : 
+```ruby
+	gem install cathodic
+```
+
+However, if you're using rails, you might want to use bundler (if you don't, you should, it's awesome), therefore add the following line to your Gemfile
+```ruby
+	gem cathodic
+```
+
+And run the following command : 
+```console
+	bundle install
+```
+
+To install the gem, and correctly add it to your rails project.
+
+Using Cathodic
+------------------------------
+
+Cathodic is a very easy to use gem. Once you've installed it, you only need to instanciate a TwitchData object (contained in the Cathodic module) by calling the following constructor :
+```ruby
+	Cathodic::TwitchData.new(url)
+```
+Where url is the url of the twitch.tv channel (http://twitch.tv/kustomgames/ for example). This url can be provided by one of your users, or fetched from the twitch.tv api.
+
+The data tied to the stream can now be accessed by using the accessors : if you want to retreive the number of viewers on the stream and put it on the console output you just have to call the viewers accessor : 
+```ruby
+	data = Cathodic::TwitchData.new(url)
+	puts data.viewers
+```
+Here are all the data you can access at the moment : 
+
+* online : boolean - True if the stream is online, false otherwise
+* account_name : string - Contains the account name from the provided url
+* thumbnail_address : string - Contains the url of the stream's preview thumbnail (will soon change to a new thumbnail object)
+* embed : string - Contains the html embed code for the twitch tv player which will play the stream's livestream
+* viewers : integer - Contains the number of people currently watching the stream (when the TwitchData object was created!)
+* entry_point : string - Contains the entry point to the api (for future upgrades of the gem, to support multiple providers)
+* url : string - Contains the url to the twitch.tv stream page
+* game : string - Contains the game currently played on the stream (updated by the streamer, might not be accurate)
+* status : string - Contains the status of the stream, a title displayed on top of the embed which describes the current activity on screen (updated by the streamer, might not be accurate)
+* logo : string - Contains the url of the stream's logo
+* banner : string - Contains the url of the stream's banner
+* stream_name : string - The casse sensitive stream name (example : account_name is kustomgames and stream_name is KustomGames)
+* chat_embed : string - Conatains the html code used to pop out the stream's chat (incoming)
+
+
+

data/cathodic.gemspec

@@ -1,22 +1,23 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "cathodic/version"
-
-Gem::Specification.new do |s|
-  s.name        = "cathodic"
-  s.version     = Cathodic::VERSION
-  s.authors     = ["Paul Forti"]
-  s.email       = ["paul@itsbi.fr"]
-  s.homepage    = "https://github.com/kustom666/cathodic"
-  s.summary     = "Gets a twitch.tv stream's info from the api"
-  s.description = "Cathodic helps users retreiving the data from a twitch tv stream, such as the number of viewers, 
-                   a preview thumbnail, the embed code, the status etc from the twitch channel's url"
-
-  s.rubyforge_project = "cathodic"
-  s.add_development_dependency "json"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cathodic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cathodic"
+  s.version     = Cathodic::VERSION
+  s.authors     = ["Paul Forti"]
+  s.email       = ["paul@itsbi.fr"]
+  s.homepage    = "https://github.com/kustom666/cathodic"
+  s.summary     = "Gets a twitch.tv stream's info from the api"
+  s.description = "Cathodic helps users retreiving the data from a twitch tv stream, such as the number of viewers, 
+                   a preview thumbnail, the embed code, the status etc from the twitch channel's url"
+
+  s.rubyforge_project = "cathodic"
+  s.add_development_dependency "json"
+  s.add_runtime_dependency "json"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/cathodic.rb

@@ -1,55 +1,61 @@
- #require "cathodic/version"
-require 'json'
-require 'open-uri'
-require 'openssl'
-
-module Cathodic
-  class TwitchData
-  	attr_accessor :account_name, :online, :thumbnail_address, :embed, :viewers, :entry_point, :url, :game, :status, :logo, :banner, :stream_name, :chat_embed
-
-  	def initialize(url)
-  		@entry_point = "https://api.twitch.tv/kraken"
-  		@url = url
-  		extract_account
-  		@query_point = @entry_point + "/streams/" + @account_name
-  		extract_data
-  	end
-
-  	private
-  	def extract_account
-  		raise "Bad url" if !@url.include? "twitch.tv"
-
-  		regexp = /twitch.tv\/\w*/
-	    m = regexp.match @url
-	    buff = m.to_s
-	    buff.sub! "twitch.tv/", ""
-	    @account_name = buff
-  	end
-
-  	def extract_data
-  		answer_string = open(@query_point).read
-  		parsed_answer = JSON.parse(answer_string)
-
-  		if parsed_answer["stream"] == nil
-  			@online = false
-  		else
-  			@online = true
-  			stream = parsed_answer.fetch("stream")
-  			channel = stream.fetch("channel")
-  			
-  			@thumbnail_address = stream.fetch("preview")["medium"]
-  			@game = stream["game"]
-  			@viewers = stream["viewers"]
-
-  			@url = channel["url"]
-  			@status = channel["status"]
-  			@logo = channel["logo"]
-  			@banner = channel["banner"]
-  			@stream_name = channel["display_name"]
-
-  			@embed =  "<object type=\"application/x-shockwave-flash\" height=\"360\" width=\"640\" id=\"live_embed_player_flash\" data=\"http://en.twitch.tv/widgets/live_embed_player.swf?channel="+@account_name+"\" bgcolor=\"#000000\"><param name=\"allowFullScreen\" value=\"true\" /><param name=\"allowScriptAccess\" value=\"always\" /><param name=\"allowNetworking\" value=\"all\" /><param name=\"movie\" value=\"http://en.twitch.tv/widgets/live_embed_player.swf\" /><param name=\"flashvars\" value=\"hostname=en.twitch.tv&channel="+@account_name+"&auto_play=true&start_volume=25\" /></object>"
-  		  @chat_embed = "http://twitch.tv/chat/embed?channel="+@account_name+"&popout_chat=true"
-      end
-  	end
-  end
-end
+#Cathodic takes the url of a twitch.tv stream and fetch every data tied to it, such as the status, logo, numbed of viewers, thumnails and game
+#Author::Paul Forti
+#License::MIT
+
+require "cathodic/version"
+require 'json'
+require 'open-uri'
+require 'openssl'
+require "cathodic/thumbnail"
+require "cathodic/chat"
+
+module Cathodic
+  class TwitchData
+  	attr_accessor :account_name, :online, :thumbnail, :embed, :viewers, :entry_point, :url, :game, :status, :logo, :banner, :stream_name, :chat
+
+  	def initialize(url)
+  		@entry_point = "https://api.twitch.tv/kraken"
+  		@url = url
+  		extract_account
+  		@query_point = @entry_point + "/streams/" + @account_name
+  		extract_data
+  	end
+
+  	private
+  	def extract_account
+  		raise "Bad url" if !@url.include? "twitch.tv"
+
+  		regexp = /twitch.tv\/\w*/
+	    m = regexp.match @url
+	    buff = m.to_s
+	    buff.sub! "twitch.tv/", ""
+	    @account_name = buff
+  	end
+
+  	def extract_data
+  		answer_string = open(@query_point).read
+  		parsed_answer = JSON.parse(answer_string)
+
+  		if parsed_answer["stream"] == nil
+  			@online = false
+  		else
+  			@online = true
+  			stream = parsed_answer.fetch("stream")
+  			channel = stream.fetch("channel")
+  			
+  			@thumbnail = Cathodic::Thumbnail.new(stream)
+  			@game = stream["game"]
+  			@viewers = stream["viewers"]
+
+  			@url = channel["url"]
+  			@status = channel["status"]
+  			@logo = channel["logo"]
+  			@banner = channel["banner"]
+  			@stream_name = channel["display_name"]
+
+  			@embed =  "<object type=\"application/x-shockwave-flash\" height=\"360\" width=\"640\" id=\"live_embed_player_flash\" data=\"http://en.twitch.tv/widgets/live_embed_player.swf?channel="+@account_name+"\" bgcolor=\"#000000\"><param name=\"allowFullScreen\" value=\"true\" /><param name=\"allowScriptAccess\" value=\"always\" /><param name=\"allowNetworking\" value=\"all\" /><param name=\"movie\" value=\"http://en.twitch.tv/widgets/live_embed_player.swf\" /><param name=\"flashvars\" value=\"hostname=en.twitch.tv&channel="+@account_name+"&auto_play=true&start_volume=25\" /></object>"
+  		  @chat_embed = Cathodic::Chat.new(@account_name)
+      end
+  	end
+  end
+end

data/lib/cathodic/chat.rb

@@ -0,0 +1,34 @@
+module Cathodic
+	#The chat class represents the twitch.tv chat, you can fetch the embed code or the pop out chat code and links 
+	#Author::Paul Forti
+	#License::MIT
+	#-embed : the url to the embed version of the chat
+	#-popout : the url used to pop out the chat
+	#-emoticons : the hash containing all the serialized emoticons (image url, regexp, etc)
+	#-popout_link : the html link used to pop out the chat
+	class Chat
+		attr_accessor :embed, :popout, :emoticons, :popout_link
+
+		#The constructor needs to be given an account name, most likely the one retrieved from the stream's url 
+		#-account_name : the account name of the stream's chat you want to get 
+		def initialize(account_name)
+			@account_name = account_name
+			generate_links
+		end
+
+		#This method fetchs the emoticons info about a stream's chat. It takes a lot of CPU, memory and the query is pretty big
+		#Don't use it unless you REALLY need the emoticons
+		def fetch_emoticons
+			query_point = "https://api.twitch.tv/kraken/chat/"+@account_name+"emoticons"
+			@emoticons = open(query_point).read
+		end
+
+		private
+		def generate_links
+			@embed = "http://twitch.tv/chat/embed?channel="+@account_name
+			@popout = @embed + "&popout_chat=true"
+			@popout_link = "<a href=\""+@popout+"\" target=\"_new\">Pop-Out</a>"
+		end
+
+	end
+end

data/lib/cathodic/thumbnail.rb

@@ -0,0 +1,41 @@
+module Cathodic
+	#The Thumbnail class represents a twitch thumbnail, you can access any type of thumbnail representing a small preview of the stream any time
+	#Author::Paul Forti
+	#License::MIT
+	#-small : the url to a small thumbnail 80x50
+	#-medium : the url to a medium thumbnail 320x200
+	#-large : the url to a large thumbnail 640x400
+	#-template : the url to a generic thumbnail, you have to replace {width} by the width you want, same goes for {height}
+	#-sized_thumb : nil if sized has not been called, otherwise it's the url to a custom sized thumbnail (the size is defined when calling sized)
+	class Thumbnail
+		attr_accessor :small, :medium, :large, :template, :sized_thumb
+
+		#The constructor needs a hash representing the stream object
+		#Must be fetched from the Twitch.tv API (or have the same structure)
+		#-stream_hash : the hash representing the twitch.tv stream.
+		def initialize(stream_hash)
+			raise "Uncorrect stream hash" if !stream_hash.has_key?("preview")
+			@preview = stream_hash.fetch("preview")
+			extract_thumbnails
+		end
+
+		#Sized generates the url of a stream thumbnail that is width large and height tall
+		#width : The thumbnail's desired width
+		#height : The thumbnail's desired height
+		def sized(width, height)
+			@sized_thumb = @template
+			@sized_thumb.sub! "{width}", width.to_s
+			@sized_thumb.sub! "{height}", height.to_s
+		end
+
+		private
+
+		#Extracts the url of the three different sizes of thumbnail, plus the url of a the template (to generate custom sized thumbnails)
+		def extract_thumbnails
+			@small = @preview["small"]
+			@medium = @preview["medium"]
+			@large = @preview["large"]
+			@template = @preview["template"]
+		end
+	end
+end

data/lib/cathodic/version.rb

@@ -1,3 +1,3 @@
-module Cathodic
-  VERSION = "0.0.3"
-end
+module Cathodic
+  VERSION = "0.1.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cathodic
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "Cathodic helps users retreiving the data from a twitch tv stream,
   such as the number of viewers, \n                   a preview thumbnail, the embed
   code, the status etc from the twitch channel's url"
@@ -37,11 +53,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Rakefile
 - Readme.md
 - cathodic.gemspec
 - lib/cathodic.rb
+- lib/cathodic/chat.rb
+- lib/cathodic/thumbnail.rb
 - lib/cathodic/version.rb
 homepage: https://github.com/kustom666/cathodic
 licenses: []
@@ -63,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cathodic
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Gets a twitch.tv stream's info from the api