jtv 0.0.1 → 0.0.2

data/README.md

@@ -33,15 +33,31 @@ ENV['JTV_CONSUMER_SECRET']
 ## Usage
 
 The Jtv gem offers various classes depending on the type of information
-you're looking for.
+you're looking for. JtvChannel and JtvClip should be used for creating records. 
+Jtv methods should be used for updating records.
+
+It's reccomended to cache your requests, and to always keep your
+account's rate limit in mind.
+
+Check out the [RDOC](http://rubydoc.info/github/Mockra/Jtv/).
+
+### Jtv
+
+```ruby
+Jtv.channel_viewers( 'channel_handle' )
+```
+
+This method will return nil if the stream is offline. Use this
+method for providing realtime viewer numbers and stream status.
 
 ### JtvChannel
+
 The JtvChannel class provides access to stream information for a
 specific channel. You'll need to pass the channel handle when you
 initialize your object.
 
 ```ruby
-channel = JtvChannel.new( 'channel' )
+channel = JtvChannel.new( 'channel_handle' )
 ```
 
 You'll then have access to the following information.
@@ -49,6 +65,11 @@ You'll then have access to the following information.
 ```ruby
 channel.viewers
 # Number of current viewers on the stream, requires a second API call
+# If the stream is offline, this will return nil
+
+Jtv.channel_viewers( 'channel_handle' )
+# This will return nil for offline streams.
+# Use this method for updating current viewers
 
 channel.image_huge
 # 320x240 Image URL
@@ -75,6 +96,7 @@ channel.description
 ```
 
 ### JtvClip
+
 The JtvClip class provides access to specific clip information. To
 create a clip object, simply pass the clip id when you initialize the
 object.
@@ -106,11 +128,6 @@ Contributions and feedback are more than welcome and highly encouraged.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## TODO
-
-* Add JtvCategory, which will return an array of objects from a category.
-* Add support for POST API calls.
-
 ## Contact
 
 [david@mockra.com](mailto:david@mockra.com)

data/lib/jtv.rb

@@ -8,6 +8,17 @@ module Jtv
 
   require 'oauth'
 
+  def self.channel_viewers( channel )
+    client = Jtv::JtvClient.new
+    json_data = client.get( "/stream/list.json?channel=#{channel}" )
+    if json_data.body == "[]"
+      return nil
+    else
+      data = JSON.parse( json_data.body )
+    end
+    data[0]['stream_count'].to_i
+  end
+
   class JtvClient
 
     # Set API Keys through environment variables.

data/lib/jtv/jtv_channel.rb

@@ -5,6 +5,8 @@ class JtvChannel
   attr_reader :viewers, :title, :url, :image_huge, :screen_cap_huge,
     :id, :about, :description, :embed, :blog, :facebook
 
+  # Create a new channel object, this method should be passed the channel handle.
+  # Example: channel = JtvChannel.new( 'day9tv' )
   def initialize(channel)
     client = Jtv::JtvClient.new
     json_data = client.get( "/channel/show/#{channel}.json" )
@@ -23,11 +25,12 @@ class JtvChannel
     @facebook = data['facebook']
   end
 
+  # Polls the Justin.TV API to find the number of current viewers on the channel.
   def viewers
     client = Jtv::JtvClient.new
     json_data = client.get( "/stream/list.json?channel=#{self.id}" )
     if json_data.body == "[]"
-      return 0
+      return nil
     else
       data = JSON.parse( json_data.body )
     end

data/lib/jtv/jtv_clip.rb

@@ -5,6 +5,8 @@ class JtvClip
   attr_reader :description, :created_on, :length, :id, :title,
     :tags, :embed, :image_huge
 
+  # Create a new clip object, this method should be passed the clip id.
+  # Example: clip = JtvClip.new( 1894735 )
   def initialize(clip)
 
     client = Jtv::JtvClient.new

data/lib/jtv/version.rb

@@ -1,3 +1,3 @@
 module Jtv
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jtv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
+date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70143935183360 !ruby/object:Gem::Requirement
+  requirement: &70359962754580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70143935183360
+  version_requirements: *70359962754580
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70143935182380 !ruby/object:Gem::Requirement
+  requirement: &70359962753100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70143935182380
+  version_requirements: *70359962753100
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70143935181580 !ruby/object:Gem::Requirement
+  requirement: &70359962751300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70143935181580
+  version_requirements: *70359962751300
 description: Gem for quickly accessing the Justin.TV API
 email:
 - david@mockra.com
@@ -79,15 +79,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4210132887760206074
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4210132887760206074
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.13
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: This tool provides simple Rails integration for common Justin.TV API calls.