yt 0.5.14 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc8bf39c826412cf4ebac40de897b1e6d298d3db
-  data.tar.gz: 56a50c740682435e1cf6640e13b1f456f85f7ef7
+  metadata.gz: 21b5af2314c676c2ba25c60e8b5f9162cb2692f1
+  data.tar.gz: 3b9b42304e0f418b5b95830171dfddecc53dccb1
 SHA512:
-  metadata.gz: f23bdaf43476b944abfe8a0614cd381f4a340929aee7e480425a07f62ce4dbed0e76d5e65b4f15e22a4098fdee392de0b9e4b39492ddb4c28cb9fdab60ea2fa0
-  data.tar.gz: 5a3629db8476e76a4a37dbbb457f85a43a800149d7f31d8f9eb16cec181ee6d8f2be5ed5c5bb4e0dfa049750b3a919104cff4ad905f4d59d513d90eeafa0d9ce
+  metadata.gz: 2c61d1a02c65e1409c0ee6959a131027919962dd91255378e95eb3b7c6d4940fe92c6c999c161aee7d69a1abdc20e6bd1e7b3d619fbe1e423e651e4fcb0c5847
+  data.tar.gz: 50a18ac7b664828653834e7aa5464376bd3ffd89cc4870fd64640a7a47d265522f8bdc17d6d5d80c80b88412c06e9b57db0b18bfa6e0cca5a8055cefcaaf5bda

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yt (0.5.14)
+    yt (0.6.0)
       activesupport
 
 GEM

data/HISTORY.md

@@ -1,3 +1,8 @@
+v0.6 - 2014/06/05
+-----------------
+
+* [breaking change] Rename Channel#earning to Channel#earnings_on
+
 v0.5 - 2014/05/16
 -----------------
 
@@ -20,6 +25,7 @@ v0.5 - 2014/05/16
 * Automatically refresh the access token when it expires or becomes invalid
 * Retry once YouTube earning queries that return error 503
 * Wait 3 seconds and retry *every* request that returns 500, 503 or 400 with "Invalid query"
+* New Views collection to retrieve view count for YouTube-partnered channels
 
 v0.4 - 2014/05/09
 --------------------

data/README.md

@@ -112,8 +112,11 @@ channel.delete_playlists title: 'New playlist' #=> [true]
 content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
 channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow', auth: content_owner
 
-channel.earning 5.days.ago #=> 12.23
+channel.earnings_on 5.days.ago #=> 12.23
 channel.earnings since: 3.days.ago, until: 2.days.ago #=> {Wed, 28 May 2014 => 1.34, Thu, 29 May 2014 => 0.47}
+
+channel.views_on 5.days.ago #=> 44
+channel.views since: 3.days.ago, until: 2.days.ago #=> {Wed, 28 May 2014 => 12, Thu, 29 May 2014 => 3}
 ```
 
 *The methods above require to be authenticated as the channel’s content owner (see below).*
@@ -323,7 +326,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.5.14'
+    gem 'yt', '~> 0.6.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/associations.rb

@@ -25,6 +25,7 @@ module Yt
     autoload :Subscriptions
     autoload :UserInfos
     autoload :Videos
+    autoload :Views
 
     def has_many(attributes, options = {})
       mod = attributes.to_s.sub(/.*\./, '').camelize

data/lib/yt/associations/earnings.rb

@@ -6,17 +6,17 @@ module Yt
     # allows to invoke earning-related methods, such as .earnings.
     # YouTube resources with earning are: channels.
     module Earnings
-      # Return the estimated earning for one specific day.
+      # Return the estimated earnings for one specific day.
       #
       # @param [Date or Time or DateTime or String] date The date to obtain
       # the estimated earnings for. If String, must be Date-parseable.
       #
       # @return [Float] The estimated earnings in USD.
-      def earning(date)
+      def earnings_on(date)
         earnings(from: date, to: date).values.first
       end
 
-      # Return the estimated earning for a range of days.
+      # Return the estimated earnings for a range of days.
       #
       # @param [Hash] options the range of days to get the earnings for.
       # @option options [Date or Time or DateTime or String] :since The start
@@ -29,8 +29,8 @@ module Yt
       # @return [Hash] The estimated earnings by day. Each :key is a Date
       # and each :value is a Float, representing estimated earnings in USD.
       def earnings(options = {})
-        from = options[:since] || options[:from] || 1.week.ago
-        to = options[:until] || options[:to] || 1.day.ago
+        from = options[:since] || options[:from] || 6.days.ago
+        to = options[:until] || options[:to] || 2.days.ago
         range = Range.new *[from, to].map(&:to_date)
 
         Hash[*range.flat_map do |date|

data/lib/yt/associations/views.rb

@@ -0,0 +1,52 @@
+require 'yt/collections/views'
+
+module Yt
+  module Associations
+    # Provides the `has_many :views` method to YouTube resources, which
+    # allows to invoke view-related methods, such as .views.
+    # YouTube resources with views are: channels.
+    module Views
+      # Return the view count for one specific day.
+      #
+      # @param [Date or Time or DateTime or String] date The date to obtain
+      # the estimated views for. If String, must be Date-parseable.
+      #
+      # @return [Integer or Nil] The estimated views.
+      def views_on(date)
+        views(from: date, to: date).values.first
+      end
+
+      # Return the view count for a range of days.
+      #
+      # @param [Hash] options the range of days to get the views for.
+      # @option options [Date or Time or DateTime or String] :since The start
+      # of the days range. If String, must be Date-parseable.
+      # @note options[:since] is aliased as options[:from]
+      # @option options [Date or Time or DateTime or String] :until The end
+      # of the days range. If String, must be Date-parseable.
+      # @note options[:until] is aliased as options[:to]
+      #
+      # @return [Hash] The view count by day. Each :key is a Date
+      # and each :value is an Integer or nil, representing the number of views.
+      def views(options = {})
+        from = options[:since] || options[:from] || 5.days.ago
+        to = options[:until] || options[:to] || 1.day.ago
+        range = Range.new *[from, to].map(&:to_date)
+
+        Hash[*range.flat_map do |date|
+          [date, (@views ||= {})[date] ||= range_views(range)[date]]
+        end]
+      end
+
+    private
+
+      def range_views(date_range)
+        (@range_views ||= {})[date_range] ||= all_views.within date_range
+      end
+
+      def all_views
+        Collections::Views.of self
+      end
+    end
+  end
+end

data/lib/yt/collections/views.rb

@@ -0,0 +1,38 @@
+require 'yt/collections/base'
+
+module Yt
+  module Collections
+    class Views < Base
+
+      def within(days_range)
+        @days_range = days_range
+        Hash[*flat_map{|daily_view| daily_view}]
+      end
+
+    private
+
+      def new_item(data)
+        # NOTE: could use column headers to be more precise
+        [Date.iso8601(data.first), (data.last.to_i if data.last)]
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:path] = '/youtube/analytics/v1/reports'
+          params[:params] = {}.tap do |params|
+            params['ids'] = "contentOwner==#{@auth.owner_name}"
+            params['filters'] = "channel==#{@parent.id}"
+            params['start-date'] = @days_range.begin
+            params['end-date'] = @days_range.end
+            params['metrics'] = :views
+            params['dimensions'] = :day
+          end
+        end
+      end
+
+      def items_key
+        'rows'
+      end
+    end
+  end
+end

data/lib/yt/models/channel.rb

@@ -6,7 +6,8 @@ module Yt
       has_many :subscriptions
       has_many :videos
       has_many :playlists
-      has_many :earnings # requires auth with an account with 'yt-analytics-monetary.readonly'
+      has_many :earnings
+      has_many :views
     end
   end
 end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.5.14'
+  VERSION = '0.6.0'
 end

data/spec/associations/device_auth/earnings_spec.rb

@@ -7,10 +7,10 @@ describe Yt::Associations::Earnings, :partner do
     context 'managed by the authenticated Content Owner' do
       let(:channel_id) { ENV['YT_TEST_PARTNER_CHANNEL_ID'] }
 
-      describe '#earning' do
+      describe '#earnings_on' do
         context 'and a date in which the channel made any money' do
-          let(:earning) { channel.earning 5.days.ago}
-          it { expect(earning).to be_a Float }
+          let(:earnings) { channel.earnings_on 5.days.ago}
+          it { expect(earnings).to be_a Float }
         end
 
         # NOTE: This test sounds redundant, but it’s actually a reflection of
@@ -22,17 +22,17 @@ describe Yt::Associations::Earnings, :partner do
         # which the earnings have not been estimated yet.
         context 'and a date in which the channel did not make any money' do
           let(:zero_date) { ENV['YT_TEST_PARTNER_CHANNEL_NO_EARNINGS_DATE'] }
-          let(:earning) { channel.earning zero_date}
-          it { expect(earning).to eq 0 }
+          let(:earnings) { channel.earnings_on zero_date}
+          it { expect(earnings).to eq 0 }
         end
 
         context 'and a date for which earnings have not yet been estimated' do
-          let(:earning) { channel.earning 5.days.from_now}
-          it { expect(earning).to be_nil }
+          let(:earnings) { channel.earnings_on 5.days.from_now}
+          it { expect(earnings).to be_nil }
         end
       end
 
-      describe '#earning' do
+      describe '#earnings' do
         let(:date) { 4.days.ago }
 
         context 'given a :since option' do
@@ -59,7 +59,7 @@ describe Yt::Associations::Earnings, :partner do
 
     context 'not managed by the authenticated Content Owner' do
       let(:channel_id) { 'UCBR8-60-B28hp2BmDPdntcQ' }
-      it { expect{channel.earning 5.days.ago}.to raise_error Yt::Errors::Forbidden }
+      it { expect{channel.earnings}.to raise_error Yt::Errors::Forbidden }
     end
   end
 end

data/spec/associations/device_auth/views_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Yt::Associations::Views, :partner do
+  context 'given a partnered channel' do
+    let(:channel) { Yt::Channel.new id: channel_id, auth: $content_owner }
+
+    context 'managed by the authenticated Content Owner' do
+      let(:channel_id) { ENV['YT_TEST_PARTNER_CHANNEL_ID'] }
+
+      describe '#views_on' do
+        context 'and a date in which the channel was partnered' do
+          let(:views) { channel.views_on 5.days.ago}
+          it { expect(views).to be_an Integer }
+        end
+
+        context 'and a date in which the channel was not partnered' do
+          let(:views) { channel.views_on 20.years.ago}
+          it { expect(views).to be_nil }
+        end
+      end
+
+      describe '#views' do
+        let(:date) { 4.days.ago }
+
+        context 'given a :since option' do
+          let(:views) { channel.views since: date}
+          it { expect(views.keys.min).to eq date.to_date }
+        end
+
+        context 'given a :from option' do
+          let(:views) { channel.views from: date}
+          it { expect(views.keys.min).to eq date.to_date }
+        end
+
+        context 'given a :until option' do
+          let(:views) { channel.views until: date}
+          it { expect(views.keys.max).to eq date.to_date }
+        end
+
+        context 'given a :to option' do
+          let(:views) { channel.views to: date}
+          it { expect(views.keys.max).to eq date.to_date }
+        end
+      end
+    end
+
+    context 'not managed by the authenticated Content Owner' do
+      let(:channel_id) { 'UCBR8-60-B28hp2BmDPdntcQ' }
+      it { expect{channel.views}.to raise_error Yt::Errors::Forbidden }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 0.6.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -138,6 +138,7 @@ files:
 - lib/yt/associations/subscriptions.rb
 - lib/yt/associations/user_infos.rb
 - lib/yt/associations/videos.rb
+- lib/yt/associations/views.rb
 - lib/yt/collections/annotations.rb
 - lib/yt/collections/authentications.rb
 - lib/yt/collections/base.rb
@@ -153,6 +154,7 @@ files:
 - lib/yt/collections/subscriptions.rb
 - lib/yt/collections/user_infos.rb
 - lib/yt/collections/videos.rb
+- lib/yt/collections/views.rb
 - lib/yt/config.rb
 - lib/yt/errors/forbidden.rb
 - lib/yt/errors/no_items.rb
@@ -194,6 +196,7 @@ files:
 - spec/associations/device_auth/subscriptions_spec.rb
 - spec/associations/device_auth/user_infos_spec.rb
 - spec/associations/device_auth/videos_spec.rb
+- spec/associations/device_auth/views_spec.rb
 - spec/associations/no_auth/annotations_spec.rb
 - spec/associations/server_auth/channels_spec.rb
 - spec/associations/server_auth/details_sets_spec.rb
@@ -279,6 +282,7 @@ test_files:
 - spec/associations/device_auth/subscriptions_spec.rb
 - spec/associations/device_auth/user_infos_spec.rb
 - spec/associations/device_auth/videos_spec.rb
+- spec/associations/device_auth/views_spec.rb
 - spec/associations/no_auth/annotations_spec.rb
 - spec/associations/server_auth/channels_spec.rb
 - spec/associations/server_auth/details_sets_spec.rb