yt 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b618d7f55a83eeba246fba2937b6fdfb13b41a49
-  data.tar.gz: 9a40df4f2d2dd15abaa142c4ce39233f2921f89e
+  metadata.gz: 2c609731e55cd81b71dfbc3f53f47147dac54b51
+  data.tar.gz: 0993daf654fda172520af7d6d01e8620ff66fbf6
 SHA512:
-  metadata.gz: f5fa21279a6b52775b60dacdc2b4e4ae39edecee2d04cd60b3b8461f9412b32b987f223e89bf58b72475675edb319455d77d7009340315ef60d839e86b4124f5
-  data.tar.gz: fa8634ac7fa6c44e0269be8a180b527102742789f1c4e6d50e3d6c137e38329dbbbe7482fd0bb0038a3de0f22e07a1d1e3ded545c5234de8249ca3761d867e28
+  metadata.gz: 60d5bf311041934ec83bd36cfff50905d04e3ef8444f90e8be39ad3249da24618ef308bdee47688785a5bdc8d8024d91dc2a253a44d3cf204d331e6209eb66cb
+  data.tar.gz: fea7bc7fb323a51c21be93a0108e8d3350f808c8a4bb56cc956d2db5d4cf8c720fe6bdb8e492f39f65337d76d8843edf9898cd2464f9d354adc9ca089d0a834b

data/Gemfile.lock

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

data/HISTORY.md

@@ -7,6 +7,9 @@ v0.5 - 2014/05/16
 * Add `has_one :id` to resources, to retrieve the ID of resources initialized by URL
 * Raise an error if some `has_one` associations are not found (id, snippet, details set, user info)
 * Don't check for the right :scope if Account is initialized with credentials
+* Move models in Yt::Models but still auto-include them in the main namespace
+* 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
 
 v0.4 - 2014/05/09
 --------------------

data/README.md

@@ -8,6 +8,7 @@ Yt helps you write apps that need to interact with the YouTube API V3.
 [![Build Status](https://travis-ci.org/Fullscreen/yt.png?branch=master)](https://travis-ci.org/Fullscreen/yt)
 [![Coverage Status](https://coveralls.io/repos/Fullscreen/yt/badge.png?)](https://coveralls.io/r/Fullscreen/yt)
 [![Code Climate](https://codeclimate.com/github/Fullscreen/yt.png)](https://codeclimate.com/github/Fullscreen/yt)
+[![Inline docs](http://inch-pages.github.io/github/Fullscreen/yt.png)](http://inch-pages.github.io/github/Fullscreen/yt)
 
 After [registering your app](#registering-your-app), you can run commands like:
 
@@ -169,7 +170,6 @@ Next, add the following snippet of code to the initializer of your app:
 
 ```ruby
 Yt.configure do |config|
-  config.scenario = :server_app
   config.api_key = '123456789012345678901234567890'
 end
 ```
@@ -246,7 +246,6 @@ refresh token, then add the following snippet of code to the initializer of your
 
 ```ruby
 Yt.configure do |config|
-  config.scenario = :device_app
   config.client_id = '1234567890.apps.googleusercontent.com'
   config.client_secret = '1234567890'
 end
@@ -282,7 +281,6 @@ is equivalent to configuration your app with the initializer:
 
 ```ruby
 Yt.configure do |config|
-  config.scenario = :device_app
   config.client_id = '1234567890.apps.googleusercontent.com'
   config.client_secret = '1234567890'
   config.api_key = '123456789012345678901234567890'
@@ -302,7 +300,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.5.4'
+    gem 'yt', '~> 0.5.5'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/bin/yt

@@ -9,13 +9,6 @@ end
 
 ############################
 
-Yt.configure do |config|
-  config.scenario = :server_app
-  config.api_key = ENV['YT_TEST_APP_SERVER_API_KEY']
-end
-
-############################
-
 channel = Yt::Channel.new id: ARGV[0] || 'UCxO1tY8h1AhOz0T4ENwmpow'
 
 puts "Title: #{channel.title}"

data/lib/yt/actions/delete.rb

@@ -7,16 +7,16 @@ module Yt
     private
 
       def do_delete(extra_delete_params = {})
-        request = Request.new delete_params.merge(extra_delete_params)
+        request = Yt::Request.new delete_params.merge(extra_delete_params)
         response = request.run
-        raise unless response.is_a? Net::HTTPNoContent
         yield response.body
       end
 
       def delete_params
-        Request.default_params.tap do |params|
+        {}.tap do |params|
           params[:method] = :delete
           params[:auth] = @auth
+          params[:expected_response] = Net::HTTPNoContent
         end
       end
     end

data/lib/yt/actions/insert.rb

@@ -7,17 +7,17 @@ module Yt
     private
 
       def do_insert(extra_insert_params = {})
-        request = Request.new insert_params.merge(extra_insert_params)
+        request = Yt::Request.new insert_params.merge(extra_insert_params)
         response = request.run
-        raise unless response.is_a? Net::HTTPOK
         @items = []
         new_item response.body
       end
 
       def insert_params
-        Request.default_params.tap do |params|
+        {}.tap do |params|
           params[:method] = :post
           params[:auth] = @auth
+          params[:expected_response] = Net::HTTPOK
         end
       end
     end

data/lib/yt/actions/list.rb

@@ -8,9 +8,7 @@ module Yt
       alias size count
 
       def first!
-        first.tap do |item|
-          raise Errors::NoItems unless item
-        end
+        first.tap{|item| raise Errors::NoItems unless item}
       end
 
     private
@@ -50,9 +48,8 @@ module Yt
       end
 
       def fetch_page(params = {})
-        request = Request.new params
+        request = Yt::Request.new params
         response = request.run
-        raise unless response.is_a? Net::HTTPOK
         token = response.body['nextPageToken']
         items = response.body.fetch 'items', []
         {items: items, token: token}
@@ -61,10 +58,11 @@ module Yt
       def list_params
         path = "/youtube/v3/#{self.class.to_s.demodulize.camelize :lower}"
 
-        Request.default_params.tap do |params|
+        {}.tap do |params|
           params[:method] = :get
           params[:auth] = @auth
           params[:path] = path
+          params[:exptected_response] = Net::HTTPOK
         end
       end
     end

data/lib/yt/actions/update.rb

@@ -3,18 +3,20 @@ require 'yt/models/request'
 module Yt
   module Actions
     module Update
-      def do_update(extra_update_params = {}, options = {})
-        request = Request.new update_params.deep_merge(extra_update_params)
+
+    private
+
+      def do_update(extra_update_params = {})
+        request = Yt::Request.new update_params.deep_merge(extra_update_params)
         response = request.run
-        expected_response = options.fetch :expect, Net::HTTPNoContent
-        raise unless response.is_a? expected_response
         yield response.body
       end
 
       def update_params
-        Request.default_params.tap do |params|
+        {}.tap do |params|
           params[:method] = :put
           params[:auth] = @auth
+          params[:expected_response] = Net::HTTPNoContent
         end
       end
     end

data/lib/yt/associations/authentications.rb

@@ -0,0 +1,114 @@
+require 'yt/collections/authentications'
+require 'yt/config'
+require 'yt/errors/no_items'
+require 'yt/errors/missing_auth'
+
+module Yt
+  module Associations
+    # Provides the `has_one :access_token` method to YouTube resources, which
+    # allows to access to content detail set-specific methods like `access_token`.
+    # YouTube resources with access tokens are: accounts.
+    module Authentications
+      def authentication
+        @authentication = current_authentication
+        @authentication ||= new_authentication || refreshed_authentication!
+      end
+
+      def authentication_url
+        host = 'accounts.google.com'
+        path = '/o/oauth2/auth'
+        query = authentication_url_params.to_param
+        URI::HTTPS.build(host: host, path: path, query: query).to_s
+      end
+
+    private
+
+      def current_authentication
+        @authentication ||= Yt::Authentication.new current_data if @access_token
+        @authentication unless @authentication.nil? || @authentication.expired?
+      end
+
+      def current_data
+        {}.tap do |data|
+          data['access_token'] = @access_token
+          data['expires_at'] = @expires_at
+          data['refresh_token'] = @refresh_token
+        end
+      end
+
+      # Tries to obtain an access token using the authorization code (which
+      # can only be used once). On failure, does not raise an error because
+      # the access token might still be retrieved with a refresh token.
+      def new_authentication
+        new_authentications.first!
+      rescue Errors::NoItems => error
+        nil
+      end
+
+      # Tries to obtain an access token using the refresh token (which can
+      # be used multiple times). On failure, raise an error because there are
+      # no more options to obtain an access token.
+      def refreshed_authentication!
+        refreshed_authentications.first!
+      rescue Errors::NoItems => error
+        raise Errors::MissingAuth, error.to_param
+      end
+
+      def new_authentications
+        @new_authentications ||= Collections::Authentications.of(self).tap do |auth|
+          auth.auth_params = new_authentication_params
+        end
+      end
+
+      def refreshed_authentications
+        @refreshed_authentications ||= Collections::Authentications.of(self).tap do |auth|
+          auth.auth_params = refreshed_authentication_params
+        end
+      end
+
+      def authentication_url_params
+        {}.tap do |params|
+          params[:client_id] = client_id
+          params[:scope] = authentication_scope
+          params[:redirect_uri] = @redirect_uri
+          params[:response_type] = :code
+          params[:access_type] = :offline
+          # params[:include_granted_scopes] = true
+        end
+      end
+
+      def authentication_scope
+        @scopes.map do |scope|
+          "https://www.googleapis.com/auth/#{scope}"
+        end.join(' ') if @scopes.is_a?(Array)
+      end
+
+      def new_authentication_params
+        {}.tap do |params|
+          params[:client_id] = client_id
+          params[:client_secret] = client_secret
+          params[:code] = @authorization_code
+          params[:redirect_uri] = @redirect_uri
+          params[:grant_type] = :authorization_code
+        end
+      end
+
+      def refreshed_authentication_params
+        {}.tap do |params|
+          params[:client_id] = client_id
+          params[:client_secret] = client_secret
+          params[:refresh_token] = @refresh_token
+          params[:grant_type] = :refresh_token
+        end
+      end
+
+      def client_id
+        Yt.configuration.client_id
+      end
+
+      def client_secret
+        Yt.configuration.client_secret
+      end
+    end
+  end
+end

data/lib/yt/associations.rb

@@ -11,6 +11,7 @@ module Yt
     extend ActiveSupport::Autoload
 
     autoload :Annotations
+    autoload :Authentications
     autoload :Channels
     autoload :DetailsSets
     autoload :Ids

data/lib/yt/collections/annotations.rb

@@ -17,13 +17,13 @@ module Yt
           params[:host] = 'www.youtube.com'
           params[:path] = '/annotations_invideo'
           params[:params] = {video_id: @parent.id}
+          params[:expected_response] = Net::HTTPOK
         end
       end
 
       def next_page
-        request = Request.new list_params
+        request = Yt::Request.new list_params
         response = request.run
-        raise unless response.is_a? Net::HTTPOK
         @page_token = nil
 
         document = response.body.fetch('document', {})['annotations'] || {}

data/lib/yt/collections/authentications.rb

@@ -0,0 +1,42 @@
+require 'yt/collections/base'
+require 'yt/models/authentication'
+
+module Yt
+  module Collections
+    class Authentications < Base
+      attr_accessor :auth_params
+
+    private
+
+      def new_item(data)
+        Yt::Authentication.new data
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'accounts.google.com'
+          params[:path] = '/o/oauth2/token'
+          params[:body_type] = :form
+          params[:method] = :post
+          params[:auth] = nil
+          params[:body] = auth_params
+        end
+      end
+
+      def more_pages?
+        auth_params.values.all?
+      end
+
+      def next_page
+        request = Yt::Request.new list_params
+        Array.wrap request.run.body
+      rescue Yt::Error => error
+        expected?(error) ? [] : raise(error)
+      end
+
+      def expected?(error)
+        error.kind == 'invalid_grant'
+      end
+    end
+  end
+end

data/lib/yt/collections/base.rb

@@ -1,7 +1,7 @@
 require 'yt/actions/delete_all'
 require 'yt/actions/insert'
 require 'yt/actions/list'
-require 'yt/errors/error'
+require 'yt/errors/request_error'
 
 module Yt
   module Collections

data/lib/yt/collections/playlist_items.rb

@@ -11,7 +11,7 @@ module Yt
         resource["#{attrs[:kind]}Id"] = attrs[:id]
         snippet = {playlistId: @parent.id, resourceId: resource}
         do_insert body: {snippet: snippet}, params: {part: 'snippet,status'}
-      rescue Errors::Base => error
+      rescue Yt::Error => error
         ignorable_errors = error.reasons & ['videoNotFound', 'forbidden']
         raise error unless options[:ignore_errors] && ignorable_errors.any?
       end

data/lib/yt/collections/snippets.rb

@@ -12,10 +12,9 @@ module Yt
       end
 
       def list_params
-        parents_path = @parent.class.to_s.demodulize.underscore.pluralize
         super.tap do |params|
           params[:params] = {id: @parent.id, part: 'snippet'}
-          params[:path] = "/youtube/v3/#{parents_path}"
+          params[:path] = "/youtube/v3/#{@parent.kind.pluralize}"
         end
       end
     end

data/lib/yt/collections/subscriptions.rb

@@ -8,7 +8,7 @@ module Yt
       def insert(options = {})
         throttle
         do_insert
-      rescue Errors::Base => error
+      rescue Yt::Error => error
         ignorable_errors = error.reasons & ['subscriptionDuplicate']
         raise error unless options[:ignore_errors] && ignorable_errors.any?
       end

data/lib/yt/collections/user_infos.rb

@@ -14,13 +14,13 @@ module Yt
       def list_params
         super.tap do |params|
           params[:path] = '/oauth2/v2/userinfo'
+          params[:expected_response] = Net::HTTPOK
         end
       end
 
       def next_page
-        request = Request.new list_params
+        request = Yt::Request.new list_params
         response = request.run
-        raise unless response.is_a? Net::HTTPOK
         @page_token = nil
         
         Array.wrap response.body

data/lib/yt/config.rb

@@ -13,7 +13,6 @@ module Yt
   # @example A server-to-server YouTube client app
   #
   #   Yt.configure do |config|
-  #     config.scenario = :server_app
   #     config.api_key = 'ABCDEFGHIJ1234567890'
   #   end
   #
@@ -30,7 +29,6 @@ module Yt
     #
     # @example
     #   Yt.configure do |config|
-    #     config.scenario = :server_app
     #     config.api_key = 'ABCDEFGHIJ1234567890'
     #   end
     # @see Yt::Configuration

data/lib/yt/errors/missing_auth.rb

@@ -0,0 +1,50 @@
+require 'yt/errors/request_error'
+require 'yt/config'
+
+module Yt
+  module Errors
+    class MissingAuth < RequestError
+      private
+
+      def explanation
+        'A request to YouTube API was sent without a valid authentication'
+      end
+
+      def more_details
+        if [Yt.configuration.client_id, Yt.configuration.api_key].none?
+          <<-MSG.gsub(/^ {10}/, '')
+          In order to perform this request, you need to register your app with
+          Google Developers Console (https://console.developers.google.com).
+
+          Make sure your app has access to the Google+ and YouTube APIs.
+
+          If your app requires read-only access to public YouTube data, then
+          generate a server API key and set its value with the initializer:
+
+          Yt.configure do |config|
+            config.api_key = '123456789012345678901234567890'
+          end
+
+          or through an environment variable:
+
+          export YT_API_KEY="123456789012345678901234567890"
+
+          If your app needs to perform actions on behalf of YouTube accounts,
+          then generate a client ID and SECRET and set their values with the
+          initializer:
+
+          Yt.configure do |config|
+            config.client_id = '1234567890.apps.googleusercontent.com'
+            config.client_secret = '1234567890'
+          end
+
+          or through environment variables:
+
+          export YT_CLIENT_ID="1234567890.apps.googleusercontent.com"
+          export YT_CLIENT_SECRET="1234567890"
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/yt/errors/no_items.rb

@@ -1,16 +1,12 @@
-require 'yt/errors/base'
+require 'yt/errors/request_error'
 
 module Yt
   module Errors
-    class NoItems < Base
-      def message
-        <<-MSG.gsub(/^ {6}/, '')
-        A request to YouTube API V3 returned no items (but some were expected):
-        #{response_body}
+    class NoItems < RequestError
+      private
 
-        You can retry the same request manually by running:
-        #{request_curl}
-        MSG
+      def explanation
+        'A request to YouTube API returned no items but some were expected'
       end
     end
   end

data/lib/yt/errors/request_error.rb

@@ -0,0 +1,52 @@
+module Yt
+  module Errors
+    class RequestError < StandardError
+      def initialize(msg = nil)
+        @msg = msg
+        super msg
+      end
+
+      def message
+        <<-MSG.gsub(/^ {8}/, '')
+        #{explanation}:
+        #{response_body}
+
+        You can retry the same request manually by running:
+        #{request_curl}
+        #{more_details}
+        MSG
+      end
+
+      def kind
+        response_body.fetch 'error', {}
+      end
+
+      def reasons
+        kind.fetch('errors', []).map{|e| e['reason']}
+      end
+
+    private
+
+      def explanation
+        'A request to YouTube API failed'
+      end
+
+      def more_details
+      end
+
+      def response_body
+        json['response_body']
+      end
+
+      def request_curl
+        json['request_curl']
+      end
+
+      def json
+        @json ||= JSON(@msg) rescue {}
+      end
+    end
+  end
+
+  Error = Errors::RequestError
+end

data/lib/yt/models/account.rb

@@ -1,52 +1,25 @@
 require 'yt/models/base'
-require 'yt/config'
 
 module Yt
-  # Provides methods to access a YouTube account.
-  class Account < Base
-
-    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]
-
-    def initialize(options = {})
-      @access_token = options[:access_token]
-      @refresh_token = options[:refresh_token]
-      @redirect_url = options[:redirect_url]
-    end
-
-    def access_token
-      @access_token ||= refresh_access_token || get_access_token
-    end
-
-    def auth
-      self
-    end
-
-  private
-
-    # Obtain a new access token using the refresh token
-    def refresh_access_token
-      if @refresh_token
-        body = {grant_type: 'refresh_token', refresh_token: @refresh_token}
-        request = Request.new auth_params.deep_merge(body: body)
-        response = request.run
-        response.body['access_token']
+  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]
+
+      def initialize(options = {})
+        @access_token = options[:access_token]
+        @refresh_token = options[:refresh_token]
+        @expires_at = options[:expires_at]
+        @authorization_code = options[:authorization_code]
+        @redirect_uri = options[:redirect_uri]
+        @scopes = options[:scopes]
       end
-    end
 
-    def auth_params
-      {
-        host: 'accounts.google.com',
-        path: '/o/oauth2/token',
-        format: :json,
-        body_type: :form,
-        method: :post,
-        body: {
-          client_id: Yt.configuration.client_id,
-          client_secret: Yt.configuration.client_secret
-        }
-      }
+      def auth
+        self
+      end
     end
   end
 end