yt 0.0.1 → 0.4.0

data/lib/yt/collections/user_infos.rb

@@ -0,0 +1,41 @@
+require 'yt/collections/base'
+require 'yt/models/user_info'
+
+module Yt
+  module Collections
+    class UserInfos < Base
+
+      def initialize(options = {})
+        @account = options[:account]
+        @auth = options[:auth]
+      end
+
+      def self.by_account(account)
+        new account: account, auth: account.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::UserInfo.new data: data
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:path] = '/oauth2/v2/userinfo'
+          # TODO: Remove youtube from here, implement incremental scopes
+          params[:scope] = 'https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile'
+        end
+      end
+
+      def next_page
+        request = Request.new list_params
+        response = request.run
+        raise unless response.is_a? Net::HTTPOK
+        @page_token = nil
+        
+        Array.wrap response.body
+      end
+    end
+  end
+end

data/lib/yt/collections/videos.rb

@@ -0,0 +1,32 @@
+require 'yt/collections/base'
+require 'yt/models/video'
+
+module Yt
+  module Collections
+    class Videos < Base
+
+      def initialize(options = {})
+        @channel = options[:channel]
+        @auth = options[:auth]
+      end
+
+      def self.by_channel(channel)
+        new channel: channel, auth: channel.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Video.new id: data['id']['videoId'], snippet: data['snippet'], auth: @auth
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {channelId: @channel.id, type: :video, maxResults: 50, part: 'snippet'}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube'
+          params[:path] = '/youtube/v3/search'
+        end
+      end
+    end
+  end
+end

data/lib/yt/config.rb

@@ -0,0 +1,55 @@
+require 'yt/models/configuration'
+
+module Yt
+  # Provides methods to read and write runtime configuration information.
+  #
+  # Configuration options are loaded from `~/.yt`, `.yt`, command line
+  # switches, and the `YT_OPTS` environment variable (listed in lowest to
+  # highest precedence).
+  #
+  # @note Config is the only module auto-loaded in the Yt module,
+  #       in order to have a syntax as easy as Yt.configure
+  #
+  # @example A server-to-server YouTube client app
+  #
+  #   Yt.configure do |config|
+  #     config.scenario = :server_app
+  #     config.api_key = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @example A web YouTube client app
+  #
+  #   Yt.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  module Config
+    # Yields the global configuration to a block.
+    # @yield [Yt::Configuration] global configuration
+    #
+    # @example
+    #   Yt.configure do |config|
+    #     config.scenario = :server_app
+    #     config.api_key = 'ABCDEFGHIJ1234567890'
+    #   end
+    # @see Yt::Configuration
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global [Configuration](Yt/Configuration) object. While you
+    # _can_ use this method to access the configuration, the more common
+    # convention is to use [Yt.configure](Yt#configure-class_method).
+    #
+    # @example
+    #     Yt.configuration.api_key = 'ABCDEFGHIJ1234567890'
+    # @see Yt.configure
+    # @see Yt::Configuration
+    def configuration
+      @configuration ||= Yt::Configuration.new
+    end
+  end
+
+  extend Config
+end

data/lib/yt/models/account.rb

@@ -0,0 +1,68 @@
+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 = {})
+      # By default is someone passes a refresh_token but not a scope, we can assume it's a youtube one
+      @scope = options.fetch :scope, 'https://www.googleapis.com/auth/youtube'
+      @access_token = options[:access_token]
+      @refresh_token = options[:refresh_token]
+      @redirect_url = options[:redirect_url]
+    end
+
+    def access_token_for(scope)
+      # TODO incremental scope
+
+      # HERE manage the fact that we must change some scope on device,
+      # like 'https://www.googleapis.com/auth/youtube.readonly' is not accepted
+      if Yt.configuration.scenario == :device_app && scope == 'https://www.googleapis.com/auth/youtube.readonly'
+        scope = 'https://www.googleapis.com/auth/youtube'
+      end
+
+      # TODO !! include? is not enough, because (for instance) 'youtube' also includes 'youtube.readonly'
+
+      # unless (@scope == scope) || (scope == 'https://www.googleapis.com/auth/youtube.readonly' && @scope =='https://www.googleapis.com/auth/youtube')
+      #   @scope = scope
+      #   @access_token = @refresh_token = nil
+      # end
+      @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']
+      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
+        }
+      }
+    end
+  end
+end

data/lib/yt/models/annotation.rb

@@ -0,0 +1,137 @@
+module Yt
+  # Provides methods to access and analyze a single YouTube annotation.
+  class Annotation
+    # Instantiate an Annotation object from its YouTube XML representation.
+    #
+    # @note There is no documented way to access annotations through API.
+    #       There is an endpoint that returns an XML in an undocumented format,
+    #       which is here parsed into a comprehensible set of attributes.
+    #
+    # @param [String] xml_data The YouTube XML representation of an annotation
+    def initialize(options = {})
+      @data = options[:data]
+    end
+
+    # Checks whether the entire annotation box remains above y
+    #
+    # @param [Integer] y Vertical position in the Youtube video (0 to 100)
+    #
+    # @return [Boolean] Whether the box remains above y
+    def above?(y)
+      top && top < y
+    end
+
+    # Checks whether the entire annotation box remains below y
+    #
+    # @param [Integer] y Vertical position in the Youtube video (0 to 100)
+    #
+    # @return [Boolean] Whether the box remains below y
+    def below?(y)
+      bottom && bottom > y
+    end
+
+    # Checks whether there is a link to subscribe.
+    # Should a branding watermark also counts, because it links to the channel?
+    #
+    # @return [Boolean] Whether there is a link to subscribe in the annotation
+    def has_link_to_subscribe?(options = {}) # TODO: options for which videos
+      link_class == '5'
+    end
+
+    # Checks whether there is a link to a video.
+    # An Invideo featured video also counts
+    #
+    # @return [Boolean] Whether there is a link to a video in the annotation
+    def has_link_to_video?(options = {}) # TODO: options for which videos
+      link_class == '1' || type == 'promotion'
+    end
+
+    # Checks whether there is a link to a playlist.
+    # A link to a video with the playlist in the URL also counts
+    #
+    # @return [Boolean] Whether there is a link to a playlist in the annotation
+    def has_link_to_playlist?
+      link_class == '2' || text.include?('&list=')
+    end
+
+    # Checks whether the link opens in the same window.
+    #
+    # @return [Boolean] Whether the link opens in the same window
+    def has_link_to_same_window?
+      link_target == 'current'
+    end
+
+    # Checks whether the annotation comes from InVideo Programming
+    #
+    # @return [Boolean] Whether the annotation comes from InVideo Programming
+    def has_invideo_programming?
+      type == 'promotion' || type == 'branding'
+    end
+
+    # @return [Boolean] Whether the annotation starts after the number of seconds
+    # @note This is broken for invideo programming, because they do not
+    # have the timestamp in the region, but in the "data" field
+    def starts_after?(seconds)
+      timestamps.first > seconds if timestamps.any?
+    end
+
+    # @return [Boolean] Whether the annotation starts before the number of seconds
+    # @note This is broken for invideo programming, because they do not
+    # have the timestamp in the region, but in the "data" field
+    def starts_before?(seconds)
+      timestamps.first < seconds if timestamps.any?
+    end
+
+  private
+
+    def text
+      @text ||= @data.fetch 'TEXT', ''
+    end
+
+    def type
+      @type ||= @data.fetch 'type', ''
+    end
+
+    def link_class
+      @link_class ||= url['link_class']
+    end
+
+    def link_target
+      @link_target ||= url['target']
+    end
+
+    def url
+      @url ||= action.fetch 'url', {}
+    end
+
+    def action
+      @action ||= @data.fetch 'action', {}
+    end
+
+    def top
+      @top ||= positions.map{|pos| pos['y'].to_f}.max
+    end
+
+    def bottom
+      @bottom ||= positions.map{|pos| pos['y'].to_f + pos['h'].to_f}.max
+    end
+
+    def timestamps
+      @timestamps ||= positions.map do |pos|
+        Time.parse(pos['t']) - Time.parse('0:00')
+      end
+    end
+
+    def positions
+      @positions ||= region['rectRegion'] || region['anchoredRegion'] || []
+    end
+
+    def region
+      @region ||= segment.fetch 'movingRegion', {}
+    end
+
+    def segment
+      @segment ||= (@data['segment'] || {})
+    end
+  end
+end

data/lib/yt/models/base.rb

@@ -0,0 +1,11 @@
+require 'yt/associations'
+require 'yt/actions/delete'
+require 'yt/actions/update'
+
+module Yt
+  class Base
+    extend Associations
+    include Actions::Delete
+    include Actions::Update
+  end
+end

data/lib/yt/models/channel.rb

@@ -0,0 +1,17 @@
+require 'yt/models/base'
+
+module Yt
+  class Channel < Base
+    attr_reader :id, :auth
+    has_one :snippet, delegate: [:title, :description, :thumbnail_url, :published_at]
+    has_many :subscriptions
+    has_many :videos
+    has_many :playlists
+
+    def initialize(options = {})
+      @id = options[:id]
+      @auth = options[:auth]
+      @snippet = Snippet.new(data: options[:snippet]) if options[:snippet]
+    end
+  end
+end

data/lib/yt/models/configuration.rb

@@ -0,0 +1,29 @@
+module Yt
+  # Stores runtime configuration information.
+  #
+  # Configuration options are loaded from `~/.yt`, `.yt`, command line
+  # switches, and the `YT_OPTS` environment variable (listed in lowest to
+  # highest precedence).
+  #
+  # @example A server-to-server YouTube client app
+  #
+  #   Yt.configure do |config|
+  #     config.scenario = :server_app
+  #     config.api_key = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @example A web YouTube client app
+  #
+  #   Yt.configure do |config|
+  #     config.client_id = 'ABCDEFGHIJ1234567890'
+  #     config.client_secret = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  class Configuration
+    attr_accessor :scenario, :api_key, :client_id, :client_secret, :account
+
+    def initialize
+      @scenario = :web_app
+    end
+  end
+end

data/lib/yt/models/description.rb

@@ -0,0 +1,98 @@
+module Yt
+  # Provides read-only access to the description of a YouTube resource.
+  # Resources with descriptions are: videos and channels.
+  #
+  # @example
+  #
+  # description = Yt::Description.new 'Fullscreen provides a suite of end-to-end YouTube tools and services to many of the world’s leading brands and media companies.'
+  # description.to_s.slice(0,19) # => 'Fullscreen provides'
+  # description.length # => 127
+  #
+  class Description < String
+    # Returns whether the description includes a YouTube video URL
+    #
+    # @example
+    #
+    # description = Yt::Description.new 'Link to video: youtube.com/watch?v=MESycYJytkU'
+    # description.has_link_to_video? #=> true
+    #
+    # @return [Boolean] Whether the description includes a link to a video
+    def has_link_to_video?
+      # TODO: might take as an option WHICH video to link to
+      # in order to check if it's my own video
+      regex? :video_long_url, :video_short_url
+    end
+
+    # Returns whether the description includes a YouTube channel URL
+    #
+    # @example
+    #
+    # description = Yt::Description.new Link to channel: youtube.com/fullscreen
+    # description.has_link_to_channel? #=> true
+    #
+    # @return [Boolean] Whether the description includes a link to a channel
+    def has_link_to_channel?(options = {}) # TODO: which channel
+      # TODO: might take as an option WHICH channel to link to
+      # in order to check if it's my own channel
+      regex? :channel_long_url, :channel_short_url, :channel_user_url
+    end
+
+    # Returns whether the description includes a YouTube subscription URL
+    #
+    # @example
+    #
+    # description = Yt::Description.new Link to subscribe: youtube.com/subscription_center?add_user=fullscreen
+    # description.has_link_to_subscribe? #=> true
+    #
+    # @return [Boolean] Whether the description includes a link to subscribe
+    def has_link_to_subscribe?(options = {}) # TODO: which channel
+      # TODO: might take as an option WHICH channel to subscribe to
+      # in order to check if it's my own channel
+      regex? :subscribe_center_url, :subscribe_widget_url, :subscribe_confirm_url
+    end
+
+    # Returns whether the description includes a YouTube playlist URL
+    #
+    # @example
+    #
+    # description = Yt::Description.new Link to playlist: youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow
+    # description.has_link_to_playlist? #=> true
+    #
+    # @return [Boolean] Whether the description includes a link to a playlist
+    def has_link_to_playlist?
+      regex? :playlist_long_url, :playlist_embed_url
+    end
+
+  private
+
+    def regex?(*keys)
+      keys.find{|key| self =~ regex_for(key)}
+    end
+
+    def regex_for(key)
+      host, name = '(?:https?://)?(?:www\.)?', '([a-zA-Z0-9_-]+)'
+      case key
+      when :video_long_url
+        %r{#{host}youtube\.com/watch\?v=#{name}}
+      when :video_short_url
+        %r{#{host}youtu\.be/#{name}}
+      when :channel_long_url
+        %r{#{host}youtube\.com/channel/#{name}}
+      when :channel_short_url
+        %r{#{host}youtube\.com/#{name}}
+      when :channel_user_url
+        %r{#{host}youtube\.com/user/#{name}}
+      when :subscribe_center_url
+        %r{#{host}youtube\.com/subscription_center\?add_user=#{name}}
+      when :subscribe_widget_url
+        %r{#{host}youtube\.com/subscribe_widget\?p=#{name}}
+      when :subscribe_confirm_url
+        %r{#{host}youtube\.com/channel/(?:[a-zA-Z0-9&_=-]*)\?sub_confirmation=1}
+      when :playlist_long_url
+        %r{#{host}youtube\.com/playlist\?list=#{name}}
+      when :playlist_embed_url
+        %r{#{host}youtube\.com/watch\?v=(?:[a-zA-Z0-9&_=-]*)&list=#{name}}
+      end
+    end
+  end
+end