rbvimeo 0.2.0 → 0.3.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Pruitt
+
+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.txt → README.textile}

@@ -1,28 +1,52 @@
 rbVimeo
-by Matt Pruitt
+
+Matt Pruitt
+
 www.guitsaru.com
 
-== DESCRIPTION:
+h2. Description
 
 A ruby wrapper for the Vimeo API
 
-== FEATURES/PROBLEMS:
+h2. Features/Problems
 
 This does not handle authentication.  It only gets public videos from Vimeo.
 
-== SYNOPSIS:
+h2. Usage
+
+@vimeo = RBVIMEO::Vimeo.new(api_key, api_signature)@
+
+@video = vimeo.video(video_id)@
+
+<br />
+
+See the docs for all Video properties
+
+@video.title@
+
+@video.caption@
+
+@video.comments # Returns an array of comment objects@
+
+@video.likes@
+
+@video.plays@
+
+h2. Documentation
+
+"Documentation":http://rbvimeo.rubyforge.org
+
+h2. Installation
 
-vimeo = RBVIMEO::Vimeo.new(api_key, api_signature)
-vid = vimeo.video(video_id)
+<pre>sudo gem install guitsaru-rbvimeo -s http://gems.github.com</pre>
 
-== INSTALL:
+h2. Contributing
 
-To install, run 'gem install rbvimeo'
+Fork the project on "github.":http://github.com/guitsaru/rbvimeo
 
-In order to run the specs, first make a test_settings.yml file (a sample is
-provided) using your api key and api secret.
+In order to run the specs, edit the test_settings.yml file (a sample is provided) using your api key and api secret.
 
-== LICENSE:
+h2. License
 
 (The MIT License)
 

data/Rakefile

@@ -1,21 +1,83 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
+require 'rubygems'
+require 'rake'
 
-load 'tasks/setup.rb'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rbvimeo"
+    gem.summary = %Q{A ruby wrapper for the vimeo api.}
+    gem.email = "guitsaru@gmail.com"
+    gem.homepage = "http://github.com/guitsaru/rbvimeo"
+    gem.authors = ["Matt Pruitt"]
+    gem.rubyforge_project = "rbvimeo"
+    gem.add_dependency('hpricot', '>= 0.6')
+  
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
 
-ensure_in_path 'lib'
-require 'rbVimeo'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
 
-task :default => 'spec:run'
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
 
-PROJ.name = 'rbvimeo'
-PROJ.authors = 'Matt Pruitt'
-PROJ.email = 'guitsaru@gmail.com'
-PROJ.url = 'www.guitsaru.com'
-PROJ.rubyforge.name = 'rbvimeo'
-PROJ.version = '0.2.0'
-PROJ.spec.opts << '--color'
-PROJ.gem.dependencies << 'hpricot'
 
-# EOF
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rbvimeo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/rbvimeo/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 3
+:patch: 0

data/lib/rbvimeo/comment.rb

@@ -0,0 +1,21 @@
+module RBVIMEO
+  class Comment
+    attr_accessor :id, :author, :authorname, :datecreate, :permalink, :text, :portraits
+    
+    def initialize
+      @portraits = []
+    end
+    
+    def date
+      return @datecreate
+    end
+    
+    def url
+      return @permalink
+    end
+    
+    def id
+      return @id.to_i
+    end
+  end
+end

data/lib/{User.rb → rbvimeo/user.rb}

@@ -1,5 +1,9 @@
 module RBVIMEO
   class User
     attr_accessor :id, :username, :fullname
+    
+    def id
+      return @id.to_i
+    end
   end
 end

data/lib/rbvimeo/video.rb

@@ -0,0 +1,138 @@
+module RBVIMEO
+  class Video
+    attr_reader :id, :title, :caption, :upload_date, :number_of_likes, :number_of_plays
+    attr_reader :number_of_comments, :width, :height, :owner, :tags, :url
+    attr_reader :thumbs
+
+    
+    # Fetches data about a video from the Vimeo site
+    # id is the id of the the Vimeo video
+    # vimeo is an instance of RBVIMEO::Vimeo
+    #
+    # To load a movie with vimeo id 339189:
+    # @vimeo = RBVIMEO::Vimeo.new api_key, api_secret
+    # video = RBVIMEO::Video.new 339189, @vimeo
+    def initialize id, vimeo
+      @thumbs = []
+      @comments = []
+      @id = id
+      @vimeo = vimeo
+      
+      url = vimeo.generate_url({"method" => "vimeo.videos.getInfo", 
+        "video_id" => id, "api_key" => vimeo.api_key}, "read")
+
+      xml_doc = @vimeo.get_xml(url)
+
+      return @id = -1 if parse_xml(xml_doc).nil?
+    end
+
+    # Returns the code to embed the video
+    def embed width, height
+      string = <<EOF
+<object type="application/x-shockwave-flash" width=#{width} height=#{height} data="http://www.vimeo.com/moogaloop.swf?clip_id=#{@id}&server=www.vimeo.com&fullscreen=0&show_title=0'&show_byline=0&showportrait=0&color=00ADEF">
+<param name="quality" value="best" />
+<param name="allowfullscreen" value="false" />
+<param name="scale" value="showAll" />
+<param name="movie" value="http://www.vimeo.com/moogaloop.swf?clip_id=#{@id}&server=www.vimeo.com&fullscreen=0&show_title=0&show_byline=0&showportrait=0&color=00ADEF" /></object>
+EOF
+    string.gsub("\n", "")
+    end
+
+    def comments
+      get_comments if @comments.empty?
+      return @comments
+    end
+    
+    def likes
+      @number_of_likes.to_i
+    end
+    
+    def plays
+      @number_of_plays.to_i
+    end
+    
+    def num_comments
+      @number_of_comments.to_i
+    end
+    
+    def number_of_likes
+      @number_of_likes.to_i
+    end
+    
+    def number_of_plays
+      @number_of_plays.to_i
+    end
+    
+    def number_of_comments
+      @number_of_comments.to_i
+    end
+    
+    def height
+      @height.to_i
+    end
+    
+    def width
+      @width.to_i
+    end
+  
+  private
+    # Parses data using the xml recieved from the Vimeo REST API
+    # Should not need to be called by anything other than the initialize method
+    def parse_xml xml_doc
+      return nil if xml_doc.at("title").nil?
+      @id = id
+      
+      %w[title caption upload_date number_of_likes number_of_plays width height number_of_comments url].each do |attribute|
+        instance_variable_set("@#{attribute}", xml_doc.at(attribute).inner_html)
+      end
+      
+      @owner = User.new
+      %w[id username fullname].each do |attribute|
+        @owner.instance_variable_set("@#{attribute}", xml_doc.at("owner").attributes[attribute])
+      end
+
+      (xml_doc/:thumbnail).each do |thumbnail|
+        @thumbs << build_thumbnail(thumbnail)
+      end
+    end
+  
+    # Fetches the comments for the specified Video
+    # id is the id of the Vimeo video
+    # vimeo is an instance of RBVIMEO::Vimeo
+    # returns an Array of comments
+    #
+    # To load a movie with vimeo id 339189:
+    #
+    # comments = video.comments 339189, @vimeo
+    def get_comments
+      xml_doc = @vimeo.get_xml(@vimeo.generate_url({"method" => "vimeo.videos.comments.getList",
+        "video_id" => @id, "api_key" => @vimeo.api_key}, "read"))
+      
+      (xml_doc/:comment).each do |comment|  
+        @comments << build_comment(comment)
+      end
+      return self
+    end
+    
+    def build_comment(c)
+      comment = Comment.new
+
+      comment.text = c.children.select{|e| e.text?}.join
+      
+      %w[id author authorname datecreate permalink].each do |attribute|
+        comment.instance_variable_set("@#{attribute}", c.attributes[attribute])
+      end
+
+      (c/'portraits'/'portrait').each do |portrait|
+        comment.portraits << build_thumbnail(portrait)
+      end
+      
+      return comment
+    end
+    
+    def build_thumbnail(t)
+      thumbnail = Thumbnail.new(t.inner_html, t.attributes['width'].to_i, t.attributes['height'].to_i)
+    end
+    
+  end
+end

data/lib/{rbVimeo.rb → rbvimeo/vimeo.rb}

@@ -1,25 +1,11 @@
-# Matt Pruitt
-# Ruby Library for working with Vimeo
-# Based on the sample PHP Vimeo API
-
-require 'digest/md5'
-require 'net/http'
-require 'rexml/document'
-
-require 'Video'
-require 'Thumbnail'
-require 'User'
-require 'Comment'
-
-
 module RBVIMEO
   class Vimeo
     attr_accessor :api_key, :api_secret
-  
+
     @@API_REST_URL  = "http://www.vimeo.com/api/rest"
     @@API_AUTH_URL   = "http://www.vimeo.com/services/auth/"
     @@API_UPLOAD_URL = "http://www.vimeo.com/services/upload/"
-    
+
     # api_key and api_secret should both be generated on www.vimeo.com
     def initialize api_key, api_secret
       @api_key = api_key
@@ -38,7 +24,12 @@ module RBVIMEO
       url += "&api_sig=#{generate_signature(parameters)}"
       return url
     end
-    
+
+    # Returns the xml from the given url
+    def get_xml url
+      return Hpricot(open(url))
+    end
+
     # parameters is a hash 
     def generate_signature parameters
       temp = ''
@@ -49,15 +40,15 @@ module RBVIMEO
       signature = @api_secret + temp
       Digest::MD5.hexdigest(signature)
     end
-    
+
     # Provides easier access to RBVIMEO::Video
     # video = @vimeo.video 339189
-    def video id, xml=nil
-      vid = Video.new(id, self, xml)
+    def video id
+      vid = Video.new(id, self)
       return nil if vid.id == -1
       return vid
     end
-    
+
     # Provides easier access to RBVIMEO::User
     # user = @vimeo.user
     def user

data/lib/rbvimeo.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'digest/md5'
+require 'open-uri'
+require 'hpricot'
+
+require 'rbvimeo/vimeo'
+require 'rbvimeo/video'
+require 'rbvimeo/thumbnail'
+require 'rbvimeo/user'
+require 'rbvimeo/comment'

data/test/rbvimeo_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class RbvimeoTest < Test::Unit::TestCase
+  context "Vimeo" do
+    setup do
+      @api_key = '56a9c1c65e700ca10a678a2bcd8e77af'
+      @api_secret = '59c629610'
+      @vimeo = RBVIMEO::Vimeo.new(@api_key, @api_secret)
+      @params = {"method" => "vimeo.videos.getInfo", "video_id" => "339189", "api_key" => @api_key}
+    end
+    
+    should "initialize" do
+      assert_not_nil(@api_key)
+      assert_not_nil(@api_secret)
+    end
+    
+    should "generate a signature" do
+      assert_equal("09cc6d8b963c73caf647e436b2147810", @vimeo.generate_signature(@params))
+    end
+    
+    should "generate a url" do
+      assert_equal("http://www.vimeo.com/api/rest?api_key=#{@api_key}&method=vimeo.videos.getInfo&video_id=339189&api_sig=09cc6d8b963c73caf647e436b2147810", @vimeo.generate_url(@params, "read"))
+    end
+    
+    should "generate a video" do
+      test_video_xml_file = File.join(File.dirname(__FILE__), %w[XML/339189.xml])
+
+      video_hpricot = open(test_video_xml_file) {|file| Hpricot(file)}
+      @vimeo.stubs(:get_xml).returns(video_hpricot)
+
+      @vid = @vimeo.video(339189)
+      
+      assert_not_nil(@vid)
+    end
+    
+    should "generate a user" do
+      assert_not_nil(@vimeo.user)
+    end
+    
+    should "return an xml file" do
+      test_video_xml_file = File.join(File.dirname(__FILE__), %w[XML/339189.xml])
+
+      video_hpricot = open(test_video_xml_file) {|file| Hpricot(file)}
+      @vimeo.stubs(:get_xml).returns(video_hpricot)
+      
+      assert_not_nil(@vimeo.get_xml(@vimeo.generate_url(@params, "read")).at('video'))
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rbvimeo'
+
+class Test::Unit::TestCase
+end

data/test/video_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class VideoTest < Test::Unit::TestCase
+  context "initialization" do
+    setup do
+      @api_key = '56a9c1c65e700ca10a678a2bcd8e77af'
+      @api_secret = '59c629610'
+      @vimeo = RBVIMEO::Vimeo.new(@api_key, @api_secret)
+      @params = {"method" => "vimeo.videos.getInfo", "video_id" => "339189", "api_key" => @api_key}
+    end
+    
+    context "a valid video" do
+      setup do
+        test_video_xml_file = File.join(File.dirname(__FILE__), %w[XML/339189.xml])
+
+        video_hpricot = open(test_video_xml_file) {|file| Hpricot(file)}
+        @vimeo.stubs(:get_xml).returns(video_hpricot)
+
+        @vid = @vimeo.video(339189)
+      end
+
+      should "have a title" do
+        assert_equal("Upload Tutorial", @vid.title.chomp)
+      end
+      
+      should "have a caption" do
+        assert_equal("This is a tutorial about our new Uploader. Enjoy!", @vid.caption.chomp)
+      end
+      
+      should "have an upload date" do
+        assert_equal("2007-10-12 16:30:32", @vid.upload_date)
+      end
+      
+      should "have likes" do
+        assert_equal(174, @vid.likes)
+        assert_equal(174, @vid.number_of_likes)
+      end
+      
+      should "have plays" do
+        assert_equal(515407, @vid.plays)
+        assert_equal(515407, @vid.number_of_plays)
+      end
+      
+      should "have comments" do
+        test_video_xml_file = File.join(File.dirname(__FILE__), %w[XML/339189.comments.xml])
+
+        comment_hpricot = open(test_video_xml_file) {|file| Hpricot(file)}
+        @vimeo.stubs(:get_xml).returns(comment_hpricot)
+
+        assert_equal(34, @vid.num_comments)
+        assert_equal(34, @vid.number_of_comments)
+        assert_equal(265313, @vid.comments[0].id)
+        assert_equal("ctd3", @vid.comments[0].author)
+        assert_equal("CTD3", @vid.comments[0].authorname)
+        assert_equal("2007-10-12 17:47:13", @vid.comments[0].date)
+        assert_equal("http://www.vimeo.com/339189#comment_265313", @vid.comments[0].url)
+        assert_match(/Sure is! Great changes!/, @vid.comments[0].text)
+        assert_equal("http://80.media.vimeo.com/d1/5/35/44/42/portrait-35444268.jpg", @vid.comments[0].portraits[0].url)
+        assert_equal(24, @vid.comments[0].portraits[0].width)
+        assert_equal(24, @vid.comments[0].portraits[0].height)
+      end
+      
+      should "have an owner" do
+        assert_equal(152184, @vid.owner.id)
+        assert_equal("staff", @vid.owner.username)
+        assert_equal("Vimeo Staff", @vid.owner.fullname)
+      end
+      
+      should "have a url" do
+        assert_equal("http://www.vimeo.com/339189/l:app-230", @vid.url)
+      end
+      
+      should "have a thumbnail" do
+        assert_equal("http://40.media.vimeo.com/d1/5/36/63/98/thumbnail-36639824.jpg", @vid.thumbs[0].url)
+        assert_equal(96, @vid.thumbs[0].width)
+        assert_equal(72, @vid.thumbs[0].height)
+      end
+      
+      should "have embed code" do
+        assert_not_nil(@vid.embed(240, 480))
+      end
+    end
+    
+    context "an invalid video" do
+      setup do
+        not_found_xml_file = File.join(File.dirname(__FILE__), %w[XML/not_found.xml])
+
+        video_hpricot = open(not_found_xml_file) {|file| Hpricot(file)}
+        @vimeo.stubs(:get_xml).returns(video_hpricot)
+
+        @vid = @vimeo.video(-34)
+      end
+
+      should "return nil on nonexistant video" do
+        assert_nil(@vid)
+      end
+    end
+    
+  end
+end