yt 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b9767e99d417362ada2195c0d52a9a739a0ead3
-  data.tar.gz: c73d616d817e5c08a67fe6e82bd4192060175c36
+  metadata.gz: 17691684dae81110d7d3ff39e8952823deedc5ac
+  data.tar.gz: a2438b53994ef551b3525a310db27990695a7f1d
 SHA512:
-  metadata.gz: 81cf574551196ee465e708561ad151c1c095d5348c537fadcb6cf7fca6ffe085e0dec832e712263146106f6a43657879171a058eba3fc9fa186dda0015b3580a
-  data.tar.gz: af7747988d6d86dc5cc51b3442c018d344ff6ca12bd8612c462d2fdd778e036e70c2dde22d2f2220add7d8dbf08877ffa7ac04f900375419d2469828a821506c
+  metadata.gz: 9994436e29b6ef5b5bc3533db28e5f40e2839948076f30cac3794769b4e962cd0dee3dc88e4f1f52641420cd401b62070d8cc8bcf9aae4eabf349b397bfa6408
+  data.tar.gz: 98f99214f24da915e60247d4192579b93b5579e5e16e83cde009bd017f21c46c5a9a6c22a7451b291c1e4afd69fc130570b29fd419b37b1d96d9148a0469e6fb

data/.gitignore

@@ -24,3 +24,4 @@ Gemfile.lock
 doc/
 .yardoc/
 _site/
+TODO.md

data/CHANGELOG.md

@@ -6,6 +6,29 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.19.0 - 2015-04-28
+
+**How to upgrade**
+
+If your code never calls `partnered_channels.includes(:viewer_percentages)` on
+a Yt::ContentOwner, then you are good to go.
+
+If it does, then be aware that viewer percentage is not eager-loaded anymore,
+so the call above is equivalent to `partenered_channels`. The reason is that
+viewer percentage *requires* a time-range, and using a default range of the
+last 3 months can generate more confusion than added value.
+
+Also if your code still uses the deprecated:
+
+- `.viewer_percentages` method, replace with `.viewer_percentage`.
+- `policy.time_updated` method, replace with `policy.updated_at`.
+- `video.uploaded?` method, replace with `video.uploading?`.
+
+* [REMOVAL] Remove `.includes(:viewer_percentages)` on `content_owner.partnered_channels`.
+* [REMOVAL] Remove deprecated `viewer_percentages` (use `viewer_percentage` instead)
+* [REMOVAL] Remove deprecated `policy.time_updated` (use `updated_at` instead)
+* [REMOVAL] Remove deprecated `video.uploaded?` (use `uploading?` instead)
+
 ## 0.18.0 - 2015-04-28
 
 **How to upgrade**

data/README.md

@@ -3,7 +3,7 @@ Yt - a Ruby client for the YouTube API
 
 Yt helps you write apps that need to interact with YouTube.
 
-The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/gems/yt/frames).
+The **source code** is available on [GitHub](https://github.com/Fullscreen/yt) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/yt/frames).
 
 [![Build Status](http://img.shields.io/travis/Fullscreen/yt/master.svg)](https://travis-ci.org/Fullscreen/yt)
 [![Coverage Status](http://img.shields.io/coveralls/Fullscreen/yt/master.svg)](https://coveralls.io/r/Fullscreen/yt)
@@ -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.18.0'
+    gem 'yt', '~> 0.19.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -115,8 +115,6 @@ content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.
 content_owner.partnered_channels.count #=> 12
 content_owner.partnered_channels.map &:title #=> ["Fullscreen", "Best of Fullscreen", ...]
 content_owner.partnered_channels.where(part: 'statistics').map &:subscriber_count #=> [136925, 56945, ...]
-content_owner.partnered_channels.includes(:viewer_percentages).map &:viewer_percentages #=> [{female: {'18-24' => 12.12,…}…}, {female: {'18-24' => 40.12,…}…}, …]
-
 
 content_owner.claims.where(q: 'Fullscreen').count #=> 24
 content_owner.claims.first #=> #<Yt::Models::Claim @id=...>

data/lib/yt/collections/partnered_channels.rb

@@ -6,26 +6,6 @@ module Yt
 
     private
 
-      def attributes_for_new_item(data)
-        super(data).tap do |attributes|
-          attributes[:viewer_percentages] = data['viewerPercentages']
-        end
-      end
-
-      def eager_load_items_from(items)
-        if included_relationships.include? :viewer_percentages
-          filters = "channel==#{items.map{|item| item['id']}.join(',')}"
-          ids = "contentOwner==#{@auth.owner_name}"
-          conditions = {ids: ids, filters: filters}
-          viewer_percentages = Collections::ViewerPercentages.new auth: @auth
-          viewer_percentages = viewer_percentages.where conditions
-          items.each do |item|
-            item['viewerPercentages'] = viewer_percentages[item['id']]
-          end
-        end
-        super
-      end
-
       # @private
       # @note Partnered Channels overwrites +channel_params+ since the query
       #   is slightly different.

data/lib/yt/models/base.rb

@@ -7,7 +7,6 @@ require 'yt/associations/has_authentication'
 require 'yt/associations/has_many'
 require 'yt/associations/has_one'
 require 'yt/associations/has_reports'
-require 'yt/associations/has_viewer_percentages'
 
 require 'yt/errors/request_error'
 
@@ -20,7 +19,6 @@ module Yt
 
       include Associations::HasAttribute
       extend Associations::HasReports
-      extend Associations::HasViewerPercentages
       extend Associations::HasOne
       extend Associations::HasMany
       extend Associations::HasAuthentication

data/lib/yt/models/channel.rb

@@ -70,10 +70,6 @@ module Yt
       # @macro has_report
       has_report :viewer_percentage
 
-      # @deprecated Use {#has_report :viewer_percentage}.
-      # @macro has_viewer_percentages
-      has_viewer_percentages
-
       # @!attribute [r] statistics_set
       #   @return [Yt::Models::StatisticsSet] the statistics for the video.
       has_one :statistics_set
@@ -107,9 +103,6 @@ module Yt
         if options[:statistics]
           @statistics_set = StatisticsSet.new data: options[:statistics]
         end
-        if options[:viewer_percentages]
-          @viewer_percentages = options[:viewer_percentages]
-        end
       end
 
       # Returns whether the authenticated account is subscribed to the channel.

data/lib/yt/models/policy.rb

@@ -25,11 +25,6 @@ module Yt
       # @return [String] the time the policy was updated.
       has_attribute :updated_at, type: Time, from: :time_updated
 
-      # @deprecated Use {#updated_at} instead.
-      def time_updated
-        updated_at
-      end
-
       # @return [Array<PolicyRule>] a list of rules that specify the action
       #   that YouTube should take and may optionally specify the conditions
       #   under which that action is enforced.

data/lib/yt/models/video.rb

@@ -79,12 +79,6 @@ module Yt
         status.upload_status == 'uploaded'
       end
 
-      # @deprecated Use {#uploading?} instead.
-      # @return [Boolean] whether the video is being uploaded to YouTube.
-      def uploaded?
-        uploading?
-      end
-
       # @return [Boolean] whether the video failed to upload to YouTube because
       #   of an unsupported codec.
       # @see https://support.google.com/youtube/answer/1722171
@@ -439,10 +433,6 @@ module Yt
       # @macro daily_report
       has_report :monetized_playbacks
 
-      # @deprecated Use {#has_report :viewer_percentage}.
-      # @macro has_viewer_percentages
-      has_viewer_percentages
-
     ### STATISTICS ###
 
       has_one :statistics_set

data/lib/yt/version.rb

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

data/spec/requests/as_account/channel_spec.rb

@@ -205,11 +205,6 @@ describe Yt::Channel, :device_app do
       expect{channel.impressions_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
     end
 
-    # @deprecated, use channel.viewer_percentage instead
-    it 'returns valid reports for channel-related demographics' do
-      expect{channel.viewer_percentages}.not_to raise_error
-    end
-
     it 'cannot give information about its content owner' do
       expect{channel.content_owner}.to raise_error Yt::Errors::Forbidden
       expect{channel.linked_at}.to raise_error Yt::Errors::Forbidden

data/spec/requests/as_account/video_spec.rb

@@ -319,11 +319,6 @@ describe Yt::Video, :device_app do
       expect{video.earnings_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
       expect{video.impressions_on 3.days.ago}.to raise_error Yt::Errors::Unauthorized
     end
-
-    # @deprecated, use video.viewer_percentage instead
-    it 'returns valid reports for video-related demographics' do
-      expect{video.viewer_percentages}.not_to raise_error
-    end
   end
 
   # @note: This test is separated from the block above because, for some

data/spec/requests/as_content_owner/channel_spec.rb

@@ -977,22 +977,6 @@ describe Yt::Channel, :partner do
         end
       end
 
-      # @deprecated, use channel.viewer_percentage instead
-      specify 'viewer percentages by gender and age range can be retrieved' do
-        expect(channel.viewer_percentages[:female]['18-24']).to be_a Float
-        expect(channel.viewer_percentages[:female]['25-34']).to be_a Float
-        expect(channel.viewer_percentages[:female]['35-44']).to be_a Float
-        expect(channel.viewer_percentages[:female]['45-54']).to be_a Float
-        expect(channel.viewer_percentages[:female]['55-64']).to be_a Float
-        expect(channel.viewer_percentages[:female]['65-']).to be_a Float
-        expect(channel.viewer_percentages[:male]['18-24']).to be_a Float
-        expect(channel.viewer_percentages[:male]['25-34']).to be_a Float
-        expect(channel.viewer_percentages[:male]['35-44']).to be_a Float
-        expect(channel.viewer_percentages[:male]['45-54']).to be_a Float
-        expect(channel.viewer_percentages[:male]['55-64']).to be_a Float
-        expect(channel.viewer_percentages[:male]['65-']).to be_a Float
-      end
-
       specify 'information about its content owner can be retrieved' do
         expect(channel.content_owner).to be_a String
         expect(channel.linked_at).to be_a Time

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -12,14 +12,6 @@ describe Yt::ContentOwner, :partner do
     specify '.size', :ruby2 do
       expect(partnered_channels.size).to be > 0
     end
-
-    context 'with includes(:viewer_percentages)' do
-      let(:channel) { partnered_channels.includes(:viewer_percentages).first }
-
-      specify 'eager-loads the viewer percentages of each channel' do
-        expect(channel.instance_variable_defined? :@viewer_percentages).to be true
-      end
-    end
   end
 
   describe 'claims' do

data/spec/requests/as_content_owner/video_spec.rb

@@ -884,22 +884,6 @@ describe Yt::Video, :partner do
           expect(viewer_percentage.values).to all(be_instance_of Float)
         end
       end
-
-      # @deprecated, use video.viewer_percentage instead
-      specify 'viewer percentages by gender and age range can be retrieved' do
-        expect(video.viewer_percentages[:female]['18-24']).to be_a Float
-        expect(video.viewer_percentages[:female]['25-34']).to be_a Float
-        expect(video.viewer_percentages[:female]['35-44']).to be_a Float
-        expect(video.viewer_percentages[:female]['45-54']).to be_a Float
-        expect(video.viewer_percentages[:female]['55-64']).to be_a Float
-        expect(video.viewer_percentages[:female]['65-']).to be_a Float
-        expect(video.viewer_percentages[:male]['18-24']).to be_a Float
-        expect(video.viewer_percentages[:male]['25-34']).to be_a Float
-        expect(video.viewer_percentages[:male]['35-44']).to be_a Float
-        expect(video.viewer_percentages[:male]['45-54']).to be_a Float
-        expect(video.viewer_percentages[:male]['55-64']).to be_a Float
-        expect(video.viewer_percentages[:male]['65-']).to be_a Float
-      end
     end
 
     context 'given a video claimable by the authenticated Content Owner' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -129,7 +129,6 @@ files:
 - lib/yt/associations/has_many.rb
 - lib/yt/associations/has_one.rb
 - lib/yt/associations/has_reports.rb
-- lib/yt/associations/has_viewer_percentages.rb
 - lib/yt/collections/advertising_options_sets.rb
 - lib/yt/collections/annotations.rb
 - lib/yt/collections/assets.rb
@@ -165,7 +164,6 @@ files:
 - lib/yt/collections/user_infos.rb
 - lib/yt/collections/video_categories.rb
 - lib/yt/collections/videos.rb
-- lib/yt/collections/viewer_percentages.rb
 - lib/yt/config.rb
 - lib/yt/errors/forbidden.rb
 - lib/yt/errors/missing_auth.rb
@@ -284,7 +282,6 @@ files:
 - spec/requests/as_content_owner/ownership_spec.rb
 - spec/requests/as_content_owner/playlist_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
-- spec/requests/as_content_owner/viewer_percentages_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb
@@ -388,7 +385,6 @@ test_files:
 - spec/requests/as_content_owner/ownership_spec.rb
 - spec/requests/as_content_owner/playlist_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
-- spec/requests/as_content_owner/viewer_percentages_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
 - spec/requests/as_server_app/playlist_spec.rb

data/lib/yt/associations/has_viewer_percentages.rb

@@ -1,40 +0,0 @@
-module Yt
-  module Associations
-    # Provides methods to access the viewer percentage reports of a resource.
-    #
-    # YouTube resources with viewer percentage reports are:
-    # {Yt::Models::Channel channels} and {Yt::Models::Channel videos}.
-    # @deprecated
-    module HasViewerPercentages
-      # @!macro has_viewer_percentages
-      #   @deprecated
-      #   @!method viewer_percentages
-      #     @return [Hash<Symbol,Hash<String,Float>>] the viewer percentages.
-      #       The first-level hash identifies the genres (:female, :male).
-      #       The second-level hash identifies the age ranges ('18-24',
-      #       '25-34', '35-44', '45-54', '55-64', '65-')
-      #     @example Return the % of male viewers of a channel older than 64
-      #       channel.viewer_percentages[:male]['65-'] #=> 12.02
-
-      # Defines one public instance methods to access the viewer percentages of
-      # a resource for a specific metric.
-      # @example Adds +viewer_percentages+ and +viewer_percentage+ on Channel.
-      #   class Channel < Resource
-      #     has_viewer_percentages
-      #   end
-      def has_viewer_percentages
-        require 'yt/collections/viewer_percentages'
-
-        define_viewer_percentages_method
-      end
-
-    private
-
-      def define_viewer_percentages_method
-        define_method :viewer_percentages do
-          @viewer_percentages ||= Collections::ViewerPercentages.of(self)[id]
-        end
-      end
-    end
-  end
-end

data/lib/yt/collections/viewer_percentages.rb

@@ -1,56 +0,0 @@
-require 'yt/collections/base'
-
-module Yt
-  module Collections
-    # @deprecated Use {Yt::Collections::Reports} instead.
-    class ViewerPercentages < Base
-      delegate :[], to: :all
-
-      def all
-        Hash.new{|h,k| h[k] = Hash.new{|h,k| h[k] = Hash.new 0.0}}.tap do |hash|
-          each do |item|
-            hash[item.id][item.gender][item.age_range] = item.value
-          end
-        end
-      end
-
-    private
-
-      # @note could use column headers to be more precise
-      def new_item(data)
-        Struct.new(:id, :gender, :age_range, :value).new.tap do |item|
-          item.id = data.first
-          item.gender = data.second.to_sym
-          item.age_range = data.third.gsub /^age/, ''
-          item.value = data.last
-        end
-      end
-
-      def list_params
-        super.tap do |params|
-          params[:path] = '/youtube/analytics/v1/reports'
-          params[:params] = reports_params
-          params[:capitalize_params] = false
-        end
-      end
-
-      def reports_params
-        {}.tap do |params|
-          params['start-date'] = 3.months.ago.to_date
-          params['end-date'] = Date.today.to_date
-          params['metrics'] = :viewerPercentage
-          params['sort'] = 'gender,ageGroup'
-          params.merge! @parent.reports_params if @parent
-          apply_where_params! params
-          main_dimension = params.fetch(:filters, '').split('==').first
-          main_dimension ||= params.fetch(:ids, '').split('==').first
-          params['dimensions'] = "#{main_dimension},#{params['sort']}"
-        end
-      end
-
-      def items_key
-        'rows'
-      end
-    end
-  end
-end

data/spec/requests/as_content_owner/viewer_percentages_spec.rb

@@ -1,18 +0,0 @@
-# encoding: UTF-8
-require 'spec_helper'
-require 'yt/collections/viewer_percentages'
-
-describe Yt::Collections::ViewerPercentages, :partner do
-  subject(:viewer_percentages) { Yt::Collections::ViewerPercentages.new auth: $content_owner }
-
-  context 'for two channels at once' do
-    let(:filters) { 'channel==UCxO1tY8h1AhOz0T4ENwmpow,UCsmvakQZlvGsyjyOhmhvOsw' }
-    let(:ids) { "contentOwner==#{$content_owner.owner_name}" }
-    let(:result) { viewer_percentages.where filters: filters, ids: ids }
-
-    it 'returns the viewer percentages of both' do
-      expect(result['UCggO99g88eUDPcqkTShOPvw'][:female]['18-24']).to be_a Float
-      expect(result['UC8oJ8Sdgkpcy4gylGjTHtBw'][:male]['18-24']).to be_a Float
-    end
-  end
-end