jtv 1.0.0.beta1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55e6cb2e9244cffac200d57c616e2596b13bf484
+  data.tar.gz: 5b0cc8b1ba65ce9eba06d372bee8ced5d23a9bcc
+SHA512:
+  metadata.gz: 0142328529cddcedb4079abfeb955313065da1e2a036aa9431c130da12dba14cf4386632c7e0b13064cd411a075c253e40d0659f0f372812df62af67ac177b45
+  data.tar.gz: 3d088168caf4810cc63ea011fdde152e849f7b7a7e9bdb7d1c200e644afae44d07d855c9b9da314bbde20ffb227e6f979e598c0884c468a65b51002f7d0fc572

data/CHANGELOG.md

@@ -13,3 +13,6 @@
 
 # v1.0.0.beta1
 * Added access to User API
+
+# v1.0.0
+* Channel access has been added

data/README.md

@@ -118,6 +118,71 @@ Get all channels who are favorites of a user.
 
 Pass in a user's login.
 
+### Channel
+
+#### Show
+
+Returns extended information for a channel, specified by channel id or login.
+Requires OAuth authentication for private channels.
+
+```ruby
+  Jtv.channel_show 'apidemo'
+  # {'login'=>'apidemo'...}
+```
+
+Pass in a login or id for the channel.
+
+#### Fans
+
+Get users who are fans of a channel. Requires OAuth authentication for private
+channels.
+
+```ruby
+  Jtv.fans id: 'officecam'
+  # [{'id'=>23}]
+```
+
+Login must be included for the channel. Optional limit and offset params
+(defaults are 20 for limit and 0 for offset). Results returned are limited to
+100. Results are returned in create date order.
+
+#### Archives
+
+Get archives from a given channel. Requires OAuth authentication for private
+channels.
+
+```ruby
+  Jtv.archives id: 'dotahut', limit: 2
+  # [{'video_codec' => 'AVC'}, {}]
+```
+
+channel id or login must be included as a param. Optional limit and offset
+params (defaults are 20 for limit and 0 for offset). Results returned are
+limited to 100. Results are returned in create date order
+
+#### Embed
+
+Get embed code for a channel.
+
+```ruby
+  Jtv.embed 'justin', volume: 50
+  # "<object></object>"
+```
+
+You can supply params volume, publisher_guard (for the default channel password
+to try), height, width, and watermark_position
+
+#### Chat Embed
+
+Get chat embed code for a channel.
+
+```ruby
+  Jtv.chat_embed 'justin', height: 1000
+  # "<iframe></iframe>"
+```
+
+You can supply params height and width.
+
 ## Contributing
 
 Contributions and feedback are more than welcome and highly encouraged.

data/jtv.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'vcr'
-  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'webmock'
   gem.add_dependency 'faraday'
   gem.add_dependency 'json'
   gem.add_dependency 'simple_oauth'

data/lib/jtv/channel.rb

@@ -0,0 +1,23 @@
+module Jtv
+  module Channel
+    def channel_show id
+      get "channel/show/#{id}.json"
+    end
+
+    def fans params = {}
+      get 'channel/fans', params
+    end
+
+    def archives params = {}
+      get 'channel/archives', params
+    end
+
+    def embed id, params = {}
+      request(:get, "channel/embed/#{id}", params)[:body]
+    end
+
+    def chat_embed id, params = {}
+      request(:get, "channel/chat_embed/#{id}", params)[:body]
+    end
+  end
+end

data/lib/jtv/client.rb

@@ -4,12 +4,14 @@ require 'faraday'
 require 'jtv/defaults'
 require 'jtv/stream'
 require 'jtv/user'
+require 'jtv/channel'
 
 module Jtv
   class Client
     include Jtv::Defaults
     include Jtv::Stream
     include Jtv::User
+    include Jtv::Channel
 
     def initialize args = {}
       args.each do |key, value|

data/lib/jtv/version.rb

@@ -1,3 +1,3 @@
 module Jtv
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0"
 end

data/spec/features/channel_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'vcr_config'
+
+describe Jtv::Channel do
+  describe '#fans', :vcr do
+    it 'fetches fans for a given channel' do
+      fans = Jtv.fans id: 'officecam'
+      expect(fans).to be_an Array
+      expect(fans.first).to be_a Hash
+      expect(fans.first['id']).to be_an Integer
+    end
+  end
+
+  describe '#archives', :vcr do
+    it 'returns an array of archives for given channel' do
+      archives = Jtv.archives id: 'dotahut', limit: 2
+      expect(archives).to be_an Array
+      expect(archives.count).to eq 2
+      expect(archives.first['video_codec']).to eq 'AVC'
+    end
+  end
+
+  describe '#channel_show', :vcr do
+    it 'provides information for a given channel' do
+      channel = Jtv.channel_show 'apidemo'
+      expect(channel['login']).to eq 'apidemo'
+    end
+  end
+
+  describe '#embed', :vcr do
+    it 'returns a string containing an embed object' do
+      embed = Jtv.embed 'justin', volume: 50
+      expect(embed).to be_a String
+      expect(embed).to include 'volume=50'
+      expect(embed).to include 'object'
+      expect(embed).to include 'x-shockwave-flash'
+    end
+  end
+
+  describe '#chat_embed', :vcr do
+    it 'returns an iframe for chat' do
+      chat = Jtv.chat_embed 'justin', height: 50
+      expect(chat).to be_a String
+      expect(chat).to include 'height:50px'
+      expect(chat).to include 'iframe'
+    end
+  end
+end

data/spec/features/stream_spec.rb

@@ -2,18 +2,14 @@ require 'spec_helper'
 require 'vcr_config'
 
 describe Jtv::Stream do
-  describe '#summary' do
-    use_vcr_cassette
-
-    it 'fetches a live channel' do
+  describe '#summary', :vcr do
+    it 'returns a summary of Jutstin.tv data' do
       summary = Jtv.summary
       expect(summary['streams_count']).to be > 0
     end
   end
 
-  describe '#list' do
-    use_vcr_cassette
-
+  describe '#list', :vcr do
     it 'returns a list of streams for a category' do
       list = Jtv.list category: 'gaming'
       expect(list.count).to eq 50
@@ -21,9 +17,7 @@ describe Jtv::Stream do
     end
   end
 
-  describe '#search' do
-    use_vcr_cassette
-
+  describe '#search', :vcr do
     it 'returns streams based on search query' do
       search = Jtv.search 'league of legends', limit: 10
       expect(search.count).to eq 10

data/spec/features/user_spec.rb

@@ -2,18 +2,14 @@ require 'spec_helper'
 require 'vcr_config'
 
 describe Jtv::User do
-  describe '#user_show' do
-    use_vcr_cassette
-
+  describe '#user_show', :vcr do
     it 'fetches information on user' do
       user = Jtv.user_show 'augury'
       expect(user['login']).to eq 'augury'
     end
   end
 
-  describe '#favorites' do
-    use_vcr_cassette
-
+  describe '#favorites', :vcr do
     it 'fetches favorites from user' do
       user = Jtv.favorites 'augury'
       expect(user.first['language']).to eq 'en'

data/spec/jtv/channel_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../../lib/jtv/channel'
+
+class Client; include Jtv::Channel; end
+
+describe Jtv::Channel do
+  let(:client) { Client.new }
+
+  describe '#channel_show' do
+    it 'sends path with user to get' do
+      client.should_receive(:get).with 'channel/show/test.json'
+      client.channel_show 'test'
+    end
+  end
+
+  describe '#fans' do
+    it 'sends fans and params to get' do
+      client.should_receive(:get).with 'channel/fans', { channel: 'test' }
+      client.fans channel: 'test'
+    end
+  end
+
+  describe '#archives' do
+    it 'sends archives and params to get' do
+      client.should_receive(:get).with 'channel/archives', { channel: 'test' }
+      client.archives channel: 'test'
+    end
+  end
+
+  describe '#embed' do
+    it 'sends :get, embed path with login and params to request' do
+      client.should_receive(:request).with(:get, 'channel/embed/test',
+        { volume: 50 }).and_return({})
+      client.embed 'test', volume: 50
+    end
+  end
+
+  describe '#chat_embed' do
+    it 'sends :get, chat_embed path with login and params to request' do
+      client.should_receive(:request).with(:get, 'channel/chat_embed/justin',
+        { height: 50 }).and_return({})
+      client.chat_embed 'justin', height: 50
+    end
+  end
+end

data/spec/jtv/client_spec.rb

@@ -31,4 +31,14 @@ describe Jtv::Client do
       expect(client).to respond_to :favorites
     end
   end
+
+  context 'when including channel' do
+    it 'has access to show, stream_key, fans, and archives' do
+      expect(client).to respond_to :channel_show
+      expect(client).to respond_to :fans
+      expect(client).to respond_to :archives
+      expect(client).to respond_to :embed
+      expect(client).to respond_to :chat_embed
+    end
+  end
 end

data/spec/vcr_cassettes/Jtv_Channel/_archives/returns_an_array_of_archives_for_given_channel.yml

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.justin.tv/channel/archives?id=dotahut&limit=2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Jtv Gem
+      Authorization:
+      - OAuth oauth_nonce="51bdd0301c7a46881c7635851e726de7", oauth_signature="yZqw6ElypWDy5BrEKQCNZMqks8M%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1361148689", oauth_version="1.0"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Feb 2013 00:51:29 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Status:
+      - 200 OK
+      Via:
+      - Twice 0.2 twice8:3346
+      X-Runtime:
+      - '0.027745'
+      X-Geo:
+      - US
+      X-Request-Id:
+      - 701588087b4b4105c6c82ecef540c699
+      Etag:
+      - '"69d23dbdb82971fa60ad0740024a8500"'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      X-Rack-Cache:
+      - miss
+      Set-Cookie:
+      - language=en; domain=.twitch.tv; path=/; expires=Fri, 18-Feb-2033 00:51:29
+        GMT
+      Front-End-Https:
+      - 'off'
+    body:
+      encoding: UTF-8
+      string: '[{"image_url_medium":"http://static-cdn.jtvnw.net/jtv.thumbs/archive-368105393-320x240.jpg","video_rotation":"0","created_on":"2013-02-16
+        22:36:52 UTC","title":"DotaHut Invitational: No Tidehunter vs. Team Liquid
+        (bo3 casted by Maut)","filtered":"unchecked","stream_name":"live_user_dotahut","video_bitrate":"1634887.0","broadcaster":"delay","save_forever":"false","broadcast_id":"4881010784","updated_on":"2013-02-16
+        22:36:55 UTC","file_name":"2013-2-16/live_user_dotahut_1361053132.flv","id":"368105393","broadcast_part":"6","origin_name":"3810080","file_size":"216827014","audio_codec":"aac","deleted_by_user":"false","user_id":"38409951","tag_list":"","keyframes":"","length":"1061","video_file_url":"http://media22.justin.tv/archives/2013-2-16/live_user_dotahut_1361053132.flv","servers":"23","video_codec":"AVC","last_part":"true","start_time":"2013-02-16
+        22:18:52 UTC"},{"image_url_medium":"http://static-cdn.jtvnw.net/jtv.thumbs/archive-368099460-320x240.jpg","video_rotation":"0","created_on":"2013-02-16
+        22:19:10 UTC","title":"DotaHut Invitational: No Tidehunter vs. Team Liquid
+        (bo3 casted by Maut)","filtered":"unchecked","stream_name":"live_user_dotahut","video_bitrate":"1024628.0","broadcaster":"delay","save_forever":"false","broadcast_id":"4881010784","updated_on":"2013-02-16
+        22:19:12 UTC","file_name":"2013-2-16/live_user_dotahut_1361051335.flv","id":"368099460","broadcast_part":"5","origin_name":"3810080","file_size":"230157225","audio_codec":"aac","deleted_by_user":"false","user_id":"38409951","tag_list":"","keyframes":"","length":"1797","video_file_url":"http://media32.justin.tv/archives/2013-2-16/live_user_dotahut_1361051335.flv","servers":"34","video_codec":"AVC","last_part":"false","start_time":"2013-02-16
+        21:48:55 UTC"}]'
+    http_version: 
+  recorded_at: Mon, 18 Feb 2013 00:51:29 GMT
+recorded_with: VCR 2.4.0

data/spec/vcr_cassettes/Jtv_Channel/_channel_show/provides_information_for_a_given_channel.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.justin.tv/channel/show/apidemo.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - Jtv Gem
+      Authorization:
+      - OAuth oauth_nonce="613a09775b6dbb5efbc4e91b7da1c3f4", oauth_signature="XxWxfNSnQqyKGRV3IbCTAND3GLA%3D",
+        oauth_signature_method="HMAC-SHA1", oauth_timestamp="1361148689", oauth_version="1.0"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Feb 2013 00:51:29 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Status:
+      - 200 OK
+      Via:
+      - Twice 0.2 twice1:3357
+      X-Runtime:
+      - '0.013731'
+      X-Geo:
+      - US
+      X-Request-Id:
+      - 914065f70dc7d033f46e7f6f7afbc54e
+      Etag:
+      - '"bfaefa574dd7d39f6d74ff48befc9bc1"'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      X-Rack-Cache:
+      - miss
+      Set-Cookie:
+      - language=en; domain=.twitch.tv; path=/; expires=Fri, 18-Feb-2033 00:51:29
+        GMT
+      Front-End-Https:
+      - 'off'
+    body:
+      encoding: UTF-8
+      string: '{"screen_cap_url_huge":"http://static-cdn.jtvnw.net/previews/live_user_apidemo-630x473.jpg","timezone":"America/Los_Angeles","tags":null,"category_title":"Animals","subcategory":"other_animals","category":"animals","about":null,"views_count":"38302","screen_cap_url_large":"http://static-cdn.jtvnw.net/previews/live_user_apidemo-320x240.jpg","status":null,"channel_background_image_url":null,"embed_enabled":true,"image_url_huge":"http://www-cdn.jtvnw.net/images/xarth/404_user_600x600.png","channel_url":"http://www.justin.tv/apidemo","subcategory_title":"Other
+        Animals","title":"API demo (in HD)","channel_link_color":"#0066CC","screen_cap_url_small":"http://static-cdn.jtvnw.net/previews/live_user_apidemo-70x53.jpg","mature":null,"channel_header_image_url":null,"screen_cap_url_medium":"http://static-cdn.jtvnw.net/previews/live_user_apidemo-150x113.jpg","image_url_large":"http://www-cdn.jtvnw.net/images/xarth/404_user_300x300.png","id":6285586,"channel_column_color":"#FFFFFF","image_url_medium":"http://www-cdn.jtvnw.net/images/xarth/404_user_150x150.png","producer":false,"image_url_small":"http://www-cdn.jtvnw.net/images/xarth/404_user_70x70.png","channel_background_color":"#E1E3E6","anonymous_chatters_allowed":false,"embed_code":"    <object
+        type=\"application/x-shockwave-flash\" height=\"295\" width=\"353\" id=\"live_embed_player_flash\"
+        data=\"http://www.justin.tv/widgets/live_embed_player.swf?channel=apidemo\"
+        bgcolor=\"#000000\"><param name=\"allowFullScreen\" value=\"true\" /><param
+        name=\"allowscriptaccess\" value=\"always\" /><param name=\"movie\" value=\"http://www.justin.tv/widgets/live_embed_player.swf\"
+        /><param name=\"flashvars\" value=\"auto_play=false&channel=apidemo&start_volume=25\"
+        /></object>\n","image_url_tiny":"http://www-cdn.jtvnw.net/images/xarth/404_user_50x50.png","language":"en","login":"apidemo","channel_text_color":"#222222","description":null}'
+    http_version: 
+  recorded_at: Mon, 18 Feb 2013 00:51:29 GMT
+recorded_with: VCR 2.4.0