yt 0.13.5 → 0.13.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4884014eca0d0aa5a8fce33dd4aab23a10be20c7
-  data.tar.gz: aa69ac27584d778a2c6d737eef6423cd7fc918c1
+  metadata.gz: 30c38777c96e3983801b273d1ca29efd2e107cd9
+  data.tar.gz: 4de8292876f8d7193a0d5e32355b65a0fdd5444b
 SHA512:
-  metadata.gz: 0f0a0e1d935a0a6458d424e0777cdb8293ea52b750e3a95833930deb10f4dbc4ec2a5aa6dd51b93f2bf97b9772cf9d3bf635384d3b8b0775f66123d725036c7d
-  data.tar.gz: 5356a175d23cfa1e4e6404ae83fdde6aa5a70f88f9f63c8411363a57c7ab347e7379b30104221b8c38b5690e3f68802213b33e73fa96615afb09704c294ad3f8
+  metadata.gz: 35e20ccb37d0a7a9a8faa9045735025488a896b21313a47189556f7031dd0581f8f485e775dbf8cbbfb791a5805a2e4b07e4856334da6827c1394959911ee243
+  data.tar.gz: af3f518907140a82bb4a22baa82d1b07a4fb47ae62b016c91f138a6c8b3cab733fb26a0b4f8c7af73dff9651907fd83a56561edf30ec3ec5126b76060f24dfda

data/CHANGELOG.md

@@ -6,6 +6,12 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.13.6 - 2014-10-08
+
+* [ENHANCEMENT] Accept `includes(:viewer_percentages)` in `.partnered_channels` to eager-load multiple viewer percentages at once.
+* [ENHANCEMENT] Accept `where` in ViewerPercentages to collect data for multiple channels at once.
+* [ENHANCEMENT] Accept `part` in the `where` clause of Channels, so statistics can be loaded at once.
+
 ## 0.13.5 - 2014-10-06
 
 * [ENHANCEMENT] Add `advertising_options_set` and `ad_formats` to video

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-
+gem 'pry'
 # Specify your gem's dependencies in yt.gemspec
 gemspec

data/README.md

@@ -113,7 +113,10 @@ Use [Yt::ContentOwner](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models
 content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
 
 content_owner.partnered_channels.count #=> 12
-content_owner.partnered_channels.first #=> #<Yt::Models::Channel @id=...>
+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/actions/list.rb

@@ -6,8 +6,8 @@ require 'yt/config'
 module Yt
   module Actions
     module List
-      delegate :count, :first, :any?, :each, :map, :flat_map, :find,
-        :size, to: :list
+      delegate :any?, :count, :each, :each_cons, :each_slice, :find, :first,
+        :flat_map, :map, :size, to: :list
 
       def first!
         first.tap{|item| raise Errors::NoItems, error_message unless item}
@@ -84,7 +84,11 @@ module Yt
         params[:params][:page_token] = @page_token if @page_token
         next_page = fetch_page params
         @page_token = next_page[:token]
-        next_page[:items]
+        eager_load_items_from next_page[:items]
+      end
+
+      def eager_load_items_from(items)
+        items
       end
 
       def fetch_page(params = {})

data/lib/yt/associations/has_viewer_percentages.rb

@@ -38,7 +38,7 @@ module Yt
       def define_viewer_percentages_method
         # @todo: add options like start and end date
         define_method :viewer_percentages do
-          @viewer_percentages ||= Collections::ViewerPercentages.of(self).all
+          @viewer_percentages ||= Collections::ViewerPercentages.of(self)[id]
         end
       end
 

data/lib/yt/collections/channels.rb

@@ -9,6 +9,12 @@ module Yt
 
     private
 
+      def attributes_for_new_item(data)
+        super(data).tap do |attributes|
+          attributes[:statistics] = data['statistics']
+        end
+      end
+
       # @return [Hash] the parameters to submit to YouTube to list channels.
       # @see https://developers.google.com/youtube/v3/docs/channels/list
       def list_params
@@ -16,7 +22,9 @@ module Yt
       end
 
       def channels_params
-        resources_params.merge mine: true
+        params = resources_params
+        params.merge! mine: true if @parent
+        apply_where_params! params
       end
     end
   end

data/lib/yt/collections/partnered_channels.rb

@@ -4,8 +4,35 @@ module Yt
   module Collections
     class PartneredChannels < Channels
 
+      def includes(relationship)
+        self.tap do
+          @items = []
+          @includes_relationship = relationship
+        end
+      end
+
     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 @includes_relationship == :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
+        items
+      end
+
       # @private
       # @note Partnered Channels overwrites +channel_params+ since the query
       #   is slightly different.
@@ -13,7 +40,7 @@ module Yt
         super.tap do |params|
           params.delete :mine
           params[:managed_by_me] = true
-          params[:on_behalf_of_content_owner] = @parent.owner_name
+          params[:on_behalf_of_content_owner] = @auth.owner_name
         end
       end
 

data/lib/yt/collections/viewer_percentages.rb

@@ -3,10 +3,13 @@ require 'yt/collections/base'
 module Yt
   module Collections
     class ViewerPercentages < Base
+      delegate :[], to: :all
 
       def all
-        Hash.new{|h,k| h[k] = Hash.new(0.0)}.tap do |hash|
-          each{|item| hash[item.gender][item.age_range] = item.value}
+        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
 
@@ -14,9 +17,10 @@ module Yt
 
       # @note could use column headers to be more precise
       def new_item(data)
-        Struct.new(:gender, :age_range, :value).new.tap do |item|
-          item.gender = data.first.to_sym
-          item.age_range = data.second.gsub /^age/, ''
+        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
@@ -30,12 +34,16 @@ module Yt
       end
 
       def reports_params
-        @parent.reports_params.tap do |params|
+        {}.tap do |params|
           params['start-date'] = 3.months.ago.to_date
           params['end-date'] = Date.today.to_date
           params['metrics'] = :viewerPercentage
-          params['dimensions'] = 'gender,ageGroup'
           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
 

data/lib/yt/models/channel.rb

@@ -63,6 +63,18 @@ module Yt
       #     return an authenticated account.
       has_one :subscription
 
+      # Override Resource's new to set statistics as well
+      # if the response includes them
+      def initialize(options = {})
+        super options
+        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.
       #
       # This method requires {Resource#auth auth} to return an
@@ -149,10 +161,10 @@ module Yt
       def reports_params
         {}.tap do |params|
           if auth.owner_name
-            params['ids'] = "contentOwner==#{auth.owner_name}"
-            params['filters'] = "channel==#{id}"
+            params[:ids] = "contentOwner==#{auth.owner_name}"
+            params[:filters] = "channel==#{id}"
           else
-            params['ids'] = "channel==#{id}"
+            params[:ids] = "channel==#{id}"
           end
         end
       end

data/lib/yt/models/video.rb

@@ -167,11 +167,11 @@ module Yt
       def reports_params
         {}.tap do |params|
           if auth.owner_name
-            params['ids'] = "contentOwner==#{auth.owner_name}"
+            params[:ids] = "contentOwner==#{auth.owner_name}"
           else
-            params['ids'] = "channel==#{channel_id}"
+            params[:ids] = "channel==#{channel_id}"
           end
-          params['filters'] = "video==#{id}"
+          params[:filters] = "video==#{id}"
         end
       end
 

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.13.5'
+  VERSION = '0.13.6'
 end

data/spec/requests/as_account/channels_spec.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'yt/collections/channels'
+
+describe Yt::Collections::Channels, :device_app do
+  subject(:channels) { Yt::Collections::Channels.new auth: $account }
+
+  context 'with a list of parts' do
+    let(:part) { 'statistics' }
+    let(:channel) { channels.where(part: part, id: 'UCxO1tY8h1AhOz0T4ENwmpow').first }
+
+    specify 'load ONLY the specified parts of the channels' do
+      expect(channel.instance_variable_defined? :@snippet).to be false
+      expect(channel.instance_variable_defined? :@status).to be false
+      expect(channel.instance_variable_defined? :@statistics_set).to be true
+    end
+  end
+end

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -2,12 +2,24 @@ require 'spec_helper'
 require 'yt/models/content_owner'
 
 describe Yt::ContentOwner, :partner do
-  describe '.partnered_channels.first' do
-    it { expect($content_owner.partnered_channels.first).to be_a Yt::Channel }
-  end
+  describe '.partnered_channels' do
+    let(:partnered_channels) { $content_owner.partnered_channels }
+
+    specify '.first' do
+      expect(partnered_channels.first).to be_a Yt::Channel
+    end
+
+    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 }
 
-  describe '.partnered_channels.size', :ruby2 do
-    it { expect($content_owner.partnered_channels.size).to be > 0 }
+      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/viewer_percentages_spec.rb

@@ -0,0 +1,18 @@
+# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.13.6
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -251,6 +251,7 @@ files:
 - spec/requests/as_account/account_spec.rb
 - spec/requests/as_account/authentications_spec.rb
 - spec/requests/as_account/channel_spec.rb
+- spec/requests/as_account/channels_spec.rb
 - spec/requests/as_account/playlist_item_spec.rb
 - spec/requests/as_account/playlist_spec.rb
 - spec/requests/as_account/resource_spec.rb
@@ -264,6 +265,7 @@ files:
 - spec/requests/as_content_owner/match_policy_spec.rb
 - spec/requests/as_content_owner/ownership_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
@@ -345,6 +347,7 @@ test_files:
 - spec/requests/as_account/account_spec.rb
 - spec/requests/as_account/authentications_spec.rb
 - spec/requests/as_account/channel_spec.rb
+- spec/requests/as_account/channels_spec.rb
 - spec/requests/as_account/playlist_item_spec.rb
 - spec/requests/as_account/playlist_spec.rb
 - spec/requests/as_account/resource_spec.rb
@@ -358,6 +361,7 @@ test_files:
 - spec/requests/as_content_owner/match_policy_spec.rb
 - spec/requests/as_content_owner/ownership_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