vimeo 1.0.0

data/lib/vimeo/advanced/channel.rb

@@ -0,0 +1,58 @@
+module Vimeo
+  module Advanced
+    class Channel < Vimeo::Advanced::Base
+
+      # Adds a video to a channel.
+      create_api_method :add_video,
+                        "vimeo.channels.addVideo",
+                        :required => [:auth_token, :channel_id, :video_id]
+                        
+      # Returns a list of all channels.
+      create_api_method :get_all,
+                        "vimeo.channels.getAll",
+                        :optional => [:page, :per_page, :sort]
+
+      # Returns information about a channel.
+      # FIXME: Do we need page and per_page here?
+      create_api_method :get_info,
+                        "vimeo.channels.getInfo",
+                        :required => [:channel_id],
+                        :optional => [:page, :per_page]
+      
+      # 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.
+      # FIXME: Should there be a sort option here?
+      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 => [:auth_token, :channel_id, :video_id]
+      
+      # Subscribes to a channel
+      create_api_method :subscribe,
+                        "vimeo.channels.subscribe",
+                        :required => [:auth_token, :channel_id]
+      
+      # Unsubscribes from a channel
+      create_api_method :unsubscribe,
+                        "vimeo.channels.unsubscribe",
+                        :required => [:auth_token, :channel_id]
+
+    end # Channel
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/contact.rb

@@ -0,0 +1,31 @@
+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, :sort]
+
+      # Returns a list of your contacts who are online.
+      # FIXME: Shouldn't this have optional params?
+      create_api_method :get_online,
+                        "vimeo.contacts.getOnline",
+                        :optional => [:page, :per_page, :sort]
+      
+      # 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,68 @@
+module Vimeo
+  module Advanced
+    class Group < Vimeo::Advanced::Base
+
+      # Adds a video to a group.
+      create_api_method :add_video,
+                        "vimeo.groups.addVideo",
+                        :required => [:auth_token, :group_id, :video_id]
+
+      # Returns a list of all groups.
+      create_api_method :get_all,
+                        "vimeo.groups.getAll",
+                        :optional => [:page, :per_page, :sort]
+      
+      # Returns a list of a group's files.
+      # FIXME: Sort optional param?
+      create_api_method :get_files,
+                        "vimeo.groups.getFiles",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+      # Returns information about a group.
+      # FIXME: Does this need pagination options?
+      create_api_method :get_info,
+                        "vimeo.groups.getInfo",
+                        :required => [:group_id],
+                        :optional => [:page, :per_page]
+
+      # 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.
+      # FIXME: Should this have sort?
+      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.
+      # FIXME: Should this have sort?
+      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.
+      # FIXME: Should this have sort?
+      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 => [:auth_token, :group_id]
+      
+      # Leaves a group.
+      create_api_method :leave,
+                        "vimeo.groups.leave",
+                        :required => [:auth_token, :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,48 @@
+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 => [:auth_token, :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 => [:auth_token, :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",
+                        :required => [:auth_token]
+
+      # 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 => [:auth_token, :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 => [:auth_token, :user_id, :types]
+
+    end # Person
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/test.rb

@@ -0,0 +1,36 @@
+module Vimeo
+  module Advanced
+
+    class Test < Vimeo::Advanced::Base
+      
+      # An echo test. Echoes all parameters.
+      # Options can be anything except method, api_key,
+      # and api_sig -- if any of these options are
+      # present they will be overwritten by the proper
+      # values.
+      create_api_method :echo,
+                        "vimeo.test.echo"
+
+      # def echo(options={})
+      #   options.merge!(:method => "vimeo.test.echo")
+      #   api_sig = generate_api_sig options
+      #   options.merge!(:api_sig => api_sig)
+      #   self.class.post("/api/rest", :query => options)
+      # end
+
+      # Tests if the user associated to this token
+      # is able to make authenticated calls.      
+      create_api_method :login,
+                        "vimeo.test.login",
+                        :required => [:auth_token]
+
+
+      # A simple ping test.
+      create_api_method :null,
+                        "vimeo.test.null",
+                        :required => [:auth_token]
+      
+    end
+
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/upload.rb

@@ -0,0 +1,62 @@
+require 'httpclient'
+require 'json'
+
+module Vimeo
+  module Advanced
+
+    class Upload < Vimeo::Advanced::Base
+
+      # TODO: Make this work with either a JSON or an XML manifest.
+      # Confirms the upload process.
+      create_api_method :confirm,
+                        "vimeo.videos.upload.confirm",
+                        :required => [:auth_token, :ticket_id],
+                        :unsigned => [:json_manifest]
+      
+      # "{\"files\":[{\"md5\":\"731f09145a1ea9ec9dad689de6fa0358\"}]}"
+
+      # Returns the space and HD uploads left for a user.
+      create_api_method :get_quota,
+                        "vimeo.videos.upload.getQuota",
+                        :required => [:auth_token]
+                        
+      # Returns an upload ticket.
+      create_api_method :get_ticket,
+                        "vimeo.videos.upload.getTicket",
+                        :required => [:auth_token]
+
+      # 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",
+                        :required => [:auth_token, :ticket_id],
+                        :unsigned => [:json_manifest]
+
+
+      # TODO: Make this more flexible for split uploads?
+      def self.create_json_manifest(md5s)
+        { :files => md5s.map { |md5| { :md5 => md5 } } }.to_json
+      end
+
+    end # Upload
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/video.rb

@@ -0,0 +1,131 @@
+module Vimeo
+  module Advanced
+    class Video < Vimeo::Advanced::Base
+
+      create_api_method :add_cast,
+                        "vimeo.videos.addCast",
+                        :required => [:auth_token, :video_id, :user_id],
+                        :optional => [:role]
+
+      create_api_method :add_photos,
+                        "vimeo.videos.addPhotos",
+                        :required => [:auth_token, :video_id, :photo_urls]
+
+      create_api_method :add_tags,
+                        "vimeo.videos.addTags",
+                        :required => [:auth_token, :video_id, :tags]
+
+      create_api_method :clear_tags,
+                        "vimeo.videos.clearTags",
+                        :required => [:auth_token, :video_id]
+
+      create_api_method :delete,
+                        "vimeo.videos.delete",
+                        :required => [:auth_token, :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 => [:auth_token, :video_id, :user_id]
+
+      create_api_method :remove_tag,
+                        "vimeo.videos.removeTag",
+                        :required => [:auth_token, :video_id, :tag_id]
+
+      create_api_method :search,
+                        "vimeo.videos.search",
+                        :required => [:query],
+                        :optional => [:page, :per_page, :full_response, :sort, :user_id]
+
+      create_api_method :set_description,
+                        "vimeo.videos.setDescription",
+                        :required => [:auth_token, :video_id, :description]
+
+      create_api_method :set_like,
+                        "vimeo.videos.setLike",
+                        :required => [:auth_token, :video_id, :like]
+
+      create_api_method :set_privacy,
+                        "vimeo.videos.setPrivacy",
+                        :required => [:auth_token, :video_id, :privacy],
+                        :optional => [:users, :password]
+
+      create_api_method :set_title,
+                        "vimeo.videos.setTitle",
+                        :required => [:auth_token, :video_id, :title]
+
+      
+      # comments
+      create_api_method :add_comment,
+                        "vimeo.videos.comments.addComment",
+                        :required => [:auth_token, :video_id, :comment_text],
+                        :optional => [:reply_to_comment_id]
+
+      create_api_method :delete_comment,
+                        "vimeo.videos.comments.deleteComment",
+                        :required => [:auth_token, :video_id, :comment_id]
+
+      create_api_method :edit_comment,
+                        "vimeo.videos.comments.editComment",
+                        :required => [:auth_token, :video_id, :comment_id, :comment_text]
+
+      create_api_method :get_comments_list,
+                        "vimeo.videos.comments.getList",
+                        :required => [:video_id],
+                        :optional => [:page, :per_page]
+
+    end # Video
+  end # Advanced
+end # Vimeo

data/lib/vimeo/advanced/video_embed.rb

@@ -0,0 +1,19 @@
+module Vimeo
+  module Advanced
+    class VideoEmbed < Vimeo::Advanced::Base
+
+      # Returns a list of presets for a video embed.
+      # FIXME: Needs a page optional as well...?
+      create_api_method :get_presets,
+                        "vimeo.video.embed.getPresets",
+                        :required => [:auth_token],
+                        :optional => [:page, :per_page]
+
+      # Sets a preset for a video embed.
+      create_api_method :set_preset,
+                        "vimeo.video.embed.setPreset",
+                        :required => [:auth_token, :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/auth'
+require 'advanced/channel'
+require 'advanced/contact'
+require 'advanced/group'
+require 'advanced/group_events'
+require 'advanced/group_forums'
+require 'advanced/person'
+require 'advanced/test'
+require 'advanced/upload'
+require 'advanced/video'
+require 'advanced/video_embed'
+
+module Vimeo
+  module Advanced
+    
+  end
+end

data/lib/vimeo/simple/activity.rb

@@ -0,0 +1,42 @@
+module Vimeo
+  module Simple
+
+    class Activity < Vimeo::Simple::Base
+      # Returns a list of a user's activities.
+      #
+      # @param [String] username The user's id or username.
+      def self.user_did(username)
+        get("/activity/#{username}/user_did.json")
+      end
+    
+      # Returns a list of activities that happened to a user.
+      #
+      # @param [String] username The user's id or username.
+      def self.happened_to_user(username)
+        get("/activity/#{username}/happened_to_user.json")
+      end
+    
+      # Returns a list of activities a user's contact's did.
+      #
+      # @param [String] username The user's id or username.
+      def self.contacts_did(username)
+        get("/activity/#{username}/contacts_did.json")
+      end
+    
+      # Returns a list of activities that happened to a user's contacts.
+      #
+      # @param [String] username The user's id or username.
+      def self.happened_to_contacts(username)
+        get("/activity/#{username}/happened_to_contacts.json")
+      end
+    
+      # Returns a list of activities everyone did.
+      #
+      # @param [String] username The user's id or username.
+      def self.everyone_did(username)
+        get("/activity/#{username}/everyone_did.json")
+      end
+    end
+
+  end # Simple
+end # Vimeo

data/lib/vimeo/simple/album.rb

@@ -0,0 +1,21 @@
+module Vimeo
+  module Simple
+
+    class Album < Vimeo::Simple::Base
+      # Returns a list of an album's videos.
+      #
+      # @param [String] album_id The album's id.
+      def self.videos(album_id)
+        get("/album/#{album_id}/videos.json")
+      end
+
+      # Returns an album's metadata.
+      #
+      # @param [String] album_id The album's id.
+      def self.info(album_id)
+        get("/album/#{album_id}/info.json")
+      end
+    end
+
+  end # Simple
+end # Vimeo

data/lib/vimeo/simple/base.rb

@@ -0,0 +1,10 @@
+module Vimeo
+  module Simple
+    
+    class Base      
+      include HTTParty
+      base_uri 'vimeo.com/api/v2'
+    end # Base
+
+  end # Simple
+end # Vimeo

data/lib/vimeo/simple/channel.rb

@@ -0,0 +1,21 @@
+module Vimeo
+  module Simple
+
+    class Channel < Vimeo::Simple::Base      
+      # Returns a list of a channel's videos.
+      #
+      # @param [String] channelname The channel's name.
+      def self.videos(channelname)
+        get("/channel/#{channelname}/videos.json")
+      end
+      
+      # Returns a channel's metadata.
+      #
+      # @param [String] channelname The channel's name.
+      def self.info(channelname)
+        get("/channel/#{channelname}/info.json")
+      end
+    end
+
+  end # Simple
+end # Vimeo

data/lib/vimeo/simple/group.rb

@@ -0,0 +1,28 @@
+module Vimeo
+  module Simple
+
+    class Group < Vimeo::Simple::Base
+      # Returns a list of a group's videos.
+      #
+      # @param [String] group_name The groups's name.
+      def self.videos(groupname)
+        get("/group/#{groupname}/videos.json")
+      end
+
+      # Returns a list of a group's users.
+      #
+      # @param [String] group_name The groups's name.
+      def self.users(groupname)
+        get("/group/#{groupname}/users.json")
+      end
+
+      # Returns a group's metadata.
+      #
+      # @param [String] group_name The groups's name.
+      def self.info(groupname)
+        get("/group/#{groupname}/info.json")
+      end
+    end
+
+  end # Simple
+end # Vimeo