viddler 0.2.2 → 0.3.0

data/lib/viddler/comment.rb

@@ -2,13 +2,15 @@ module Viddler
   # This class wraps Viddler's comment's information.
   class Comment
   
-    attr_accessor :author, :text, :time
+    attr_accessor :id, :author, :text, :time, :timepoint
   
     def initialize(attributes={}) #:nodoc:
       a = attributes
+      @id     = a['id']      
       @author = a['author']
       @text   = a['text']      
       @time   = Time.at(fix_unix_time(a['time']))
+      @timepoint = a['add_timepoint'].to_i / 1000
     end
     
     private
@@ -19,4 +21,4 @@ module Viddler
     end
   
   end
-end
+end

data/lib/viddler/multipart_params.rb

@@ -16,20 +16,25 @@ class MultipartParams #:nodoc:
   end
   
   def pack_params(hash)
-    marker = "--#{@boundary_token}\r\n"
-    files_params = hash.find_all{|k,v| v.is_a?(File)}.to_h
-    text_params = hash - files_params
+    marker = "--#{@boundary_token}"
+    # Partition the hash, then return 2 hashes from the arrays returned.
+    files_params, text_params = hash.partition { |k,v| v.is_a?(File) or v.is_a?(Tempfile) }.map do |a|
+                                      # Converts array like [['foo', 'bar']] => {'foo' => 'bar'}
+                                      a.inject({}) { |h, x| h[x[0]] = x[1]; h }
+                                    end
     
-    pack_hash(text_params, marker) + marker + pack_hash(files_params, marker) + "--#{@boundary_token}--\r\n"
+    pack_hash(text_params, marker+"\r\n") + pack_hash(files_params, marker+"\r\n") + marker + "--"
   end
   
   def pack_hash(hash, marker)
     hash.map do |name, value|
       marker + case value
-      when String
+      when String, Fixnum
         text_to_multipart(name, value)
-      when File
+      when File, Tempfile
         file_to_multipart(name, value)
+      else
+        raise "Unexpected #{value.class}: #{value.inspect}"
       end
     end.join('')
   end

data/lib/viddler/request.rb

@@ -1,34 +1,34 @@
 require 'rest_client'
 
 module Viddler
-  
+
   # Raised when response from Viddler contains absolutely no data
   class EmptyResponseError < ViddlerError #:nodoc:
   end
-  
+
   # Raised when response from Viddler contains an error
   class ResponseError < ViddlerError #:nodoc:
     def initialize(message)
       super message
     end
   end
-  
+
   # Class used to send requests over http to Viddler API.
   class Request #:nodoc:
-    
+
     API_URL = 'http://api.viddler.com/rest/v1/'
     DEFAULT_HEADERS = {:accept => 'application/xml', :content_type => 'application/x-www-form-urlencoded'}
-  
+    
     attr_accessor :url, :http_method, :response, :body
     attr_reader :headers, :params
-  
+
     def initialize(http_method, method) #:nodoc:
       @http_method = http_method.to_s
       @url = API_URL
-      self.params = {:method => viddlerize(method)}    
+      self.params = {:method => viddlerize(method)}
       self.headers = DEFAULT_HEADERS
     end
-    
+
     # Use this method to setup your request's payload and headers.
     #
     # Example:
@@ -41,54 +41,54 @@ module Viddler
     #     p.sessionid = '12323'
     #     p.api_key   = '13123
     #   end
-    # 
+    #
     def set(container, &declarations)
       struct = OpenStruct.new
       declarations.call(struct)
       send("#{container}=", struct.table)
     end
-    
+
     # Send http request to Viddler API.
     def run(&block)
       if block_given?
         set(:params, &block)
       end
-    
+      
       if post? and multipart?
         put_multipart_params_into_body
       else
         put_params_into_url
-      end    
+      end
       request = RestClient::Request.execute(
-         :method => http_method, 
-         :url => url, 
-         :headers => headers, 
+         :method => http_method,
+         :url => url,
+         :headers => headers,
          :payload => body
        )
        self.response = parse_response(request)
     end
-  
+
     private
-  
+
     def parse_response(raw_response)
-      raise EmptyResponseError if raw_response.blank?
+      raise EmptyResponseError if raw_response.nil? || raw_response.empty?
       response_hash = Hash.from_xml(raw_response)
       if response_error = response_hash['error']
         raise ResponseError.new(viddler_error_message(response_error))
       end
       response_hash
     end
-  
+
     def put_multipart_params_into_body
       multiparams = MultipartParams.new(params)
       self.body = multiparams.body
       self.headers = {:content_type => multiparams.content_type}
     end
-  
+
     def put_params_into_url
-      self.url = API_URL + '?' + params.to_query
+      self.url = self.url + '?' + params.to_query
     end
-  
+
     def viddlerize(name)
       if name.include?('viddler.')
         name
@@ -96,34 +96,35 @@ module Viddler
         'viddler.' + name
       end
     end
-    
+
     def params=(hash) #:nodoc:
       @params ||= Hash.new
       @params.update(hash)
     end
-  
+
     def headers=(hash) #:nodoc:
       @headers ||= Hash.new
       @headers.update(hash)
     end
-  
+
     def multipart? #:nodoc:
-      if params.find{|k,v| v.is_a?(File)} then true else false end
+      # Todo: Fix this to find a common ancestor.
+      if params.find{|k,v| v.is_a?(File) or v.is_a?(Tempfile) } then true else false end
     end
-  
+
     def post? #:nodoc:
       http_method == 'post'
     end
-    
+
     def viddler_error_message(response_error)
       description = response_error['description'] || ''
-      details = response_error['details'] || ''      
+      details = response_error['details'] || ''
       code = response_error['code'] || ''
-      
+
       details = ": #{details};" unless details.empty?
       code = " [code: #{code}]" unless code.empty?
       %Q[#{description}#{details}#{code}]
     end
-  
+
   end
-end
+end

data/lib/viddler/version.rb

@@ -2,7 +2,7 @@ module Viddler #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 2
+    TINY  = 8
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/viddler/video.rb

@@ -1,7 +1,9 @@
 module Viddler
   # This class wraps Viddler's video's information.
   class Video
-  
+    
+    include Comparable
+    
     attr_accessor :id, 
                   :url, 
                   :title, 
@@ -13,56 +15,93 @@ module Viddler
                   :view_count, 
                   :upload_time,
                   :comment_count, 
-                  :update_time, 
                   :permissions, 
-                  :comment_list
+                  :comments,
+                  :width,
+                  :height
   
     def initialize(attributes={}) #:nodoc:
-      a = attributes
-      @id               = a['id']
-      @title            = a['title']
-      @description      = a['description']
-      @tags             = a['tags']
-      @url              = a['url']
-      @thumbnail_url    = a['thumbnail_url']
-      @author           = a['author']
-      @length_seconds   = a['length_seconds'].to_i
-      @view_count       = a['view_count'].to_i
-      @comment_count    = a['comment_count'].to_i
-      @update_time      = a['update_time'] ? Time.at(a['update_time'].to_i) : nil
-      @permissions      = a['permissions'] ? a['permissions'] : nil
-      @comments         = a['comment_list'].values.flatten.collect do |comment| 
+      @id               = attributes['id']
+      @title            = attributes['title']
+      @description      = attributes['description']
+      @tags             = attributes['tags'] ? attributes['tags']['global'].to_a : []
+      @url              = attributes['url']
+      @thumbnail_url    = attributes['thumbnail_url']
+      @author           = attributes['author']
+      @length_seconds   = attributes['length_seconds'].to_i
+      @view_count       = attributes['view_count'].to_i
+      @comment_count    = attributes['comment_count'].to_i
+      @upload_time      = attributes['upload_time'] ? Time.at(attributes['upload_time'].to_i/1000) : nil
+      @permissions      = attributes['permissions'] ? attributes['permissions'] : nil
+      @comments         = attributes['comment_list'].values.flatten.collect do |comment| 
                             Viddler::Comment.new(comment)
-                          end if a['comment_list']
+                          end if attributes['comment_list']
+      @width            = attributes['width'].to_i
+      @height           = attributes['height'].to_i
     end
     
-    # Returns HTML code for video embedding.
+    # Returns proper HTML code for embedding
+    #
+    # <tt>options</tt> hash could contain:
+    # * <tt>player_type:</tt> The type of player to embed, either "simple" or "player" (default is "player");
+    # * <tt>width:</tt> The width of the player (default is 437);
+    # * <tt>height:</tt> The height of the player (default is 370);
+    # * <tt>autoplay:</tt> Whether or not to autoplay the video, either "t" or "f" (default is "f");
+    # * <tt>playAll:</tt> Set to "true" to enable play all player (requires player_type to be "player");
+    #
+    # Any additional options passed to the method will be added as flashvars
+    #
+    # Example:
+    #
+    #  @video.embed_code(:player_type => 'simple', :width => 300, :height => 300, autoplay => 't')
+    #
+    # Returns embed code for auto playing simple player with 300px width and height
+    #
     def embed_code(options={})
-      options = {
+      options.reverse_merge! \
                   :player_type => 'player',
                   :width => 437,
                   :height => 370,
-                  :autoplay => 'f'
-                }.merge(options)
+                  :autoplay => 'f',
+                  :use_secret_url => false
 
       # get non flashvars from options
-      player_type = options.delete(:player_type)
-      width       = options.delete(:width)
-      height      = options.delete(:height)
+      player_type     = options.delete(:player_type)
+      width           = options.delete(:width)
+      height          = options.delete(:height)
+      use_secret_url  = options.delete(:use_secret_url)
 
       flashvars = options.collect{|key,value| "#{key}=#{value}"}.join('&')
 
+      additional = use_secret_url ? "0/#{permissions['view']['secreturl']}/" : ''
+
       html = <<CODE
 <object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="#{width}" height="#{height}" id="viddlerplayer-#{self.id}">
-<param name="movie" value="http://www.viddler.com/#{player_type}/#{self.id}/" />
+<param name="movie" value="http://www.viddler.com/#{player_type}/#{self.id}/#{additional}" />
 <param name="allowScriptAccess" value="always" />
 <param name="allowFullScreen" value="true" />
 <param name="flashvars" value="#{flashvars}" />
-<embed src="http://www.viddler.com/#{player_type}/#{self.id}/" width="#{width}" height="#{height}" type="application/x-shockwave-flash" allowScriptAccess="always" flashvars="#{flashvars}" allowFullScreen="true" name="viddlerplayer-#{self.id}" >
+<embed src="http://www.viddler.com/#{player_type}/#{self.id}/#{additional}" width="#{width}" height="#{height}" type="application/x-shockwave-flash" allowScriptAccess="always" flashvars="#{flashvars}" allowFullScreen="true" name="viddlerplayer-#{self.id}" >
 </embed>
-</object>'
+</object>
 CODE
     end
-  
+    
+    def ==(other)
+      eql?(other)
+    end
+    
+    def eql?(other)
+      id == other.id
+    end
+    
+    def hash
+      id.to_i
+    end
+    
+    def <=>(other)
+      title <=> other.title
+    end
+
   end
-end
+end

data/test/fixtures/embed_code.txt

@@ -0,0 +1,8 @@
+<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="437" height="370" id="viddlerplayer-6a2babb2">
+<param name="movie" value="http://www.viddler.com/player/6a2babb2/" />
+<param name="allowScriptAccess" value="always" />
+<param name="allowFullScreen" value="true" />
+<param name="flashvars" value="autoplay=f" />
+<embed src="http://www.viddler.com/player/6a2babb2/" width="437" height="370" type="application/x-shockwave-flash" allowScriptAccess="always" flashvars="autoplay=f" allowFullScreen="true" name="viddlerplayer-6a2babb2" >
+</embed>
+</object>

data/test/test_helper.rb

@@ -1,2 +1,7 @@
 require 'test/unit'
-require 'viddler'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require File.dirname(__FILE__) + '/../lib/viddler'

data/test/test_viddler.rb

@@ -5,20 +5,31 @@ class ViddlerTest < Test::Unit::TestCase
     def message
       'In order to run this test, insert working Viddler API key inside API_KEY constant.'
     end
-  end  
-  
+  end
+
   class CredentialsRequired < Exception
     def message
       'In order to run this test, insert working Viddler username and password inside LOGIN and PASSWORD constants.'
     end
   end
-  
-  # In order to run the tests you need a working Viddler account and an API key.
-  API_KEY               = nil
-  LOGIN                 = nil
-  PASSWORD              = nil
-  TEST_VIDEO_FILE_PATH  = '/Users/ilya/Desktop/file.mov'
-  
+
+  begin
+    load 'api_settings.rb'
+    raise LoadError unless defined?(API_KEY)
+    raise LoadError unless defined?(LOGIN)
+    raise LoadError unless defined?(PASSWORD)
+    raise LoadError unless defined?(TEST_VIDEO_FILE_PATH)
+  rescue LoadError
+    puts "\n"
+    puts "To run tests, create an test/api_settings.rb file with the following constants:\n\n"
+    puts "API_KEY = 'your_viddler_api_key'"
+    puts "LOGIN = 'your_viddler_login'"
+    puts "PASSWORD = 'your_viddler_password'"
+    puts "TEST_VIDEO_FILE_PATH = '/path/to/video/file'"
+    puts "\n"*2
+    exit
+  end
+
   def setup
     raise KeyRequired unless API_KEY
     @viddler = Viddler::Base.new(API_KEY, LOGIN, PASSWORD)
@@ -29,72 +40,107 @@ class ViddlerTest < Test::Unit::TestCase
     @viddler.authenticate
     assert @viddler.authenticated?
   end
-  
+
   def test_should_get_record_token
     credentials_required
     token = @viddler.get_record_token
     assert_kind_of String, token
   end
-  
+
   def test_should_upload_video
     credentials_required
     file = File.open(TEST_VIDEO_FILE_PATH)
-    video = @viddler.upload_video(:file => file, :title => 'Testing', :description => 'Bla', :tags => 'one, two, three', :make_public => '0')
+    video = @viddler.upload_video(:file => file, :title => 'Testing', :description => 'Bla', :tags => 'one, two, three', :make_public => 1)
+    assert_kind_of Viddler::Video, video
   end
-  
+
+  def test_should_upload_tempfile
+    credentials_required
+    file = File.open(TEST_VIDEO_FILE_PATH)
+    tmpfile = Tempfile.new('viddlertest')
+    tmpfile.write file.read
+    tmpfile.seek 0
+    video = @viddler.upload_video(:file => tmpfile, :title => 'Testing Tempfile', :description => 'tempfile description', :tags => 'one, two, three', :make_public => 1)
+    assert_kind_of Viddler::Video, video
+  end
+
+  # Works in v2 API, use that.
+  # def test_should_delete_video
+  #   credentials_required
+  #   file = File.open(TEST_VIDEO_FILE_PATH)
+  #   video = @viddler.upload_video(:file => file, :title => 'Testing', :description => 'Bla', :tags => 'one, two, three', :make_public => 1)
+  #   assert @viddler.delete_video(video.id)
+  # end
+
+  # doesnt work
+  # def test_should_update_profile
+  #   credentials_required
+  #   user = @viddler.update_profile(:first_name => 'Ilya',
+  #                                  :last_name => 'Sabanin',
+  #                                  :about_me => 'A guy',
+  #                                  :birthdate => '1987-05-22',
+  #                                  :gender => 'm',
+  #                                  :company => 'Wildbit',
+  #                                  :city => 'Krasnoyarsk')
+  #   assert_kind_of Viddler::User, user
+  # end
+
   def test_should_find_profile
     user = @viddler.find_profile('ilya')
     assert_kind_of Viddler::User, user
   end
-  
-  def test_should_update_profile
-    credentials_required
-    user = @viddler.update_profile(:first_name => 'Ilya', 
-                                   :last_name => 'Sabanin', 
-                                   :about_me => 'A guy', 
-                                   :birthdate => '1987-05-22',
-                                   :gender => 'm',
-                                   :company => 'Wildbit',
-                                   :city => 'Krasnoyarsk')
-    assert_kind_of Viddler::User, user
-  end
-  
+
   def test_should_update_account
     credentials_required
     assert @viddler.update_account(:show_account => '0')
   end
-  
+
   def test_should_get_video_status
     assert @viddler.get_video_status('f8605d95')
   end
-  
+
   def test_should_find_video_by_id
     video = @viddler.find_video_by_id('6b0b9af1')
     assert_kind_of Viddler::Video, video
   end
-  
+
+  def test_should_get_dimensions
+    video = @viddler.find_video_by_id('6b0b9af1')
+    assert_equal 640, video.width
+    assert_equal 360, video.height
+  end
+
   def test_should_find_video_by_url
     video = @viddler.find_video_by_url('http://www.viddler.com/explore/ijustine/videos/293/')
     assert_kind_of Viddler::Video, video
   end
-  
+
   def test_should_find_all_videos_by_user
     videos = @viddler.find_all_videos_by_user('ijustine')
     assert_kind_of Viddler::Video, videos.first
   end
   
+  def test_should_update_video
+    credentials_required
+    videos = @viddler.find_all_videos_by_user(LOGIN)
+    raise LoadError, "You must have at least one video in your account to test updates" unless videos.length > 0
+    video = videos.first
+    update = @viddler.update_video(video.id, :title => video.title + ' [test]', :description => video.description + ' [tested]')
+    assert_kind_of Viddler::Video, update
+  end
+
   def test_should_find_all_videos_by_tag
     videos = @viddler.find_all_videos_by_tag('hot')
     assert_kind_of Viddler::Video, videos.first
   end
-  
+
   def test_should_find_all_features_videos
     videos = @viddler.find_all_featured_videos
     assert_kind_of Viddler::Video, videos.first
   end
-  
+
   private
-  
+
   def credentials_required
     raise CredentialsRequired unless LOGIN and PASSWORD
   end