Class: Yt::Models::URL

Inherits:
Object
  • Object
show all
Defined in:
lib/yt/models/url.rb

Overview

Provides methods to identify YouTube resources from names or URLs.

Examples:

Identify a YouTube video from its short URL:

url = Yt::URL.new 'youtu.be/kawaiiguy'
url.id # => 'UC4lU5YG9QDgs0X2jdnt7cdQ'
url.resource # => #<Yt::Channel @id=UC4lU5YG9QDgs0X2jdnt7cdQ>

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(text) ⇒ URL

Returns a new instance of URL.

Parameters:

  • text (String)

    the name or URL of a YouTube resource (in any form).


15
16
17
# File 'lib/yt/models/url.rb', line 15

def initialize(text)
  @text = text.to_s.strip
end

Instance Method Details

#id<String, nil>

Returns the ID of the YouTube resource matching the URL.

Returns:

  • (<String, nil>)

    the ID of the YouTube resource matching the URL.


26
27
28
# File 'lib/yt/models/url.rb', line 26

def id
  Resource.new(url: @text).id
end

#kindSymbol

Possible values are: :playlist, :video, :channel, and +:unknown:.

Returns:

  • (Symbol)

    the kind of YouTube resource matching the URL.


21
22
23
# File 'lib/yt/models/url.rb', line 21

def kind
  Resource.new(url: @text).kind.to_sym
end

#resource(options = {}) ⇒ <Yt::Channel>

Returns the resource associated with the URL.

Returns:

  • (<Yt::Channel>)

    the resource associated with the URL


31
32
33
34
35
36
37
38
# File 'lib/yt/models/url.rb', line 31

def resource(options = {})
  @resource ||= case kind
    when :channel then Yt::Channel
    when :video then Yt::Video
    when :playlist then Yt::Playlist
    else raise Yt::Errors::NoItems
  end.new options.merge(id: id)
end