YPBT 0.2.5 → 0.2.11

data/lib/YPBT/runner.rb

@@ -1,37 +1,38 @@
-# frozen_string_literal: true
-
-module YoutubeVideo
-  # Executable code for file(s) in bin/ folder
-  class Runner
-    def self.run!(args)
-      video_id = args[0] || ENV['YT_VIDEO_ID']
-      unless video_id
-        puts 'USAGE: YPBT [video_id]'
-        exit(1)
-      end
-
-      video = YoutubeVideo::Video.find(video_id: video_id)
-
-      output_info(video)
-    end
-
-    def self.output_info(video)
-      title = video.title
-      separator = Array.new(video.title.length) { '-' }.join
-      video_info =
-        video.comments.map.with_index do |comment, index|
-          comment_info(comment, index)
-        end.join
-
-      [title, separator, video_info].join("\n")
-    end
-
-    def self.comment_info(comment, index)
-      "#{index + 1}:\n"\
-      "  Author: #{comment.author.author_name}\n"\
-      "  Comment: #{comment.text_display}\n"\
-      "  LIKE: #{comment.author.like_count}\n"\
-      "  AuthorChannelUrl: #{comment.author.author_channel_url}\n"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module YoutubeVideo
+  # Executable code for file(s) in bin/ folder
+  class Runner
+    def self.run!(args)
+      video_id = args[0] || ENV['YT_VIDEO_ID']
+      unless video_id
+        puts 'USAGE: YPBT [video_id]'
+        exit(1)
+      end
+
+      video = YoutubeVideo::Video.find(video_id: video_id)
+
+      output_info(video)
+    end
+
+    def self.output_info(video)
+      return 'Nothing found. (Invalid video id or api-key)' if video.nil?
+      title = video.title
+      separator = Array.new(video.title.length) { '-' }.join
+      video_info =
+        video.comments.map.with_index do |comment, index|
+          comment_info(comment, index)
+        end.join
+
+      [title, separator, video_info].join("\n")
+    end
+
+    def self.comment_info(comment, index)
+      "#{index + 1}:\n"\
+      "  Author: #{comment.author.author_name}\n"\
+      "  Comment: #{comment.text_display}\n"\
+      "  LIKE: #{comment.author.like_count}\n"\
+      "  AuthorChannelUrl: #{comment.author.author_channel_url}\n"
+    end
+  end
+end

data/lib/YPBT/time_tag.rb

@@ -1,55 +1,55 @@
-require 'ruby-duration'
-
-module YoutubeVideo
-  TAG_TYPES = { MUSIC: 'music', VIDEO: 'video' }.freeze
-  # comment's time tag infomation
-  class Timetag
-    attr_reader :start_time, :end_time, :tag_type, :duration, :comment,
-                :like_count
-    def initialize(start_time:, comment:, end_time: nil, like_count: nil,
-                   tag_type: nil)
-      @start_time = string_to_time start_time
-      @end_time = end_time
-      @like_count = like_count ? like_count : comment.like_count
-      @tag_type = tag_type
-    end
-
-    def start_time
-      @start_time&.iso8601
-    end
-
-    def end_time=(end_time)
-      @end_time = string_to_time end_time if end_time
-    end
-
-    def end_time
-      @end_time&.iso8601 if @end_time
-    end
-
-    def duration
-      @duration = @end_time - @start_time if @end_time && @start_time
-      @duration&.iso8601 if @duration
-    end
-
-    def tag_type=(tag_type)
-      @tag_type = TAG_TYPES[tag_type.to_sym] if tag_type
-    end
-
-    def self.find(comment:)
-      time_tag_pattern = /http.+?youtube.+?\?.+?t=.+?\>([0-9:]+)<\/a>/
-      start_times_string = comment.text_display.scan time_tag_pattern
-      tags = start_times_string.map do |match_parts|
-        Timetag.new(start_time: match_parts[0], comment: comment)
-      end
-      tags
-    end
-
-    private
-
-    def string_to_time(time_string)
-      time_unit = [:seconds, :minutes, :hours, :day, :weeks]
-      time_array = time_string.scan(/[0-9]+/).map(&:to_i).reverse
-      Duration.new(Hash[time_unit.zip(time_array)])
-    end
-  end
-end
+require 'ruby-duration'
+
+module YoutubeVideo
+  TAG_TYPES = { MUSIC: 'music', VIDEO: 'video' }.freeze
+  # comment's time tag infomation
+  class Timetag
+    attr_reader :start_time, :end_time, :tag_type, :duration, :comment,
+                :like_count
+    def initialize(start_time:, comment:, end_time: nil, like_count: nil,
+                   tag_type: nil)
+      @start_time = string_to_time start_time
+      @end_time = end_time
+      @like_count = like_count ? like_count : comment.like_count
+      @tag_type = tag_type
+    end
+
+    def start_time
+      @start_time&.iso8601
+    end
+
+    def end_time=(end_time)
+      @end_time = string_to_time end_time if end_time
+    end
+
+    def end_time
+      @end_time&.iso8601 if @end_time
+    end
+
+    def duration
+      @duration = @end_time - @start_time if @end_time && @start_time
+      @duration&.iso8601 if @duration
+    end
+
+    def tag_type=(tag_type)
+      @tag_type = TAG_TYPES[tag_type.to_sym] if tag_type
+    end
+
+    def self.find(comment:)
+      time_tag_pattern = /http.+?youtube.+?\?.+?t=.+?\>([0-9:]+)<\/a>/
+      start_times_string = comment.text_display.scan time_tag_pattern
+      tags = start_times_string.map do |match_parts|
+        Timetag.new(start_time: match_parts[0], comment: comment)
+      end
+      tags
+    end
+
+    private
+
+    def string_to_time(time_string)
+      time_unit = [:seconds, :minutes, :hours, :day, :weeks]
+      time_array = time_string.scan(/[0-9]+/).map(&:to_i).reverse
+      Duration.new(Hash[time_unit.zip(time_array)])
+    end
+  end
+end

data/lib/YPBT/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module YoutubeVideo
-  VERSION = '0.2.5'
-end
+# frozen_string_literal: true
+
+module YoutubeVideo
+  VERSION = '0.2.11'
+end

data/lib/YPBT/video.rb

@@ -1,63 +1,73 @@
-# frozen_string_literal: true
-require_relative 'comment'
-require_relative 'youtube_api'
-
-module YoutubeVideo
-  # Main class to setup a Video
-  class Video
-    attr_reader :title, :description, :dislike_count, :like_count,
-                :comment_count, :view_count, :duration, :id, :channel_id
-
-    def initialize(data:)
-      @id = data['id']
-      @title = data['snippet']['title']
-      @channel_id = data['snippet']['channelId']
-      @description = data['snippet']['description']
-      @dislike_count = data['statistics']['dislikeCount'].to_i
-      @like_count = data['statistics']['likeCount'].to_i
-      @view_count = data['statistics']['viewCount'].to_i
-      @duration = data['contentDetails']['duration']
-    end
-
-    def comments
-      # contain only the comments which have time tag.
-      return @comments if @comments
-      raw_comments = YtApi.time_tags_info(@id)
-      @comments = raw_comments.map { |comment| Comment.new(data: comment) }
-    end
-
-    def channel_title
-      load_channel_info unless @channel_title
-      @channel_title
-    end
-
-    def channel_image_url
-      load_channel_info unless @channel_image_url
-      @channel_image_url
-    end
-
-    def channel_description
-      load_channel_info unless @channel_description
-      @channel_description
-    end
-
-    def embed_url
-      return @embed_url if @embed_url
-      @embed_url = "https://www.youtube.com/embed/#{@id}"
-    end
-
-    def self.find(video_id:)
-      video_data = YtApi.video_info(video_id)
-      new(data: video_data) if video_data
-    end
-
-    private
-
-    def load_channel_info
-      channel_data = YtApi.channel_info @channel_id
-      @channel_title = channel_data['title']
-      @channel_image_url = channel_data['image_url']
-      @channel_description = channel_data['description']
-    end
-  end
-end
+# frozen_string_literal: true
+require_relative 'comment'
+require_relative 'youtube_api'
+
+module YoutubeVideo
+  # Main class to setup a Video
+  class Video
+    attr_reader :title, :description, :dislike_count, :like_count,
+                :comment_count, :view_count, :duration, :id, :channel_id,
+                :thumbnail_url, :category_id
+
+    def initialize(data:)
+      @id = data['id']
+      @title = data['snippet']['title']
+      @channel_id = data['snippet']['channelId']
+      @description = data['snippet']['description']
+      @category_id = data['snippet']['categoryId']
+      @thumbnail_url = data['snippet']['thumbnails']['medium']['url']
+      @dislike_count = data['statistics']['dislikeCount'].to_i
+      @like_count = data['statistics']['likeCount'].to_i
+      @view_count = data['statistics']['viewCount'].to_i
+      @duration = data['contentDetails']['duration']
+      @is_channel = false
+    end
+
+    def comments
+      # contain only the comments which have time tag.
+      return @comments if @comments
+      raw_comments = YtApi.time_tags_info(@id)
+      @comments = raw_comments.map { |comment| Comment.new(data: comment) }
+    end
+
+    def channel_title
+      load_channel_info unless @is_channel
+      @channel_title
+    end
+
+    def channel_image_url
+      load_channel_info unless @is_channel
+      @channel_image_url
+    end
+
+    def channel_description
+      load_channel_info unless @is_channel
+      @channel_description
+    end
+
+    def embed_url
+      return @embed_url if @embed_url
+      @embed_url = "https://www.youtube.com/embed/#{@id}"
+    end
+
+    def self.find(video_id:)
+      video_data = YtApi.video_info(video_id)
+      new(data: video_data) if video_data
+    end
+
+    def self.find_popular(max_results: 25)
+      videos_data = YtApi.popular_videos_info(max_results)
+      videos_data.map { |data| new(data: data) } unless videos_data.empty?
+    end
+
+    private
+
+    def load_channel_info
+      channel_data = YtApi.channel_info @channel_id
+      @channel_title = channel_data['title'] if channel_data
+      @channel_image_url = channel_data['image_url'] if channel_data
+      @channel_description = channel_data['description'] if channel_data
+      @is_channel = true
+    end
+  end
+end

data/lib/YPBT/youtube_api.rb

@@ -1,108 +1,127 @@
-# frozen_string_literal: true
-require 'http'
-require 'json'
-
-module YoutubeVideo
-  # Service for all Youtube API calls
-  class YtApi
-    YT_URL = 'https://www.googleapis.com'
-    YT_COMPANY = 'youtube'
-    YT_COMPANY_URL = URI.join(YT_URL, "#{YT_COMPANY}/")
-    API_VER = 'v3'
-    YT_API_URL = URI.join(YT_COMPANY_URL, "#{API_VER}/")
-    TIME_TAG_PATTERN = /http.+?youtube.+?\?.+?t=.+?\>([0-9:]+)<\/a>/
-    def self.api_key
-      return @api_key if @api_key
-      @api_key = ENV['YOUTUBE_API_KEY']
-    end
-
-    def self.config=(credentials)
-      @config ? @config.update(credentials) : @config = credentials
-    end
-
-    def self.video_info(video_id)
-      field = 'items(id,snippet(channelId,description,publishedAt,title),'\
-              'statistics(likeCount,dislikeCount,viewCount),'\
-              'contentDetails(duration))'
-      video_response = HTTP.get(yt_resource_url('videos'),
-                                params: { id:     video_id,
-                                          key:    api_key,
-                                          part:   'snippet,statistics,
-                                                    contentDetails',
-                                          fields: field })
-      JSON.parse(video_response.to_s)['items'].first
-    end
-
-    def self.comment_info(comment_id)
-      comment_response = HTTP.get(yt_resource_url('comments'),
-                                  params: { id: comment_id,
-                                            key: api_key,
-                                            part: 'snippet' })
-      item = JSON.parse(comment_response.to_s)['items'].first
-      comment = item['snippet']
-      comment['id'] = comment_id
-      comment
-    end
-
-    def self.video_comments_info(video_id, page_token = '', max_results = 100)
-      comment_threads_response = HTTP.get(yt_resource_url('commentThreads'),
-                                          params: { videoId:  video_id,
-                                                    key:      api_key,
-                                                    order:    'relevance',
-                                                    part:     'snippet',
-                                                    maxResults: max_results,
-                                                    pageToken: page_token })
-      comment_threads = JSON.parse(comment_threads_response.to_s)
-      comments = extract_comment(comment_threads)
-      next_page_token = comment_threads['nextPageToken']
-      [next_page_token, comments]
-    end
-
-    def self.channel_info(channel_id)
-      fields = 'items(id,snippet(title,description,thumbnails(default(url))))'
-      channel_response = HTTP.get(yt_resource_url('channels'),
-                                  params: {   id:     channel_id,
-                                              key:    api_key,
-                                              part:   'snippet',
-                                              fields: fields })
-      channel_data = JSON.parse(channel_response.to_s)['items'].first['snippet']
-      {
-        'title' => channel_data['title'],
-        'description' => channel_data['description'],
-        'image_url' => channel_data['thumbnails']['default']['url']
-      }
-    end
-
-    def self.extract_comment(comment_threads)
-      comments = comment_threads['items'].map do |item|
-        comment = item['snippet']['topLevelComment']['snippet']
-        comment['id'] = item['id']
-        comment
-      end
-      comments
-    end
-
-    def self.time_tags_info(video_id, max_search_time = 5)
-      next_page = ''
-      comments_with_tags = []
-      max_search_time.times do
-        next_page, tmp_comments = video_comments_info(video_id, next_page)
-        tmp_comments.each do |comment|
-          comments_with_tags.push(comment) if time_tag? comment
-        end
-        break unless next_page
-      end
-      comments_with_tags
-    end
-
-
-    def self.time_tag?(comment)
-      !(comment['textDisplay'] =~ TIME_TAG_PATTERN).nil?
-    end
-
-    private_class_method
-    def self.yt_resource_url(resouce_name)
-      URI.join(YT_API_URL, resouce_name.to_s)
-    end
-  end
-end
+# frozen_string_literal: true
+require 'http'
+require 'json'
+
+module YoutubeVideo
+  # Service for all Youtube API calls
+  class YtApi
+    YT_URL = 'https://youtube.googleapis.com'
+    YT_COMPANY = 'youtube'
+    YT_COMPANY_URL = URI.join(YT_URL, "#{YT_COMPANY}/")
+    API_VER = 'v3'
+    YT_API_URL = URI.join(YT_COMPANY_URL, "#{API_VER}/")
+    TIME_TAG_PATTERN = /http.+?youtube.+?\?.+?t=.+?\>([0-9:]+)<\/a>/
+    def self.api_key
+      return @api_key if @api_key
+      @api_key = ENV['YOUTUBE_API_KEY']
+    end
+
+    def self.config=(credentials)
+      @config ? @config.update(credentials) : @config = credentials
+    end
+
+    def self.video_info(video_id)
+      field = 'items(id,'\
+              'snippet(thumbnails(medium),channelId,description,'\
+              'publishedAt,title,categoryId),'\
+              'statistics(likeCount,dislikeCount,viewCount),'\
+              'contentDetails(duration))'
+      video_response = HTTP.get(yt_resource_url('videos'),
+                                params: { id:     video_id,
+                                          key:    api_key,
+                                          part:   'snippet,statistics,'\
+                                                  'contentDetails',
+                                          fields: field })
+      JSON.parse(video_response.to_s)['items']&.first
+    end
+
+    def self.popular_videos_info(max_results = 25)
+      field = 'items(id,'\
+              'snippet(thumbnails(medium),channelId,description,'\
+              'publishedAt,title,categoryId),'\
+              'statistics(likeCount,dislikeCount,viewCount),'\
+              'contentDetails(duration))'
+      video_response = HTTP.get(yt_resource_url('videos'),
+                                params: { chart:     'mostpopular',
+                                          key:    api_key,
+                                          maxResults: max_results,
+                                          part:   'snippet,statistics,'\
+                                                  'contentDetails',
+                                          fields: field })
+      JSON.parse(video_response.to_s)['items']
+    end
+
+    def self.comment_info(comment_id)
+      comment_response = HTTP.get(yt_resource_url('comments'),
+                                  params: { id: comment_id,
+                                            key: api_key,
+                                            part: 'snippet' })
+      item = JSON.parse(comment_response.to_s)['items'].first
+      comment = item['snippet']
+      comment['id'] = comment_id
+      comment
+    end
+
+    def self.video_comments_info(video_id, page_token = '', max_results = 100)
+      comment_threads_response = HTTP.get(yt_resource_url('commentThreads'),
+                                          params: { videoId:  video_id,
+                                                    key:      api_key,
+                                                    order:    'relevance',
+                                                    part:     'snippet',
+                                                    maxResults: max_results,
+                                                    pageToken: page_token })
+      comment_threads = JSON.parse(comment_threads_response.to_s)
+      comments = extract_comment(comment_threads)
+      next_page_token = comment_threads['nextPageToken']
+      [next_page_token, comments]
+    end
+
+    def self.channel_info(channel_id)
+      fields = 'items(id,snippet(title,description,thumbnails(default(url))))'
+      channel_response = HTTP.get(yt_resource_url('channels'),
+                                  params: {   id:     channel_id,
+                                              key:    api_key,
+                                              part:   'snippet',
+                                              fields: fields })
+      channel_data = JSON.parse(channel_response.to_s)['items'].first
+      if channel_data
+        {
+          'title' => channel_data['snippet']['title'],
+          'description' => channel_data['snippet']['description'],
+          'image_url' => channel_data['snippet']['thumbnails']['default']['url']
+        }
+      end
+    end
+
+    def self.extract_comment(comment_threads)
+      comments = comment_threads['items'].map do |item|
+        comment = item['snippet']['topLevelComment']['snippet']
+        comment['id'] = item['id']
+        comment
+      end
+      comments
+    end
+
+    def self.time_tags_info(video_id, max_search_time = 5)
+      next_page = ''
+      comments_with_tags = []
+      max_search_time.times do
+        next_page, tmp_comments = video_comments_info(video_id, next_page)
+        tmp_comments.each do |comment|
+          comments_with_tags.push(comment) if time_tag? comment
+        end
+        break unless next_page
+      end
+      comments_with_tags
+    end
+
+    def self.time_tag?(comment)
+      !(comment['textDisplay'] =~ TIME_TAG_PATTERN).nil?
+    end
+
+    private_class_method
+    def self.yt_resource_url(resouce_name)
+      URI.join(YT_API_URL, resouce_name.to_s)
+    end
+  end
+end