yt 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29f2a9daff36933af1c9fafa394009a4660697cd
-  data.tar.gz: b9cb80c044040fc195eac01bad264d1fb65fea69
+  metadata.gz: 5c6e034f7f20ce13ac90b4156e7e6845ef96730a
+  data.tar.gz: 95f4e7115e31707a6fbf64ea7d671f6c9dd34b19
 SHA512:
-  metadata.gz: 02a7be4f86dd4fe2801edf57ffa79f05a2b16321d3d3e5a7043893b3eb40d81bf4173049de53443bd816fe5cdf177b64f5e9150140a1b25d4f30bb5ee3523f24
-  data.tar.gz: d9a7005315e12337e16d89e19f8112d3b484594d984fdd7315f6fb5a3c34193f21ed1758fd9bf65487a2c849422b0763abc4b5b50406f3e733344b59c6561c5c
+  metadata.gz: 363c34358726c126c90b7fab58747d3df03a1fc0f1711e524d28cc35c954859865fbbde3a0e9207a6f6d49f2cc1235cb12ec5dc62632cc29699df0b4908fd271
+  data.tar.gz: 5d2436157647425de284a1fbb918f12c9e7f6f510b9c0dab9a8e97b2193468994cb4a53e2f8ffcdd3052c2d520e75cb3bed15e0aa57bd2c139383090158c96be

data/.travis.yml

@@ -15,4 +15,9 @@ env:
   global:
   - secure: ApPj5c9h6xk+AbHHf4KXL10QnleYCWwcp2+qMFolrS6RWR5vhrnKq1UBo0h59HuvXeOQIgZ/GmocuSEZovS9c1hQP3n0PHSNEnGUNJyn6CS3BiPQSWmC3p2pONo1Xv+hVWfzDoEv80b82GX5P5x/l1BSqhpxLA9geITJprWsoLg=
   - secure: CkLyqIq/yTV5h/41b0wxIhMN0LvTk51IBht1+l678YSK7zT9emo9DcwnZVQ9f9KluDD8SyUGRORD40eQs8XmqpDCx7gj7i5e3TEVBofM9YnyFMR1lsWRiMr8jf2eksuP10kEkV7S7E1KH4LI2K1ZcOVqfN0G3Vs0C5D8GwpEcQ8=
-  - secure: XzuEz0AV6eDeT3+VaodXRMOh+fDvtG1X/VDfnh3f3gmVsnW1d8gdZY9Gw9rkSixK0SwL58BcSu+SU9BlDAsa0asv2XF8h51Q7s3x0ld9I60ssV/4DXSXqicHYcq13Vd86JMmURUuLiJM3y5lXb0bMGXNOkgYZ19gd5X9No+Tkww=
+  - secure: XzuEz0AV6eDeT3+VaodXRMOh+fDvtG1X/VDfnh3f3gmVsnW1d8gdZY9Gw9rkSixK0SwL58BcSu+SU9BlDAsa0asv2XF8h51Q7s3x0ld9I60ssV/4DXSXqicHYcq13Vd86JMmURUuLiJM3y5lXb0bMGXNOkgYZ19gd5X9No+Tkww=
+  - secure: GvFLpteuIhPHtNT41VBR49sJf5yAWpwwGA24Ov92e5FaVzZD8eiBQZYwjx3Whyo5nkSN5nDzYeKvEdkHaE+sIhSjhoeSY6Q85YK9o/4hSSxjo71OepZXfawKH0xtpkbI+N1fMuUCZR0ustSCLx1snLLZtFRQR2YWU6qg+Yj48Ds=
+  - secure: d7yJZSz7Xk0LgJJSTbiK+yb12fdu9101wGXR56sSaRb5BoulBO12uKQgMYMa1kAh6imrNL4WzGOQQGC3SXDAEL6riHcuQJQOmM5zRJtZOrgitVe4cUm9Lv7jo4OyoJNd65EqpOaFPlI0Z3hp0xy3tOuTXemjie44ReKsCUp7z2Y=
+  - secure: Hpv62bpHo2zNHwB6VYNKxXLv12GHC0fiGUZ/uDv/4ncukifR9zEeucp104o3f4jqRpauy533kNw1JmucXI6Y+IEyHoEcqA99/i/HirS5WlB7vRH1ATX20Jj3kQ2JaFBIzidX9gNXvSNwpI2XK267eqfZUDFU8zp6aUPnJ6tgpq0=
+  - secure: Ejj8tsuwyrRVmCc/R9ubKWCHWhCGpe0Dy6fc1UuPCkcMZyXq9ZC02v2obWsTQQ7epEgsCYZAO4v/gWpuv1b1huGcWdfJzMW7RCoY87cEf9HnAK0lSwGx4+/pYkEMe8y5p149C3vAR8nqczvEavN1fUq/WwPUqp+JyDP7kwFTs2Y=
+  - secure: gE5kAT1R54hmS+W3YYGcUtlD8ZskvTctVR3sr+C5CUjVPdq6Ktx5Q/a6EJyAVVrhxpaCOuk3LG+VkzdQIVFUNRiDPcOulkond4HkSQDoy+IJ/wTXvUS+lIJ1ERUnWega+APrQUjH5s2WayPGZUBqWt/u8Tt9EmSUZfuKZSEXqZk=

data/Gemfile.lock

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

data/HISTORY.md

@@ -11,6 +11,7 @@ v0.5 - 2014/05/16
 * New Authentication model to separate `access_token` and `refresh_token` from Account
 * New types of Errors that render more verbose errors and the failing request in cURL syntax
 * Separate Error class for 500 error, so they can be easily found in app logs
+* New Earning collection to retrieve estimated earning for YouTube-partnered channels
 
 v0.4 - 2014/05/09
 --------------------

data/README.md

@@ -41,9 +41,9 @@ Use [Yt::Account](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Account) to
 * access the YouTube channel of the account
 
 ```ruby
-account = Yt::Account.new
+# An account can be initialized with access token, refresh token or an authorization code
+account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
 
-# An OAuth2 prompt will appear before the following commands
 account.email #=> .. your e-mail address..
 account.channel #=> #<Yt::Channel @id=...>
 ```
@@ -60,6 +60,7 @@ Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Channel) to
 * access the playlists of a channel
 * subscribe to and unsubscribe from a channel
 * create and delete playlists from a channel
+* retrieve the estimated daily earnings of a channel
 
 ```ruby
 channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
@@ -71,8 +72,14 @@ channel.videos.first #=> #<Yt::Video @id=...>
 
 channel.playlists.count #=> 2
 channel.playlists.first #=> #<Yt::Playlist @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
 
-# An OAuth2 prompt will appear before the following commands
 channel.subscribed? #=> false
 channel.subscribe #=> true
 
@@ -81,7 +88,18 @@ channel.delete_playlists title: 'New playlist' #=> [true]
 
 ```
 
-*Subscribing to and unsubscribing from a channel requires authentication (see below).*
+*The methods above require to be authenticated as a YouTube account (see below).*
+
+```ruby
+content_owner = Yt::Account.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 since: 3.days.ago, until: 2.days.ago #=> {Wed, 28 May 2014 => 1.34, Thu, 29 May 2014 => 0.47}
+```
+
+*The methods above require to be authenticated as the channel’s content owner (see below).*
+
 
 Yt::Video
 -----------
@@ -100,13 +118,19 @@ video.description.has_link_to_subscribe? #=> false
 
 video.annotations.count #=> 1
 video.annotations.first #=> #<Yt::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
 
-# An OAuth2 prompt will appear before the following commands
 video.liked? #=> false
 video.like #=> true
 ```
 
-*Liking and disliking a video requires authentication (see below).*
+*The methods above require to be authenticated as a YouTube account (see below).*
 
 Yt::Playlist
 ------------
@@ -127,14 +151,17 @@ playlist.playlist_items.count #=> 1
 playlist.playlist_items.first #=> #<Yt::PlaylistItem @id=...>
 playlist.playlist_items.first.position #=> 0
 playlist.playlist_items.first.video.title #=> "Fullscreen Creator Platform"
+```
+
+*The methods above do not require authentication.*
 
-# An OAuth2 prompt will appear before the following commands
+```ruby
 playlist.add_video 'MESycYJytkU'
 playlist.add_videos ['MESycYJytkU', 'MESycYJytkU']
 playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]
 ```
 
-*Adding and removing videos/items requires authentication (see below).*
+*The methods above require to be authenticated as the playlist’s owner (see below).*
 
 
 Yt::Annotation
@@ -219,8 +246,28 @@ account.email #=> (retrieves the account’s e-mail address)
 account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
 ```
 
-Scenario 3. If you don’t have the account’s refresh token, then [..TODO..]
+Scenario 3. If you don’t have any account’s token, then you can get one by
+having the user authorize your app through the Google OAuth page. First,
+build the the Google OAuth page URL with the following code:
 
+```ruby
+Yt::Account.new(scopes: scopes, redirect_uri: redirect_uri).authentication_url
+```
+
+where `scopes` is the list of scopes you want the user to authorize, and
+`redirect_uri` is the page of your web app the user should come back after
+authorizing (remember, this must be added to the Google Console as well).
+Sample scopes are: `youtube`, `youtube.readonly` `userinfo.email`.
+
+After authorizing your app, the user will be redirected to `redirect_uri`
+with an extra `code` parameter that looks something like `4/Ja60jJ7_Kw0`.
+Just pass the code to the following method to authenticate and initialize the account:
+
+```ruby
+account = Yt::Account.new authorization_code: '4/Ja60jJ7_Kw0'
+account.email #=> (retrieves the account’s e-mail address)
+account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
+```
 
 Device apps that do require user interactions
 ---------------------------------------------
@@ -300,7 +347,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.5.6'
+    gem 'yt', '~> 0.5.7'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/actions/list.rb

@@ -4,7 +4,7 @@ require 'yt/errors/no_items'
 module Yt
   module Actions
     module List
-      delegate :count, :first, :any?, :each, :map, :find, to: :list
+      delegate :count, :first, :any?, :each, :map, :flat_map, :find, to: :list
       alias size count
 
       def first!
@@ -51,7 +51,7 @@ module Yt
         request = Yt::Request.new params
         response = request.run
         token = response.body['nextPageToken']
-        items = response.body.fetch 'items', []
+        items = response.body.fetch items_key, []
         {items: items, token: token}
       end
 
@@ -65,6 +65,10 @@ module Yt
           params[:exptected_response] = Net::HTTPOK
         end
       end
+
+      def items_key
+        'items'
+      end
     end
   end
 end

data/lib/yt/associations/earnings.rb

@@ -0,0 +1,52 @@
+require 'yt/collections/earnings'
+
+module Yt
+  module Associations
+    # Provides the `has_many :earnings` method to YouTube resources, which
+    # 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.
+      #
+      # @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)
+        earnings(from: date, to: date).values.first
+      end
+
+      # Return the estimated earning 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
+      # 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 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
+        range = Range.new *[from, to].map(&:to_date)
+
+        Hash[*range.flat_map do |date|
+          [date, (@earnings ||= {})[date] ||= range_earnings(range)[date]]
+        end]
+      end
+
+    private
+
+      def range_earnings(date_range)
+        (@range_earnings ||= {})[date_range] ||= all_earnings.within date_range
+      end
+
+      def all_earnings
+        Collections::Earnings.of self
+      end
+    end
+  end
+end

data/lib/yt/associations.rb

@@ -14,6 +14,7 @@ module Yt
     autoload :Authentications
     autoload :Channels
     autoload :DetailsSets
+    autoload :Earnings
     autoload :Ids
     autoload :PlaylistItems
     autoload :Playlists

data/lib/yt/collections/earnings.rb

@@ -0,0 +1,38 @@
+require 'yt/collections/base'
+
+module Yt
+  module Collections
+    class Earnings < Base
+
+      def within(days_range)
+        @days_range = days_range
+        Hash[*flat_map{|daily_earning| daily_earning}]
+      end
+
+    private
+
+      def new_item(data)
+        # NOTE: could use column headers to be more precise
+        [Date.iso8601(data.first), 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'] = :earnings
+            params['dimensions'] = :day
+          end
+        end
+      end
+
+      def items_key
+        'rows'
+      end
+    end
+  end
+end

data/lib/yt/models/account.rb

@@ -4,9 +4,10 @@ module Yt
   module Models
     # Provides methods to access a YouTube account.
     class Account < Base
-      has_one :authentication, delegate: [:access_token, :refresh_token, :expires_at]
       has_one :channel, delegate: [:videos, :playlists, :create_playlist, :delete_playlists, :update_playlists]
       has_one :user_info, delegate: [:id, :email, :has_verified_email?, :gender, :name, :given_name, :family_name, :profile_url, :avatar_url, :locale, :hd]
+      has_one :authentication, delegate: [:access_token, :refresh_token, :expires_at]
+      attr_reader :owner_name
 
       def initialize(options = {})
         @access_token = options[:access_token]
@@ -15,6 +16,7 @@ module Yt
         @authorization_code = options[:authorization_code]
         @redirect_uri = options[:redirect_uri]
         @scopes = options[:scopes]
+        @owner_name = options[:owner_name]
       end
 
       def auth

data/lib/yt/models/channel.rb

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

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

data/spec/associations/device_auth/earnings_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Yt::Associations::Earnings, :partner do
+  context 'given a Youtube Partner channel (with a content owner)' do
+    let(:channel) { $partner_channel }
+
+    describe '#earning' do
+      context 'given a date for which YouTube has estimated earnings' do
+        let(:earning) { channel.earning 5.days.ago}
+        it { expect(earning).to be_a Float }
+      end
+
+      context 'given a date for which YouTube does not have estimated earnings' do
+        let(:earning) { channel.earning 5.days.from_now}
+        it { expect(earning).to be_nil }
+      end
+    end
+
+    describe '#earning' do
+      let(:date) { 4.days.ago }
+
+      context 'given a :since option' do
+        let(:earnings) { channel.earnings since: date}
+        it { expect(earnings.keys.min).to eq date.to_date }
+      end
+
+      context 'given a :from option' do
+        let(:earnings) { channel.earnings from: date}
+        it { expect(earnings.keys.min).to eq date.to_date }
+      end
+
+      context 'given a :until option' do
+        let(:earnings) { channel.earnings until: date}
+        it { expect(earnings.keys.max).to eq date.to_date }
+      end
+
+      context 'given a :to option' do
+        let(:earnings) { channel.earnings to: date}
+        it { expect(earnings.keys.max).to eq date.to_date }
+      end
+    end
+  end
+end

data/spec/support/global_hooks.rb

@@ -30,4 +30,17 @@ RSpec.configure do |config|
       config.api_key = ENV['YT_TEST_SERVER_API_KEY']
     end
   end
-end
+
+  config.before :all, partner: true do
+    Yt.configure do |config|
+      config.client_id = ENV['YT_TEST_PARTNER_CLIENT_ID']
+      config.client_secret = ENV['YT_TEST_PARTNER_CLIENT_SECRET']
+    end
+    # Create one Youtube Partner channel, authenticated as the content owner
+    attrs = {refresh_token: ENV['YT_TEST_CONTENT_OWNER_REFRESH_TOKEN']}
+    attrs[:owner_name] = ENV['YT_TEST_CONTENT_OWNER_NAME']
+    content_owner = Yt::Account.new attrs
+    attrs = {id: ENV['YT_TEST_PARTNER_CHANNEL_ID'], auth: content_owner}
+    $partner_channel = Yt::Channel.new attrs
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,6 +127,7 @@ files:
 - lib/yt/associations/authentications.rb
 - lib/yt/associations/channels.rb
 - lib/yt/associations/details_sets.rb
+- lib/yt/associations/earnings.rb
 - lib/yt/associations/ids.rb
 - lib/yt/associations/playlist_items.rb
 - lib/yt/associations/playlists.rb
@@ -141,6 +142,7 @@ files:
 - lib/yt/collections/base.rb
 - lib/yt/collections/channels.rb
 - lib/yt/collections/details_sets.rb
+- lib/yt/collections/earnings.rb
 - lib/yt/collections/ids.rb
 - lib/yt/collections/playlist_items.rb
 - lib/yt/collections/playlists.rb
@@ -178,6 +180,7 @@ files:
 - spec/associations/device_auth/authentications_spec.rb
 - spec/associations/device_auth/channels_spec.rb
 - spec/associations/device_auth/details_sets_spec.rb
+- spec/associations/device_auth/earnings_spec.rb
 - spec/associations/device_auth/ids_spec.rb
 - spec/associations/device_auth/playlist_items_spec.rb
 - spec/associations/device_auth/playlists_spec.rb
@@ -260,6 +263,7 @@ test_files:
 - spec/associations/device_auth/authentications_spec.rb
 - spec/associations/device_auth/channels_spec.rb
 - spec/associations/device_auth/details_sets_spec.rb
+- spec/associations/device_auth/earnings_spec.rb
 - spec/associations/device_auth/ids_spec.rb
 - spec/associations/device_auth/playlist_items_spec.rb
 - spec/associations/device_auth/playlists_spec.rb