downthetube 0.0.9 → 1.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## v1.0.0
+
+* Added test coverage with RSpec
+* Fixed some bugs

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    downthetube (0.0.9)
+      gdata_19 (>= 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    gdata_19 (1.1.3)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  downthetube!
+  rspec

data/README

@@ -16,61 +16,21 @@ require 'downthetube'
 
 And then play. I've tried to make it do what you would expect:
 
-irb(main):018:0> pl = Youtube::Playlist.new "76E01802262A6694"
-=> #<Youtube::Playlist:0x7ff91ce51f38 @url="http://gdata.youtube.com/feeds/api/playlists/76E01802262A6694">
-
-irb(main):019:0> playlists = Youtube.playlists_for "stephensam"
-=> [#<Youtube::Playlist:0x7ff91ce214c8 @client=#<GData::Client::YouTube:0x7ff91ce1e9a8 @source="AnonymousApp", @http_service=GData::HTTP::DefaultService, @clientlogin_url="https://www.google.com/youtube/accounts/ClientLogin", @authsub_scope="http://gdata.youtube.com", @version="2", @headers={}, @clientlogin_service="youtube">, @url="http://gdata.youtube.com/feeds/api/playlists/76E01802262A6694", @author="stephensam", @xml=<entry gd:etag='W/&quot;CUQGR347eCp7ImA9WhZVGEk.&quot;'> ... </>, @title="Capoeira Angola", @id="76E01802262A6694">]
-
-irb(main):021:0> playlists.first.title
-=> "Capoeira Angola"
-
-irb(main):022:0> playlists.class
-=> Array
-
-irb(main):023:0> vids = playlists.first.videos 2
-=> [#<Youtube::Video:0x7ff91cf63098 @xml=<entry gd:etag='W/&quot;AkQDQ3s-fCp7ImA9WhZUEkk.&quot;'> ... </>>, #<Youtube::Video:0x7ff91cf59bd8 @xml=<entry gd:etag='W/&quot;AkQDQ3s-fCp7ImA9WhZUEkk.&quot;'> ... </>>]
-
-irb(main):024:0> vid = vids.last
-=> #<Youtube::Video:0x7ff91cf59bd8 @xml=<entry gd:etag='W/&quot;AkQDQ3s-fCp7ImA9WhZUEkk.&quot;'> ... </>>
-
-irb(main):025:0> vid.title
-=> "Mestre Jogo De Dentro e Mestra Tisza,Ilheus 2008"
-
-irb(main):026:0> vid.description
-=> "Roda de fim de ano na praca de Ilheus 2008,gravado por CM Denis."
-
-irb(main):027:0> vid.url
-=> "http://www.youtube.com/watch?v=4I_4JgV-y8s"
-
-irb(main):028:0> vid.thumbnail :large
-=> "http://i.ytimg.com/vi/4I_4JgV-y8s/hqdefault.jpg"
-
-irb(main):029:0> itapua = Youtube::Video.new "5Pg6a3TbF68"
-=> #<Youtube::Video:0x7ff91cf097a0 @url="http://gdata.youtube.com/feeds/api/videos/5Pg6a3TbF68?v=2">
-
-irb(main):030:0> itapua.thumbnail
-=> "http://i.ytimg.com/vi/5Pg6a3TbF68/default.jpg"
-
-irb(main):031:0> itapua.title
-=> "Itapuã e Gibi - Roda Lavradio"
-
-irb(main):032:0> itapua.url
-=> "http://www.youtube.com/watch?v=5Pg6a3TbF68"
-
-You can also get the video object to return a hash of its important info by calling to_h:
-
-irb(main):009:0> vid = Youtube::Video.new "QSiGw6noULA"
-=> #<Youtube::Video:0x7fec0cbc9300 @url="http://gdata.youtube.com/feeds/api/videos/QSiGw6noULA?v=2">
-
-irb(main):010:0> vid.to_h
-=> {:title=>"Semente do Jogo de Angola - Tradição - Parte 1", :small_thumbnail=>"http://i.ytimg.com/vi/QSiGw6noULA/default.jpg", :description=>"Video produzido pelo Grupo de capoeira Semente do Jogo de Angola - Mestre Jogo de Dentro\nwww.sementedojogodeangola.org.br", :large_thumbnail=>"http://i.ytimg.com/vi/QSiGw6noULA/hqdefault.jpg", :uploader=>"valmirmauricio", :duration=>"120", :url=>"http://www.youtube.com/watch?v=QSiGw6noULA", :id=>"QSiGw6noULA"}
+  Youtube::Playlist.new("76E01802262A6694")
+  playlists = Youtube.playlists_for "stephensam"
+  playlists.first.title # "Capoeira Angola"
+  vids = playlists.first.videos 2
+  vid = vids.last
+  vid.title # "Mestre Jogo De Dentro e Mestra Tisza,Ilheus 2008"
+  vid.description # "Roda de fim de ano na praca de Ilheus 2008,gravado por CM Denis."
+  vid.url # "http://www.youtube.com/watch?v=4I_4JgV-y8s"
+  vid.thumbnail(:large) # "http://i.ytimg.com/vi/4I_4JgV-y8s/hqdefault.jpg"
 
 LICENSE:
 
 (The MIT License)
 
-Copyright © 2010 - 2011 Mike Williamson
+Copyright © 2011 Mike Williamson
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

data/downthetube.gemspec

@@ -1,18 +1,18 @@
 specification = Gem::Specification.new do |spec|
   # Descriptive and source information for this gem.
   spec.name = "downthetube"
-  spec.version = "0.0.9"
+  spec.version = "1.0"
   spec.description = "A library to make downloading playlists and videos from Youtube less nasty."
   spec.summary = "Downloads playlists and videos from Youtube."
   spec.author = "Mike Williamson"
   spec.email = "blessedbyvirtuosity@gmail.com"
-  spec.homepage = ""
+  spec.homepage = "http://mikewilliamson.wordpress.com"
   require 'rake'
-  spec.files = %w(README lib/downthetube.rb lib/youtube.rb lib/video.rb lib/play_list.rb downthetube.gemspec)
-  spec.has_rdoc = false
+  spec.files = %w(README CHANGELOG.md Gemfile Gemfile.lock lib/downthetube.rb lib/youtube.rb lib/video.rb lib/play_list.rb downthetube.gemspec)
+  spec.has_rdoc = true
   spec.add_dependency("gdata_19", ">= 1.0.0")
   spec.extra_rdoc_files = ["README"]
   spec.require_path = ["lib"]
-  #spec.test_files = ["spec"]
+  spec.test_files = ["spec"]
 end
 

data/lib/play_list.rb

@@ -1,7 +1,21 @@
 module Youtube
-  class Playlist
-    #TODO reduce the duplication between this and the video class
+  ##
+  # Represents an individual playlist. A single Playlist object can be
+  # instantiated with a playlist id. The id can be found in the url 
+  # and a few other places: gdata.youtube.com/feeds/api/playlists/<b>AAE42E282C4AD007</b>?v=2
+  # 
+  # === Example
+  #  playlist = Youtube::Playlist.new "AAE42E282C4AD007"
+  #  playlist.title # "Mestre Jogo de Dentro & Seus Alunos"
+  #  playlist.id # "AAE42E282C4AD007" 
+  #  playlist.author # "stephensam" 
+  #  playlist.url #"\http://gdata.youtube.com/feeds/api/playlists/AAE42E282C4AD007" 
+  #  videos = playlist.videos(3) # returns 3 videos
 
+  class Playlist
+    #--
+    # TODO reduce the duplication between this and the video class
+    #++
     #include Naming from ActiveRecord if its here.
     begin
       self.extend ActiveModel::Naming
@@ -9,54 +23,45 @@ module Youtube
       #do nothing 
     end
   
-    attr_reader :url
-  
+    ##
+    # Instantiate individual instances of this class with a
+    # YouTube id.
+
     def initialize entry
 
       define_attrs
 
       if ((entry) && (entry.class == REXML::Element))
         @xml = entry
+        @id = /\w{16}/.match(@xml.elements['id'].text).to_s
         populate_attrs
 
       elsif((entry.class==String)&&(entry =~ /\w{16}/))
         @url = "http://gdata.youtube.com/feeds/api/playlists/#{entry}"
+        @id = entry.to_s
       else
         raise "The Playlist class did not understand the parameter it was initialized with."
       end
     end
 
-    def populate_attrs
-        @client ||= GData::Client::YouTube.new
-        @xml ||= @client.get(self.url).to_xml
 
-        @id = @xml.get_text('yt:playlistId')
-        @title =  @xml.get_text('title')
-        @author =  @xml.get_text('author/name')
-        @xml.each_element_with_attribute('src'){|a| @url = a.attribute('src').to_s }
-    end
-
-
-    def define_attrs
-      [:title, :author, :id].each do |attr|
-        method_def = <<-EOM
-          def #{attr}
-            if @#{attr}
-              @#{attr}
-            else
-              populate_attrs
-              @#{attr}
-            end
-          end
-        EOM
-        Playlist.class_eval method_def
-      end
-    end
   
-    def self.name
+    def self.name # :nodoc:
       "Playlist"
     end
+
+    ##
+    # Returns the gdata api url of the playlist.
+    # If you want the human friendly url pass in :human as an argument.
+    def url type = :api
+      type == :human ? @human_url : @url
+    end
   
+    ##
+    # This is the main raison d'être of the Playlist class:
+    # to retrieve a set of videos. If you want/need to you can 
+    # pass a integer like 5 to limit the number of videos returned.
+    #
     def videos limit=nil
   
       case 
@@ -77,6 +82,31 @@ module Youtube
   
     private
   
+    def populate_attrs # :nodoc:
+      @client ||= GData::Client::YouTube.new
+      @xml ||= @client.get(self.url).to_xml
+
+      @title =  @xml.elements['title'].text
+      @author =  @xml.elements['author/name'].text
+      @human_url = @xml.elements['link'].attribute('href').value
+      @url = @xml.elements.collect('link'){|l| l}[1].attribute('href').value
+    end
+
+    def define_attrs # :nodoc:
+      [:title, :author, :id].each do |attr|
+        method_def = <<-EOM
+          def #{attr}
+            if @#{attr}
+              @#{attr}.to_s
+            else
+              populate_attrs
+              @#{attr}.to_s
+            end
+          end
+        EOM
+        Playlist.class_eval method_def
+      end
+    end
     def get_videos number=nil
           @client ||= GData::Client::YouTube.new
         feed = @client.get(self.url).to_xml
@@ -85,13 +115,13 @@ module Youtube
         if number
             feed.elements.each('entry') do |entry|
             if counter <= number
-      	@videos<< Video.new(entry)
+      	@videos<< Youtube::Video.new(entry)
       	counter += 1
             end
           end
         else
             feed.elements.each('entry') do |entry|
-            @videos<< Video.new(entry)
+            @videos<< Youtube::Video.new(entry)
           end
         end
     end

data/lib/video.rb

@@ -1,6 +1,20 @@
+require 'open-uri'
 module Youtube
+  ##
+  # The video class rather unsurprisingly represents an individual
+  # YouTube video. 
+  # 
+  # === Example
+  #   video = playlist.videos.first
+  #   video.title # "Semeando 2010 - Mestre Jogo de Dentro" 
+  #   video.duration #returns number of seconds: "93" 
+  #   video.description # "2010 o VII Encontro Internacional de Capoeira Angola... " 
+  #   video.thumbnail(:large) # "\http://i.ytimg.com/vi/4YMMWt2808U/hqdefault.jpg" 
+  #   video.id # "4YMMWt2808U" 
+  #   video.uploader # "micheldezen" 
+  #   video.url # "http://www.youtube.com/watch?v=4YMMWt2808U"
+
   class Video
-    require 'gdata'
     #include Naming from ActiveRecord if its here.
     begin
       self.extend ActiveModel::Naming
@@ -8,8 +22,6 @@ module Youtube
       #do nothing 
     end
     
-    attr_reader :url
-
     def initialize entry
       
       define_attrs
@@ -23,27 +35,22 @@ module Youtube
       end
     end
 
-    def define_attrs
-      [:title, :description, :id, :uploader, :duration].each do |attr|
-        method_def = <<-EOM
-          def #{attr}
-            if @#{attr}
-              @#{attr}
-            else
-              populate_attrs
-              @#{attr}
-            end
-          end
-        EOM
-        Video.class_eval method_def
-      end
+    ##
+    # Returns the url of the video
+    def url
+      populate_attrs unless @url
+      @url
     end
 
     
-    def self.name
+    def self.name # :nodoc:
       "Video"
     end
 
+    ##
+    # Returns the url of the thumbnail image for the video.
+    # If you want the large thumbnail pass :large as a parameter.
+
     def thumbnail size=:small
       populate_attrs unless @large_thumbnail && @small_thumbnail
      if size == :large
@@ -52,7 +59,41 @@ module Youtube
 	@small_thumbnail
       end	
     end
+    
+    ##
+    # Returns that the video was instantiated with.
+    def to_xml
+      @xml.to_s
+    end
+
+    ##
+    # Returns a hash with the video attributes in it.
+    def to_h
+      populate_attrs unless @xml
+        h = {}
+      instance_variables.each do |var| 
+        h[var.to_s.gsub('@', '').to_sym]= self.instance_variable_get(var.to_sym).to_s unless [:@client, :@xml].include? var
+      end
+      h
+    end
 
+    private
+
+    def define_attrs
+      [:title, :description, :id, :uploader, :duration].each do |attr|
+        method_def = <<-EOM
+          def #{attr}
+            if @#{attr}
+              @#{attr}.to_s
+            else
+              populate_attrs
+              @#{attr}.to_s
+            end
+          end
+        EOM
+        Video.class_eval method_def
+      end
+    end
 
     def populate_attrs
         
@@ -77,20 +118,6 @@ module Youtube
 	  end
 	end
     end
-
-    def to_xml
-      @xml.to_s
-    end
-
-    def to_h
-      populate_attrs unless @xml
-        h = {}
-      instance_variables.each do |var| 
-        h[var.gsub('@', '').to_sym]= self.instance_variable_get(var.to_sym).to_s unless %w( @client @xml ).include? var
-      end
-      h
-    end
-
   end
 end
 

data/lib/youtube.rb

@@ -2,17 +2,44 @@ module Youtube
     require 'rubygems'
     require 'gdata'
     require 'rexml/document'  
+
+    ##
+    # This is the main entry point. It accepts a YouTube 
+    # username such as <tt>stephensam</tt> and returning an array
+    # of playlists belonging to that user.
+    #
+    # === Example
+    # playlists = Youtube.playlists_for("stephensam") # returns playlists for user <tt>stephensam</tt>
+ 
+
     def Youtube.playlists_for user
-      @client = GData::Client::YouTube.new
-      feed = @client.get("http://gdata.youtube.com/feeds/api/users/#{user}/playlists?v=2").to_xml
+      youtube = YT.new()
+      feed = youtube.feed_for(user)
       playlists = []
       feed.elements.each('entry') do |entry| 
   	playlists<< Playlist.new(entry)
       end
       playlists
     end  
-   
-  
-  
-  
+
+
+    class RetrievalError < StandardError
+    end
+
+    class YT  # :nodoc: all
+
+      def feed_for user
+        client = get_client
+        begin
+          response = client.get("http://gdata.youtube.com/feeds/api/users/#{user}/playlists?v=2")
+          response.to_xml
+        rescue Exception => e
+          raise Youtube::RetrievalError.new(e.message)
+        end
+      end
+
+      def get_client 
+        client = GData::Client::YouTube.new
+      end
+    end
 end

metadata

@@ -1,87 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: downthetube
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: '1.0'
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 9
-  version: 0.0.9
 platform: ruby
-authors: 
+authors:
 - Mike Williamson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-22 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: gdata_19
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &21505680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-description: A library to make downloading playlists and videos from Youtube less nasty.
+  prerelease: false
+  version_requirements: *21505680
+description: A library to make downloading playlists and videos from Youtube less
+  nasty.
 email: blessedbyvirtuosity@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
-files: 
+files:
 - README
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - lib/downthetube.rb
 - lib/youtube.rb
 - lib/video.rb
 - lib/play_list.rb
 - downthetube.gemspec
-has_rdoc: true
-homepage: ""
+homepage: http://mikewilliamson.wordpress.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Downloads playlists and videos from Youtube.
 test_files: []
-