yt 0.25.13 → 0.32.2

data/lib/yt/collections/ids.rb

@@ -1,27 +0,0 @@
-require 'yt/collections/base'
-require 'yt/models/id'
-
-module Yt
-  module Collections
-    # @private
-    class Ids < Base
-
-    private
-
-      def attributes_for_new_item(data)
-        data['id']
-      end
-
-      def list_params
-        super.tap do |params|
-          params[:params] = ids_params
-          params[:path] = "/youtube/v3/#{@parent.kind.pluralize}"
-        end
-      end
-
-      def ids_params
-        {for_username: @parent.username, part: 'id'}
-      end
-    end
-  end
-end

data/lib/yt/config.rb

@@ -1,54 +0,0 @@
-require 'yt/models/configuration'
-
-module Yt
-  # Provides methods to read and write global configuration settings.
-  #
-  # A typical usage is to set the API keys retrieved from the
-  # {http://console.developers.google.com Google Developers Console}.
-  #
-  # @example Set the API key for a server-only YouTube app:
-  #   Yt.configure do |config|
-  #     config.api_key = 'ABCDEFGHIJ1234567890'
-  #   end
-  #
-  # @example Set the API client id/secret for a web-client YouTube app:
-  #   Yt.configure do |config|
-  #     config.client_id = 'ABCDEFGHIJ1234567890'
-  #     config.client_secret = 'ABCDEFGHIJ1234567890'
-  #   end
-  #
-  # Note that Yt.configure has precedence over values through with
-  # environment variables (see {Yt::Models::Configuration}).
-  #
-  module Config
-    # Yields the global configuration to the given block.
-    #
-    # @example
-    #   Yt.configure do |config|
-    #     config.api_key = 'ABCDEFGHIJ1234567890'
-    #   end
-    #
-    # @yield [Yt::Models::Configuration] The global configuration.
-    def configure
-      yield configuration if block_given?
-    end
-
-    # Returns the global {Yt::Models::Configuration} object.
-    #
-    # While this method _can_ be used to read and write configuration settings,
-    # it is easier to use {Yt::Config#configure} Yt.configure}.
-    #
-    # @example
-    #     Yt.configuration.api_key = 'ABCDEFGHIJ1234567890'
-    #
-    # @return [Yt::Models::Configuration] The global configuration.
-    def configuration
-      @configuration ||= Yt::Configuration.new
-    end
-  end
-
-  # @note Config is the only module auto-loaded in the Yt module,
-  #       in order to have a syntax as easy as Yt.configure
-
-  extend Config
-end

data/lib/yt/models/configuration.rb

@@ -1,70 +0,0 @@
-module Yt
-  module Models
-    # Provides an object to store global configuration settings.
-    #
-    # This class is typically not used directly, but by calling
-    # {Yt::Config#configure Yt.configure}, which creates and updates a single
-    # instance of {Yt::Models::Configuration}.
-    #
-    # @example Set the API client id/secret for a web-client YouTube app:
-    #   Yt.configure do |config|
-    #     config.client_id = 'ABCDEFGHIJ1234567890'
-    #     config.client_secret = 'ABCDEFGHIJ1234567890'
-    #   end
-    #
-    # @see Yt::Config for more examples.
-    #
-    # An alternative way to set global configuration settings is by storing
-    # them in the following environment variables:
-    #
-    # * +YT_CLIENT_ID+ to store the Client ID for web/device apps
-    # * +YT_CLIENT_SECRET+ to store the Client Secret for web/device apps
-    # * +YT_API_KEY+ to store the API key for server/browser apps
-    # * +YT_LOG_LEVEL+ to store the verbosity level of the logs
-    #
-    # In case both methods are used together,
-    # {Yt::Config#configure Yt.configure} takes precedence.
-    #
-    # @example Set the API client id/secret for a web-client YouTube app:
-    #   ENV['YT_CLIENT_ID'] = 'ABCDEFGHIJ1234567890'
-    #   ENV['YT_CLIENT_SECRET'] = 'ABCDEFGHIJ1234567890'
-    #
-    class Configuration
-      # @return [String] the Client ID for web/device YouTube applications.
-      # @see https://console.developers.google.com Google Developers Console
-      attr_accessor :client_id
-
-      # @return [String] the Client Secret for web/device YouTube applications.
-      # @see https://console.developers.google.com Google Developers Console
-      attr_accessor :client_secret
-
-      # @return [String] the API key for server/browser YouTube applications.
-      # @see https://console.developers.google.com Google Developers Console
-      attr_accessor :api_key
-
-      # @return [String] the level of output to print for debugging purposes.
-      attr_accessor :log_level
-
-      # Initialize the global configuration settings, using the values of
-      # the specified following environment variables by default.
-      def initialize
-        @client_id = ENV['YT_CLIENT_ID']
-        @client_secret = ENV['YT_CLIENT_SECRET']
-        @api_key = ENV['YT_API_KEY']
-        @log_level = ENV['YT_LOG_LEVEL']
-      end
-
-      # @return [Boolean] whether the logging output is extra-verbose.
-      #   Useful when developing (e.g., to print the curl of every request).
-      def developing?
-        log_level.to_s.in? %w(devel)
-      end
-
-      # @return [Boolean] whether the logging output is verbose.
-      #   Useful when debugging (e.g., to print the curl of failing requests).
-      def debugging?
-        log_level.to_s.in? %w(devel debug)
-      end
-    end
-  end
-end

data/lib/yt/models/description.rb

@@ -1,58 +0,0 @@
-require 'yt/models/url'
-
-module Yt
-  module Models
-    # Encapsulates information about the description of a resource, for
-    # instance a channel.
-    # @see https://developers.google.com/youtube/v3/docs/channels#resource
-    #
-    # The value has a maximum length of 1000 characters.
-    class Description < String
-      # @return [Boolean] whether the description includes a link to a video
-      # @example
-      #   description = Yt::Models::Description.new 'Link to video: youtube.com/watch?v=MESycYJytkU'
-      #   description.has_link_to_video? #=> true
-      #
-      # @todo add an option to match the link to a specific video
-      def has_link_to_video?
-        links.any?{|link| link.kind == :video}
-      end
-
-      # @return [Boolean] whether the description includes a link to a channel
-      # @example
-      #   description = Yt::Description.new 'Link to channel: youtube.com/fullscreen'
-      #   description.has_link_to_channel? #=> true
-      #
-      # @todo add an option to match the link to a specific channel
-      def has_link_to_channel?(options = {})
-        links.any?{|link| link.kind == :channel}
-      end
-
-      # @return [Boolean] whether the description includes a link to subscribe
-      # @example
-      #   description = Yt::Description.new 'Link to subscribe: youtube.com/subscription_center?add_user=fullscreen'
-      #   description.has_link_to_subscribe? #=> true
-      #
-      # @todo add an option to match the link to subscribe to a specific channel
-      def has_link_to_subscribe?(options = {})
-        links.any?{|link| link.kind == :subscription}
-      end
-
-      # @return [Boolean] whether the description includes a link to a playlist
-      # @example
-      #   description = Yt::Description.new 'Link to playlist: youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow'
-      #   description.has_link_to_playlist? #=> true
-      #
-      # @todo add an option to match the link to a specific playlist
-      def has_link_to_playlist?
-        links.any?{|link| link.kind == :playlist}
-      end
-
-    private
-
-      def links
-        @links ||= self.split(' ').map{|word| URL.new word}
-      end
-    end
-  end
-end

data/lib/yt/models/url.rb

@@ -1,91 +0,0 @@
-module Yt
-  module Models
-    # @private
-    class URL
-      attr_reader :kind
-
-      def initialize(url)
-        @url = url
-        @kind ||= parse url
-        @match_data ||= {}
-      end
-
-      def id
-        @match_data[:id]
-      rescue IndexError
-      end
-
-      def username
-        @match_data[:username]
-      rescue IndexError
-      end
-
-    private
-
-      def parse(url)
-        matching_pattern = patterns.find do |pattern|
-          @match_data = url.match pattern[:regex]
-        end
-        matching_pattern[:kind] if matching_pattern
-      end
-
-      def patterns
-        # @note: :channel *must* be the last since one of its regex eats the
-        # remaining patterns. In short, don't change the following order
-
-        @patterns ||= patterns_for :playlist, :subscription, :video, :channel
-      end
-
-      def patterns_for(*kinds)
-        prefix = '^(?:https?://)?(?:www\.)?'
-        suffix = '(?:|/)'
-        kinds.map do |kind|
-          patterns = send "#{kind}_patterns" # meta programming :/
-          patterns.map do |pattern|
-            {kind: kind, regex: %r{#{prefix}#{pattern}#{suffix}}}
-          end
-        end.flatten
-      end
-
-      def subscription_patterns
-        name = '(?:[a-zA-Z0-9&_=-]*)'
-
-        %W{
-          subscription_center\\?add_user=#{name}
-          subscribe_widget\\?p=#{name}
-          channel/#{name}\\?sub_confirmation=1
-        }.map{|path| "youtube\\.com/#{path}"}
-      end
-
-      def playlist_patterns
-        playlist_id = '(?<id>[a-zA-Z0-9_-]+)'
-
-        %W{
-          playlist\\?list=#{playlist_id}
-        }.map{|path| "youtube\\.com/#{path}"}
-      end
-
-      def video_patterns
-        video_id = '(?<id>[a-zA-Z0-9_-]+)'
-
-        %W{
-          youtube\\.com/watch\\?v=#{video_id}
-          youtu\\.be/#{video_id}
-          youtube\\.com/embed/#{video_id}
-          youtube\\.com/v/#{video_id}
-        }
-      end
-
-      def channel_patterns
-        channel_id = '(?<id>[a-zA-Z0-9_-]+)'
-        username = '(?<username>[a-zA-Z0-9_-]+)'
-
-        %W{
-          channel/#{channel_id}
-          user/#{username}
-          #{username}
-        }.map{|path| "youtube\\.com/#{path}"}
-      end
-    end
-  end
-end

data/spec/models/configuration_spec.rb

@@ -1,44 +0,0 @@
-require 'spec_helper'
-
-describe Yt::Configuration do
-  subject(:config) { Yt::Configuration.new }
-
-  describe '#client_id' do
-    context 'without an environment variable YT_CLIENT_ID' do
-      before { ENV['YT_CLIENT_ID'] = nil }
-      it {expect(config.client_id).to be_nil }
-    end
-
-    context 'given an environment variable YT_CLIENT_ID' do
-      let(:client_id) { '1234567890.apps.googleusercontent.com' }
-      before { ENV['YT_CLIENT_ID'] = client_id}
-      it {expect(config.client_id).to eq client_id }
-    end
-  end
-
-  describe '#client_secret' do
-    context 'without an environment variable YT_CLIENT_SECRET' do
-      before { ENV['YT_CLIENT_SECRET'] = nil }
-      it {expect(config.client_secret).to be_nil }
-    end
-
-    context 'given an environment variable YT_CLIENT_SECRET' do
-      let(:client_secret) { '1234567890' }
-      before { ENV['YT_CLIENT_SECRET'] = client_secret}
-      it {expect(config.client_secret).to eq client_secret }
-    end
-  end
-
-  describe '#api_key' do
-    context 'without an environment variable YT_API_KEY' do
-      before { ENV['YT_API_KEY'] = nil }
-      it {expect(config.api_key).to be_nil }
-    end
-
-    context 'given an environment variable YT_API_KEY' do
-      let(:api_key) { '123456789012345678901234567890' }
-      before { ENV['YT_API_KEY'] = api_key}
-      it {expect(config.api_key).to eq api_key }
-    end
-  end
-end

data/spec/models/description_spec.rb

@@ -1,94 +0,0 @@
-require 'spec_helper'
-require 'yt/models/description'
-
-describe Yt::Description do
-  subject(:description) { Yt::Description.new text }
-
-  describe '#text' do
-    let(:text) { 'this is a description' }
-    it { expect(description).to eq 'this is a description' }
-  end
-
-  describe '#length' do
-    let(:text) { 'twenty one characters' }
-    it { expect(description.length).to eq 21 }
-  end
-
-  describe '#has_link_to_video?' do
-    context 'without a video URL' do
-      let(:text) { 'Link to channel: youtube.com/fullscreen' }
-      it { expect(description).not_to have_link_to_video }
-    end
-
-    context 'with a video long URL' do
-      let(:text) { 'example.com and Link to video: youtube.com/watch?v=MESycYJytkU' }
-      it { expect(description).to have_link_to_video }
-    end
-
-    context 'with a video short URL' do
-      let(:text) { 'Link to video: youtu.be/MESycYJytkU' }
-      it { expect(description).to have_link_to_video }
-    end
-
-    context 'with a playlist-embedded video URL' do
-      let(:text) { 'Link to video in playlist: youtube.com/watch?v=MESycYJytkU&index=619&list=LLxO1tY8h1AhOz0T4ENwmpow' }
-      it { expect(description).to have_link_to_video }
-    end
-  end
-
-  describe '#has_link_to_channel?' do
-    context 'without a channel URL' do
-      let(:text) { 'youtu.be/MESycYJytkU is a video link' }
-      it { expect(description).not_to have_link_to_channel }
-    end
-
-    context 'with a channel long URL' do
-      let(:text) { 'Link to channel: youtube.com/channel/UCxO1tY8h1AhOz0T4ENwmpow' }
-      it { expect(description).to have_link_to_channel }
-    end
-
-    context 'with a channel short URL' do
-      let(:text) { 'Link to channel: youtube.com/fullscreen' }
-      it { expect(description).to have_link_to_channel }
-    end
-
-    context 'with a channel user URL' do
-      let(:text) { 'Link to channel: youtube.com/user/fullscreen' }
-      it { expect(description).to have_link_to_channel }
-    end
-  end
-
-  describe '#has_link_to_subscribe?' do
-    context 'without a subscribe URL' do
-      let(:text) { 'Link to video: youtu.be/MESycYJytkU' }
-      it { expect(description).not_to have_link_to_subscribe }
-    end
-
-    context 'with a subscribe center URL' do
-      let(:text) { 'Link to subscribe: youtube.com/subscription_center?add_user=fullscreen' }
-      it { expect(description).to have_link_to_subscribe }
-    end
-
-    context 'with a subscribe short URL' do
-      let(:text) { 'Link to subscribe: youtube.com/subscribe_widget?p=fullscreen' }
-      it { expect(description).to have_link_to_subscribe }
-    end
-
-    context 'with a subscribe confirm URL' do
-      let(:text) { 'Link to subscribe: youtube.com/channel/UCxO1tY8h1AhOz0T4ENwmpow?sub_confirmation=1' }
-      it { expect(description).to have_link_to_subscribe }
-    end
-  end
-
-  describe '#has_link_to_playlist?' do
-    context 'without a playlist URL' do
-      let(:text) { 'Link to video: youtu.be/MESycYJytkU' }
-      it { expect(description).not_to have_link_to_playlist }
-    end
-
-    context 'with a playlist long URL' do
-      let(:text) { 'Link to playlist: youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow' }
-      it { expect(description).to have_link_to_playlist }
-    end
-  end
-end

data/spec/models/url_spec.rb

@@ -1,84 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'yt/models/url'
-
-describe Yt::URL do
-  subject(:url) { Yt::URL.new text }
-
-  context 'given a long video URL' do
-    let(:text) { 'youtube.com/watch?v=MESycYJytkU' }
-    it {expect(url.kind).to eq :video }
-    it {expect(url.id).to eq 'MESycYJytkU' }
-    it {expect(url.username).to be_nil }
-  end
-
-  context 'given a short video URL' do
-    let(:text) { 'https://youtu.be/MESycYJytkU' }
-    it {expect(url.kind).to eq :video }
-    it {expect(url.id).to eq 'MESycYJytkU' }
-  end
-
-  context 'given an embed video URL' do
-    let(:text) { 'https://www.youtube.com/embed/MESycYJytkU' }
-    it {expect(url.kind).to eq :video }
-    it {expect(url.id).to eq 'MESycYJytkU' }
-  end
-
-  context 'given a v video URL' do
-    let(:text) { 'https://www.youtube.com/v/MESycYJytkU' }
-    it {expect(url.kind).to eq :video }
-    it {expect(url.id).to eq 'MESycYJytkU' }
-  end
-
-  context 'given a playlist-embedded video URL' do
-    let(:text) { 'youtube.com/watch?v=MESycYJytkU&list=LLxO1tY8h1AhOz0T4ENwmpow' }
-    it {expect(url.kind).to eq :video }
-    it {expect(url.id).to eq 'MESycYJytkU' }
-  end
-
-  context 'given a long channel URL' do
-    let(:text) { 'http://youtube.com/channel/UCxO1tY8h1AhOz0T4ENwmpow' }
-    it {expect(url.kind).to eq :channel }
-    it {expect(url.id).to eq 'UCxO1tY8h1AhOz0T4ENwmpow' }
-  end
-
-  context 'given a short channel URL' do
-    let(:text) { 'https://www.youtube.com/Fullscreen' }
-    it {expect(url.kind).to eq :channel }
-    it {expect(url.username).to eq 'Fullscreen' }
-    it {expect(url.id).to be_nil }
-  end
-
-  context 'given a user’s channel URL' do
-    let(:text) { 'https://www.youtube.com/user/Fullscreen' }
-    it {expect(url.kind).to eq :channel }
-    it {expect(url.username).to eq 'Fullscreen' }
-  end
-
-  context 'given a subscription center URL' do
-    let(:text) { 'youtube.com/subscription_center?add_user=Fullscreen' }
-    it {expect(url.kind).to eq :subscription }
-  end
-
-  context 'given a subscription widget URL' do
-    let(:text) { 'youtube.com/subscribe_widget?p=Fullscreen' }
-    it {expect(url.kind).to eq :subscription }
-  end
-
-  context 'given a subscription confirmation URL' do
-    let(:text) { 'youtube.com/channel/UCxO1tY8h1AhOz0T4ENwmpow?sub_confirmation=1' }
-    it {expect(url.kind).to eq :subscription }
-  end
-
-  context 'given a long playlist URL' do
-    let(:text) { 'youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow' }
-    it {expect(url.kind).to eq :playlist }
-    it {expect(url.id).to eq 'LLxO1tY8h1AhOz0T4ENwmpow' }
-  end
-
-  context 'given a valid URL with a trailing slash' do
-    let(:text) { 'https://www.youtube.com/user/Fullscreen/' }
-    it {expect(url.kind).to eq :channel }
-  end
-end