vimeo 1.2.2 → 1.3.0

data/README.markdown

@@ -2,10 +2,7 @@
 
 This gem implements a full-featured Ruby interface for the Vimeo API v2.
 
-For a more in depth look at the API check out [Vimeo's Simple API Documentation](http://www.vimeo.com/api/docs/simple-api) or [Vimeo's Advanced API Documentation](http://www.vimeo.com/api/docs/advanced-api). I would also recommend checking out the [API Forums](http://www.vimeo.com/forum:api) if
-things aren't working as they should.
-
-__I have been experiencing trouble with intermittent 303 errors (Invalid Signature). As far as I can tell, this is a server-side issue.__
+For a more in depth look at the API check out [Vimeo's Simple API Documentation](http://www.vimeo.com/api/docs/simple-api) or [Vimeo's Advanced API Documentation](http://www.vimeo.com/api/docs/advanced-api). I would also recommend checking out the [API Forums](http://www.vimeo.com/forum:api) if things aren't working as they should.
 
 ## Install
 
@@ -17,6 +14,10 @@ If you're using Rails, add the following to your environment.rb file:
 
     config.gem "vimeo"
 
+Or for bundler:
+
+gem 'vimeo'
+
 ## How to Use
 
 There are two modules:
@@ -43,7 +44,7 @@ The wrapper for the Simple API consists of several classes. To use the Simple AP
     #   "bio":"",
     #   "profile_url":"http:\/\/vimeo.com\/matthooks",
     #   "videos_url":"http:\/\/vimeo.com\/matthooks\/videos",
-    #   "total_videos_uploaded":2,
+    #   "total_videos_appears_ined":2,
     #   "total_videos_appears_in":0,
     #   "total_videos_liked":2,
     #   "total_contacts":3,
@@ -74,7 +75,7 @@ Thanks to HTTParty, the data is parsed and ready to use.
 
     Vimeo::Simple::Album.videos("album_id")
     Vimeo::Simple::Album.info("album_id")
-  
+
 ### Vimeo::Simple::Channel
 
     Vimeo::Simple::Channel.videos("channelname")
@@ -116,8 +117,8 @@ First, instantiate the Base class:
 
 Get a request token, and save the token secret in the session hash.
 
-	request_token = base.get_request_token
-	session[:oauth_secret] = request_token.secret
+    request_token = base.get_request_token
+    session[:oauth_secret] = request_token.secret
 
 Then, send your user to the authorization URL:
 
@@ -131,7 +132,7 @@ Once the user has allowed your application to access their account, they will be
     user.token = access_token.token
     user.secret = access_token.secret
     user.save
-  
+
 Now you've got everything you need to use the Advanced API. Let's get a user's videos:
 
     video = Vimeo::Advanced::Video.new("consumer_key", "consumer_secret", :token => user.token, :secret => user.secret)
@@ -160,13 +161,13 @@ Some methods have optional variables. Pass these as a hash at the end of a call.
     album.set_description("album_id", "description")
     album.get_password("album_id", "password")
     album.get_title("album_id", "title")
-  
+
 ### Vimeo::Advanced::Base
 
     base = Vimeo::Advanced::Base.new("consumer_key", "consumer_secret", :token => user.token, :secret => user.secret)
 
     base.check_access_token
-  
+
 ### Vimeo::Advanced::Channel
 
     channel = Vimeo::Advanced::Channel.new("consumer_key", "consumer_secret", :token => user.token, :secret => user.secret)
@@ -245,11 +246,15 @@ Some methods have optional variables. Pass these as a hash at the end of a call.
 
     upload = Vimeo::Advanced::Upload.new("consumer_key", "consumer_secret", :token => user.token, :secret => user.secret)
 
-    upload.confirm("ticket_id", "json_manifest")
-    upload.get_quota
+    # Other than get_quota, none of these methods should be called directly. The 'upload' method uses these internally.
+    upload.check_ticket("ticket_id")
+    upload.complete("ticket_id", "filename")
     upload.get_ticket
-    upload.upload("path_to_file", "ticket_id", "end_point")
-    upload.verify_manifest("ticket_id", "json_manifest")
+    upload.get_quota
+    upload.verify_chunks("ticket_id")
+
+    # supports File, String (a file path), #read
+    upload.upload("movie.mp4")
 
 ### Vimeo::Advanced::Video
 
@@ -294,7 +299,15 @@ Some methods have optional variables. Pass these as a hash at the end of a call.
 
 ## Uploads
 
-__Uploads are not working since the move to OAuth. They will be fixed shortly.__
+Uploads are working! In order to upload a file, create your upload object, like so:
+
+    upload = Vimeo::Advanced::Upload.new("consumer_key", "consumer_secret", :token => user.token, :secret => user.secret)
+
+Then call the upload method:
+
+    upload.upload("/path/to/file") # You can also pass a File object or any IO.
+
+The upload method will automatically get an upload ticket, perform the multipart POST, verify the file chunks and then complete the upload.
 
 ## Todo
 

data/Rakefile

@@ -15,16 +15,17 @@ begin
     gem.add_development_dependency "fakeweb", ">= 1.2.6"
     gem.add_development_dependency "crack", ">= 0.1.4"
     gem.add_development_dependency "ruby-prof", ">= 0.9.2"
-    
+
     gem.has_rdoc = true
-    
+
     gem.rdoc_options = ['--main', 'README.rdoc', '--inline-source', '--charset=UTF-8']
     gem.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'CHANGELOG.rdoc']
-    
+
     gem.add_dependency "httparty", ">= 0.4.5"
     gem.add_dependency "json", ">= 1.1.9"
-    gem.add_dependency "oauth", ">= 0.3.6"
+    gem.add_dependency "oauth", ">= 0.4.3"
     gem.add_dependency "httpclient", ">= 2.1.5.2"
+    gem.add_dependency "multipart-post", ">= 1.0.1"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -55,6 +56,36 @@ task :test => :check_dependencies
 
 task :default => :test
 
+namespace :vimeo do
+  desc "Multi-step wizard to acquire an access_token. CONSUMER_KEY and CONSUMER_SECRET required."
+  task :auth do
+    require 'vimeo'
+
+    def ask(message)
+      print message
+      STDOUT.flush
+      STDIN.gets.chomp
+    end
+
+    consumer_key = ENV['CONSUMER_KEY']
+    consumer_secret = ENV['CONSUMER_SECRET']
+    base = Vimeo::Advanced::Base.new(consumer_key, consumer_secret)
+
+    request_token = base.get_request_token
+    oauth_secret = request_token.secret
+
+    puts "Please visit: #{base.authorize_url}"
+
+    oauth_token = ask("oauth_token=")
+    oauth_verifier = ask("oauth_verifier=")
+
+    access_token = base.get_access_token(oauth_token, oauth_secret, oauth_verifier)
+
+    puts "token: #{access_token.token}"
+    puts "secret: #{access_token.secret}"
+  end
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 2
-:build: 
-:patch: 2
+:patch: 0
 :major: 1
+:build: 
+:minor: 3

data/lib/vimeo.rb

@@ -2,6 +2,8 @@ require 'rubygems'
 require 'httparty'
 require 'digest/md5'
 
+require 'net/http/post/multipart'
+
 $:.unshift(File.dirname(__FILE__))
 require 'vimeo/simple'
 require 'vimeo/advanced'

data/lib/vimeo/advanced/base.rb

@@ -66,6 +66,8 @@ module Vimeo
 
     class Base
       extend CreateApiMethod
+      
+      ENDPOINT = "http://vimeo.com/api/rest/v2"
 
       def initialize(consumer_key, consumer_secret, options = {})
         @oauth_consumer = OAuth::Consumer.new(consumer_key, consumer_secret, :site => 'http://vimeo.com', :http_method => :get, :scheme => :header)
@@ -94,9 +96,9 @@ private
 
       def make_request(options, authorized)
         if authorized
-          raw_response = @oauth_consumer.request(:post, "http://vimeo.com/api/rest/v2", get_access_token, {}, options).body
+          raw_response = @oauth_consumer.request(:post, Vimeo::Advanced::Base::ENDPOINT, get_access_token, {}, options).body
         else
-          raw_response = @oauth_consumer.request(:post, "http://vimeo.com/api/rest/v2", nil, {}, options).body
+          raw_response = @oauth_consumer.request(:post, Vimeo::Advanced::Base::ENDPOINT, nil, {}, options).body
         end
         
         response = Crack::JSON.parse(raw_response)

data/lib/vimeo/advanced/upload.rb

@@ -1,57 +1,141 @@
-require 'httpclient'
 require 'json'
 
 module Vimeo
   module Advanced
 
     class Upload < Vimeo::Advanced::Base
+      class UploadError < RuntimeError; end
 
-      # TODO: Make this work with either a JSON or an XML manifest.
-      # Confirms the upload process.
-      create_api_method :confirm,
-                        "vimeo.videos.upload.confirm",
+      # 2 megabytes
+      CHUNK_SIZE = 2 * 1024 * 1024
+
+      # multipart boundary
+      BOUNDARY = "-----------RubyMultipartPost"
+
+      # Check to make sure an upload ticket is still valid.
+      create_api_method :check_ticket,
+                        "vimeo.videos.upload.checkTicket",
                         :required => [:ticket_id]
-      
-      # "{\"files\":[{\"md5\":\"731f09145a1ea9ec9dad689de6fa0358\"}]}"
+
+      # Complete the upload process.
+      create_api_method :complete,
+                        "vimeo.videos.upload.complete",
+                        :required => [:ticket_id, :filename]
+
+      # Returns an upload ticket.
+      create_api_method :get_ticket,
+                        "vimeo.videos.upload.getTicket",
+                        :optional => [:video_id]
 
       # Returns the space and HD uploads left for a user.
       create_api_method :get_quota,
                         "vimeo.videos.upload.getQuota"
-                        
-      # Returns an upload ticket.
-      create_api_method :get_ticket,
-                        "vimeo.videos.upload.getTicket"
-
-      # Upload +file+ to vimeo with +ticket_id+ and +auth_token+
-      # Returns the json manifest necessary to confirm the upload.
-      def upload(auth_token, file_path, ticket_id, end_point)
-        params = {
-          :auth_token => auth_token,
-          :ticket_id  => ticket_id
-        }
-        params[:api_sig] = generate_api_sig params
-        
-        params.merge!({ :file_data => File.open(file_path) })
-        
-        client = HTTPClient.new
-        response = client.post(end_point, params)
-        md5 = response.content
-
-        self.class.create_json_manifest(md5)
-      end
 
-      # TODO: Make this work with either json or xml manifest.
-      # FIXME: Ticket id is required?
-      # Verifies a file manifest.
-      create_api_method :verify_manifest,
-                        "vimeo.videos.upload.verifyManifest",
+      # Verify that the chunks were uploaded properly.
+      create_api_method :verify_chunks,
+                        "vimeo.videos.upload.verifyChunks",
                         :required => [:ticket_id]
 
-      # TODO: Make this more flexible for split uploads?
-      def self.create_json_manifest(md5s)
-        { :files => md5s.map { |md5| { :md5 => md5 } } }.to_json
+
+      # Uploads data (IO streams or files) to Vimeo.
+      def upload(uploadable)
+        case uploadable
+        when File
+          upload_file(uploadable)
+        when String
+          upload_file(File.new(uploadable))
+        else
+          upload_io(uploadable)
+        end
+      end
+
+      protected
+
+      def upload_chunk(chunk_id, data, endpoint, filename)
+        endpoint += "&chunk_id=#{chunk_id}"
+
+        response = @oauth_consumer.request(:post, endpoint, get_access_token, {}, {}) do |req|
+          req.set_content_type("multipart/form-data", { "boundary" => BOUNDARY })
+
+          io = StringIO.new(data)
+          io.instance_variable_set :"@original_filename", filename
+          def io.original_filename; @original_filename; end
+          def io.content_type; "application/octet-stream"; end
+
+          parts = []
+          parts << Parts::FilePart.new(BOUNDARY, "file_data", io)
+          parts << Parts::EpiloguePart.new(BOUNDARY)
+
+          ios                = parts.map{|p| p.to_io }
+          req.content_length = parts.inject(0) {|sum,i| sum + i.length }
+          req.body_stream    = CompositeReadIO.new(*ios)
+
+          :continue
+        end
+
+        response.body
       end
 
+      def upload_io(io, size, filename = 'io.data')
+        raise "#{io.inspect} must respond to #read" unless io.respond_to?(:read)
+
+        quota_response = get_quota
+        user           = quota_response["user"]
+        upload_space   = user["upload_space"]
+        free           = upload_space["free"].to_i
+
+        raise UploadError.new, "file size exceeds quota. required: #{size}, free: #{free}" if size > free
+
+        ticket_response = get_ticket
+        ticket          = ticket_response["ticket"]
+        max_file_size   = ticket["max_file_size"].to_i
+        ticket_id       = ticket["id"]
+        endpoint        = ticket["endpoint"]
+
+        raise UploadError.new, "file was too big: #{size}, maximum: #{max_file_size}" if size > max_file_size
+
+        chunk_sizes = {}
+        chunk_index = 0
+
+        while (chunk = io.read(CHUNK_SIZE)) do
+
+          chunk_id              = upload_chunk(chunk_index, chunk, endpoint, filename)
+          chunk_sizes[chunk_id] = chunk.length
+          chunk_index           += 1
+        end
+
+        validate_chunks_after_upload(ticket_id, chunk_sizes)
+
+        complete(ticket_id, filename)
+      end
+
+      def upload_file(file)
+        file_path = file.path
+
+        size     = File.size(file_path)
+        basename = File.basename(file_path)
+        io       = File.open(file_path)
+        io.binmode
+
+        upload_io(io, size, basename).tap do
+          io.close
+        end
+      end
+
+      def validate_chunks_after_upload(ticket_id, chunk_sizes)
+        verification    = verify_chunks(ticket_id)
+        ticket          = verification["ticket"]
+        chunk_list      = Array(ticket["chunks"]["chunk"])
+        received_chunks = Hash[chunk_list.map { |chunk| [chunk["id"], chunk["size"].to_i] }]
+
+        chunk_sizes.each do |id, size|
+          vimeo_size = received_chunks[id]
+
+          if vimeo_size != size
+            raise UploadError.new, "Chunk (id: #{id}) was invalid - was: #{vimeo_size}, should be: #{size}."
+          end
+        end
+      end
     end # Upload
   end # Advanced
-end # Vimeo
+end # Vimeo

data/test/vimeo/advanced/upload_test.rb

@@ -3,48 +3,23 @@ require 'test_helper'
 class UploadTest < Test::Unit::TestCase
 
   context "vimeo advanced upload" do
-    
+
     setup do
       @upload = Vimeo::Advanced::Upload.new("12345", "secret", :token => "token", :secret => "secret")
     end
 
-    should "be able confirm an upload" do
-      stub_post("?api_key=12345&ticket_id=ticket_id&format=json&auth_token=token&api_sig=576b41966709651aead8754b3c5d370d&method=vimeo.videos.upload.confirm", "advanced/upload/confirm.json")
-      response = @upload.confirm("ticket_id")
-
-      assert_equal "ticket_id", response["ticket"]["id"]
-    end
-    
     should "be able to get a user's quota" do
       stub_post("?api_key=12345&auth_token=token&format=json&api_sig=4eb2da55156fca5ab81bfe1a67a016ec&method=vimeo.videos.upload.getQuota", "advanced/upload/get_quota.json")
       response = @upload.get_quota
-      
+
       assert_equal "888046", response["user"]["id"]
     end
-    
+
     should "be able to get an upload ticket" do
       stub_post("?api_key=12345&auth_token=token&format=json&api_sig=0eabe7404e1c1fd22a269190c36e4093&method=vimeo.videos.upload.getTicket", "advanced/upload/get_ticket.json")
       response = @upload.get_ticket
-      
-      assert_equal "ticket_id", response["ticket"]["id"]
-    end
 
-    # TODO: Stub out the HTTPClient calls correctly since FakeWeb doesn't work here.
-    # should "be able to upload a file to vimeo" do
-    #   HTTPClient.any_instance.stubs(:post)
-    #   file_path = File.expand_path(File.dirname(__FILE__) + "../../../fixtures/advanced/upload/sample_iTunes.mov")
-    #   response = @upload.upload(file_path, "ticket_id", "http:\/\/67.202.6.15\/upload_multi?ticket_id=ticket_id")
-    # 
-    #   assert_equal "MD5", response
-    # end
-    
-    # TODO: Make sure this manifest fixture file is right.
-    should "be able to verify a file manifest" do
-      stub_post("?api_key=12345&ticket_id=ticket_id&format=json&auth_token=token&api_sig=3b1c022ba0be09e5901bd91fb5a4426c&method=vimeo.videos.upload.verifyManifest", "advanced/upload/verify_manifest.json")
-      response = @upload.verify_manifest("ticket_id")
-      
       assert_equal "ticket_id", response["ticket"]["id"]
     end
-
   end
 end

data/vimeo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vimeo}
-  s.version = "1.2.2"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Hooks"]
-  s.date = %q{2010-09-18}
+  s.date = %q{2010-11-12}
   s.description = %q{A full featured Ruby implementation of the Vimeo API.}
   s.email = %q{matthooks@gmail.com}
   s.extra_rdoc_files = [
@@ -100,12 +100,9 @@ Gem::Specification.new do |s|
      "test/fixtures/advanced/test/echo.json",
      "test/fixtures/advanced/test/login.json",
      "test/fixtures/advanced/test/null.json",
-     "test/fixtures/advanced/upload/confirm.json",
      "test/fixtures/advanced/upload/get_quota.json",
      "test/fixtures/advanced/upload/get_ticket.json",
-     "test/fixtures/advanced/upload/manifest_to_upload.json",
      "test/fixtures/advanced/upload/sample_iTunes.mov",
-     "test/fixtures/advanced/upload/verify_manifest.json",
      "test/fixtures/advanced/video/add_cast.json",
      "test/fixtures/advanced/video/add_comment.json",
      "test/fixtures/advanced/video/add_photos.json",
@@ -227,8 +224,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ruby-prof>, [">= 0.9.2"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.4.5"])
       s.add_runtime_dependency(%q<json>, [">= 1.1.9"])
-      s.add_runtime_dependency(%q<oauth>, [">= 0.3.6"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0.4.3"])
       s.add_runtime_dependency(%q<httpclient>, [">= 2.1.5.2"])
+      s.add_runtime_dependency(%q<multipart-post>, [">= 1.0.1"])
     else
       s.add_dependency(%q<shoulda>, [">= 2.11.3"])
       s.add_dependency(%q<fakeweb>, [">= 1.2.6"])
@@ -236,8 +234,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<ruby-prof>, [">= 0.9.2"])
       s.add_dependency(%q<httparty>, [">= 0.4.5"])
       s.add_dependency(%q<json>, [">= 1.1.9"])
-      s.add_dependency(%q<oauth>, [">= 0.3.6"])
+      s.add_dependency(%q<oauth>, [">= 0.4.3"])
       s.add_dependency(%q<httpclient>, [">= 2.1.5.2"])
+      s.add_dependency(%q<multipart-post>, [">= 1.0.1"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 2.11.3"])
@@ -246,8 +245,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<ruby-prof>, [">= 0.9.2"])
     s.add_dependency(%q<httparty>, [">= 0.4.5"])
     s.add_dependency(%q<json>, [">= 1.1.9"])
-    s.add_dependency(%q<oauth>, [">= 0.3.6"])
+    s.add_dependency(%q<oauth>, [">= 0.4.3"])
     s.add_dependency(%q<httpclient>, [">= 2.1.5.2"])
+    s.add_dependency(%q<multipart-post>, [">= 1.0.1"])
   end
 end
 

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 2
-  version: 1.2.2
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Matt Hooks
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-18 00:00:00 -05:00
+date: 2010-11-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,12 +122,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 9
         segments: 
         - 0
+        - 4
         - 3
-        - 6
-        version: 0.3.6
+        version: 0.4.3
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
@@ -147,6 +147,22 @@ dependencies:
         version: 2.1.5.2
   type: :runtime
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id009
 description: A full featured Ruby implementation of the Vimeo API.
 email: matthooks@gmail.com
 executables: []
@@ -240,12 +256,9 @@ files:
 - test/fixtures/advanced/test/echo.json
 - test/fixtures/advanced/test/login.json
 - test/fixtures/advanced/test/null.json
-- test/fixtures/advanced/upload/confirm.json
 - test/fixtures/advanced/upload/get_quota.json
 - test/fixtures/advanced/upload/get_ticket.json
-- test/fixtures/advanced/upload/manifest_to_upload.json
 - test/fixtures/advanced/upload/sample_iTunes.mov
-- test/fixtures/advanced/upload/verify_manifest.json
 - test/fixtures/advanced/video/add_cast.json
 - test/fixtures/advanced/video/add_comment.json
 - test/fixtures/advanced/video/add_photos.json

data/test/fixtures/advanced/upload/confirm.json

@@ -1,9 +0,0 @@
-{
-  "stat":"ok",
-  "generated_in":"38.5153",
-  "ticket": {
-    "video_id":"6777401",
-    "id":"ticket_id",
-    "manifest":"MD5"
-  }
-}

data/test/fixtures/advanced/upload/manifest_to_upload.json

@@ -1,6 +0,0 @@
-{
-    "files": [{
-        "md5":
-        "718a4221052e81534696bc84ef5bc195"
-    }]
-}

data/test/fixtures/advanced/upload/verify_manifest.json

@@ -1,11 +0,0 @@
-{
-  "ticket":{
-    "id":"ticket_id",
-    "md5":"MD5",
-    "missing_files":[{
-      "file":{
-        "md5":"MD5"
-      }
-    }]
-  }
-}