yt 0.5.4 → 0.5.5

data/lib/yt/models/annotation.rb

@@ -1,142 +1,144 @@
 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
+  module Models
+    # 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 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 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 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 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 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 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
+      # 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 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
+      # @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
+    private
 
-    def text
-      @text ||= @data.fetch 'TEXT', ''
-    end
+      def text
+        @text ||= @data.fetch 'TEXT', ''
+      end
 
-    def type
-      @type ||= @data.fetch 'type', ''
-    end
+      def type
+        @type ||= @data.fetch 'type', ''
+      end
 
-    def link_class
-      @link_class ||= url['link_class']
-    end
+      def link_class
+        @link_class ||= url['link_class']
+      end
 
-    def link_target
-      @link_target ||= url['target']
-    end
+      def link_target
+        @link_target ||= url['target']
+      end
 
-    def url
-      @url ||= action.fetch 'url', {}
-    end
+      def url
+        @url ||= action.fetch 'url', {}
+      end
 
-    def action
-      @action ||= @data.fetch 'action', {}
-    end
+      def action
+        @action ||= @data.fetch 'action', {}
+      end
 
-    def top
-      @top ||= positions.map{|pos| pos['y'].to_f}.max
-    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 bottom
+        @bottom ||= positions.map{|pos| pos['y'].to_f + pos['h'].to_f}.max
+      end
 
-    def timestamps
-      @timestamps ||= positions.map do |pos|
-        regex = %r{(?:|(?<hours>\d*):)(?:|(?<min>\d*):)(?<sec>\d*)\.(?<ms>\d*)}
-        match = pos['t'].match regex
-        hours = (match[:hours] || '0').to_i
-        minutes = (match[:min] || '0').to_i
-        seconds = (match[:sec]).to_i
-        (hours * 60 + minutes) * 60 + seconds
+      def timestamps
+        @timestamps ||= positions.map do |pos|
+          regex = %r{(?:|(?<hours>\d*):)(?:|(?<min>\d*):)(?<sec>\d*)\.(?<ms>\d*)}
+          match = pos['t'].match regex
+          hours = (match[:hours] || '0').to_i
+          minutes = (match[:min] || '0').to_i
+          seconds = (match[:sec]).to_i
+          (hours * 60 + minutes) * 60 + seconds
+        end
       end
-    end
 
-    def positions
-      @positions ||= region['rectRegion'] || region['anchoredRegion'] || []
-    end
+      def positions
+        @positions ||= region['rectRegion'] || region['anchoredRegion'] || []
+      end
 
-    def region
-      @region ||= segment.fetch 'movingRegion', {}
-    end
+      def region
+        @region ||= segment.fetch 'movingRegion', {}
+      end
 
-    def segment
-      @segment ||= (@data['segment'] || {})
+      def segment
+        @segment ||= (@data['segment'] || {})
+      end
     end
   end
 end

data/lib/yt/models/authentication.rb

@@ -0,0 +1,27 @@
+module Yt
+  module Models
+    class Authentication
+      attr_reader :access_token, :refresh_token, :expires_at
+
+      def initialize(data = {})
+        @access_token = data['access_token']
+        @refresh_token = data['refresh_token']
+        @expires_at = expiration_date data.slice('expires_at', 'expires_in')
+      end
+
+      def expired?
+        @expires_at && @expires_at.past?
+      end
+
+    private
+
+      def expiration_date(options = {})
+        if options['expires_in']
+          Time.now + options['expires_in'].seconds
+        else
+          Time.parse options['expires_at'] rescue nil
+        end
+      end
+    end
+  end
+end

data/lib/yt/models/base.rb

@@ -1,12 +1,16 @@
 require 'yt/associations'
 require 'yt/actions/delete'
 require 'yt/actions/update'
-require 'yt/errors/error'
+require 'yt/errors/request_error'
 
 module Yt
-  class Base
-    extend Associations
-    include Actions::Delete
-    include Actions::Update
+  module Models
+    class Base
+      extend Associations
+      include Actions::Delete
+      include Actions::Update
+    end
   end
+
+  include Models
 end

data/lib/yt/models/channel.rb

@@ -1,9 +1,11 @@
 require 'yt/models/resource'
 
 module Yt
-  class Channel < Resource
-    has_many :subscriptions
-    has_many :videos
-    has_many :playlists
+  module Models
+    class Channel < Resource
+      has_many :subscriptions
+      has_many :videos
+      has_many :playlists
+    end
   end
 end

data/lib/yt/models/configuration.rb

@@ -1,40 +1,32 @@
 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
+  module Models
+    # 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.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 :api_key, :client_id, :client_secret
 
-    def initialize
-      @scenario = set_scenario ENV['YT_CLIENT_SCENARIO']
-      @client_id = ENV['YT_CLIENT_ID']
-      @client_secret = ENV['YT_CLIENT_SECRET']
-      @api_key = ENV['YT_API_KEY']
-    end
-
-  private
-
-    def set_scenario(value)
-      valid_scenarios = [:web_app, :device_app, :server_app]
-      scenario = valid_scenarios.find{|scenario| scenario.to_s == value}
-      scenario || :web_app
+      def initialize
+        @client_id = ENV['YT_CLIENT_ID']
+        @client_secret = ENV['YT_CLIENT_SECRET']
+        @api_key = ENV['YT_API_KEY']
+      end
     end
   end
 end

data/lib/yt/models/description.rb

@@ -1,74 +1,76 @@
 require 'yt/models/url'
 
 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
+  module Models
+    # Provides read-only access to the description of a YouTube resource.
+    # Resources with descriptions are: videos and channels.
     #
     # @example
     #
-    # description = Yt::Description.new 'Link to video: youtube.com/watch?v=MESycYJytkU'
-    # description.has_link_to_video? #=> true
+    # 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
     #
-    # @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
-      links.any?{|link| link.kind == :video}
-    end
+    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
+        links.any?{|link| link.kind == :video}
+      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
-      links.any?{|link| link.kind == :channel}
-    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
+        links.any?{|link| link.kind == :channel}
+      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
-      links.any?{|link| link.kind == :subscription}
-    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
+        links.any?{|link| link.kind == :subscription}
+      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?
-      links.any?{|link| link.kind == :playlist}
-    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?
+        links.any?{|link| link.kind == :playlist}
+      end
 
-  private
+    private
 
-    def links
-      @links ||= self.split(' ').map{|word| URL.new word}
+      def links
+        @links ||= self.split(' ').map{|word| URL.new word}
+      end
     end
   end
 end

data/lib/yt/models/details_set.rb

@@ -1,34 +1,36 @@
 require 'yt/models/base'
 
 module Yt
-  class DetailsSet < Base
+  module Models
+    class DetailsSet < Base
 
-    def initialize(options = {})
-      @data = options[:data]
-    end
+      def initialize(options = {})
+        @data = options[:data]
+      end
 
-    # Return the duration of the YouTube video.
-    #
-    # @return [Integer] Duration in seconds of the YouTube video
-    def duration
-      @duration = to_seconds @data.fetch('duration', 0)
-    end
-    # also available: dimension, definition, caption, licensed_content?
+      # Return the duration of the YouTube video.
+      #
+      # @return [Integer] Duration in seconds of the YouTube video
+      def duration
+        @duration = to_seconds @data.fetch('duration', 0)
+      end
+      # also available: dimension, definition, caption, licensed_content?
 
-  private
+    private
 
-    # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S,
-    # in which the letters PT indicate that the value specifies a period of time, and
-    # the letters M and S refer to length in minutes and seconds, respectively. The #
-    # characters preceding the M and S letters are both integers that specify the number
-    # of minutes (or seconds) of the video. For example, a value of PT15M51S indicates
-    # that the video is 15 minutes and 51 seconds long.
-    def to_seconds(iso8601_duration)
-      match = iso8601_duration.match %r{^PT(?:|(?<hours>\d*?)H)(?:|(?<min>\d*?)M)(?:|(?<sec>\d*?)S)$}
-      hours = (match[:hours] || '0').to_i
-      minutes = (match[:min] || '0').to_i
-      seconds = (match[:sec]).to_i
-      (hours * 60 + minutes) * 60 + seconds
+      # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S,
+      # in which the letters PT indicate that the value specifies a period of time, and
+      # the letters M and S refer to length in minutes and seconds, respectively. The #
+      # characters preceding the M and S letters are both integers that specify the number
+      # of minutes (or seconds) of the video. For example, a value of PT15M51S indicates
+      # that the video is 15 minutes and 51 seconds long.
+      def to_seconds(iso8601_duration)
+        match = iso8601_duration.match %r{^PT(?:|(?<hours>\d*?)H)(?:|(?<min>\d*?)M)(?:|(?<sec>\d*?)S)$}
+        hours = (match[:hours] || '0').to_i
+        minutes = (match[:min] || '0').to_i
+        seconds = (match[:sec]).to_i
+        (hours * 60 + minutes) * 60 + seconds
+      end
     end
   end
 end

data/lib/yt/models/id.rb

@@ -1,4 +1,6 @@
 module Yt
-  class Id < String
+  module Models
+    class Id < String
+    end
   end
 end