slainer68_vimeo 1.4.3

data/lib/vimeo/advanced/channel.rb

@@ -0,0 +1,55 @@
+module Vimeo
+  module Advanced
+    class Channel < Vimeo::Advanced::Base
+
+      # Adds a video to a channel.
+      create_api_method :add_video,
+                        "vimeo.channels.addVideo",
+                        :required => [:channel_id, :video_id]
+                        
+      # Returns a list of all channels.
+      create_api_method :get_all,
+                        "vimeo.channels.getAll",
+                        :optional => [:page, :per_page, :sort, :user_id]
+
+      # Returns information about a channel.
+      create_api_method :get_info,
+                        "vimeo.channels.getInfo",
+                        :required => [:channel_id]
+      
+      # Returns a list of the moderators of a channel.
+      create_api_method :get_moderators,
+                        "vimeo.channels.getModerators",
+                        :required => [:channel_id],
+                        :optional => [:page, :per_page]
+      
+      # Returns a list of the subscribers of a channel.
+      create_api_method :get_subscribers,
+                        "vimeo.channels.getSubscribers",
+                        :required => [:channel_id],
+                        :optional => [:page, :per_page]
+                        
+      # Returns a list of the videos in a channel.
+      create_api_method :get_videos,
+                        "vimeo.channels.getVideos",
+                        :required => [:channel_id],
+                        :optional => [:page, :per_page, :full_response]
+                        
+      # Removes a video from a channel.
+      create_api_method :remove_video,
+                        "vimeo.channels.removeVideo",
+                        :required => [:channel_id, :video_id]
+      
+      # Subscribes to a channel
+      create_api_method :subscribe,
+                        "vimeo.channels.subscribe",
+                        :required => [:channel_id]
+      
+      # Unsubscribes from a channel
+      create_api_method :unsubscribe,
+                        "vimeo.channels.unsubscribe",
+                        :required => [:channel_id]
+
+    end # Channel
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/contact.rb

@@ -0,0 +1,30 @@
+module Vimeo
+  module Advanced
+    class Contact < Vimeo::Advanced::Base
+
+      # Returns a list of a user's contacts.
+      create_api_method :get_all,
+                        "vimeo.contacts.getAll",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :sort]
+
+      # Returns a list of your mutual contacts with a user.
+      create_api_method :get_mutual,
+                        "vimeo.contacts.getMutual",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page]
+
+      # Returns a list of your contacts who are online.
+      create_api_method :get_online,
+                        "vimeo.contacts.getOnline",
+                        :optional => [:page, :per_page]
+      
+      # Returns a list of users who added a user as a contact.
+      create_api_method :get_who_added,
+                        "vimeo.contacts.getWhoAdded",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :sort]
+
+    end # Contact
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/group.rb

@@ -0,0 +1,62 @@
+module Vimeo
+  module Advanced
+    class Group < Vimeo::Advanced::Base
+
+      # Adds a video to a group.
+      create_api_method :add_video,
+                        "vimeo.groups.addVideo",
+                        :required => [:group_id, :video_id]
+
+      # Returns a list of all groups.
+      create_api_method :get_all,
+                        "vimeo.groups.getAll",
+                        :optional => [:page, :per_page, :sort, :user_id]
+      
+      # Returns a list of a group's files.
+      create_api_method :get_files,
+                        "vimeo.groups.getFiles",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+      # Returns information about a group.
+      create_api_method :get_info,
+                        "vimeo.groups.getInfo",
+                        :required => [:group_id]
+
+      # Returns a list of the members in a group.
+      create_api_method :get_members,
+                        "vimeo.groups.getMembers",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page, :sort]
+      
+      # Returns a list of the moderators of a group.
+      create_api_method :get_moderators,
+                        "vimeo.groups.getModerators",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+      # Returns a list of the comments on a video in a group.
+      create_api_method :get_video_comments,
+                        "vimeo.groups.getVideoComments",
+                        :required => [:group_id, :video_id],
+                        :optional => [:page, :per_page]
+                        
+      # Returns a list of the videos in a group.
+      create_api_method :get_videos,
+                        "vimeo.groups.getVideos",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page, :sort, :full_response]
+
+      # Joins a group.
+      create_api_method :join,
+                        "vimeo.groups.join",
+                        :required => [:group_id]
+      
+      # Leaves a group.
+      create_api_method :leave,
+                        "vimeo.groups.leave",
+                        :required => [:group_id]
+
+    end # Group
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/group_events.rb

@@ -0,0 +1,25 @@
+module Vimeo
+  module Advanced
+    class GroupEvents < Vimeo::Advanced::Base
+
+      # Returns a list of events from a group for a specific month.
+      create_api_method :get_month,
+                        "vimeo.groups.events.getMonth",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page, :month, :year]
+
+      # Returns a list of all past events from a group.
+      create_api_method :get_past,
+                        "vimeo.groups.events.getPast",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+      
+      # Returns a list of all upcoming events from a group.
+      create_api_method :get_upcoming,
+                        "vimeo.groups.events.getUpcoming",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+    end # GroupEvents
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/group_forums.rb

@@ -0,0 +1,19 @@
+module Vimeo
+  module Advanced
+    class GroupForums < Vimeo::Advanced::Base
+
+      # Returns a list of comments for a group forum topic.
+      create_api_method :get_topic_comments,
+                        "vimeo.groups.forums.getTopicComments",
+                        :required => [:group_id, :topic_id],
+                        :optional => [:page, :per_page]
+
+      # Returns a list of all group forum topics.
+      create_api_method :get_topics,
+                        "vimeo.groups.forums.getTopics",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+    end # GroupForums
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/person.rb

@@ -0,0 +1,47 @@
+module Vimeo
+  module Advanced
+    class Person < Vimeo::Advanced::Base
+
+      # Adds a user to your contact list.
+      create_api_method :add_contact,
+                        "vimeo.people.addContact",
+                        :required => [:user_id]
+                        
+      # Adds a subscription to your subscriptions.
+      # Types is a comma-delimited string. Valid options: "likes", "appears", "uploads"
+      create_api_method :add_subscription,
+                        "vimeo.people.addSubscription",
+                        :required => [:user_id, :types]
+
+      # Finds a user by their e-mail.
+      create_api_method :find_by_email,
+                        "vimeo.people.findByEmail",
+                        :required => [:user_id]
+
+      create_api_method :get_hd_embeds,
+                        "vimeo.people.getHDEmbeds"
+
+      # Returns a user's information
+      create_api_method :get_info,
+                        "vimeo.people.getInfo",
+                        :required => [:user_id]
+      
+      # Returns a user's portrait URLs.
+      create_api_method :get_portrait_urls,
+                        "vimeo.people.getPortraitUrls",
+                        :required => [:user_id]
+      
+      # Removes a user from your contact list.
+      create_api_method :remove_contact,
+                        "vimeo.people.removeContact",
+                        :required => [:user_id]
+      
+      # Removes a subscription to your subscriptions.
+      # Types is a comma-delimited string. Valid options: "likes", "appears", "uploads"
+      create_api_method :remove_subscription,
+                        "vimeo.people.removeSubscription",
+                        :required => [:user_id, :types]
+
+    end # Person
+  end # Advanced
+end # Vimeo

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/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/test.rb

@@ -0,0 +1,19 @@
+module Vimeo
+  module Advanced
+    class Test < Vimeo::Advanced::Base
+
+      # http://vimeo.com/api/docs/methods/vimeo.test.echo
+      create_api_method :echo,
+                        "vimeo.test.echo"
+
+      # http://vimeo.com/api/docs/methods/vimeo.test.login
+      create_api_method :login,
+                        "vimeo.test.login"
+
+      # http://vimeo.com/api/docs/methods/vimeo.test.null
+      create_api_method :null,
+                        "vimeo.test.null"
+
+    end # Test
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/upload.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module Vimeo
+  module Advanced
+
+    class Upload < Vimeo::Advanced::Base
+      # Check to make sure an upload ticket is still valid.
+      create_api_method :check_ticket,
+                        "vimeo.videos.upload.checkTicket",
+                        :required => [:ticket_id]
+
+      # 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"
+
+      # Verify that the chunks were uploaded properly.
+      create_api_method :verify_chunks,
+                        "vimeo.videos.upload.verifyChunks",
+                        :required => [:ticket_id]
+
+      include Vimeo::Advanced::SimpleUpload
+
+    end # Upload
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/video.rb

@@ -0,0 +1,141 @@
+module Vimeo
+  module Advanced
+    class Video < Vimeo::Advanced::Base
+
+      create_api_method :add_cast,
+                        "vimeo.videos.addCast",
+                        :required => [:video_id, :user_id],
+                        :optional => [:role]
+
+      create_api_method :add_photos,
+                        "vimeo.videos.addPhotos",
+                        :required => [:video_id, :photo_urls]
+
+      create_api_method :add_tags,
+                        "vimeo.videos.addTags",
+                        :required => [:video_id, :tags]
+
+      create_api_method :clear_tags,
+                        "vimeo.videos.clearTags",
+                        :required => [:video_id]
+
+      create_api_method :delete,
+                        "vimeo.videos.delete",
+                        :required => [:video_id]
+
+      create_api_method :get_all,
+                        "vimeo.videos.getAll",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_appears_in,
+                        "vimeo.videos.getAppearsIn",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_by_tag,
+                        "vimeo.videos.getByTag",
+                        :required => [:tag],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_cast,
+                        "vimeo.videos.getCast",
+                        :required => [:video_id],
+                        :optional => [:page, :per_page]
+
+      create_api_method :get_contacts_liked,
+                        "vimeo.videos.getContactsLiked",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_contacts_uploaded,
+                        "vimeo.videos.getContactsUploaded",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_info,
+                        "vimeo.videos.getInfo",
+                        :required => [:video_id]
+
+      create_api_method :get_likes,
+                        "vimeo.videos.getLikes",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_subscriptions,
+                        "vimeo.videos.getSubscriptions",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :get_thumbnail_urls,
+                        "vimeo.videos.getThumbnailUrls",
+                        :required => [:video_id]
+
+      create_api_method :get_uploaded,
+                        "vimeo.videos.getUploaded",
+                        :required => [:user_id],
+                        :optional => [:page, :per_page, :full_response, :sort]
+
+      create_api_method :remove_cast,
+                        "vimeo.videos.removeCast",
+                        :required => [:video_id, :user_id]
+
+      create_api_method :remove_tag,
+                        "vimeo.videos.removeTag",
+                        :required => [:video_id, :tag_id]
+
+      create_api_method :search,
+                        "vimeo.videos.search",
+                        :required => [:query],
+                        :optional => [:page, :per_page, :full_response, :sort, :user_id],
+                        :authorized => false
+
+      create_api_method :set_description,
+                        "vimeo.videos.setDescription",
+                        :required => [:video_id, :description]
+
+      create_api_method :set_like,
+                        "vimeo.videos.setLike",
+                        :required => [:video_id, :like]
+
+      create_api_method :set_privacy,
+                        "vimeo.videos.setPrivacy",
+                        :required => [:video_id, :privacy],
+                        :optional => [:users, :password]
+
+      create_api_method :set_title,
+                        "vimeo.videos.setTitle",
+                        :required => [:video_id, :title]
+      
+      # comments
+      create_api_method :add_comment,
+                        "vimeo.videos.comments.addComment",
+                        :required => [:video_id, :comment_text],
+                        :optional => [:reply_to_comment_id]
+
+      create_api_method :delete_comment,
+                        "vimeo.videos.comments.deleteComment",
+                        :required => [:video_id, :comment_id]
+
+      create_api_method :edit_comment,
+                        "vimeo.videos.comments.editComment",
+                        :required => [:video_id, :comment_id, :comment_text]
+
+      create_api_method :get_comments_list,
+                        "vimeo.videos.comments.getList",
+                        :required => [:video_id],
+                        :optional => [:page, :per_page]
+      
+      # embed
+      # getPresets has a bug right now: the response is blank http://www.vimeo.com/forums/topic:32411
+      # create_api_method :get_presets,
+      #                   "vimeo.videos.embed.getPresets",
+      #                   :optional => [:page, :per_page]
+
+      create_api_method :set_preset,
+                        "vimeo.videos.embed.setPreset",
+                        :required => [:preset_id, :video_id]
+
+    end # Video
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/video_embed.rb

@@ -0,0 +1,17 @@
+module Vimeo
+  module Advanced
+    class VideoEmbed < Vimeo::Advanced::Base
+
+      # Returns a list of presets for a video embed.
+      create_api_method :get_presets,
+                        "vimeo.videos.embed.getPresets",
+                        :optional => [:page, :per_page]
+
+      # Sets a preset for a video embed.
+      create_api_method :set_preset,
+                        "vimeo.videos.embed.setPreset",
+                        :required => [:video_id, :preset_id]
+
+    end # VideoEmbed
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__))
+require 'advanced/base'
+require 'advanced/album'
+require 'advanced/channel'
+require 'advanced/contact'
+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'
+require 'advanced/video_embed'
+
+module Vimeo
+  module Advanced
+
+  end
+end