tmm1-youtube-g 0.4.9.1 → 0.5.0

data/History.txt

@@ -1,4 +1,6 @@
-== trunk
+== 0.4.9.9 / 2008-09-01
+
+* Add Geodata information (thanks Jose Galisteo)
 * Added :page and :per_page options, this allows easier usage of the will_paginate
   plugin with the library. The :offset and :max_results options are no longer available. [Daniel Insley]
 * Added ability to get video responses on the instances of the YouTube::Model::Video object. [Daniel Insley]

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+lib/youtube_g.rb
+lib/youtube_g/client.rb
+lib/youtube_g/logger.rb
+lib/youtube_g/model/author.rb
+lib/youtube_g/model/category.rb
+lib/youtube_g/model/contact.rb
+lib/youtube_g/model/content.rb
+lib/youtube_g/model/playlist.rb
+lib/youtube_g/model/rating.rb
+lib/youtube_g/model/thumbnail.rb
+lib/youtube_g/model/user.rb
+lib/youtube_g/model/video.rb
+lib/youtube_g/parser.rb
+lib/youtube_g/record.rb
+lib/youtube_g/request/base_search.rb
+lib/youtube_g/request/standard_search.rb
+lib/youtube_g/request/user_search.rb
+lib/youtube_g/request/video_search.rb
+lib/youtube_g/request/video_upload.rb
+lib/youtube_g/response/video_search.rb
+test/test_client.rb
+test/test_video.rb
+test/test_video_search.rb

data/README.txt

@@ -37,6 +37,7 @@ Basic queries:
   client.videos_by(:categories => [:news, :sports])
   client.videos_by(:categories => [:news, :sports], :tags => ['soccer', 'football'])
   client.videos_by(:user => 'liz')
+  client.videos_by(:favorites, :user => 'liz')
 	
 Standard feeds:
 	

data/lib/youtube_g.rb

@@ -25,5 +25,5 @@ require File.dirname(__FILE__) + '/youtube_g/request/video_search'
 require File.dirname(__FILE__) + '/youtube_g/response/video_search'
 
 class YouTubeG #:nodoc:
-  VERSION = '0.4.5'
+  VERSION = '0.5.0'
 end

data/lib/youtube_g/client.rb

@@ -35,10 +35,10 @@ class YouTubeG
     # YouTubeG::Response::VideoSearch
     def videos_by(params, options={})
       request_params = params.respond_to?(:to_hash) ? params : options
-      request_params[:page] ||= 1
+      request_params[:page] = integer_or_default(request_params[:page], 1)
       
       unless request_params[:max_results]
-        request_params[:max_results] = request_params[:per_page] || 25
+        request_params[:max_results] = integer_or_default(request_params[:per_page], 25)
       end
       
       unless request_params[:offset]
@@ -48,7 +48,7 @@ class YouTubeG
       if params.respond_to?(:to_hash) and not params[:user]
         request = YouTubeG::Request::VideoSearch.new(request_params)
       elsif (params.respond_to?(:to_hash) && params[:user]) || (params == :favorites)
-        request = YouTubeG::Request::UserSearch.new(request_params, options)
+        request = YouTubeG::Request::UserSearch.new(params, request_params)
       else
         request = YouTubeG::Request::StandardSearch.new(params, request_params)
       end
@@ -77,5 +77,9 @@ class YouTubeG
       page == 1 ? 1 : ((per_page * page) - per_page + 1)
     end
     
+    def integer_or_default(value, default)
+      value = value.to_i
+      value > 0 ? value : default
+    end
   end
 end

data/lib/youtube_g/model/video.rb

@@ -108,6 +108,12 @@ class YouTubeG
       
       # *Fixnum*:: Number of times that the video has been viewed
       attr_reader :view_count
+
+      # Geodata
+      attr_reader :where
+      attr_reader :position
+      attr_reader :latitude
+      attr_reader :longitude
       
       attr_reader :statistics
       

data/lib/youtube_g/parser.rb

@@ -91,6 +91,11 @@ class YouTubeG
         noembed = entry.elements["yt:noembed"] ? true : false
         racy = entry.elements["media:rating"] ? true : false
 
+        if where = entry.elements["georss:where"]
+          position = where.elements["gml:Point"].elements["gml:pos"].text
+          latitude, longitude = position.split(" ")
+        end
+
         YouTubeG::Model::Video.new(
           :video_id => video_id,
           :published_at => published_at,
@@ -108,7 +113,11 @@ class YouTubeG
           :rating => rating,
           :view_count => view_count,
           :noembed => noembed,
-          :racy => racy)
+          :racy => racy,
+          :where => where,
+          :position => position,
+          :latitude => latitude,
+          :longitude => longitude)
       end
 
       def parse_media_content (media_content_element) 

data/lib/youtube_g/request/base_search.rb

@@ -24,7 +24,7 @@ class YouTubeG
         # pair for which the value is non-nil
         u = '?'
         item_count = 0
-        params.keys.each do |key|
+        params.keys.sort.each do |key|
           value = params[key]
           next if value.nil?
 

data/lib/youtube_g/request/user_search.rb

@@ -1,10 +1,27 @@
 class YouTubeG
   module Request #:nodoc:  
     class UserSearch < BaseSearch #:nodoc:      
+      attr_reader :max_results                     # max_results
+      attr_reader :order_by                        # orderby, ([relevance], viewCount, published, rating)
+      attr_reader :offset                          # start-index
+
       def initialize(params, options={})
+        @max_results, @order_by, @offset = nil
         @url = base_url
-        return @url << "#{options[:user]}/favorites" if params == :favorites
-        @url << "#{params[:user]}/uploads" if params[:user]
+
+        if params == :favorites
+          @url << "#{options[:user]}/favorites" 
+          set_instance_variables(options)
+        elsif params[:user] && options[:favorites]
+          @url << "#{params[:user]}/favorites"
+          set_instance_variables(params)
+          break
+        elsif params[:user]
+          @url << "#{params[:user]}/uploads"
+          set_instance_variables(params)
+        end
+        
+        @url << build_query_params(to_youtube_params)
       end
 
       private
@@ -12,6 +29,14 @@ class YouTubeG
       def base_url #:nodoc:
         super << "users/"
       end
+
+      def to_youtube_params #:nodoc:
+        {
+          'max-results' => @max_results,
+          'orderby' => @order_by,
+          'start-index' => @offset
+        }
+      end
     end
     
   end

data/lib/youtube_g/response/video_search.rb

@@ -18,6 +18,24 @@ class YouTubeG
 
       # *Array*:: Array of YouTubeG::Model::Video records
       attr_reader :videos
+
+      def current_page
+        ((offset - 1) / max_result_count) + 1
+      end
+      
+      # current_page + 1 or nil if there is no next page
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+
+      # current_page - 1 or nil if there is no previous page
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+
+      def total_pages
+        (total_result_count / max_result_count.to_f).ceil
+      end
     end
   end
 end

data/test/test_client.rb

@@ -52,7 +52,6 @@ class TestClient < Test::Unit::TestCase
     assert_equal 51, response2.offset
   end
   
-  
   def test_should_get_videos_for_multiword_metasearch_query
     response = @client.videos_by(:query => 'christina ricci')
   
@@ -132,6 +131,13 @@ class TestClient < Test::Unit::TestCase
     response = @client.videos_by(:user => 'liz')
     response.videos.each { |v| assert_valid_video v }
   end
+  
+  def test_should_get_videos_by_user_with_pagination_and_ordering
+    response = @client.videos_by(:user => 'liz', :page => 2, :per_page => '2', :order_by => 'published')
+    response.videos.each { |v| assert_valid_video v }
+    assert_equal 3, response.offset
+    assert_equal 2, response.max_result_count
+  end
 
   # HTTP 403 Error
   # def test_should_get_favorite_videos_by_user
@@ -139,6 +145,12 @@ class TestClient < Test::Unit::TestCase
   #   response.videos.each { |v| assert_valid_video v }
   # end
   
+  def test_should_get_favorite_videos_by_user
+    response = @client.videos_by(:favorites, :user => 'drnicwilliams')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/drnicwilliams/favorites", response.feed_id
+    response.videos.each { |v| assert_valid_video v }
+  end
+  
   def test_should_get_videos_for_query_search_with_categories_excluded
     video = @client.video_by("EkF4JD2rO3Q")
     assert_equal "<object width=\"425\" height=\"350\">\n  <param name=\"movie\" value=\"http://www.youtube.com/v/EkF4JD2rO3Q\"></param>\n  <param name=\"wmode\" value=\"transparent\"></param>\n  <embed src=\"http://www.youtube.com/v/EkF4JD2rO3Q\" type=\"application/x-shockwave-flash\" \n   wmode=\"transparent\" width=\"425\" height=\"350\"></embed>\n</object>\n", video.embed_html

data/test/test_video_search.rb

@@ -74,7 +74,7 @@ class TestVideoSearch < Test::Unit::TestCase
   
   def test_should_build_url_for_most_viewed_offset_and_max_results_with_time
     request = YouTubeG::Request::StandardSearch.new(:top_rated, :offset => 5, :max_results => 10, :time => :today)
-    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated?time=today&max-results=10&start-index=5", request.url   
+    assert_equal "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated?max-results=10&start-index=5&time=today", request.url   
   end
 
   def test_should_raise_exception_for_invalid_type
@@ -111,7 +111,7 @@ class TestVideoSearch < Test::Unit::TestCase
     request = YouTubeG::Request::VideoSearch.new(:query => 'bench press', 
                                                  :categories => { :exclude => [:comedy, :entertainment] },
                                                  :max_results => 10)
-    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/-Comedy/-Entertainment/?vq=bench+press&max-results=10", request.url
+    assert_equal "http://gdata.youtube.com/feeds/api/videos/-/-Comedy/-Entertainment/?max-results=10&vq=bench+press", request.url
   end
   
   # -- User Queries ---------------------------------------------------------------------------------
@@ -121,8 +121,18 @@ class TestVideoSearch < Test::Unit::TestCase
     assert_equal "http://gdata.youtube.com/feeds/api/users/liz/uploads", request.url
   end
   
+  def test_should_build_url_for_videos_by_user_paginate_and_order
+    request = YouTubeG::Request::UserSearch.new(:user => 'liz', :offset => 20, :max_results => 10, :order_by => 'published')
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/uploads?max-results=10&orderby=published&start-index=20", request.url
+  end
+
   def test_should_build_url_for_favorite_videos_by_user
     request = YouTubeG::Request::UserSearch.new(:favorites, :user => 'liz')
     assert_equal "http://gdata.youtube.com/feeds/api/users/liz/favorites", request.url
   end
+
+  def test_should_build_url_for_favorite_videos_by_user_paginate
+    request = YouTubeG::Request::UserSearch.new(:favorites, :user => 'liz', :offset => 20, :max_results => 10)
+    assert_equal "http://gdata.youtube.com/feeds/api/users/liz/favorites?max-results=10&start-index=20", request.url
+  end
 end

data/youtube-g.gemspec

@@ -1,7 +1,7 @@
 spec = Gem::Specification.new do |s|
   s.name = 'youtube-g'
-  s.version = '0.4.9.1'
-  s.date = '2008-06-08'
+  s.version = '0.5.0'
+  s.date = '2009-01-07'
   s.summary = 'An object-oriented Ruby wrapper for the YouTube GData API'
   s.email = "ruby-youtube-library@googlegroups.com"
   s.homepage = "http://youtube-g.rubyforge.org/"
@@ -12,32 +12,33 @@ spec = Gem::Specification.new do |s|
   # ruby -rpp -e "pp Dir['**/*.*'].map"
   s.files = [
     "History.txt",
-    "README.txt",
-    "TODO.txt",
-    "lib/youtube_g/client.rb",
-    "lib/youtube_g/logger.rb",
-    "lib/youtube_g/model/author.rb",
-    "lib/youtube_g/model/category.rb",
-    "lib/youtube_g/model/contact.rb",
-    "lib/youtube_g/model/content.rb",
-    "lib/youtube_g/model/playlist.rb",
-    "lib/youtube_g/model/rating.rb",
-    "lib/youtube_g/model/thumbnail.rb",
-    "lib/youtube_g/model/user.rb",
-    "lib/youtube_g/model/video.rb",
-    "lib/youtube_g/parser.rb",
-    "lib/youtube_g/record.rb",
-    "lib/youtube_g/request/base_search.rb",
-    "lib/youtube_g/request/standard_search.rb",
-    "lib/youtube_g/request/user_search.rb",
-    "lib/youtube_g/request/video_search.rb",
-    "lib/youtube_g/request/video_upload.rb",
-    "lib/youtube_g/response/video_search.rb",
-    "lib/youtube_g.rb",
-    "test/test_client.rb",
-    "test/test_video.rb",
-    "test/test_video_search.rb",
-    "youtube-g.gemspec"
+     "lib/youtube_g/client.rb",
+     "lib/youtube_g/logger.rb",
+     "lib/youtube_g/model/author.rb",
+     "lib/youtube_g/model/category.rb",
+     "lib/youtube_g/model/contact.rb",
+     "lib/youtube_g/model/content.rb",
+     "lib/youtube_g/model/playlist.rb",
+     "lib/youtube_g/model/rating.rb",
+     "lib/youtube_g/model/thumbnail.rb",
+     "lib/youtube_g/model/user.rb",
+     "lib/youtube_g/model/video.rb",
+     "lib/youtube_g/parser.rb",
+     "lib/youtube_g/record.rb",
+     "lib/youtube_g/request/base_search.rb",
+     "lib/youtube_g/request/standard_search.rb",
+     "lib/youtube_g/request/user_search.rb",
+     "lib/youtube_g/request/video_search.rb",
+     "lib/youtube_g/request/video_upload.rb",
+     "lib/youtube_g/response/video_search.rb",
+     "lib/youtube_g.rb",
+     "Manifest.txt",
+     "README.txt",
+     "test/test_client.rb",
+     "test/test_video.rb",
+     "test/test_video_search.rb",
+     "TODO.txt",
+     "youtube-g.gemspec"
   ]
 
   s.test_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tmm1-youtube-g
 version: !ruby/object:Gem::Version 
-  version: 0.4.9.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Shane Vitarana
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-08 00:00:00 -07:00
+date: 2009-01-07 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -27,8 +27,6 @@ extra_rdoc_files:
 - README.txt
 files: 
 - History.txt
-- README.txt
-- TODO.txt
 - lib/youtube_g/client.rb
 - lib/youtube_g/logger.rb
 - lib/youtube_g/model/author.rb
@@ -49,9 +47,12 @@ files:
 - lib/youtube_g/request/video_upload.rb
 - lib/youtube_g/response/video_search.rb
 - lib/youtube_g.rb
+- Manifest.txt
+- README.txt
 - test/test_client.rb
 - test/test_video.rb
 - test/test_video_search.rb
+- TODO.txt
 - youtube-g.gemspec
 has_rdoc: true
 homepage: http://youtube-g.rubyforge.org/