vimeo 1.3.0 → 1.4.0

data/README.markdown

@@ -253,8 +253,8 @@ Some methods have optional variables. Pass these as a hash at the end of a call.
     upload.get_quota
     upload.verify_chunks("ticket_id")
 
-    # supports File, String (a file path), #read
-    upload.upload("movie.mp4")
+    # all-in-one solution, supports File, String (a file path), #read
+    video_id = upload.upload("movie.mp4")
 
 ### Vimeo::Advanced::Video
 
@@ -327,4 +327,4 @@ The upload method will automatically get an upload ticket, perform the multipart
 * [HTTParty](http://github.com/jnunemaker/httparty): Easily one of the best tools I have used since I started using Ruby.
 * [Jeweler](http://github.com/technicalpickles/jeweler): Great tool for creating gems for Github.
 
-### Copyright (c) 2009 Matt Hooks. See LICENSE for details.
+### Copyright (c) 2009-2010 Matt Hooks. See LICENSE for details.

data/VERSION.yml

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

data/lib/vimeo/advanced.rb

@@ -7,6 +7,7 @@ require 'advanced/group'
 require 'advanced/group_events'
 require 'advanced/group_forums'
 require 'advanced/person'
+require 'advanced/simple_upload'
 require 'advanced/test'
 require 'advanced/upload'
 require 'advanced/video'
@@ -14,6 +15,6 @@ require 'advanced/video_embed'
 
 module Vimeo
   module Advanced
-    
+
   end
 end

data/lib/vimeo/advanced/simple_upload.rb

@@ -0,0 +1,46 @@
+module Vimeo
+  module Advanced
+    module SimpleUpload
+      class UploadError < RuntimeError; end
+
+      autoload :Task,         'vimeo/advanced/simple_upload/task'
+      autoload :Chunk,        'vimeo/advanced/simple_upload/chunk'
+
+      # 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
+
+      # Uploads an IO to Vimeo.
+      def upload_io(io, size, filename = 'io.data')
+        raise "#{io.inspect} must respond to #read" unless io.respond_to?(:read)
+        task = Task.new(self, @oauth_consumer, io, size, filename)
+        task.execute
+        task.video_id
+      end
+
+      # Helper for uploading files to Vimeo.
+      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
+    end
+  end
+end

data/lib/vimeo/advanced/simple_upload/chunk.rb

@@ -0,0 +1,50 @@
+module Vimeo
+  module Advanced
+    module SimpleUpload
+      class Chunk
+        MULTIPART_BOUNDARY = "-----------RubyMultipartPost"
+
+        attr_reader :id, :index
+        attr_reader :task, :vimeo
+        attr_reader :data, :size
+
+        def initialize(task, data)
+          @task = task
+          @vimeo = task.vimeo
+          @data = data
+          @size = data.size
+          @index = task.chunks.count
+        end
+
+        # Performs the upload via Multipart.
+        def upload
+          endpoint = "#{task.endpoint}&chunk_id=#{index}"
+
+          response = task.oauth_consumer.request(:post, endpoint, vimeo.get_access_token, {}, {}) do |req|
+            req.set_content_type("multipart/form-data", { "boundary" => MULTIPART_BOUNDARY })
+
+            io = StringIO.new(data)
+            io.instance_variable_set :"@original_filename", task.filename
+            def io.original_filename; @original_filename; end
+            def io.content_type; "application/octet-stream"; end
+
+            parts = []
+            parts << Parts::FilePart.new(MULTIPART_BOUNDARY, "file_data", io)
+            parts << Parts::EpiloguePart.new(MULTIPART_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
+
+          # free memory (for big file uploads)
+          @data = nil
+
+          @id = response.body
+        end
+      end
+    end
+  end
+end

data/lib/vimeo/advanced/simple_upload/task.rb

@@ -0,0 +1,85 @@
+module Vimeo
+  module Advanced
+    module SimpleUpload
+      class Task
+        CHUNK_SIZE = 2 * 1024 * 1024 # 2 megabytes
+
+        attr_reader :vimeo, :oauth_consumer
+        attr_reader :io, :size, :filename
+        attr_reader :chunks, :endpoint
+        attr_reader :id, :video_id
+
+        def initialize(vimeo, oauth_consumer, io, size, filename)
+          @vimeo, @oauth_consumer = vimeo, oauth_consumer
+          @io, @size, @filename = io, size, filename
+          @chunks = []
+        end
+
+        # Uploads the file to Vimeo and returns the +video_id+ on success.
+        def execute
+          check_quota
+          authorize
+          upload
+          raise UploadError.new, "Validation of chunks failed." unless valid?
+          complete
+
+          return video_id
+        end
+
+        protected
+
+        # Checks whether the file can be uploaded.
+        def check_quota
+          quota = vimeo.get_quota
+          free  = quota["user"]["upload_space"]["free"].to_i
+
+          raise UploadError.new, "file size exceeds quota. required: #{size}, free: #{free}" if size > free
+        end
+
+        # Gets a +ticket_id+ for the upload.
+        def authorize
+          ticket = vimeo.get_ticket
+
+          @id             = ticket["ticket"]["id"]
+          @endpoint       = ticket["ticket"]["endpoint"]
+          max_file_size   = ticket["ticket"]["max_file_size"].to_i
+
+          raise UploadError.new, "file was too big: #{size}, maximum: #{max_file_size}" if size > max_file_size
+        end
+
+        # Performs the upload.
+        def upload
+          while (chunk_data = io.read(CHUNK_SIZE)) do
+            chunk = Chunk.new(self, chunk_data)
+            chunk.upload
+            chunks << chunk
+          end
+        end
+
+        # Tells vimeo that the upload is complete.
+        def complete
+          @video_id = vimeo.complete(id, filename)
+        end
+
+        # Compares Vimeo's chunk list with own chunk list. Returns +true+ if identical.
+        def valid?
+          received, sent = received_chunk_sizes, sent_chunk_sizes
+          sent.all? { |id, size| received[id] == size }
+        end
+
+        # Returns a hash of the sent chunks and their respective sizes.
+        def sent_chunk_sizes
+          Hash[chunks.map { |chunk| [chunk.id, chunk.size] }]
+        end
+
+        # Returns a of Vimeo's received chunks and their respective sizes.
+        def received_chunk_sizes
+          verification    = vimeo.verify_chunks(id)
+          chunk_list      = verification["ticket"]["chunks"]["chunk"]
+          chunk_list      = [chunk_list] unless chunk_list.is_a?(Array)
+          Hash[chunk_list.map { |chunk| [chunk["id"], chunk["size"].to_i] }]
+        end
+      end
+    end
+  end
+end

data/lib/vimeo/advanced/upload.rb

@@ -4,14 +4,6 @@ module Vimeo
   module Advanced
 
     class Upload < Vimeo::Advanced::Base
-      class UploadError < RuntimeError; end
-
-      # 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",
@@ -36,106 +28,8 @@ module Vimeo
                         "vimeo.videos.upload.verifyChunks",
                         :required => [:ticket_id]
 
+      include Vimeo::Advanced::SimpleUpload
 
-      # 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

data/lib/vimeo/advanced/video.rb

@@ -105,7 +105,7 @@ module Vimeo
 
       create_api_method :set_title,
                         "vimeo.videos.setTitle",
-                        :required => [:title, :video_id]
+                        :required => [:video_id, :title]
       
       # comments
       create_api_method :add_comment,
@@ -128,4 +128,4 @@ module Vimeo
 
     end # Video
   end # Advanced
-end # Vimeo
+end # Vimeo

data/vimeo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vimeo}
-  s.version = "1.3.0"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Hooks"]
-  s.date = %q{2010-11-12}
+  s.date = %q{2011-03-30}
   s.description = %q{A full featured Ruby implementation of the Vimeo API.}
   s.email = %q{matthooks@gmail.com}
   s.extra_rdoc_files = [
@@ -34,6 +34,9 @@ Gem::Specification.new do |s|
      "lib/vimeo/advanced/group_events.rb",
      "lib/vimeo/advanced/group_forums.rb",
      "lib/vimeo/advanced/person.rb",
+     "lib/vimeo/advanced/simple_upload.rb",
+     "lib/vimeo/advanced/simple_upload/chunk.rb",
+     "lib/vimeo/advanced/simple_upload/task.rb",
      "lib/vimeo/advanced/test.rb",
      "lib/vimeo/advanced/upload.rb",
      "lib/vimeo/advanced/video.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vimeo
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Matt Hooks
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -06:00
+date: 2011-03-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -190,6 +190,9 @@ files:
 - lib/vimeo/advanced/group_events.rb
 - lib/vimeo/advanced/group_forums.rb
 - lib/vimeo/advanced/person.rb
+- lib/vimeo/advanced/simple_upload.rb
+- lib/vimeo/advanced/simple_upload/chunk.rb
+- lib/vimeo/advanced/simple_upload/task.rb
 - lib/vimeo/advanced/test.rb
 - lib/vimeo/advanced/upload.rb
 - lib/vimeo/advanced/video.rb