yt 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f7f8e3686d58c93674547e4aac01644a01d0db
-  data.tar.gz: f3739308a1230e14548efe5d68abeb76e66c4422
+  metadata.gz: 72f7e8f2bdbc10f6d4ee9e400032c623f9dcaf9c
+  data.tar.gz: 3f2eaf3a29cf656f4bf127ad92d4661603effa93
 SHA512:
-  metadata.gz: 1fb1f949b74acab51e649a863733453dadbce615f5aef848f28ae1c7a25c274cf582d53ac5d3e1d3c7988758cf4561b65d10751607c5cf3dedab43c28dd04e7b
-  data.tar.gz: 774e99b48115627b617f5bfbbc57cd66d039db2fefe5b32f83e73ebcb80d1a9874586efcc961114ba758c1cf59ffb42bfc5db00ddaa4c4b3dad48d3d11836b3e
+  metadata.gz: 66571f1ace7215bc148992f19758a974f1ff46cb832c7c2312e76ed4d2bafa41241fd355e09803b0e520fc8c38e7b4d91d3baab53ba81b421d5130751d0b8aba
+  data.tar.gz: 0d5d8ba68f7350f7d9d744d3202e616cb3bc64e322185c729b24de96bce99a6a44c9cc00b7fb843c00da41b400ccb7d505b8aa0511342bebbc63dcca73e44549

data/Gemfile.lock

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

data/HISTORY.md

@@ -17,6 +17,7 @@ v0.5 - 2014/05/16
 * Retry once YouTube earning queries that return error 400 "Invalid query. Query did not conform to the expectations"
 * Update RSpec to 3.0 (only required in development/testing)
 * New ContentOwner subclass of Account with access to partnered channels
+* Automatically refresh the access token when it expires or becomes invalid
 
 v0.4 - 2014/05/09
 --------------------

data/README.md

@@ -34,7 +34,7 @@ Available resources
 Yt::Account
 -----------
 
-Use [Yt::Account](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Account) to:
+Use [Yt::Account](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Account) to:
 
 * authenticate as a YouTube account
 * read attributes of the account
@@ -50,10 +50,28 @@ account.channel #=> #<Yt::Channel @id=...>
 
 *All the above methods require authentication (see below).*
 
+Yt::ContentOwner
+----------------
+
+Use [Yt::ContentOwner](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/ContentOwner) to:
+
+* authenticate as a YouTube content owner
+* list the channels partnered with a YouTube content owner
+
+```ruby
+# A content owner is an account, therefore can be initialized with access token, refresh token or an authorization code
+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::Channel @id=...>
+```
+
+*All the above methods require authentication (see below).*
+
 Yt::Channel
 -----------
 
-Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Channel) to:
+Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Channel) to:
 
 * read attributes of a channel
 * access the videos of a channel
@@ -91,7 +109,7 @@ channel.delete_playlists title: 'New playlist' #=> [true]
 *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'
+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
@@ -104,7 +122,7 @@ channel.earnings since: 3.days.ago, until: 2.days.ago #=> {Wed, 28 May 2014 => 1
 Yt::Video
 -----------
 
-Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Video) to:
+Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Video) to:
 
 * read attributes of a video
 * access the annotations of a video
@@ -135,7 +153,7 @@ video.like #=> true
 Yt::Playlist
 ------------
 
-Use [Yt::Playlist](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Playlist) to:
+Use [Yt::Playlist](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Playlist) to:
 
 * read attributes of a playlist
 * access the items of a playlist
@@ -167,7 +185,7 @@ playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]
 Yt::Annotation
 --------------
 
-Use [Yt::Annotation](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Annotation) to:
+Use [Yt::Annotation](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Annotation) to:
 
 * read attributes of an annotation
 
@@ -347,7 +365,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.5.10'
+    gem 'yt', '~> 0.5.11'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/associations/authentications.rb

@@ -21,6 +21,15 @@ module Yt
         URI::HTTPS.build(host: host, path: path, query: query).to_s
       end
 
+      # Obtains a new access token.
+      # Returns true if the new access token is different from the previous one
+      def refresh
+        old_access_token = authentication.access_token
+        authentication.expire
+        new_access_token = authentication.access_token
+        old_access_token != new_access_token
+      end
+
     private
 
       def current_authentication

data/lib/yt/models/authentication.rb

@@ -13,6 +13,10 @@ module Yt
         @expires_at && @expires_at.past?
       end
 
+      def expire
+        @expires_at = 10.years.ago
+      end
+
     private
 
       def expiration_date(options = {})

data/lib/yt/models/request.rb

@@ -28,6 +28,8 @@ module Yt
       def run
         if response.is_a? @expected_response
           response.tap{|response| response.body = parse_format response.body}
+        elsif run_again_with_refreshed_authentication?
+          run
         else
           raise error_for(response), request_error_message
         end
@@ -35,6 +37,16 @@ module Yt
 
     private
 
+      # If a request authorized with an access token returns 401, then the
+      # access token might have expired. If a refresh token is also present,
+      # try to run the request one more time with a refreshed access token.
+      def run_again_with_refreshed_authentication?
+        if response.is_a? Net::HTTPUnauthorized
+          @response = @http_request = @uri = nil
+          @auth.refresh
+        end if @auth.respond_to? :refresh
+      end
+
       def response
         @response ||= Net::HTTP.start(*net_http_options) do |http|
           http.request http_request

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.5.10'
+  VERSION = '0.5.11'
 end

data/spec/associations/device_auth/authentications_spec.rb

@@ -50,17 +50,31 @@ describe Yt::Associations::Authentications, :device_app do
 
         context 'that has expired' do
           let(:expires_at) { 1.day.ago.to_s }
-          it { expect{account.authentication}.to raise_error Yt::Errors::Unauthorized }
+
+          context 'and no valid refresh token' do
+            it { expect{account.authentication}.to raise_error Yt::Errors::Unauthorized }
+          end
+
+          context 'and a valid refresh token' do
+            before { attrs[:refresh_token] = ENV['YT_TEST_DEVICE_REFRESH_TOKEN'] }
+            it { expect(account.authentication).to be_a Yt::Authentication }
+          end
         end
       end
 
       context 'that is invalid' do
         let(:access_token) { '--not-a-valid-access-token--' }
         let(:expires_at) { 1.day.from_now }
-        it { expect(account.authentication).to be_a Yt::Authentication }
-        it { expect{account.channel}.to raise_error Yt::Errors::Unauthorized }
-      end
 
+        context 'and no valid refresh token' do
+          it { expect{account.channel}.to raise_error Yt::Errors::Unauthorized }
+        end
+
+        context 'and a valid refresh token' do
+          before { attrs[:refresh_token] = ENV['YT_TEST_DEVICE_REFRESH_TOKEN'] }
+          it { expect{account.channel}.not_to raise_error }
+        end
+      end
     end
 
     context 'given no token or code' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Claudio Baccigalupo