active_youtube 1.0.0

data/examples.rb

@@ -0,0 +1,54 @@
+##### Examples #######
+
+#### VIDEO
+  ## search for videos
+  search = Youtube::Video.find(:first, :params => {:vq => 'ruby', :"max-results" => '5'})
+  puts search.entry.length
+
+  ## video information of id = ZTUVgYoeN_o
+  vid = Youtube::Video.find("ZTUVgYoeN_o")
+  puts vid.group.content[0].url
+
+  ## video comments
+  comments = Youtube::Video.find_custom("ZTUVgYoeN_o").get(:comments)
+  puts comments.entry[0].link[2].href
+
+  ## searching with category/tags
+  results = Youtube::Video.search_by_tags("Comedy")
+  puts results[0].entry[0].title
+  # more examples:
+  # Video.search_by_tags("Comedy", "dog")
+  # Video.search_by_tags("News","Sports","football", :exclude=>["Comedy","soccer"])
+  # Video.search_by_tags("News","Sports","football", :exclude=>"soccer")
+
+
+#### STANDARDFEED
+  ## retrieving standard feeds
+  most_viewed = Youtube::Standardfeed.find(:most_viewed, :params => {:time => 'today'})
+  puts most_viewed.entry[0].group.content[0].url
+
+#### USER
+  ## user's profile - guthrie
+  user_profile = Youtube::User.find("guthrie")
+  puts user_profile.link[1].href
+
+  ## user's playlist - john
+  user_playlist = Youtube::User.find_custom("john").get(:playlists)
+  puts user_playlist.link[1].href
+
+  ## user's upload or favorites
+  rick_video = Youtube::User.find_custom("rick").get(:uploads)
+  puts rick_video.entry[0].group.content[0].url
+
+  ## user's subscription
+  user_subscriptions = Youtube::User.find_custom("guthrie").get(:subscriptions)
+  puts user_subscriptions.to_yaml
+
+#### PLAYLIST
+  ## get playlist - multiple elements in playlist
+  playlist = Youtube::Playlist.find("EBF5D6DC4589D7B7")
+  puts playlist.entry[0].group.content[0].url
+
+  ## get playlist - single element in playlist
+  playlist = Youtube::Playlist.find("45C563323B344971")
+  puts playlist.entry[0].group.content[0].url

data/lib/active_youtube.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'active_resource'
+require File.expand_path(File.dirname(__FILE__) + "/patch")
+require File.expand_path(File.dirname(__FILE__) + "/activeyoutube")
+require File.expand_path(File.dirname(__FILE__) + "/youtube")

data/lib/activeyoutube.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'activeresource'
+
+#module Youtube    
+class ActiveYoutube < ActiveResource::Base
+  class << self
+  ## Remove format from the url.
+  def element_path(id, prefix_options = {}, query_options = nil)
+    prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+    "#{prefix(prefix_options)}#{collection_name}/#{id}#{query_string(query_options)}"
+  end
+    
+  ## Remove format from the url.
+  def collection_path(prefix_options = {}, query_options = nil)
+    prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+    "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+  end
+
+  ## For a collection call, ActiveResource formatting is not 
+  ## compliant with YouTube's output.
+  def instantiate_collection(collection, prefix_options = {})
+    unless collection.kind_of? Array
+      [instantiate_record(collection, prefix_options)]
+    else
+      collection.collect! { |record| instantiate_record(record, prefix_options) }
+    end
+  end
+
+  ## To convert output into proper standard.
+  ## If single element is present in output then entry is not an array.
+  ## So this method will ensure entry is always an array.
+  alias :old_find :find
+  def find(*args)
+    convert_entry_to_array(old_find(*args))
+  end
+
+  ## When using ActiveResource::CustomMethods, ActiveResource first tries to retrieve the id using find() 
+  ## and then makes a get() call using that id. 
+  ## But, youtube returns the url of this item as id, which we don't want. This method overrides the behavior.
+  ## Example: comments = Video.find_custom("ZTUVgYoeN_o").get(:comments)
+  def find_custom(arg)
+    object = self.new
+    object.id = arg
+    object
+  end
+
+  ##  Following method from ActiveResource::CustomMethods extends the capabilities of activeresource for non-standard urls ;-)
+  ##  The objects returned from this method are not automatically converted into ActiveResource instances - they are ordinary Hashes. 
+  ##  Modifications below ensures that you get ActiveResource instances.
+  def get(method_name, options = {})
+    object_array = connection.get(custom_method_collection_url(method_name, options), headers)
+    if object_array.class.to_s=="Array"
+      object_array.collect! {|record| convert_entry_to_array(self.class.new.load(record))}
+    else
+      convert_entry_to_array(self.class.new.load(object_array))
+    end
+  end
+
+  def convert_entry_to_array object
+    if object.respond_to?:entry and !(object.entry.kind_of? Array)
+      object.entry=[object.entry]
+    end
+    object
+  end
+  end
+
+  ## Instance Methods: (modifying the ActiveRecord::CustomMethods).
+ 
+  ## This modification is same as defined in above method 
+  def get(method_name, options = {})
+    self.class.convert_entry_to_array(load(connection.get(custom_method_element_url(method_name, options), self.class.headers)))
+  end
+
+  ## Modifying the url formation to make it Youtube API complaint
+  def custom_method_element_url(method_name, options = {})    
+    "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/" +
+    "#{method_name}#{self.class.send!(:query_string, options)}"
+  end
+end
+#end

data/lib/patch.rb

@@ -0,0 +1,36 @@
+##
+## copied from edge rails code
+module ActiveResource
+  class Base
+    private
+    # Tries to find a resource in a non empty list of nested modules
+    # Raises a NameError if it was not found in any of the given nested modules
+    def find_resource_in_modules(resource_name, module_names)
+      receiver = Object
+      namespaces = module_names[0, module_names.size-1].map do |module_name|
+        receiver = receiver.const_get(module_name)
+      end
+      if namespace = namespaces.reverse.detect { |ns| ns.const_defined?(resource_name) }
+        return namespace.const_get(resource_name)
+      else
+        raise NameError
+      end
+    end
+
+    # Tries to find a resource for a given name; if it fails, then the resource is created
+    def find_or_create_resource_for(name)
+      resource_name = name.to_s.camelize
+      ancestors = self.class.name.split("::")
+      if ancestors.size > 1
+        find_resource_in_modules(resource_name, ancestors)
+      else
+        self.class.const_get(resource_name)
+      end
+    rescue NameError
+      resource = self.class.const_set(resource_name, Class.new(ActiveResource::Base))
+      resource.prefix = self.class.prefix
+      resource.site   = self.class.site
+      resource
+    end
+  end
+end

data/lib/youtube.rb

@@ -0,0 +1,35 @@
+#### Create classes for YouTube resources.
+module Youtube
+  class Video < ActiveYoutube
+    self.site = "http://gdata.youtube.com/feeds/api"
+
+    ## To search by categories and tags
+    def self.search_by_tags (*options)
+      from_urls = []
+      if options.last.is_a? Hash
+        excludes = options.slice!(options.length-1)
+        if excludes[:exclude].kind_of? Array
+          from_urls << excludes[:exclude].map{|keyword| "-"+keyword}.join("/")
+        else
+          from_urls << "-"+excludes[:exclude]
+        end
+      end
+      from_urls << options.find_all{|keyword| keyword =~ /^[a-z]/}.join("/")
+      from_urls << options.find_all{|category| category =~ /^[A-Z]/}.join("%7C")
+      from_urls.delete_if {|x| x.empty?}
+      self.find(:all,:from=>"/feeds/api/videos/-/"+from_urls.reverse.join("/"))
+    end
+  end
+
+  class User < ActiveYoutube
+    self.site = "http://gdata.youtube.com/feeds/api"
+  end
+
+  class Standardfeed < ActiveYoutube
+    self.site = "http://gdata.youtube.com/feeds/api"
+  end
+
+  class Playlist < ActiveYoutube
+    self.site = "http://gdata.youtube.com/feeds/api"
+  end
+end

data/test/youtube_test.rb

@@ -0,0 +1,58 @@
+require "test/unit"
+require File.join(File.dirname(__FILE__), "../lib", "active_youtube")
+
+class YoutubeTest < Test::Unit::TestCase
+
+  def test_video
+    ## search for video
+    search = Youtube::Video.find(:first, :params => {:vq => 'ruby', :"max-results" => '5'})
+    
+    assert_equal(5,search.entry.length)
+
+    ## video information of id = ZTUVgYoeN_o
+    vid = Youtube::Video.find("ZTUVgYoeN_o")
+    assert_equal("http://www.youtube.com/v/ZTUVgYoeN_o",vid.group.content[0].url)
+
+    ## video comments
+    comments = Youtube::Video.find_custom("ZTUVgYoeN_o").get(:comments)
+    assert_equal("http://www.youtube.com/watch?v=ZTUVgYoeN_o",comments.entry[0].link[2].href)
+
+    ## searching with category/tags
+    results = Youtube::Video.search_by_tags("Comedy")
+    assert_equal("Russell Peters",results[0].entry[0].title)
+  end
+
+  def test_standardfeed
+    ## retrieving standard feeds
+    most_viewed = Youtube::Standardfeed.find(:most_viewed, :params => {:time => 'today'})
+    assert_equal("http://www.youtube.com/v/aiLvLxebfk0",most_viewed.entry[0].group.content[0].url)
+  end
+
+  def test_user
+    ## user's profile - guthrie
+    user_profile = Youtube::User.find("guthrie")
+    assert_equal("http://www.youtube.com/profile?user=guthrie",user_profile.link[1].href)
+
+    ## user's playlist - john
+    user_playlist = Youtube::User.find_custom("john").get(:playlists)
+    assert_equal("http://www.youtube.com/profile_play_list?user=john",user_playlist.link[1].href)
+
+    ## user's upload or favorites
+    rick_video = Youtube::User.find_custom("rick").get(:uploads)
+    assert_equal("http://www.youtube.com/v/eNpPK4W0Z3M",rick_video.entry[0].group.content[0].url)
+
+    ## user's subscription
+    #user_subscriptions = Youtube::User.find_custom("guthrie").get(:subscriptions)
+    #puts user_subscriptions.to_yaml
+  end
+
+  def test_playlist
+    ## get playlist - multiple elements in playlist
+    playlist = Youtube::Playlist.find("EBF5D6DC4589D7B7")
+    assert_equal(playlist.entry[0].group.content[0].url, "http://www.youtube.com/v/eenf1boHATs")
+
+    ## get playlist - single element in playlist
+    playlist = Youtube::Playlist.find("45C563323B344971")
+    assert_equal("http://www.youtube.com/v/i2xMvKOLzYM",playlist.entry[0].group.content[0].url)
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: active_youtube
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2008-02-03 00:00:00 +05:30
+summary: Active Youtube allows consuming YouTube API in your Ruby/Rails project using ActiveResource.
+require_paths: 
+- lib
+email: quarkruby@gmail.com
+homepage: http://www.quarkruby.com/
+rubyforge_project: 
+description: Active Youtube allows consuming YouTube API in your Ruby/Rails project using ActiveResource.
+autorequire: activeresource
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- QuarkRuby
+files: 
+- lib/active_youtube.rb
+- lib/patch.rb
+- lib/activeyoutube.rb
+- lib/youtube.rb
+- examples.rb
+test_files: 
+- test/youtube_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: