viddler 0.2.2 → 0.3.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,4 @@
+doc
+log/*.log
+pkg
+test/api_settings.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use viddler_dev

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    viddler (0.3.4)
+      activesupport (>= 3.0.0.rc)
+      mime-types
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.0.rc)
+    mime-types (1.16)
+    rest-client (1.6.0)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0.rc)
+  mime-types
+  rest-client
+  viddler!

data/History.txt

@@ -1,3 +1,12 @@
+== 0.3.1 2010-09-27
+* 1 reenhancement:
+  * Video upload working properly
+  
+
+== 0.2.4 2008-10-20
+* 1 enhancement:
+  * Added dimensions to video
+  
 == 0.2.2 2008-04-19
 
 * 1 enhancement:

data/README.txt

@@ -1,7 +1,8 @@
 = Viddler.rb
 
 * Rubyforge profile: http://viddler.rubyforge.com
-* Source code repository: https://apricode.svn.beanstalkapp.com/gems/trunk/viddler
+* Source code: http://github.com/iSabanin/viddler
+* Tracker: http://ilya_sabanin.lighthouseapp.com/projects/10110-viddler-rb/overview
 
 == DESCRIPTION:
 
@@ -25,11 +26,11 @@ Currently implemented API methods:
 * viddler.videos.getByUser
 * viddler.videos.getByTag
 * viddler.videos.getFeatured
-  
+
 == NOT YET IMPLEMENTED:
 
 * Wrapper for video permissions.
-  
+
 == REQUIREMENTS:
 
 * active_support[http://rubyforge.org/projects/activesupport/]
@@ -38,12 +39,16 @@ Currently implemented API methods:
 
 == INSTALL:
 
-* sudo gem install viddler
+* gem install viddler
 
 == CONTACT:
 
 * ilya dot sabanin at gmail.com
 
+== CONTRIBUTORS:
+
+* Kyle Slattery
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -1,4 +1,78 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
+require 'rubygems'
+require 'rake'
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "viddler"
+    gem.summary = 'Ruby wrapper around Viddler.com API.'
+    gem.email = 'ilya.sabanin@gmail.com'
+    gem.homepage = "http://viddler.rubyforge.org"
+    gem.authors = ["Ilya Sabanin"]
+
+    gem.add_dependency("activesupport", ">= 3.0.0.rc")
+    gem.add_dependency("rest-client")
+    gem.add_dependency("mime-types")
+
+    gem.description = \
+%{Ruby wrapper around Viddler.com[http://www.viddler.com] API.
+
+== FEATURES:
+
+Currently implemented API methods:
+
+* viddler.videos.getRecordToken
+* viddler.users.register
+* viddler.users.auth
+* viddler.users.getProfile
+* viddler.users.setProfile
+* viddler.users.setOptions
+* viddler.videos.upload
+* viddler.videos.getStatus
+* viddler.videos.getDetails
+* viddler.videos.getDetailsByUrl
+* viddler.videos.setDetails
+* viddler.videos.getByUser
+* viddler.videos.getByTag
+* viddler.videos.getFeatured
+}
+
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+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
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test2 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/viddler.rb

@@ -1,13 +1,10 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'rubygems'
-require 'active_support'
+require 'active_support/core_ext/object'
 require 'ostruct'
 
 require 'ext/open_struct'
 require 'ext/hash'
 require 'ext/array'
+
 require 'viddler/api_spec'
 require 'viddler/base'
 require 'viddler/multipart_params'

data/lib/viddler/api_spec.rb

@@ -57,7 +57,7 @@ module Viddler #:nodoc:
     }
     
     VIDEOS_SETDETAILS_ATTRS = {
-      :optional => {
+      :optional => [
         :title,
         :description,
         :tags,
@@ -70,7 +70,7 @@ module Viddler #:nodoc:
         :tagging_perm,
         :download_perm,
         :download_users
-      }
+      ]
     }
     
     def self.check_attributes(viddler_method, attributes)
@@ -91,4 +91,4 @@ module Viddler #:nodoc:
     
   end
   
-end
+end

data/lib/viddler/base.rb

@@ -1,9 +1,9 @@
 module Viddler
-  
+
   # Generic Viddler exception class.
   class ViddlerError < StandardError #:nodoc:
   end
-  
+
   # Raised when username and password has not been set.
   class AuthenticationRequiredError < ViddlerError #:nodoc:
     def message
@@ -17,9 +17,9 @@ module Viddler
       'This method is not yet implemented.'
     end
   end
-  
+
   # A class that can be instantiated for access to a Viddler API.
-  # 
+  #
   # Examples:
   #
   #   @viddler = Viddler::Base.new(API_KEY, USERNAME, PASSWORD)
@@ -29,6 +29,8 @@ module Viddler
   #   @viddler = Viddler::Base.new(YOUR_API_KEY)
   #
   class Base
+    attr_accessor :session_id, :username, :password
+    
     # Creates new viddler instance.
     #
     # Example:
@@ -39,7 +41,7 @@ module Viddler
       @api_key, @username, @password = api_key, username, password
       @session_id = nil
     end
-    
+
     # Implements <tt>viddler.users.auth[http://wiki.developers.viddler.com/index.php/Viddler.users.auth]</tt>.
     #
     # It's not necessary for you to call this method manually before each method that requires authentication. Viddler.rb will do that for you automatically. You can use this method for checking credentials and for trying if connection to Viddler works.
@@ -60,11 +62,11 @@ module Viddler
       end
       @session_id = request.response['auth']['sessionid']
     end
-    
+
     def authenticated?
       @session_id ? true : false
     end
-    
+
     # Implements <tt>viddler.videos.getRecordToken[http://wiki.developers.viddler.com/index.php/Viddler.videos.getRecordToken]</tt>.
     #
     # Example:
@@ -75,7 +77,7 @@ module Viddler
     #
     def get_record_token
       authenticate unless authenticated?
-      
+
       request = Viddler::Request.new(:get, 'videos.getRecordToken')
       request.run do |p|
         p.api_key     = @api_key
@@ -83,7 +85,7 @@ module Viddler
       end
       request.response['record_token']
     end
-    
+
     # Implements <tt>viddler.users.register[http://wiki.developers.viddler.com/index.php/Viddler.users.register]</tt>. <b>Restricted to Viddler qualified API keys only.</b>
     #
     # <tt>new_attributes</tt> hash should contain next required keys:
@@ -108,7 +110,7 @@ module Viddler
     #
     def register_user(new_attributes={})
       Viddler::ApiSpec.check_attributes('users.register', new_attributes)
-      
+
       request = Viddler::Request.new(:get, 'users.register')
       request.run do |p|
         p.api_key     = @api_key
@@ -118,44 +120,33 @@ module Viddler
       end
       request.response['user']['username']
     end
-
-    # Implements <tt>viddler.videos.upload[http://wiki.developers.viddler.com/index.php/Viddler.videos.upload]</tt>. Requires authentication.
-    #
-    # <tt>new_attributes</tt> hash should contain next required keys:
-    # * <tt>title:</tt> The video title;
-    # * <tt>description:</tt> The video description;
-    # * <tt>tags:</tt> The video tags;
-    # * <tt>file:</tt> The video file;
-    # * <tt>make_public:</tt> Use "1" for true and "0" for false to choose whether or not the video goes public when uploaded.
+    
+    # Implements <tt>viddler.videos.delete[http://wiki.developers.viddler.com/index.php/Viddler.videos.delete]</tt>. Requires authentication.
     #
     # Example:
     #
-    #  @viddler.upload_video(:title => 'Great Title', :file => File.open('/movies/movie.mov'), ...)
+    #  @viddler.delete_video(video_id)
     #
-    # Returns Viddler::Video instance. 
+    # Returns true for success or false for failure
     #
-    def upload_video(new_attributes={})
+    def delete_video(video_id)
       authenticate unless authenticated?
-      Viddler::ApiSpec.check_attributes('videos.upload', new_attributes)
-        
-      request = Viddler::Request.new(:post, 'videos.upload')
+      request = Viddler::Request.new(:post, 'videos.delete')
       request.run do |p|
-        p.api_key     = @api_key
-        p.sessionid   = @session_id
-        for param, value in new_attributes
-          p.send("#{param}=", value)
-        end
+        p.api_key   = @api_key
+        p.sessionid = @session_id
+        p.video_id  = video_id
       end
-      Viddler::Video.new(request.response['video'])
+      request.response.key? 'success'
     end
-  
+
     # Implements <tt>viddler.users.getProfile[http://wiki.developers.viddler.com/index.php/Viddler.users.getProfile]</tt>.
     #
     # Example:
     #
     #  @viddler.find_profile(viddler_username)
     #
-    # Returns Viddler::User instance. 
+    # Returns Viddler::User instance.
     #
     def find_profile(viddler_name)
       request = Viddler::Request.new(:get, 'users.getProfile')
@@ -165,7 +156,7 @@ module Viddler
       end
       Viddler::User.new request.response['user']
     end
-    
+
     # Implements <tt>viddler.users.setProfile[http://wiki.developers.viddler.com/index.php/Viddler.users.setProfile]</tt>. Requires authentication.
     #
     # <tt>new_attributes</tt> hash could contain next optional keys:
@@ -181,12 +172,12 @@ module Viddler
     #
     #  @viddler.update_profile(:first_name => 'Vasya', :last_name => 'Pupkin')
     #
-    # Returns Viddler::User instance. 
+    # Returns Viddler::User instance.
     #
     def update_profile(new_attributes={})
       authenticate unless authenticated?
       Viddler::ApiSpec.check_attributes('users.setProfile', new_attributes)
-      
+
       request = Viddler::Request.new(:post, 'users.setProfile')
       request.run do |p|
         p.api_key   = @api_key
@@ -197,7 +188,7 @@ module Viddler
       end
       Viddler::User.new request.response['user']
     end
-  
+
     # Implements <tt>viddler.users.setOptions[http://wiki.developers.viddler.com/index.php/Viddler.users.setOptions]</tt>. Requires authentication. <b>Restricted to Viddler partners only.</b>
     #
     # <tt>new_attributes</tt> hash could contain next optional keys:
@@ -221,7 +212,7 @@ module Viddler
     def update_account(new_attributes={})
       authenticate unless authenticated?
       Viddler::ApiSpec.check_attributes('users.setOptions', new_attributes)
-      
+
       request = Viddler::Request.new(:get, 'users.setOptions')
       request.run do |p|
         p.api_key   = @api_key
@@ -232,7 +223,7 @@ module Viddler
       end
       request.response['updated'].to_i
     end
-  
+
     # Implements <tt>viddler.videos.getStatus[http://wiki.developers.viddler.com/index.php/Viddler.vidoes.getStatus]</tt>.
     #
     # Example:
@@ -247,9 +238,9 @@ module Viddler
         p.api_key     = @api_key
         p.video_id    = video_id
       end
-      OpenStruct.new request.response['video_status']      
+      OpenStruct.new request.response['video_status']
     end
-  
+
     # Implements <tt>viddler.videos.getDetails[http://wiki.developers.viddler.com/index.php/Viddler.videos.getDetails]</tt>. Authentication is optional.
     #
     # Example:
@@ -261,7 +252,7 @@ module Viddler
     def find_video_by_id(video_id)
       # Authentication is optional for this request
       authenticate if could_authenticate? and !authenticated?
-    
+
       request = Viddler::Request.new(:get, 'videos.getDetails')
       request.run do |p|
         p.api_key     = @api_key
@@ -270,7 +261,7 @@ module Viddler
       end
       Viddler::Video.new(request.response['video'])
     end
-    
+
     # Implements <tt>viddler.videos.getDetailsByUrl[http://wiki.developers.viddler.com/index.php/Viddler.videos.getDetailsByUrl]</tt>. Authentication is optional.
     #
     # Example:
@@ -282,16 +273,16 @@ module Viddler
     def find_video_by_url(video_url)
       # Authentication is optional for this request
       authenticate if could_authenticate? and !authenticated?
-    
+
       request = Viddler::Request.new(:get, 'videos.getDetailsByUrl')
       request.run do |p|
         p.sessionid   = @session_id if authenticated?
         p.api_key     = @api_key
-        p.url         = video_url      
+        p.url         = video_url
       end
       Viddler::Video.new(request.response['video'])
     end
-  
+
     # Implements <tt>viddler.videos.setDetails[http://wiki.developers.viddler.com/index.php/Viddler.videos.setDetails]</tt>. Requires authentication.
     #
     # <tt>new_attributes</tt> hash could contain next optional keys:
@@ -319,7 +310,7 @@ module Viddler
     def update_video(video_id, new_attributes={})
       authenticate unless authenticated?
       Viddler::ApiSpec.check_attributes('videos.setDetails', new_attributes)
-      
+
       request = Viddler::Request.new(:get, 'videos.setDetails')
       request.run do |p|
         p.api_key   = @api_key
@@ -331,7 +322,59 @@ module Viddler
       end
       Viddler::Video.new(request.response['video'])
     end
-  
+
+    def set_permalink(video_id, url)
+      authenticate unless authenticated?
+
+      request = Viddler::Request.new(:post, 'videos.setPermalink')
+      request.run do |p|
+        p.api_key   = @api_key
+        p.sessionid = @session_id
+        p.video_id  = video_id
+        p.permalink  = url
+      end
+    end
+    
+    # Implements <tt>viddler.videos.upload[http://wiki.developers.viddler.com/index.php/Viddler.videos.upload]</tt>. Requires authentication.
+    #
+    # <tt>new_attributes</tt> hash should contain all required keys:
+    # * <tt>title:</tt> The video title;
+    # * <tt>description:</tt> The video description;
+    # * <tt>tags:</tt> The video tags;
+    # * <tt>file:</tt> The video file;
+    # * <tt>make_public:</tt> Use "1" for true and "0" for false to choose whether or not the video goes public when uploaded.
+    #
+    # Example:
+    #
+    #  @viddler.upload_video(:title => 'Great Title', :file => File.open('/movies/movie.mov'), ...)
+    #
+    # Returns Viddler::Video instance. 
+    #
+    def upload_video(new_attributes={})
+      authenticate unless authenticated?
+      Viddler::ApiSpec.check_attributes('videos.upload', new_attributes)
+
+      # Get an upload endpoint
+      # request = Viddler::Request.new(:post, 'viddler.videos.prepareUpload')
+      # request.run do |p|
+      #   p.api_key     = @api_key
+      #   p.sessionid   = @session_id
+      # end
+      # endpoint = request.response['upload']['endpoint'] 
+    
+      # Upload to endpoint url
+      request = Viddler::Request.new(:post, 'videos.upload')
+      # request.url = endpoint
+      request.run do |p|
+        p.api_key     = @api_key
+        p.sessionid   = @session_id
+        for param, value in new_attributes
+          p.send("#{param}=", value)
+        end
+      end
+      Viddler::Video.new(request.response['video'])
+    end
+
     # Implements <tt>viddler.videos.getByUser[http://wiki.developers.viddler.com/index.php/Viddler.videos.getByUser]</tt>. Authentication is optional.
     #
     # Options hash could contain next values:
@@ -346,20 +389,20 @@ module Viddler
     #
     def find_all_videos_by_user(username, options={})
       authenticate if could_authenticate? and !authenticated?
-    
+
       options.assert_valid_keys(:page, :per_page)
-    
+
       request = Viddler::Request.new(:get, 'videos.getByUser')
       request.run do |p|
         p.api_key     = @api_key
-        p.sessionid   = @session_id if authenticated?
+        p.sessionid   = @session_id
         p.user        = username
         p.page        = options[:page] || 1
-        p.per_page    = options[:per_page] || 20      
+        p.per_page    = options[:per_page] || 20
       end
-      parse_videos_list(request.response['video_list'])    
+      parse_videos_list(request.response['video_list'])
     end
-    
+
     # Implements <tt>viddler.videos.getByTag[http://wiki.developers.viddler.com/index.php/Viddler.videos.getByTag]</tt>.
     #
     # Options hash could contain next values:
@@ -374,7 +417,7 @@ module Viddler
     #
     def find_all_videos_by_tag(tag_name, options={})
       options.assert_valid_keys(:page, :per_page)
-    
+
       request = Viddler::Request.new(:get, 'videos.getByTag')
       request.run do |p|
         p.api_key     = @api_key
@@ -384,7 +427,7 @@ module Viddler
       end
       parse_videos_list(request.response['video_list'])
     end
-    
+
     # Implements <tt>viddler.videos.getFeatured[http://wiki.developers.viddler.com/index.php/Viddler.videos.getFeatured]</tt>.
     #
     # Example:
@@ -393,25 +436,37 @@ module Viddler
     #
     # Returns array of Viddler::Video instances.
     #
-    def find_all_featured_videos    
+    def find_all_featured_videos
       request = Viddler::Request.new(:get, 'videos.getFeatured')
       request.run do |p|
         p.api_key     = @api_key
       end
       parse_videos_list(request.response['video_list'])
     end
-  
+
+    def delete_comment(id)
+      authenticate unless authenticated?
+      request = Viddler::Request.new(:post, 'videos.comments.remove')
+      request.run do |p|
+        p.api_key     = @api_key
+        p.sessionid   = @session_id
+        p.comment_id  = id
+      end
+    end
+
     private
-    
+
     def could_authenticate?
       @username and @password
     end
-  
+
     def parse_videos_list(video_list)
-      video_list['video'].collect do |attr|
+      Array.wrap(video_list['video']).collect do |attr|
         next unless attr.is_a?(Hash)
         Viddler::Video.new(attr)
       end
+
     end
   end
-end
+
+end