jtv 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.0.1
+* Initial Release with JtvChannel and JtvClip

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jtv.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mockra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Jtv
+
+This gem allows you to quickly add Justin.TV integration to your Ruby applications. Jtv is a useful tool for providing a list of livestreams, as well as embedding Justin.TV streams and clips.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jtv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jtv
+
+## Justin.TV API Keys
+
+If you want access to higher rate limits for your application, then you
+need to sign up for a [Justin.TV developer account](http://www.justin.tv/developer/activate).
+
+Once you have your API Keys, you'll need to set them up as environment
+variables for them to work with this gem. A great article on environment
+variables can be found at [Heroku](https://devcenter.heroku.com/articles/config-vars).
+
+``` ruby
+ENV['JTV_CONSUMER_KEY']
+ENV['JTV_CONSUMER_SECRET']
+```
+
+## Usage
+
+The Jtv gem offers various classes depending on the type of information
+you're looking for.
+
+### 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' )
+```
+
+You'll then have access to the following information.
+
+```ruby
+channel.viewers
+# Number of current viewers on the stream, requires a second API call
+
+channel.image_huge
+# 320x240 Image URL
+
+channel.screen_cap_huge
+# 320x240 Screen Capture URL
+
+channel.id
+# The channel handle
+
+channel.embed
+#Code required to embed the Justin.TV Player, response looks like:
+```
+
+```
+<object type="application/x-shockwave-flash" height="295" width="353" id="jtv_player_flash" data="http://www.justin.tv/widgets/jtv_player.swf?channel=apidemo&quot; bgcolor="#000000"><param name="allowFullScreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="movie" value="http://www.justin.tv/widgets/jtv_player.swf&quot; /><param name="flashvars" value="channel=apidemo&auto_play=false&start_volume=25" /></object>
+```
+
+```ruby
+channel.title
+channel.url
+channel.about
+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.
+
+```ruby
+clip = JtvClip.new( 1278312 )
+```
+
+The following method calls are available through the Clip class.
+
+```ruby
+clip.description
+clip.title
+clip.id
+clip.tags
+clip.embed
+clip.image_huge
+clip.length
+clip.created_on
+```
+
+## Contributing
+
+Contributions and feedback are more than welcome and highly encouraged.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+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)
+
+[@Mockra_](http://twitter.com/#!/mockra_)
+
+[mockra.com](http://mockra.com)

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/jtv.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jtv/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mockra"]
+  gem.email         = ["david@mockra.com"]
+  gem.description   = %q{Gem for quickly accessing the Justin.TV API}
+  gem.summary       = %q{This tool provides simple Rails integration for common Justin.TV API calls.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jtv"
+  gem.require_paths = ["lib"]
+  gem.version       = Jtv::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'json'
+  gem.add_dependency 'oauth'
+end

data/lib/jtv.rb

@@ -0,0 +1,48 @@
+require "jtv/version"
+require 'jtv/jtv_channel'
+require 'jtv/jtv_clip'
+
+require 'json'
+
+module Jtv
+
+  require 'oauth'
+
+  class JtvClient
+
+    # Set API Keys through environment variables.
+    CONSUMER_KEY = ENV['JTV_CONSUMER_KEY']
+    CONSUMER_SECRET = ENV['JTV_CONSUMER_SECRET']
+
+    def initialize
+      @consumer = OAuth::Consumer.new(
+        CONSUMER_KEY,
+        CONSUMER_SECRET,
+        :site => "http://api.justin.tv",
+        :http_method => :get
+      )
+    end
+
+    def get(path, access_token=nil)
+      (access_token || default_token).get("/api#{path}")
+    end
+
+    def post(path, post_params, access_token=nil)
+      (access_token || default_token).post("/api#{path}", post_params)
+    end
+
+    def make_request_token
+      @consumer.get_request_token
+    end
+
+    def exchange_request_token_for_access_token(request_token)
+      request_token.get_access_token
+    end
+
+    private
+    def default_token
+      OAuth::AccessToken.new @consumer
+    end
+  end
+
+end

data/lib/jtv/jtv_channel.rb

@@ -0,0 +1,37 @@
+class JtvChannel
+
+  require 'jtv'
+
+  attr_reader :viewers, :title, :url, :image_huge, :screen_cap_huge,
+    :id, :about, :description, :embed, :blog, :facebook
+
+  def initialize(channel)
+    client = Jtv::JtvClient.new
+    json_data = client.get( "/channel/show/#{channel}.json" )
+
+    data = JSON.parse json_data.body
+
+    @id = channel
+    @title = data['title']
+    @url = data['channel_url']
+    @image_huge = data['image_url_huge']
+    @screen_cap_huge = data['screen_cap_url_huge']
+    @about = data['about']
+    @description = data['description']
+    @embed = data['embed_code']
+    @blog = data['blog']
+    @facebook = data['facebook']
+  end
+
+  def viewers
+    client = Jtv::JtvClient.new
+    json_data = client.get( "/stream/list.json?channel=#{self.id}" )
+    if json_data.body == "[]"
+      return 0
+    else
+      data = JSON.parse( json_data.body )
+    end
+    data[0]['stream_count'].to_i
+  end
+
+end

data/lib/jtv/jtv_clip.rb

@@ -0,0 +1,26 @@
+class JtvClip
+
+  require 'jtv'
+
+  attr_reader :description, :created_on, :length, :id, :title,
+    :tags, :embed, :image_huge
+
+  def initialize(clip)
+
+    client = Jtv::JtvClient.new
+    json_data = client.get( "/clip/show/#{clip}.json" )
+
+    data = JSON.parse json_data.body
+    data = data[0]
+
+    @description = data['description']
+    @created_on = data['created_on']
+    @length = data['length']
+    @id = clip
+    @title = data['title']
+    @tags = data['tags']
+    @embed = data['embed_code']
+    @image_huge = data['image_url_huge']
+  end
+
+end

data/lib/jtv/version.rb

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

data/spec/jtv/jtv_channel_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe JtvChannel do
+
+  describe 'initialize' do
+
+    it 'should create a channel' do
+      channel = JtvChannel.new( 'mockra' )
+      channel.should be_a JtvChannel
+    end
+
+  end
+
+  describe 'viewers' do
+
+    it 'should return an integer' do
+      channel = JtvChannel.new( 'mockra' )
+      channel.viewers.should be_a Integer
+    end
+
+  end
+
+end

data/spec/jtv/jtv_clip_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe JtvClip do
+
+  describe 'initialize' do
+
+    it 'should create a clip' do
+      clip = JtvClip.new( 1278312 )
+      clip.should be_a JtvClip
+    end
+
+    it 'should set the correct length' do
+      clip = JtvClip.new( 1278312 )
+      clip.length.should == 22
+    end
+
+  end
+
+end
+

data/spec/jtv_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Jtv do
+
+  describe 'JtvClient' do
+
+    it 'should set the consumer_key' do
+      pending('Need to test the environment variables')
+      Jtv::JtvClient::CONSUMER_KEY.should == ENV['JTV_CONSUMER_KEY']
+    end
+
+    it 'should create a client' do
+      client = Jtv::JtvClient.new
+      client.should be_a Jtv::JtvClient
+    end
+
+    describe 'get' do
+
+      it 'should return Net::HTTPOK' do
+        client = Jtv::JtvClient.new
+        data = client.get( '/stream/list.json' )
+        data.should be_a(Net::HTTPOK)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'jtv'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: jtv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mockra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70143935183360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70143935183360
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70143935182380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143935182380
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70143935181580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143935181580
+description: Gem for quickly accessing the Justin.TV API
+email:
+- david@mockra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jtv.gemspec
+- lib/jtv.rb
+- lib/jtv/jtv_channel.rb
+- lib/jtv/jtv_clip.rb
+- lib/jtv/version.rb
+- spec/jtv/jtv_channel_spec.rb
+- spec/jtv/jtv_clip_spec.rb
+- spec/jtv_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: This tool provides simple Rails integration for common Justin.TV API calls.
+test_files:
+- spec/jtv/jtv_channel_spec.rb
+- spec/jtv/jtv_clip_spec.rb
+- spec/jtv_spec.rb
+- spec/spec_helper.rb