youtube-data 0.1.0 → 0.1.1

data/lib/youtube/thumbnail.rb

@@ -1,91 +1,102 @@
-# frozen_string_literal: true
-
-module Youtube
-
-  # Used for extracting thumbnails/ images data and bytes stored on `i.ytimg.com`.
-  #
-  # @param extractor [Youtube::DataExtractor] The extractor to use when getting initial required video data.
-  #
-  class Thumbnail
-    BASEHOST = URI('https://i.ytimg.com/')
-
-    def initialize(extractor)
-      @extractor = extractor
-
-      @session = Net::HTTP.start(BASEHOST.hostname, {'use_ssl': true})
-
-      @thumb_json_array = jump_to_in_json
-      @thumb_default_json = @thumb_json_array[0]
-    end
-
-    # An array of thumbnail(s) json data (stored as a hash).
-    #
-    # @return [Array] The array of hashes about the thumbnail(s).
-    # @yield [Array] The same as return, but yields to block if given.
-    #
-    def thumbnails_json
-      return @thumb_json_array unless block_given?
-      yield @thumb_json_array
-    end
-
-    # The json data for the default thumbnail (stored as a hash).
-    #
-    # @return [Hash] The hash form of the default thumbnail's json.
-    # @yield [Hash] The same as return, but yields to block if given.
-    #
-    def default_json
-      return @thumb_default_json unless block_given?
-      yield @thumb_default_json
-    end
-
-    # Destination URL to default thumbnail file on the server which is returned/ yielded as a `URI::HTTPS` instance.
-    def default_url
-      return URI(@thumb_default_json['url']) unless block_given?
-      yield URI(@thumb_default_json['url'])
-    end
-
-    # The file name for the default thumbnail which is returned/ yielded as `String` instance.
-    def default_filename
-      filename = default_url.path[/[A-Za-z0-9]+\.[A-Za-z0-9]+/]
-      return filename unless block_given?
-      yield filename
-    end
-
-    # The bytes contained in the default thumbnail file stored on the server returned/ yielded as `String` instance.
-    def default_bytes
-      res = get_raw(default_url.path)
-      return res.body unless block_given?
-      yield res.body
-    end
-
-    # Send a simple get request using the thumbnail session. This should be how the module sends all further requests
-    # to the `i.ytimg.com` hostname outside of this class also.
-    #
-    # @param path [String] Any valid path on the server, prefixed with `/`.
-    # @return [Net::HTTPResponse] The untouched response sent back from the request.
-    # @yield [Net::HTTPResponse] Same as return but yielded to block.
-    #
-    def get_raw(path)
-      res = get_request_path(path)
-      return res unless block_given?
-      yield res
-    end
-
-    # Use `get_raw` method it's the same, but is shorter and can yield.
-    private def get_request_path(path)
-      if path.class != "".class
-        raise InvalidPathError, 'Path on server must be type `String\''
-      end
-      if path.empty? == false and path[0] != "/"
-        raise InvalidPathError, 'Path must be prefixed with `/\''
-      end
-      return @session.get(path)
-    end
-
-    private def jump_to_in_json
-      return @extractor.video_json_untouched['microformat']['playerMicroformatRenderer']['thumbnail']['thumbnails']
-    end
-
-  end
-
-end
+# frozen_string_literal: true
+
+module Youtube
+
+  # Used for extracting thumbnails/ images data and bytes stored on `i.ytimg.com`.
+  #
+  # @param extractor [Youtube::DataExtractor] The extractor to use when getting initial required video data.
+  #
+  class Thumbnail
+    BASEHOST = URI('https://i.ytimg.com/')
+
+    def initialize(extractor, opts = {})
+      @extractor = extractor
+
+      # The session to use for the extractor allows information to persist during requests/session.
+      @session = Net::HTTP.start(BASEHOST.hostname, {'use_ssl': true})
+      if opts.include?(:mock_session)
+        @session = opts[:mock_session]
+      end
+
+      @thumb_json_array = Youtube::Video.new(@extractor).thumbnails
+      @thumb_default_json = @thumb_json_array[0]
+    end
+
+    def inspect
+      return itself
+    end
+
+    # An array of thumbnail(s) json data (stored as a hash).
+    #
+    # @return [Array] The array of hashes about the thumbnail(s).
+    # @yield [Array] The same as return, but yields to block if given.
+    #
+    def thumbnails_json
+      return @thumb_json_array unless block_given?
+      yield @thumb_json_array
+    end
+
+    # The json data for the default thumbnail (stored as a hash).
+    #
+    # @return [Hash] The hash form of the default thumbnail's json.
+    # @yield [Hash] The same as return, but yields to block if given.
+    #
+    def default_json
+      return @thumb_default_json unless block_given?
+      yield @thumb_default_json
+    end
+
+    # @return [URI::HTTPS] Destination of the default thumbnail file on the server.
+    def default_url
+      return URI(@thumb_default_json['url'])
+    end
+
+    # @return [String] Filename for the default thumbnail.
+    def default_filename
+      return default_url.path[/[A-Za-z0-9]+\.[A-Za-z0-9]+/]
+    end
+
+    # @return [String] The bytes from the default thumbnail file on the server. Sends one request.
+    def default_bytes
+      return get_raw(default_url.path).body
+    end
+
+    # Downloads default thumbnail to cwd with it's name from server unless a path/ file name is specified.
+    def download_default(file_path=nil)
+      download_thumbnail(default_bytes, if file_path.nil? then default_filename else file_path end)
+    end
+
+    # Send a simple get request using the thumbnail session. This should be how the module sends all further requests
+    # to the `i.ytimg.com` hostname outside of this class also.
+    #
+    # @param path [String] Any valid path on the server, prefixed with `/`.
+    # @return [Net::HTTPResponse] The untouched response sent back from the request.
+    # @yield [Net::HTTPResponse] Same as return but yielded to block.
+    #
+    def get_raw(path)
+      res = get_request_path(path)
+      return res unless block_given?
+      yield res
+    end
+
+    # Downloads thumbnail bytes (writes to file in byte mode).
+    private def download_thumbnail(bytes, file_path=nil)
+      File.open(file_path, 'wb') do |file_stream|
+        file_stream.write(bytes)
+      end
+    end
+
+    # Use `get_raw` method it's the same, but is shorter and can yield.
+    private def get_request_path(path)
+      if path.class != "".class
+        raise InvalidPathError, 'Path on server must be type `String\''
+      end
+      if path.empty? == false and path[0] != "/"
+        raise InvalidPathError, 'Path must be prefixed with `/\''
+      end
+      return @session.get(path)
+    end
+
+  end
+
+end

data/lib/youtube/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Youtube
-  VERSION = "0.1.0"
-end
+# frozen_string_literal: true
+
+module Youtube
+  VERSION = "0.1.1"
+end

data/lib/youtube/video.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Youtube
+
+  class Video
+
+    def initialize(extractor, opts = {})
+      @extractor = extractor
+    end
+
+    def inspect
+      return itself
+    end
+
+    # @return [Hash] The section of scraped json that contains video information just as is.
+    def json
+      @video_info_json = @extractor.video_json_untouched['videoDetails']
+      return @video_info_json unless block_given?
+      yield @video_info_json
+    end
+
+    # @return [Array] An array of different thumbnail image info hashes.
+    def thumbnails
+      return json['thumbnail']['thumbnails']
+    end
+
+    # @return [String] ID of the channel that owns the video.
+    def channel_id
+      return json['channelId']
+    end
+
+    # @return [String] ID of the video.
+    def id
+      return json['videoId']
+    end
+
+    # @return [String] The title of the video.
+    def title
+      return json['title']
+    end
+
+    # @return [String] The video description.
+    def description
+      return json['shortDescription']
+    end
+
+    # @return [Integer] Number of views that the video has.
+    def views
+      return json['viewCount'].to_i
+    end
+
+    # @return [String] The person who uploaded the video.
+    def author
+      return json['author']
+    end
+
+    # Same as `author` method.
+    def uploader
+      return author
+    end
+
+    # @return [Array] An array of keywords relating to the video.
+    def keywords
+      return json['keywords']
+    end
+
+    # @return [Integer] Length of the video in seconds.
+    def length_in_seconds
+      return json['lengthSeconds'].to_i
+    end
+
+    # @return [TrueClass, FalseClass] Whether or not the video is crawlable in the player.
+    def is_crawlable?
+      return json['isCrawlable']
+    end
+
+    # @return [TrueClass, FalseClass] Whether or not the video displays likes.
+    def allow_ratings?
+      return json['allowRatings']
+    end
+
+    # @return [TrueClass, FalseClass] Whether or not the video is a live stream.
+    def is_live?
+      return json['isLiveContent']
+    end
+
+  end
+
+end

data/lib/youtube-data.rb

@@ -1,13 +1,25 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'net/http'
-require 'json'
-
-require_relative 'youtube/version'
-require_relative 'youtube/extractor'
-require_relative 'youtube/thumbnail'
-
-module Youtube
-  class Error < StandardError; end
-end
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+require 'json'
+
+require_relative 'youtube/version'
+require_relative 'youtube/extractor'
+require_relative 'youtube/thumbnail'
+require_relative 'youtube/video'
+
+module Youtube
+
+  class InitExtractorError < RuntimeError
+  end
+
+  class InvalidVideoIDError < StandardError
+  end
+
+  class InvalidPathError < StandardError
+  end
+
+  class Error < StandardError; end
+
+end

data/sig/youtube.rbs

@@ -1,4 +1,4 @@
-module Youtube
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end
+module Youtube
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/tests/data/get_data

@@ -0,0 +1,12 @@
+#!/usr/bin/bash
+# Get the test html for mocked testing video id = FtutLA63Cp8.
+
+cur=$(basename $(pwd))
+
+if [ $cur != 'tests' ]
+then
+    echo 'This script must be run from within the `tests/` sub-directory.'
+    exit -1
+fi
+
+curl 'https://www.youtube.com/watch?v=FtutLA63Cp8' -o 'data/raw_video.html'

data/tests/mocks.rb

@@ -1,29 +1,29 @@
-require 'net/http/response'
-
-# Mock types for testing the `Youtube` module.
-module Mocks
-
-  class MockResponse < Net::HTTPResponse
-
-    def stream_check  # Avoid: `stream_check': undefined method `closed?' for nil:NilClass (NoMethodError)
-      return
-    end
-
-  end
-
-  class MockSession
-    def initialize(url)
-      @res = MockResponse.new(1.0, 200, "OK")
-    end
-
-    def set_res_body(content)
-      @res.read_body  # Update body content and set.
-      @res.body = content
-    end
-
-    def get(path)
-      return @res
-    end
-  end
-
-end
+require 'net/http/response'
+
+# Mock types for testing the `Youtube` module.
+module Mocks
+
+  class MockResponse < Net::HTTPResponse
+
+    def stream_check  # Avoid: `stream_check': undefined method `closed?' for nil:NilClass (NoMethodError)
+      return
+    end
+
+  end
+
+  class MockSession
+    def initialize(url)
+      @res = MockResponse.new(1.0, 200, "OK")
+    end
+
+    def set_res_body(content)
+      @res.read_body  # Update body content and set.
+      @res.body = content
+    end
+
+    def get(path)
+      return @res
+    end
+  end
+
+end

data/tests/test_all.rb

@@ -1,3 +1,10 @@
-require 'test/unit'
-
-require_relative 'test_extractor'
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require_relative 'test_extractor'
+require_relative 'test_thumbnail'
+require_relative 'test_video'
+
+#https://ruby-doc.org/stdlib-3.0.2/libdoc/test-unit/rdoc/Test/Unit/Assertions.html

data/tests/test_extractor.rb

@@ -1,32 +1,45 @@
-require 'test/unit'
-
-require_relative '../lib/youtube-data'
-require_relative 'mocks'
-
-
-#https://ruby-doc.org/stdlib-3.0.2/libdoc/test-unit/rdoc/Test/Unit/Assertions.html
-
-
-class TestExtractor < Test::Unit::TestCase
-  def setup
-    @mock_session = Mocks::MockSession.new(nil)
-    # Copy valid video html from file into the mock sessions `get` mock response which acts the same as normal session.
-    @mock_session.set_res_body(File.read('./data/raw_video.html'))
-    # Specify mock session to use and replace actual session with `opts[:mock_session]`.
-    @extractor = Youtube::DataExtractor.new('FtutLA63Cp8', {:mock_session => @mock_session})
-  end
-
-  def test_response_invalid_path
-    assert_raise(Youtube::InvalidPathError) do
-      @extractor.get_raw(nil)
-    end
-    assert_raise(Youtube::InvalidPathError) do
-      @extractor.get_raw("invalid/path")
-    end
-  end
-
-  def test_response_valid
-    res = @extractor.get_raw('/')
-    assert_instance_of(Mocks::MockResponse, res)
-  end
-end
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require_relative '../lib/youtube-data'
+require_relative 'mocks'
+
+
+class TestExtractor < Test::Unit::TestCase
+  def setup
+    @mock_session = Mocks::MockSession.new(nil)
+    # Copy valid video html from file into the mock sessions `get` mock response which acts the same as normal session.
+    @mock_session.set_res_body(File.read('./data/raw_video.html'))
+    # Specify mock session to use and replace actual session with `opts[:mock_session]`.
+    @extractor = Youtube::DataExtractor.new('FtutLA63Cp8', {:mock_session => @mock_session})
+  end
+
+  def test_video_uri
+    assert_equal(@extractor.video_uri, URI('https://www.youtube.com/watch?v=FtutLA63Cp8'))
+  end
+
+  def test_player_uri
+    assert_instance_of(URI::HTTPS, @extractor.player_uri)
+    assert_true(@extractor.player_uri.to_s.end_with?('base.js'))
+  end
+
+  def test_response_invalid_path
+    assert_raise(Youtube::InvalidPathError) do
+      @extractor.get_raw(nil)
+    end
+    assert_raise(Youtube::InvalidPathError) do
+      @extractor.get_raw("invalid/path")
+    end
+  end
+
+  def test_response_valid_mock_returned
+    res = @extractor.get_raw('/')
+    assert_instance_of(Mocks::MockResponse, res)
+  end
+
+  def test_not_raise_untouched_json_data
+    @extractor.video_json_untouched  # Valid json hash returned.
+  end
+
+end

data/tests/test_thumbnail.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require_relative '../lib/youtube-data'
+require_relative 'mocks'
+
+
+class TestThumbnail < Test::Unit::TestCase
+  def setup
+    @mock_session = Mocks::MockSession.new(nil)
+    # Copy valid video html from file into the mock sessions `get` mock response which acts the same as normal session.
+    @mock_session.set_res_body(File.read('./data/raw_video.html'))
+    # Specify mock session to use and replace actual session with `opts[:mock_session]`.
+    @extractor = Youtube::DataExtractor.new('FtutLA63Cp8', {:mock_session => @mock_session})
+    @thumbnail = Youtube::Thumbnail.new(@extractor, {:mock_session => @mock_session})
+  end
+
+  def test_response_invalid_path
+    assert_raise(Youtube::InvalidPathError) do
+      @thumbnail.get_raw(nil)
+    end
+    assert_raise(Youtube::InvalidPathError) do
+      @thumbnail.get_raw("invalid/path")
+    end
+  end
+
+  def test_response_valid_mock_returned
+    res = @thumbnail.get_raw('/')
+    assert_instance_of(Mocks::MockResponse, res)
+  end
+
+  def test_thumbnails_json
+    assert_instance_of(Array, @thumbnail.thumbnails_json)
+  end
+
+  def test_default_json
+    assert_instance_of(Hash, @thumbnail.default_json)
+  end
+
+end

data/tests/test_video.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require_relative '../lib/youtube-data'
+require_relative 'mocks'
+
+
+class TestVideo < Test::Unit::TestCase
+  def setup
+    @mock_session = Mocks::MockSession.new(nil)
+    # Copy valid video html from file into the mock sessions `get` mock response which acts the same as normal session.
+    @mock_session.set_res_body(File.read('./data/raw_video.html'))
+    # Specify mock session to use and replace actual session with `opts[:mock_session]`.
+    @extractor = Youtube::DataExtractor.new('FtutLA63Cp8', {:mock_session => @mock_session})
+    @video = Youtube::Video.new(@extractor)
+  end
+
+  def test_json
+    assert_instance_of(Hash, @video.json)
+  end
+
+  def test_thumbnails_array
+    assert_instance_of(Array, @video.thumbnails)
+    assert_instance_of(Hash, @video.thumbnails[0])
+  end
+
+  def test_channel_id
+    assert_equal(@video.channel_id, 'UCEJJbhF5Hod0zsupy-26n_g')
+  end
+
+  def test_id
+    assert_equal(@video.id, 'FtutLA63Cp8')
+  end
+
+  def test_title
+    assert_equal(@video.title, '【東方】Bad Apple!! ＰＶ【影絵】')
+  end
+
+  def test_description
+    assert_equal(@video.description, 'sm8628149')
+  end
+
+  def test_views
+    assert_instance_of(Integer, @video.views)
+  end
+
+  def test_author
+    assert_equal(@video.author, 'kasidid2')
+    assert_equal(@video.uploader, 'kasidid2')
+  end
+
+  def test_keywords
+    assert_instance_of(Array, @video.keywords)
+    assert_equal(@video.keywords.length, 6)
+  end
+
+  def test_length_in_seconds
+    assert_equal(@video.length_in_seconds, 219)
+  end
+
+  def test_is_crawlable
+    assert_true(@video.is_crawlable?)
+  end
+
+  def test_allow_ratings
+    assert_true(@video.allow_ratings?)
+  end
+
+  def test_is_live
+    assert_false(@video.is_live?)
+  end
+
+end