vodpod 0.0.1

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2009 Kyle Kingsbury <aphyr@aphyr.com>
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+ 
+  * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+  * Neither the name of this project nor the names of its contributors may be
+    used to endorse or promote products derived from this software without
+    specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,77 @@
+Vodpod - Ruby bindings for the Vodpod API.
+==========================================
+
+Vodpod is a web site that allows you to collect videos. This library lets you
+interact with those collections and videos over their REST-style API, using
+clean Ruby. Typically one interacts with the Vodpod API through javascript, but
+maybe you've got bigger plans. Maybe you want to integrate with a content
+management system, or copy videos automatically from a social bookmarking site.
+Be creative. :-)
+
+Right now you can search for videos across the site and in a specific pod,
+retrieve details on videos and pods, and page through videos in a pod. You can
+also post new videos to a pod, and update video attributes. Error handling is
+spotty thus far.
+
+Examples
+--------
+
+Vodpod.start(:api_key => '...', :auth => '...') do |v|
+  # Get a pod
+  pod = v.pod('aphyr')
+
+  # Basic information about a pod is loaded by default
+  pod.name   # => "aphyr's videos" 
+  pod.stats  # => {"total_views"=>23, "weekly_pod_views"=>2, ...}
+
+  # Retrieve tags (also works on videos)
+  pod.tags   # => [<Vodpod::Tag neotokyo (1)>, <Vodpod::Tag game (1)>, ...]
+
+  # Look at who's following this pod
+  pod.followers  # => [<Vodpod::User foo>, <Vodpod::User bar>, ...]
+
+  # Get a full dump of an object's contents (works on Tags, Users, Videos, ...)
+  pod.store      # => {"name"=>"aphyr's videos", "created_at" => ...}
+
+  # List some videos
+  pod.videos.map { |video| video.title }
+  # => ["Official Neotokyo Trailer", "Kittens Attack!"]
+
+  # You can page through results and filter by tags
+  pod.videos(:tags => 'music', :page => 2, :per_page => 16)
+  # => [<Vodpod::Video ...>, <Vodpod::Video ...>, ...]
+
+  # Find videos by searching (Also works on pods)
+  v.search('obama', :per_page => 48)
+  # => [<Vodpod::Video ...>, <Vodpod::Video ...>, ...]
+
+  # Get a specific video by ID
+  vid = v.video(1063027)   # => <Vodpod::Video ...>
+  
+  # Show the associated user
+  vid.user                 # => <Vodpod::User scarrfase>
+
+  # Post a new video to a pod. Returns the new video.
+  pod.post('http://www.youtube.com/watch?v=E0ewUBTSlvQ',
+    :title => 'Neotokyo Recon Demo',
+    :description => 'Demo footage of the in-development Neotokyo mod',
+    :tags => ['game', 'neotokyo', 'trailer']
+  )
+  # => <Vodpod::Video ...>
+
+  # Add a tag "sports" to every video in a pod about frisbee.
+  pod.search('frisbee').each do |video|
+    tags = "#{video.tags} sports"
+    video.update(:tags => tags)
+  end
+end
+
+Roadmap
+-------
+
+- Posting videos seems to work--the URL is correct in the returned video JSON,
+  but visiting the page doesn't seem to load. Perhaps a caching issue on
+  Vodpod's end?
+- Automatic casting for datetimes.
+- Better error handling
+- Iterators for acting on all results without thinking about pagination

data/example/test.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby
+
+require '../lib/vodpod'
+require 'pp'
+
+api_key = '5c87948ac1979401'
+auth = '5c91b8b53586434c'
+
+Vodpod.start(:api_key => api_key, :auth => auth) do |v|
+#  pp v.pod('aphyr').post('http://www.youtube.com/watch?v=E0ewUBTSlvQ', :title => "Neotokyo Recon Demo", :description => "Excitement!")
+#  pp v.video(2465983).update(:title => 'Official Neotokyo Trailer')
+  #
+  pp v.pod('aphyr').videos(:tags => 'neotokyo')
+end

data/lib/vodpod.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+
+# Vodpod API bindings for Ruby
+
+require 'rubygems'
+require 'json'
+require 'uri'
+require 'net/http'
+
+module Vodpod
+  BASE_URI = 'http://api.vodpod.com/api/'
+  ROOT = File.dirname(__FILE__)
+
+  # Load library
+  require "#{ROOT}/vodpod/version"
+  require "#{ROOT}/vodpod/error"
+  require "#{ROOT}/vodpod/connection"
+  require "#{ROOT}/vodpod/record"
+  require "#{ROOT}/vodpod/user"
+  require "#{ROOT}/vodpod/tag"
+  require "#{ROOT}/vodpod/pod"
+  require "#{ROOT}/vodpod/video"
+
+  # Performs URI escaping so that you can construct proper
+  # query strings faster.  Use this rather than the cgi.rb
+  # version since it's faster.  (Stolen from Camping).
+  def escape(s)
+    s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+      '%'+$1.unpack('H2'*$1.size).join('%').upcase
+    }.tr(' ', '+')
+  end
+  module_function :escape
+
+  # Creates a connection with the provided parameter hash, and yields it in a
+  # block. Example:
+  #
+  #   Vodpod.start(:api_key => api_key, :auth => auth) do |v|
+  #     pod = v.pod('aphyr')
+  #     p pod.created_at
+  #   end
+  def self.start(params)
+    yield Connection.new(params) 
+  end
+end

data/lib/vodpod/connection.rb

@@ -0,0 +1,95 @@
+module Vodpod
+  # Connection to vodpod.com; retreives JSON data and handles API key/auth.
+  class Connection
+
+    attr_accessor :api
+    attr_accessor :auth
+
+    # Creates a new connection. Parameters:
+    #
+    # :api_key => API key
+    # :auth => Auth key
+    def initialize(params = {})
+      @api_key = params[:api_key]
+      @auth = params[:auth]
+    end
+
+    # Request via GET
+    def get(path, params = {})
+      request :get, path, params
+    end
+ 
+    # Returns a pod by ID.
+    def pod(id)
+      Pod.load(self, 'pod_id' => id)
+    end
+
+    # Request via POST
+    def post(path, params = {})
+      request :post, path, params
+    end
+
+    # Perform a JSON request to the Vodpod API for a given path and parameter
+    # hash. Returns a parsed JSON document. Automatically provides api_key and
+    # auth params if you do not specify them. Method should be one of :get or
+    # :post--you should use the #get or #post methods for convenience.
+    def request(method, path, params = {})
+      defaults = {
+        :api_key => @api_key,
+        :auth => @auth
+      }
+
+      # Construct query fragment
+      query = defaults.merge(params).inject('?') { |s, (k, v)|
+        s << "#{Vodpod::escape(k)}=#{Vodpod::escape(v)}&"
+      }[0..-2]
+
+      begin
+        # Get URI
+        case method
+        when :get
+          # GET request
+          uri = URI.parse(Vodpod::BASE_URI + path + '.js' + query)
+          JSON.parse Net::HTTP.get(uri)
+        when :post
+          # POST request
+          uri = URI.parse(Vodpod::BASE_URI + path + '.js')
+          res = Net::HTTP.start(uri.host, uri.port) do |http|
+            http.post(uri.path, query[1..-1])
+          end
+          JSON.parse res.body
+        else
+          # Don't know how to do that kind of request
+          raise Error.new("Unsupported request method #{method.inspect}; should be one of :get, :post.")
+        end
+      rescue => e
+        # Error somewhere in the request/parse process.
+        raise Error.new("Error retrieving #{uri.path}#{query}: #{e.message}")
+      end
+    end
+
+    # Searches for videos. Optionally specify :per_page and :page.
+    def search(query, params = {})
+      list = get('video/search', params.merge(:query => query))['videos']['items']
+      return [] unless list
+
+      # Map results to Videos
+      list.map do |item|
+        # These results use Video.1234... as the ID, so we need to strip.
+        store = item['video']
+        store['video_id'] = store['video_id'].sub(/^Video\./, '').to_i
+        Video.new(self, store)
+      end
+    end
+
+    # Returns a user by ID.
+    def user(id)
+      User.new(self, 'user_id' => id)
+    end
+
+    # Returns a video by ID.
+    def video(id)
+      Video.load(self, 'video_id' => id)
+    end
+  end
+end

data/lib/vodpod/error.rb

@@ -0,0 +1,2 @@
+class Error < RuntimeError
+end

data/lib/vodpod/pod.rb

@@ -0,0 +1,119 @@
+module Vodpod
+  # Represents a pod.
+  class Pod < Record
+    # Administrative users
+    def admins
+      if items = @store['users']['admins']
+        case items
+        when {}
+          # No results
+          []
+        when Array
+          # More than one result
+          items.map do |item|
+            User.new(@connection, item['user'])
+          end
+        else
+          # One result
+          [User.new(@connection, items['user'])]
+        end
+      else
+        []
+      end
+    end
+
+    # Following users
+    def followers
+      if items = @store['users']['followers']
+        case items
+        when {}
+          # No results
+          []
+        when Array
+          # More than one result
+          items.map do |item|
+            User.new(@connection, item['user'])          
+          end
+        else
+          # One result
+          [User.new(@connection, items['user'])]
+        end
+      else
+        []
+      end
+    end
+
+    # Loads information for this pod from the API.
+    def load!
+      if pod_id
+        @store.merge! @connection.get('pod/details', :pod_id => pod_id)["pod"]
+      end
+    end
+
+    # Posts a new video to a pod. Returns the video posted.
+    # 
+    # Optional parameters:
+    #   :title       => 'Cats with captions!'
+    #   :description => 'Ahh the internet...'
+    #   :tags        => 'foo bar baz' or ['foo', 'bar', 'baz']
+    def post(url, params = {})
+      new_params = params.merge(
+        :pod_id => @store['pod_id'],
+        :url => url
+      )
+      # Convert tags to string if necessary
+      if new_params[:tags].kind_of? Array
+        new_params[:tags] = new_params[:tags].join(' ')
+      end
+
+      # Post
+      Video.new(@connection.post('video/post', new_params)['video'])
+    end
+    
+    # Searches for videos. Optionally specify :per_page and :page.
+    def search(query, params = {})
+      # Get list of videos
+      params = params.merge(:pod_id => @store['pod_id'], :query => query)
+      list = @connection.get('pod/search', params)['videos']['items']
+
+      return [] unless list
+
+      # Map results to Videos
+      list.map do |item|
+        store = item['video']
+        #store['video_id'].sub!(/^Video\./, '')
+        Video.new(@connection, store)
+      end
+    end
+
+    # Returns an array of Tags associated with this pod, by frequency of use.
+    def tags
+      list = @connection.get('pod/tags', :pod_id => pod_id)['tags']['items']
+      list.map do |item|
+        Tag.new(@connection, item['t'])
+      end
+    end
+
+    # Returns the associated user for this pod.
+    def user
+      return nil unless @store['user']
+
+      User.new(@connection, @store['user'])
+    end
+
+    # Videos in a pod. You can use :sort, :per_page, :page, and :tag_id to
+    # paginate and filter.
+    def videos(params = {})
+      # Get list of videos
+      params = params.merge(:pod_id => @store['pod_id'])
+      list = @connection.get('pod/videos', params)['videos']['items']
+
+      return [] unless list      
+
+      # Map to objects
+      list.map do |item|
+        Video.new(@connection, item['video'])
+      end
+    end
+  end
+end

data/lib/vodpod/record.rb

@@ -0,0 +1,34 @@
+module Vodpod
+  # Represents a generic Vodpod API record.
+  #
+  # Vodpod objects like Video, Pod, and Tag inherit from this class. It wraps a
+  # store (usually the deserialized JSON hash from an API call) with automatic
+  # accessors, so you can call video.title instead of video.store['title'].
+  # Records are instantiated with a connection object and a default store of an
+  # empty hash. 
+  class Record
+    attr_accessor :store
+
+    # Like Record.new, but also calls load!
+    def self.load(*params)
+      record = new(*params)
+      record.load! if record.respond_to? :load!
+      record
+    end
+
+    # Create a new Record. Takes two parameters: a Connection object so the
+    # record can perform further requests, and an optional default value for
+    # the store. 
+    def initialize(connection, store = {})
+      @connection = connection
+      @store = store
+    end
+
+    # Pass requests to store by default.
+    def method_missing(meth, *args)
+      if @store.include? meth.to_s
+        @store[meth.to_s]
+      end
+    end
+  end
+end

data/lib/vodpod/tag.rb

@@ -0,0 +1,13 @@
+module Vodpod
+  # A Tag, attached to a video. There isn't a way yet to go from tags to videos
+  # that I'm aware of, but it might happen in the future.
+  class Tag < Record
+    def inspect
+      "<Vodpod::Tag #{@store['_value']} (#{count})>"
+    end
+
+    def to_s
+      @store['_value']
+    end
+  end
+end

data/lib/vodpod/user.rb

@@ -0,0 +1,22 @@
+module Vodpod
+  # A Vodpod user, associated with a pod and with videos.
+  class User < Record
+    # Returns recent activity by people related to this user. Not working
+    # yet--maybe a Vodpod bug?
+    def network_activity
+      @connection.get('user/network_activity', :user_id => user_id)
+    end
+
+    def inspect
+      if @store
+        "<Vodpod::User #{@store['username']}>"
+      else
+        "<Vodpod::User>"
+      end
+    end
+
+    def to_s
+      @store['username']
+    end
+  end
+end

data/lib/vodpod/version.rb

@@ -0,0 +1,8 @@
+module Vodpod
+  APP_NAME = 'Vodpod'
+  APP_VERSION = '0.0.1'
+  APP_AUTHOR = 'Kyle Kingsbury'
+  APP_EMAIL = 'aphyr@aphyr.com'
+  APP_URL = 'http://aphyr.com/projects/ruby-vodpod'
+  APP_COPYRIGHT = 'Copyright (c) 2009 Kyle Kingsbury <aphyr@aphyr.com>. All rights reserved.'
+end

data/lib/vodpod/video.rb

@@ -0,0 +1,34 @@
+module Vodpod
+  # A video.
+  class Video < Record
+    # Loads information on this video by video_id
+    def load!
+      if video_id
+        @store.merge! @connection.get('video/details', :video_id => video_id)["video"]
+      end
+    end
+
+    def to_s
+      @store['title']
+    end
+
+    # Update the title, description, and/or tags for this video. Returns
+    # the updated video. Seems to create video records okay, but they aren't
+    # viewable and don't appear in collections for editing immediately.
+    def update(params)
+      new_params = params.merge(
+        :video_id => @store['video_id']
+      )
+
+      # Post
+      Video.new(@connection.post('video/update', new_params)['video'])
+    end
+
+    # Returns the User for this video.
+    def user
+      return nil unless @store['user']
+
+      User.new(@connection, @store['user'])
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: vodpod
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Kingsbury
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+description: 
+email: aphyr@aphyr.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/vodpod.rb
+- lib/vodpod
+- lib/vodpod/record.rb
+- lib/vodpod/tag.rb
+- lib/vodpod/pod.rb
+- lib/vodpod/version.rb
+- lib/vodpod/user.rb
+- lib/vodpod/video.rb
+- lib/vodpod/error.rb
+- lib/vodpod/connection.rb
+- example/test.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: http://aphyr.com/projects/ruby-vodpod
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.5
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: vodpod
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ruby bindings for the Vodpod API.
+test_files: []
+