cathodic 0.0.2 → 0.0.3

data/Readme.md

@@ -0,0 +1,60 @@
+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

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Cathodic::VERSION
   s.authors     = ["Paul Forti"]
   s.email       = ["paul@itsbi.fr"]
-  s.homepage    = ""
+  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"

data/lib/cathodic.rb

@@ -5,7 +5,7 @@ require 'openssl'
 
 module Cathodic
   class TwitchData
-  	attr_accessor :account_name, :online, :thumbnail_address, :embed, :viewers, :entry_point, :url, :game, :status, :logo, :banner, :stream_name
+  	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"
@@ -48,7 +48,8 @@ module Cathodic
   			@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>"
-  		end
+  		  @chat_embed = "http://twitch.tv/chat/embed?channel="+@account_name+"&popout_chat=true"
+      end
   	end
   end
 end

data/lib/cathodic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cathodic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -39,10 +39,11 @@ files:
 - .gitignore
 - Gemfile
 - Rakefile
+- Readme.md
 - cathodic.gemspec
 - lib/cathodic.rb
 - lib/cathodic/version.rb
-homepage: ''
+homepage: https://github.com/kustom666/cathodic
 licenses: []
 post_install_message: 
 rdoc_options: []