jtv 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,2 +1,8 @@
 # v0.0.1
 * Initial Release with JtvChannel and JtvClip
+
+# v0.0.2
+* Added Jtv.channel_viewers
+
+# v0.0.3
+* Added JtvSearch

data/README.md

@@ -50,6 +50,30 @@ 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.
 
+### JtvSearch
+
+The JtvSearch provides access to the search api. If you pass
+JtvSearch.get a search query, it will return an array of channels.
+This class makes it easy to include a generic livestream list for your
+website.
+
+```ruby
+streams = JtvSearch.get( 'league of legends', 50 )
+# You can pass the get method a search query, as well as
+# an optional stream limit that goes up to 100 and defaults to 20
+
+streams.each do |stream|
+
+  stream.id
+  stream.title
+  stream.url
+  stream.viewers
+  stream.image_huge
+  stream.screen_cap_huge
+
+end
+```
+
 ### JtvChannel
 
 The JtvChannel class provides access to stream information for a

data/lib/jtv/jtv_search.rb

@@ -0,0 +1,34 @@
+class JtvSearch
+
+  require 'jtv'
+
+  attr_reader :viewers, :title, :url, :image_huge, :screen_cap_huge, :id
+
+  # Creates a new JtvSearch object
+  def initialize( stream )
+    @viewers = stream['stream_count']
+    @title = stream['title']
+    @url = stream['channel']['channel_url']
+    @image_huge = stream['channel']['image_url_huge']
+    @screen_cap_huge = stream['channel']['screen_cap_url_huge']
+    @id = stream['channel']['login']
+  end
+  
+  # Returns an array of objects based on search paramaters,
+  # pass the desired query, as well as an optional limit up to 100
+  def self.get( query, limit=20 )
+    client = Jtv::JtvClient.new
+    query.gsub!( /[ ]/, '%20' )
+    json_data = client.get( "/stream/search/#{query}.json?limit=#{limit}" )
+
+    data = JSON.parse json_data.body
+    search_array = Array.new
+
+    data.each do |stream|
+      search_array << JtvSearch.new( stream )
+    end
+
+    search_array
+  end
+
+end

data/lib/jtv/version.rb

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

data/lib/jtv.rb

@@ -1,6 +1,7 @@
 require "jtv/version"
 require 'jtv/jtv_channel'
 require 'jtv/jtv_clip'
+require 'jtv/jtv_search'
 
 require 'json'
 
@@ -8,6 +9,7 @@ module Jtv
 
   require 'oauth'
 
+  # Get current viewers for a specific channel
   def self.channel_viewers( channel )
     client = Jtv::JtvClient.new
     json_data = client.get( "/stream/list.json?channel=#{channel}" )

data/spec/jtv/jtv_channel_spec.rb

@@ -13,9 +13,9 @@ describe JtvChannel do
 
   describe 'viewers' do
 
-    it 'should return an integer' do
+    it 'should return nil' do
       channel = JtvChannel.new( 'mockra' )
-      channel.viewers.should be_a Integer
+      channel.viewers.should be_nil
     end
 
   end

data/spec/jtv/jtv_search_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe JtvSearch do
+
+  describe 'get' do
+
+    it 'should return an array' do
+      streams = JtvSearch.get( 'league of legends', 20 )
+      streams.should be_a Array
+    end
+
+    it 'should allow a search limit' do
+      streams = JtvSearch.get( 'league of legends', 4 )
+      streams.count.should <= 4
+    end
+
+    it 'should work with no search results' do
+      query = 'x' * 50
+      streams = JtvSearch.get( query )
+      streams.count.should == 0
+    end
+
+  end
+
+end

data/spec/jtv_spec.rb

@@ -2,6 +2,15 @@ require 'spec_helper'
 
 describe Jtv do
 
+  describe 'channel_viewers' do
+
+    it 'should return nil' do
+      views = Jtv.channel_viewers( 'mockra' )
+      views.should be_nil
+    end
+
+  end
+
   describe 'JtvClient' do
 
     it 'should set the consumer_key' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jtv
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70359962754580 !ruby/object:Gem::Requirement
+  requirement: &70137589529880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359962754580
+  version_requirements: *70137589529880
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70359962753100 !ruby/object:Gem::Requirement
+  requirement: &70137589528640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70359962753100
+  version_requirements: *70137589528640
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70359962751300 !ruby/object:Gem::Requirement
+  requirement: &70137589526900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70359962751300
+  version_requirements: *70137589526900
 description: Gem for quickly accessing the Justin.TV API
 email:
 - david@mockra.com
@@ -62,9 +62,11 @@ files:
 - lib/jtv.rb
 - lib/jtv/jtv_channel.rb
 - lib/jtv/jtv_clip.rb
+- lib/jtv/jtv_search.rb
 - lib/jtv/version.rb
 - spec/jtv/jtv_channel_spec.rb
 - spec/jtv/jtv_clip_spec.rb
+- spec/jtv/jtv_search_spec.rb
 - spec/jtv_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -81,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4210132887760206074
+      hash: -1700366459635922060
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4210132887760206074
+      hash: -1700366459635922060
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -100,5 +102,6 @@ summary: This tool provides simple Rails integration for common Justin.TV API ca
 test_files:
 - spec/jtv/jtv_channel_spec.rb
 - spec/jtv/jtv_clip_spec.rb
+- spec/jtv/jtv_search_spec.rb
 - spec/jtv_spec.rb
 - spec/spec_helper.rb