yt 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a257c84e731d03c889aba6d840ae8945bff703c3
-  data.tar.gz: acddd55c13ed4013e4e8acae7c303e864bbd114b
+  metadata.gz: e6287e851c03a8285e094efa577c17f0a9ca6204
+  data.tar.gz: 0da6d402a9062dc8cc9e1759636d691f505eae13
 SHA512:
-  metadata.gz: 0c82294cbdb20eebf4208eacf95c370afa8044121bf20e8b76514979a3a4d981d2e4a46fdf82cb2915f701c983aeba9802d03405203adee27726b24a83d76a86
-  data.tar.gz: 469b86367d016835333f6a16c06a7f5463246eb4d5c53155d12e5f8274947ec85115cd891db6cda289f138075f3b05b0b156ba384e31e4d1f62207204bbf4741
+  metadata.gz: f345bff512092cf0ff25bb9223fccbe1555fba58a71bf5711312b870322925a1335c929a88e84d3c2317cd69883fcb50b80d89a102b3b64ffc96475f6064185a
+  data.tar.gz: 9544b7238eca631c1f933a9789ff88480fb57025126048c7e1bc07a5d0427ec191d5bfb3e0064c41c8c7c22a14287012a0acb0e1621cafff10d67bece4d3aa2d

data/.yardopts

@@ -1,3 +1,4 @@
+--non-transitive-tag private
 --no-private
 lib/yt/associations/has_reports.rb
 lib/yt/associations/has_viewer_percentages.rb

data/CHANGELOG.md

@@ -6,6 +6,19 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.22.0 - 2015-04-30
+
+**How to upgrade**
+
+If your code expects any of the following method to return Float values, then
+be aware that they now return Integer. You can still call `to_f` if you do need
+a Float: views, `comments`, `likes`, `dislikes`, `shares`, `subscribers_gained`,
+`subscribers_lost`, `favorites_added`, `favorites_removed`, `annotations`,
+`impressions`, `monetized_plybacks`, `playlist_starts`.
+
+* [ENHANCEMENT] Return `Integer` values for reports that can never return decimal digits.
+* [FEATURE] New `by: :range` option for reports, to return a metric without dimensions (that is, for the whole range)
+
 ## 0.21.0 - 2015-04-30
 
 **How to upgrade**

data/README.md

@@ -41,7 +41,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.21.0'
+    gem 'yt', '~> 0.22.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -54,47 +54,8 @@ Available resources
 Yt::Account
 -----------
 
-Use [Yt::Account](http://www.rubydoc.info/gems/yt/Yt/Models/Account) to:
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/accounts.html) for the list of methods available for `Yt::Account`.
 
-* authenticate as a YouTube account
-* read the attributes of the account
-* access the channel managed by the account
-* access the videos uploaded by the account
-* create playlist
-* upload a video
-* list the channels subscribed to an account
-
-```ruby
-# Accounts can be initialized with access token, refresh token or an authorization code
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-
-account.email #=> .. your e-mail address..
-account.channel #=> #<Yt::Models::Channel @id=...>
-
-account.videos.count #=> 12
-account.videos.first #=> #<Yt::Models::Video @id=...>
-
-account.upload_video 'my_video.mp4', title: 'My new video', privacy_status: 'private', category_id: '17'
-account.upload_video 'http://example.com/remote.m4v', title: 'My other video', tags: ['music']
-
-account.create_playlist title: 'New playlist', privacy_status: 'unlisted' #=> true
-
-account.subscribers.count #=> 2
-account.subscribers.first #=> #<Yt::Models::Channel @id=...>
-account.subscribers.first.title #=> 'Fullscreen'
-
-```
-
-*The methods above require to be authenticated as a YouTube account (see below).*
-
-```ruby
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-
-account.content_owners.count #=> 3
-account.content_owners.first #=>  #<Yt::Models::ContentOwner @id=...>
-```
-
-*The methods above require to be authenticated as a YouTube Content Partner account (see below).*
 
 Yt::ContentOwner
 ----------------
@@ -138,424 +99,22 @@ content_owner.create_asset type: 'web' #=> #<Yt::Models::Asset @id=...>
 Yt::Channel
 -----------
 
-Use [Yt::Channel](http://www.rubydoc.info/gems/yt/Yt/Models/Channel) to:
-
-* read the attributes of a channel
-* access the videos of a channel
-* access the playlists of a channel
-* access the channels that the channel is subscribed to
-* subscribe to and unsubscribe from a channel
-* delete playlists from a channel
-* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, annotation clicks, annotation click-through rate, annotation close rate, estimated/average video watch and impressions of a channel by day
-* retrieve the views and estimated minutes watched by traffic source
-* retrieve the views and estimated minutes watched by playback location
-* retrieve the views and estimated minutes watched by embedded player location
-* retrieve the views and estimated minutes watched by related video
-* retrieve the views and estimated minutes watched by video
-* retrieve the views and estimated minutes watched by playlist
-* retrieve the views and estimated minutes watched by device type
-* retrieve the viewer percentage of a channel by gender, by age group or by both
-
-```ruby
-# Channels can be initialized with ID or URL
-channel = Yt::Channel.new url: 'youtube.com/fullscreen'
-
-channel.title #=> "Fullscreen"
-channel.description #=> "The first media company for the connected generation."
-channel.description.has_link_to_playlist? #=> false
-channel.thumbnail_url #=> "https://yt3.ggpht.com/-KMnbKDBl60w/.../photo.jpg"
-channel.published_at #=> 2006-03-23 06:13:25 UTC
-channel.public? #=> true
-
-channel.view_count #=> 421619
-channel.comment_count #=> 773
-channel.video_count #=> 12
-channel.subscriber_count #=> 136925
-channel.subscriber_count_visible? #=> true
-
-channel.videos.count #=> 12
-channel.videos.first #=> #<Yt::Models::Video @id=...>
-
-channel.playlists.count #=> 2
-channel.playlists.first #=> #<Yt::Models::Playlist @id=...>
-
-channel.subscribed_channels.count #=> 132
-channel.subscribed_channels.first #=> #<Yt::Models::Channel @id=...>
-```
-
-*The methods above do not require authentication.*
-
-```ruby
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: account
-
-channel.subscribed? #=> false
-channel.subscribe #=> true
-```
-
-*The methods above require to be authenticated as a YouTube account (see below).*
-
-```ruby
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: account
-
-channel.delete_playlists title: 'New playlist' #=> [true]
-
-channel.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-channel.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
-channel.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
-channel.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
-channel.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
-channel.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-channel.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-channel.favorites_added from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-channel.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
-channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
-channel.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-channel.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-channel.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-channel.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
-
-channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :traffic_source #=> {annotation: 10.0, external_app: 20.0, external_url: 5.0, embedded: 1.0, search: 3.0}
-
-channel.views since: 7.days.ago, by: :playback_location #=> {embedded: 34.0, watch: 467.0, channel: 462.0, other: 3.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :playback_location #=> {embedded: 34.0, watch: 467.0, channel: 462.0, other: 3.0}
-
-channel.views since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-
-channel.views since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-
-channel.views since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-
-channel.views since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
-
-channel.views since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-```
-
-*The methods above require to be authenticated as the channel’s account (see below).*
-
-```ruby
-content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
-channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: content_owner
-
-channel.earnings_on 5.days.ago #=> 12.23
-channel.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-channel.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
-channel.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
-channel.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
-channel.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
-channel.impressions_on 5.days.ago #=> 157.0
-channel.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-channel.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
-channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
-channel.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-channel.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-channel.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-channel.viewer_percentage since: 7.days.ago #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
-
-channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :traffic_source #=> {annotation: 10.0, external_app: 20.0, external_url: 5.0, embedded: 1.0, search: 3.0}
-channel.views since: 7.days.ago, by: :playback_location #=> {embedded: 34.0, watch: 467.0, channel: 462.0, other: 3.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :playback_location #=> {embedded: 34.0, watch: 467.0, channel: 462.0, other: 3.0}
-channel.views since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-channel.views since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.views since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-channel.views since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
-channel.estimated_minutes_watched since: 7.days.ago, by: :playlist #=> {#<Yt::Models::Playlist @id=...>: 10.0, #<Yt::Models::Playlist @id=...>: 20.0, …}
-channel.views since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-channel.estimated_minutes_watched since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-channel.monetized_playbacks_on 5.days.ago #=> 123.0
-channel.viewer_percentage since: 7.days.ago, by: :gender #=> {female: 49.12, male: 50.88}
-channel.viewer_percentage since: 7.days.ago, by: :age_group #=> {'18-24' => 12.12, '25-34' => 16.16,…}
-
-channel.content_owner #=> 'CMSname'
-channel.linked_at #=> Wed, 28 May 2014
-```
-
-*The methods above require to be authenticated as the channel’s content owner (see below).*
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/channels.html) for the list of methods available for `Yt::Channel`.
 
 Yt::Video
------------
-
-Use [Yt::Video](http://www.rubydoc.info/gems/yt/Yt/Models/Video) to:
-
-* read the attributes of a video
-* update the attributes of a video
-* upload a thumbnail for a video
-* access the annotations of a video
-* delete a video
-* like and dislike a video
-* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, impressions, annotation clicks, annotation click-through rate, annotation close rate and monetized playbacks of a video by day
-* retrieve the views of a video by traffic source
-* retrieve the views of a video by playback location
-* retrieve the views of a video by embedded player location
-* retrieve the views of a video by related video
-* retrieve the views of a video by device type
-* retrieve the viewer percentage of a video by gender, by age group or by both
-* retrieve data about live-streaming videos
-* retrieve the advertising options of a video
-* retrieve the HTML code of the video player
-* retrieve the file details of a video
-* retrieve the category title of a video
-
-```ruby
-# Videos can be initialized with ID or URL
-video = Yt::Video.new url: 'http://youtu.be/MESycYJytkU'
-
-video.title #=> "Fullscreen Creator Platform"
-video.description #=> "The new Fullscreen Creator Platform gives creators and brands a suite..."
-video.description.has_link_to_channel? #=> true
-video.thumbnail_url #=> "https://i1.ytimg.com/vi/MESycYJytkU/default.jpg"
-video.published_at #=> 2013-07-09 16:27:32 UTC
-video.tags #=> []
-video.channel_id #=> "UCxO1tY8h1AhOz0T4ENwmpow"
-video.channel_title #=> "Fullscreen"
-video.category_id #=> "22"
-video.live_broadcast_content #=> "none"
-
-video.public? #=> true
-video.uploading? #=> false
-video.rejected? #=> false
-video.failed? #=> true
-video.processed? #=> false
-video.deleted? #=> false
-video.uses_unsupported_codec? #=> true
-video.has_failed_conversion? #=> false
-video.empty? #=> false
-video.invalid? #=> false
-video.too_small? #=> false
-video.aborted? #=> false
-video.claimed? #=> false
-video.infringes_copyright? #=> false
-video.duplicate? #=> false
-video.inappropriate? #=> false
-video.too_long? #=> false
-video.violates_terms_of_use? #=> false
-video.infringes_trademark? #=> false
-video.belongs_to_closed_account? #=> false
-video.belongs_to_suspended_account? #=> false
-video.scheduled? #=> true
-video.scheduled_at #=> Tue, 27 May 2014 12:50:00
-video.licensed_as_creative_commons? #=> true
-video.licensed_as_standard_youtube? #=> false
-video.embeddable? #=> false
-video.has_public_stats_viewable? #=> false
-
-video.duration #=> 86
-video.hd? #=> true
-video.stereoscopic? #=> false
-video.captioned? #=> true
-video.licensed? #=> false
-
-video.actual_start_time #=> Tue, 27 May 2014 12:50:00
-video.actual_end_time #=> Tue, 27 May 2014 12:54:00
-video.scheduled_start_time #=> Tue, 27 May 2014 12:49:00
-video.scheduled_end_time #=> Tue, 27 May 2014 12:55:00
-video.concurrent_viewers #=> 0
-
-video.embed_html #=> "<iframe type='text/html' src='http://www.youtube.com/embed/BPNYv0vd78A' width='640' height='360' frameborder='0' allowfullscreen='true'/>"
-
-video.file_size #=> 8000000
-video.file_type #=> "video"
-video.container #=> "mov"
-
-video.category_title #=> "People & Blogs"
-
-video.annotations.count #=> 1
-video.annotations.first #=> #<Yt::Models::Annotation @id=...>
-```
-
-*The methods above do not require authentication.*
-
-```ruby
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-video = Yt::Video.new id: 'MESycYJytkU', auth: account
-
-video.liked? #=> false
-video.like #=> true
-```
-
-*The methods above require to be authenticated as a YouTube account (see below).*
-
-```ruby
-account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
-video = Yt::Video.new id: 'MESycYJytkU', auth: account
-
-video.update title: 'A title', description: 'A description <with angle brackets>'
-video.update tags: ['a tag'], categoryId: '21', license: 'creativeCommon'
-
-video.upload_thumbnail 'my_thumbnail.jpg'
-video.upload_thumbnail 'http://example.com/remote.png'
-
-video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
-video.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
-video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
-video.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
-video.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-video.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-video.favorites_added from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-video.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-video.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
-video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
-video.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-video.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-video.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-video.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
-
-video.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
-video.views since: 7.days.ago, by: :playback_location #=> {:embedded=>6.0, :watch=>11.0}
-video.views since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-video.views since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-video.views since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-video.viewer_percentage since: 7.days.ago, by: :gender #=> {female: 49.12, male: 50.88}
-video.viewer_percentage since: 7.days.ago, by: :age_group #=> {'18-24' => 12.12, '25-34' => 16.16,…}
-
-video.delete #=> true
-```
-
-*The methods above require to be authenticated as the video’s owner (see below).*
-
-```ruby
-content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
-video = Yt::Video.new id: 'MESycYJytkU', auth: content_owner
-
-video.earnings_on 5.days.ago #=> 12.23
-video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
-video.likes from: 8.days.ago #=> {Tue, 27 May 2014 => 7.0, Wed, 28 May 2014 => 0.0, …}
-video.dislikes to: 2.days.ago #=> {Tue, 27 May 2014 => 0.0, Wed, 28 May 2014 => 1.0, …}
-video.shares since: 7.days.ago, until: 7.days.ago  #=> {Wed, 28 May 2014 => 3.0}
-video.subscribers_gained from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-video.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-video.favorites_added from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>1.0, Sun, 31 Aug 2014=>0.0}
-video.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2014=>0.0, Sun, 31 Aug 2014=>0.0}
-video.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
-video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
-video.impressions_on 5.days.ago #=> 157.0
-video.monetized_playbacks_on 5.days.ago #=> 123.0
-video.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
-video.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-video.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
-video.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
-
-video.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
-video.views since: 7.days.ago, by: :playback_location #=> {:embedded=>6.0, :watch=>11.0}
-video.views since: 7.days.ago, by: :embedded_player_location #=> {"fullscreen.net"=>45.0, "linkedin.com"=>5.0, "mashable.com"=>1.0, "unknown"=>1.0}
-video.views since: 7.days.ago, by: :related_video #=> {#<Yt::Models::Video @id=...>: 10.0, #<Yt::Models::Video @id=...>: 20.0, …}
-video.views since: 7.days.ago, by: :device_type #=> {mobile: 144473.0, unknown_platform: 840.0, game_console: 4940.0, desktop: 102889.0, tv: 4134.0, tablet: 50189.0}
-video.viewer_percentage since: 7.days.ago, by: :gender #=> {female: 49.12, male: 50.88}
-video.viewer_percentage since: 7.days.ago, by: :age_group #=> {'18-24' => 12.12, '25-34' => 16.16,…}
-
-video.ad_formats #=> ["standard_instream", "trueview_instream"]
-```
+---------
 
-*The methods above require to be authenticated as the video’s content owner (see below).*
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/videos.html) for the list of methods available for `Yt::Video`.
 
 Yt::Playlist
 ------------
 
-Use [Yt::Playlist](http://www.rubydoc.info/gems/yt/Yt/Models/Playlist) to:
-
-* read the attributes of a playlist
-* update the attributes of a playlist
-* access the items of a playlist
-* add one or multiple videos to a playlist
-* delete items from a playlist
-* retrieve the views, playlist starts, average time in playlist and views per playlist start of a playlist by day
-
-```ruby
-# Playlists can be initialized with ID or URL
-playlist = Yt::Playlist.new url: 'youtube.com/playlist?list=PLSWYkYzOrPMRCK6j0UgryI8E0NHhoVdRc'
-
-playlist.title #=> "Fullscreen Features"
-playlist.description #=> "You send us your best videos and we feature our favorite ones..."
-playlist.description.has_link_to_subscribe? #=> false
-playlist.thumbnail_url #=> "https://i1.ytimg.com/vi/36kL2alg7Jk/default.jpg"
-playlist.published_at #=> 2012-11-27 21:23:38 UTC
-playlist.public? #=> true
-playlist.tags #=> []
-playlist.channel_id #=> "UCxO1tY8h1AhOz0T4ENwmpow"
-playlist.channel_title #=> "Fullscreen"
-
-playlist.playlist_items.count #=> 1
-playlist.playlist_items.first #=> #<Yt::Models::PlaylistItem @id=...>
-```
-
-*The methods above do not require authentication.*
-
-```ruby
-playlist.update title: 'A <title> with angle brackets', description: 'desc', tags: ['new tag'], privacy_status: 'private'
-playlist.add_video 'MESycYJytkU', position: 2
-playlist.add_videos ['MESycYJytkU', 'MESycYJytkU']
-playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]
-
-playlist.views_on 5.days.ago #=> 12.0
-playlist.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-
-playlist.playlist_starts_on 5.days.ago #=> 12.0
-playlist.playlist_starts since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-
-playlist.average_time_in_playlist_on 5.days.ago #=> 12.0
-playlist.average_time_in_playlist since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-
-playlist.views_per_playlist_start_on 5.days.ago #=> 12.0
-playlist.views_per_playlist_start since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
-
-```
-
-*The methods above require to be authenticated as the playlist’s owner (see below).*
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlists.html) for the list of methods available for `Yt::Playlist`.
 
 Yt::PlaylistItem
 ----------------
 
-Use [Yt::PlaylistItem](http://www.rubydoc.info/gems/yt/Yt/Models/PlaylistItem) to:
-
-* read the attributes of a playlist item
-* update the position of an item inside a playlist
-* delete a playlist item
-
-```ruby
-item = Yt::PlaylistItem.new id: 'PLjW_GNR5Ir0GWEP_oveGBNjTvKkYyZfsna1TZDCBP-Z8'
-
-item.title #=> "Titanium - David Guetta - Space Among Many Cover ft. Evan Chan and Glenna Roberts"
-item.description #=> "CLICK to tweet this video: [...]"
-item.description.has_link_to_channel? #=> true
-item.thumbnail_url #=> "https://i1.ytimg.com/vi/W4GhTprSsOY/default.jpg"
-item.published_at #=> 2012-12-22 19:38:02 UTC
-item.public? #=> true
-item.channel_id #=> "UCxO1tY8h1AhOz0T4ENwmpow"
-item.channel_title #=> "Fullscreen"
-item.playlist_id #=> "PLSWYkYzOrPMRCK6j0UgryI8E0NHhoVdRc"
-item.position #=> 0
-item.video_id #=> "W4GhTprSsOY"
-item.video #=> #<Yt::Models::Video @id=...>
-```
-
-*The methods above do not require authentication.*
-
-```ruby
-item.update position: 3 #=> true
-item.delete #=> true
-```
-
-*The methods above require to be authenticated as the playlist’s owner (see below).*
-
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlist_items.html) for the list of methods available for `Yt::PlaylistItem`.
 
 Yt::Collections::Videos
 -----------------------
@@ -578,20 +137,8 @@ videos.where(id: 'MESycYJytkU,invalid').map(&:title) #=> ["Fullscreen Creator Pl
 Yt::Annotation
 --------------
 
-Use [Yt::Annotation](http://www.rubydoc.info/gems/yt/Yt/Models/Annotation) to:
-
-* read the attributes of an annotation
-
-```ruby
-video = Yt::Video.new id: 'MESycYJytkU'
-annotation = video.annotations.first
-
-annotation.below? 70 #=> false
-annotation.has_link_to_subscribe? #=> false
-annotation.has_link_to_playlist? #=> true
-```
+Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/annotations.html) for the list of methods available for `Yt::Annotation`.
 
-*Annotations do not require authentication.*
 
 Yt::MatchPolicy
 ---------------

data/lib/yt/actions/base.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 module Yt
+  # @private
   module Actions
     # Abstract module that contains methods common to every action
     module Base

data/lib/yt/associations/has_attribute.rb

@@ -1,7 +1,9 @@
 require 'yt/models/timestamp'
 
 module Yt
+  # @private
   module Associations
+    # @private
     module HasAttribute
       def self.included(base)
         base.extend(ClassMethods)

data/lib/yt/associations/has_authentication.rb

@@ -1,5 +1,6 @@
 module Yt
   module Associations
+    # @private
     # Provides authentication methods to YouTube resources, which allows to
     # access to content detail set-specific methods like `access_token`.
     #
@@ -16,6 +17,7 @@ module Yt
       end
     end
 
+    # @private
     module Authenticable
       delegate :access_token, :refresh_token, :expires_at, to: :authentication
 

data/lib/yt/associations/has_many.rb

@@ -1,5 +1,6 @@
 module Yt
   module Associations
+    # @private
     # Associations are a set of macro-like class methods to express
     # relationship between YouTube resources like "Channel has many Videos" or
     # "Account has one Id". They are inspired by ActiveRecord::Associations.

data/lib/yt/associations/has_one.rb

@@ -1,5 +1,6 @@
 module Yt
   module Associations
+    # @private
     # Associations are a set of macro-like class methods to express
     # relationship between YouTube resources like "Channel has many Videos" or
     # "Account has one Id". They are inspired by ActiveRecord::Associations.