yt 0.19.0 → 0.20.0

data/lib/yt/models/statistics_set.rb

@@ -12,32 +12,14 @@ module Yt
         @data = options[:data]
       end
 
-      # @return [Integer] the number of times the resource has been viewed.
       has_attribute :view_count, type: Integer
-
-      # @return [Integer] the number of comments for the resource.
       has_attribute :comment_count, type: Integer
-
-      # @return [Integer] the number of users who liked the resource.
       has_attribute :like_count, type: Integer
-
-      # @return [Integer] the number of users who disliked the resource.
       has_attribute :dislike_count, type: Integer
-
-      # @return [Integer] the number of users who currently have the resource
-      #   marked as a favorite resource.
       has_attribute :favorite_count, type: Integer
-
-      # @return [Integer] the number of videos updated to the resource.
       has_attribute :video_count, type: Integer
-
-      # @return [Integer] the number of subscriber the resource has.
       has_attribute :subscriber_count, type: Integer
-
-      # @return [Boolean] whether the number of subscribers is publicly visible.
-      has_attribute :subscriber_count_visible?, from: :hidden_subscriber_count do |hidden|
-        hidden == false
-      end
+      has_attribute :hidden_subscriber_count
     end
   end
 end

data/lib/yt/models/status.rb

@@ -20,8 +20,6 @@ module Yt
 
 # Privacy status
 
-      PRIVACY_STATUSES = %q(private public unlisted)
-
       has_attribute :privacy_status
       has_attribute :upload_status
       has_attribute :failure_reason

data/lib/yt/models/video.rb

@@ -6,7 +6,7 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/videos
     class Video < Resource
 
-  ### SNIPPET ###
+    ### SNIPPET ###
 
       # @!attribute [r] title
       # @return [String] the video’s title.
@@ -16,7 +16,7 @@ module Yt
       # @return [String] the video’s description.
       delegate :description, to: :snippet
 
-      # Return the URL of the video’s thumbnail.
+      # Returns the URL of the video’s thumbnail.
       # @!method thumbnail_url(size = :default)
       # @param [Symbol, String] size The size of the video’s thumbnail.
       # @return [String] if +size+ is +default+, the URL of a 120x90px image.
@@ -364,7 +364,7 @@ module Yt
       #   hidden the viewcount for the video or the video is not live.
       delegate :concurrent_viewers, to: :live_streaming_detail
 
-    ### ANNOTATIONS ###
+    ### ASSOCIATIONS ###
 
       # @!attribute [r] annotations
       #   @return [Yt::Collections::Annotations] the video’s annotations.
@@ -372,65 +372,65 @@ module Yt
 
     ### ANALYTICS ###
 
-      # @macro views_report
+      # @macro report_by_video_dimensions
       has_report :views
 
-      # @macro demographics_report
+      # @macro report_by_video_dimensions
+      has_report :estimated_minutes_watched
+
+      # @macro report_by_gender_and_age_group
       has_report :viewer_percentage
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :comments
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :likes
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :dislikes
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :shares
 
       # @note This is not the total number of subscribers gained by the video’s
       #   channel, but the subscribers gained *from* the video’s page.
-      # @macro daily_report
+      # @macro report_by_day
       has_report :subscribers_gained
 
       # @note This is not the total number of subscribers lost by the video’s
       #   channel, but the subscribers lost *from* the video’s page.
-      # @macro daily_report
+      # @macro report_by_day
       has_report :subscribers_lost
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :favorites_added
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :favorites_removed
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :average_view_duration
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :average_view_percentage
 
-      # @macro daily_report
-      has_report :estimated_minutes_watched
-
-      # @macro daily_report
+      # @macro report_by_day
       has_report :annotation_clicks
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :annotation_click_through_rate
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :annotation_close_rate
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :earnings
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :impressions
 
-      # @macro daily_report
+      # @macro report_by_day
       has_report :monetized_playbacks
 
     ### STATISTICS ###
@@ -466,7 +466,6 @@ module Yt
       #   player that will play the video.
       delegate :embed_html, to: :player
 
-
     ### ACTIONS (UPLOAD, UPDATE, DELETE) ###
 
       has_many :resumable_sessions
@@ -602,17 +601,6 @@ module Yt
 
     private
 
-      # Since YouTube API only returns tags on Videos#list, the memoized
-      # `@snippet` is erased if the video was instantiated through Video#search
-      # (e.g., by calling account.videos or channel.videos), so that the full
-      # snippet (with tags and category) is loaded, rather than the partial one.
-      def ensure_complete_snippet(attribute)
-        unless snippet.public_send(attribute).present? || snippet.complete?
-          @snippet = nil
-        end
-        snippet.public_send attribute
-      end
-
       # TODO: instead of having Video, Playlist etc override this method,
       #       they should define *what* can be updated in their own *update*
       #       method.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
 end

data/spec/models/channel_spec.rb

@@ -4,6 +4,113 @@ require 'yt/models/channel'
 describe Yt::Channel do
   subject(:channel) { Yt::Channel.new attrs }
 
+  describe '#title' do
+    context 'given a snippet with a title' do
+      let(:attrs) { {snippet: {"title"=>"Fullscreen"}} }
+      it { expect(channel.title).to eq 'Fullscreen' }
+    end
+
+    context 'given a snippet without a title' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(channel.title).to eq '' }
+    end
+  end
+
+  describe '#description' do
+    context 'given a snippet with a description' do
+      let(:attrs) { {snippet: {"description"=>"A cool channel."}} }
+      it { expect(channel.description).to eq 'A cool channel.' }
+    end
+
+    context 'given a snippet without a description' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(channel.description).to eq '' }
+    end
+  end
+
+  describe '#thumbnail_url' do
+    context 'given a snippet with thumbnails' do
+      let(:attrs) { {snippet: {"thumbnails"=>{
+        "default"=>{"url"=> "http://example.com/88x88.jpg"},
+        "medium"=>{"url"=> "http://example.com/240x240.jpg"},
+      }}} }
+      it { expect(channel.thumbnail_url).to eq 'http://example.com/88x88.jpg' }
+      it { expect(channel.thumbnail_url 'default').to eq 'http://example.com/88x88.jpg' }
+      it { expect(channel.thumbnail_url :default).to eq 'http://example.com/88x88.jpg' }
+      it { expect(channel.thumbnail_url :medium).to eq 'http://example.com/240x240.jpg' }
+      it { expect(channel.thumbnail_url :high).to be_nil }
+    end
+
+    context 'given a snippet without thumbnails' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(channel.thumbnail_url).to be_nil }
+    end
+  end
+
+  describe '#published_at' do
+    context 'given a snippet with a timestamp' do
+      let(:attrs) { {snippet: {"publishedAt"=>"2014-04-22T19:14:49.000Z"}} }
+      it { expect(channel.published_at.year).to be 2014 }
+    end
+  end
+
+  describe '#comment_count' do
+    context 'given a video with comments' do
+      let(:attrs) { {statistics: {"commentCount"=>"33"}} }
+      it { expect(channel.comment_count).to be 33 }
+    end
+  end
+
+  describe '#video_count' do
+    context 'given a video with videos' do
+      let(:attrs) { {statistics: {"videoCount"=>"42"}} }
+      it { expect(channel.video_count).to be 42 }
+    end
+  end
+
+  describe '#subscriber_count' do
+    context 'given a video with subscribers' do
+      let(:attrs) { {statistics: {"subscriberCount"=>"12"}} }
+      it { expect(channel.subscriber_count).to be 12 }
+    end
+  end
+
+  describe '#subscriber_count_visible?' do
+    context 'given a video with publicly visible subscribers' do
+      let(:attrs) { {statistics: {"hiddenSubscriberCount"=>false}} }
+      it { expect(channel).to be_subscriber_count_visible }
+    end
+
+    context 'given a video with hidden subscribers' do
+      let(:attrs) { {statistics: {"hiddenSubscriberCount"=>true}} }
+      it { expect(channel).not_to be_subscriber_count_visible }
+    end
+  end
+
+  describe '#content_owner' do
+    context 'given a content_owner_detail with a content owner' do
+      let(:attrs) { {content_owner_details: {"contentOwner"=>"FullScreen"}} }
+      it { expect(channel.content_owner).to eq 'FullScreen' }
+    end
+
+    context 'given a content_owner_detail without a content owner' do
+      let(:attrs) { {content_owner_details: {}} }
+      it { expect(channel.content_owner).to be_nil }
+    end
+  end
+
+  describe '#linked_at' do
+    context 'given a content_owner_detail with a timeLinked' do
+      let(:attrs) { {content_owner_details: {"timeLinked"=>"2014-04-22T19:14:49.000Z"}} }
+      it { expect(channel.linked_at.year).to be 2014 }
+    end
+
+    context 'given a content_owner_detail with a timeLinked' do
+      let(:attrs) { {content_owner_details: {}} }
+      it { expect(channel.linked_at).to be_nil }
+    end
+  end
+
   describe '#snippet' do
     context 'given fetching a channel returns a snippet' do
       let(:attrs) { {snippet: {"title"=>"Fullscreen"}} }

data/spec/models/content_owner_detail_spec.rb

@@ -3,28 +3,4 @@ require 'yt/models/content_owner_detail'
 
 describe Yt::ContentOwnerDetail do
   subject(:content_owner_detail) { Yt::ContentOwnerDetail.new data: data }
-
-  describe '#content_owner' do
-    context 'given a content_owner_detail with a content owner' do
-      let(:data) { {"contentOwner"=>"FullScreen"} }
-      it { expect(content_owner_detail.content_owner).to eq 'FullScreen' }
-    end
-
-    context 'given a content_owner_detail without a content owner' do
-      let(:data) { {} }
-      it { expect(content_owner_detail.content_owner).to be_nil }
-    end
-  end
-
-  describe '#linked_at' do
-    context 'given a content_owner_detail with a timeLinked' do
-      let(:data) { {"timeLinked"=>"2014-04-22T19:14:49.000Z"} }
-      it { expect(content_owner_detail.linked_at.year).to be 2014 }
-    end
-
-    context 'given a content_owner_detail with a timeLinked' do
-      let(:data) { {} }
-      it { expect(content_owner_detail.linked_at).to be_nil }
-    end
-  end
 end

data/spec/models/playlist_item_spec.rb

@@ -2,19 +2,108 @@ require 'spec_helper'
 require 'yt/models/playlist_item'
 
 describe Yt::PlaylistItem do
-  subject(:playlist_item) { Yt::PlaylistItem.new attrs }
+  subject(:item) { Yt::PlaylistItem.new attrs }
+
+  describe '#title' do
+    context 'given a snippet with a title' do
+      let(:attrs) { {snippet: {"title"=>"Fullscreen"}} }
+      it { expect(item.title).to eq 'Fullscreen' }
+    end
+
+    context 'given a snippet without a title' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.title).to eq '' }
+    end
+  end
+
+  describe '#published_at' do
+    context 'given a snippet with a timestamp' do
+      let(:attrs) { {snippet: {"publishedAt"=>"2014-04-22T19:14:49.000Z"}} }
+      it { expect(item.published_at.year).to be 2014 }
+    end
+  end
+
+  describe '#description' do
+    context 'given a snippet with a description' do
+      let(:attrs) { {snippet: {"description"=>"A video."}} }
+      it { expect(item.description).to eq 'A video.' }
+    end
+
+    context 'given a snippet without a description' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.description).to eq '' }
+    end
+  end
+
+  describe '#thumbnail_url' do
+    context 'given a snippet with thumbnails' do
+      let(:attrs) { {snippet: {"thumbnails"=>{
+        "default"=>{"url"=> "http://example.com/120x90.jpg"},
+        "medium"=>{"url"=> "http://example.com/320x180.jpg"},
+      }}} }
+      it { expect(item.thumbnail_url).to eq 'http://example.com/120x90.jpg' }
+      it { expect(item.thumbnail_url 'default').to eq 'http://example.com/120x90.jpg' }
+      it { expect(item.thumbnail_url :default).to eq 'http://example.com/120x90.jpg' }
+      it { expect(item.thumbnail_url :medium).to eq 'http://example.com/320x180.jpg' }
+      it { expect(item.thumbnail_url :large).to be_nil }
+    end
+
+    context 'given a snippet without thumbnails' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.thumbnail_url).to be_nil }
+    end
+  end
+
+  describe '#channel_id' do
+    context 'given a snippet with a channel ID' do
+      let(:attrs) { {snippet: {"channelId"=>"UCxO1tY8h1AhOz0T4ENwmpow"}} }
+      it { expect(item.channel_id).to eq 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    end
+
+    context 'given a snippet without a channel ID' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.channel_id).to be_nil }
+    end
+  end
+
+  describe '#channel_title' do
+    context 'given a snippet with a channel title' do
+      let(:attrs) { {snippet: {"channelTitle"=>"Fullscreen"}} }
+      it { expect(item.channel_title).to eq 'Fullscreen' }
+    end
+
+    context 'given a snippet without a channel title' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.channel_title).to be_nil }
+    end
+  end
+
+  describe '#video_id and #video' do
+    context 'given a snippet with a video resource' do
+      let(:attrs) { {snippet: {"resourceId"=>{"kind"=>"youtube#video","videoId"=>"W4GhTprSsOY"}}} }
+      it { expect(item.video_id).to eq 'W4GhTprSsOY' }
+      it { expect(item.video).to be_a Yt::Models::Video }
+      it { expect(item.video.id).to eq 'W4GhTprSsOY' }
+    end
+
+    context 'given a snippet without a video resource' do
+      let(:attrs) { {snippet: {}} }
+      it { expect(item.video_id).to be_nil }
+      it { expect(item.video).to be_nil }
+    end
+  end
 
   describe '#snippet' do
     context 'given fetching a playlist item returns a snippet' do
       let(:attrs) { {snippet: {"position"=>0}} }
-      it { expect(playlist_item.snippet).to be_a Yt::Snippet }
+      it { expect(item.snippet).to be_a Yt::Snippet }
     end
   end
 
   describe '#status' do
     context 'given fetching a playlist item returns a status' do
       let(:attrs) { {status: {"privacyStatus"=>"public"}} }
-      it { expect(playlist_item.status).to be_a Yt::Status }
+      it { expect(item.status).to be_a Yt::Status }
     end
   end
 
@@ -22,10 +111,10 @@ describe Yt::PlaylistItem do
     let(:attrs) { {id: 'playlist-item-id'} }
 
     context 'given an existing playlist item' do
-      before { expect(playlist_item).to receive(:do_delete).and_yield }
+      before { expect(item).to receive(:do_delete).and_yield }
 
-      it { expect(playlist_item.delete).to be true }
-      it { expect{playlist_item.delete}.to change{playlist_item.exists?} }
+      it { expect(item.delete).to be true }
+      it { expect{item.delete}.to change{item.exists?} }
     end
   end
 end