YPBT 0.1.5 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61ca8e47aa6832f4964feb5183284194e1eb1ba3
-  data.tar.gz: 031b9c6f56a7e5c12b9083ac7e8037e04f66a9aa
+  metadata.gz: 2af780eba918c5d863f386c47a56487d155bb9bd
+  data.tar.gz: 20fd1fafe9e5e595edb071ffda8b7f9beec74d7f
 SHA512:
-  metadata.gz: dad8c87e97632e19d7af64ea144e8ddb39d946eed78f968f8ea087cf18e49af0f006ae1b000c5d3b9a7bf7c08980f09d2853a44ddd91b6e084ce600a510abae0
-  data.tar.gz: 3f8942eeb84ade640a7c48b1cdc6627cee180c67be553cff9ec24d752051192f2b8a8d4984d479be9fd307ede7c94ec2ac43af09ce6f95b553be8f634a5d2925
+  metadata.gz: dbd7823b446f6bba748db5988292e754ceaa8933722d6947b959c422c8edacf38d24c5719ba1610a832907defb13bbfe5e181d2efb06779f1afb5deb56ed35c4
+  data.tar.gz: d424ff4da46cdfb44b8a23e66cd2fad2c5fa4e6c88b022459a378ff309b86bdb791e530c2e840d2c10e22ea577026a7e1850e23227431d544931addbca52ec6d

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
   - 2.3.1
-  - 2.2
-  - 2.1
 branches:
   only:
     - master

data/Rakefile

@@ -24,8 +24,9 @@ namespace :credentials do
 end
 
 desc 'run tests'
-task :spec do
-  sh 'ruby spec/video_spec.rb'
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.warning = false
 end
 
 desc 'delete cassette fixtures'

data/YPBT.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables << 'YPBT'
 
   s.add_runtime_dependency 'http', '~> 2.0'
-
+  s.add_runtime_dependency 'ruby-duration', '~>3.2.3'
   s.add_development_dependency 'minitest', '~> 5.9'
   s.add_development_dependency 'minitest-rg', '~> 5.2'
   s.add_development_dependency 'rake', '~> 11.3'
@@ -29,7 +29,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'flog', '~> 4.4'
   s.add_development_dependency 'flay', '~> 2.8'
   s.add_development_dependency 'rubocop', '~> 0.42'
-
   s.homepage    =  'https://github.com/RubyStarts3/YPBT'
   s.license     =  'MIT'
 end

data/lib/YPBT/author.rb

@@ -6,10 +6,10 @@ module YoutubeVideo
                 :like_count
     def initialize(data)
       return unless data
-      @author_name = data[0]['snippet']['authorDisplayName']
-      @author_image_url = data[0]['snippet']['authorProfileImageUrl']
-      @author_channel_url = data[0]['snippet']['authorChannelUrl']
-      @like_count = data[0]['snippet']['likeCount'].to_i
+      @author_name = data['authorDisplayName']
+      @author_image_url = data['authorProfileImageUrl']
+      @author_channel_url = data['authorChannelUrl']
+      @like_count = data['likeCount'].to_i
     end
   end
 end

data/lib/YPBT/comment.rb

@@ -6,18 +6,13 @@ require_relative 'author'
 module YoutubeVideo
   # signle comment on video's comment threads
   class Comment
-    attr_reader :comment_id, :updated_at, :text_display, :published_at
+    attr_reader :comment_id, :updated_at, :text_display, :published_at, :author,
+                :time_tags, :like_count
 
     def initialize(data: nil)
       load_data(data)
     end
 
-    def author
-      return @author if @author
-      author_data = YtApi.authors_info(@comment_id)
-      @author = YoutubeVideo::Author.new(author_data)
-    end
-
     def self.find(comment_id:)
       comment_data = YoutubeVideo::YtApi.comment_info(comment_id)
       new(data: comment_data)
@@ -26,10 +21,13 @@ module YoutubeVideo
     private
 
     def load_data(comment_data)
-      @comment_id =   comment_data['id']
-      @updated_at =   comment_data['snippet']['updateAt']
-      @text_display = comment_data['snippet']['textDisplay']
-      @published_at = comment_data['snippet']['publishedAt']
+      @comment_id = comment_data['id']
+      @like_count = comment_data['likeCount'].to_i
+      @updated_at = comment_data['updateAt']
+      @text_display = comment_data['textDisplay']
+      @published_at = comment_data['publishedAt']
+      @author = YoutubeVideo::Author.new(comment_data)
+      @time_tags = YoutubeVideo::Timetag.find(comment: self)
     end
   end
 end

data/lib/YPBT/runner.rb

@@ -19,7 +19,7 @@ module YoutubeVideo
       title = video.title
       separator = Array.new(video.title.length) { '-' }.join
       video_info =
-        video.commentthreads.first(3).map.with_index do |comment, index|
+        video.comments.map.with_index do |comment, index|
           comment_info(comment, index)
         end.join
 
@@ -28,7 +28,7 @@ module YoutubeVideo
 
     def self.comment_info(comment, index)
       "#{index + 1}:\n"\
-      "  Autor: #{comment.author.author_name}\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"

data/lib/YPBT/time_tag.rb

@@ -0,0 +1,54 @@
+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
+    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.1.5'
+  VERSION = '0.2.2'
 end

data/lib/YPBT/video.rb

@@ -14,18 +14,15 @@ module YoutubeVideo
       @description = data['snippet']['description']
       @dislike_count = data['statistics']['dislikeCount'].to_i
       @like_count = data['statistics']['likeCount'].to_i
-      @comment_count = data['statistics']['commentCount'].to_i
       @view_count = data['statistics']['viewCount'].to_i
+      @duration = data['contentDetails']['duration']
     end
 
-    def commentthreads
-      return @commentthreads if @commentthreads
-      raw_threads = YoutubeVideo::YtApi.video_commentthreads_info(@id)
-      @commentthreads = raw_threads.map do |comment|
-        YoutubeVideo::Comment.new(
-          data: comment['snippet']['topLevelComment']
-        )
-      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 embed_url
@@ -34,7 +31,7 @@ module YoutubeVideo
     end
 
     def self.find(video_id:)
-      video_data = YoutubeVideo::YtApi.video_info(video_id)
+      video_data = YtApi.video_info(video_id)
       new(data: video_data)
     end
   end

data/lib/YPBT/youtube_api.rb

@@ -10,7 +10,7 @@ module YoutubeVideo
     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']
@@ -22,42 +22,68 @@ module YoutubeVideo
 
     def self.video_info(video_id)
       field = 'items(id,snippet(channelId,description,publishedAt,title),'\
-              'statistics)'
+              'statistics(likeCount,dislikeCount,viewCount),'\
+              'contentDetails(duration))'
       video_response = HTTP.get(yt_resource_url('videos'),
                                 params: { id:     video_id,
                                           key:    api_key,
-                                          part:   'snippet,statistics',
+                                          part:   'snippet,statistics,
+                                                    contentDetails',
                                           fields: field })
       JSON.parse(video_response.to_s)['items'].first
     end
 
-    def self.video_commentthreads_info(video_id)
+    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' })
-      JSON.parse(comment_threads_response.to_s)['items']
+                                                    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.comment_info(comment_id)
-      comment_response = HTTP.get(yt_resource_url('comments'),
-                                  params: { id: comment_id,
-                                            key: api_key,
-                                            part: 'snippet' })
-      JSON.parse(comment_response.to_s)['items'][0]
+    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.authors_info(comment_id)
-      field = 'items(snippet(authorChannelId,authorChannelUrl,'\
-      'authorDisplayName,authorProfileImageUrl,likeCount))'
-      authors_response = HTTP.get(yt_resource_url('comments'),
-                                  params: { id: comment_id,
-                                            key: api_key,
-                                            part: 'snippet',
-                                            fields: field })
-      JSON.parse(authors_response.to_s)['items']
+    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)

data/spec/Ytapi_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require_relative 'spec_helper.rb'
+
+describe 'YtApi specifications' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+
+    c.filter_sensitive_data('<API_KEY>') { ENV['YOUTUBE_API_KEY'] }
+    c.filter_sensitive_data('<API_KEY_ESCAPED>') do
+      URI.escape(ENV['YOUTUBE_API_KEY'])
+    end
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe 'YtApi Credentials' do
+    it 'should be able to get a new api key with ENV credentials' do
+      YoutubeVideo::YtApi.api_key.length.must_be :>, 0
+    end
+    it 'should be able to get a new access token with file credentials' do
+      YoutubeVideo::YtApi.config = { api_key: ENV['YOUTUBE_API_KEY'] }
+    end
+  end
+
+  describe 'YtApi functions' do
+    it 'should be able to find video by video id' do
+      YoutubeVideo::YtApi.video_info(TEST_VIDEO_ID).must_be_instance_of Hash
+    end
+
+    it 'should be able find comment by comment id' do
+      result = YoutubeVideo::YtApi.comment_info(TEST_COMMENT_ID)
+      result.must_be_instance_of Hash
+      result['id'].must_equal TEST_COMMENT_ID
+    end
+
+    it 'should be able find comments by video id' do
+      next_page_token, comments = YoutubeVideo::YtApi
+                                  .video_comments_info(TEST_VIDEO_ID)
+      next_page_token.must_be_instance_of String
+      comments.must_be_instance_of Array
+      comments.length.must_be :>, 1
+      comments[0].must_be_instance_of Hash
+    end
+
+    it 'should be able find comments that contain time tags by video_id' do
+      comments = YoutubeVideo::YtApi.time_tags_info(TEST_VIDEO_ID)
+      comments.must_be_instance_of Array
+      comments.length.must_be :>, 1
+      comments[0].must_be_instance_of Hash
+      comments[0]['textDisplay'].must_match(/[0-9]+:\d+/)
+    end
+  end
+end

data/spec/comment_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require_relative 'spec_helper.rb'
+
+describe 'comment specifications' do
+  VCR.configure do |c|
+    c.cassette_library_dir = CASSETTES_FOLDER
+    c.hook_into :webmock
+
+    c.filter_sensitive_data('<API_KEY>') { ENV['YOUTUBE_API_KEY'] }
+    c.filter_sensitive_data('<API_KEY_ESCAPED>') do
+      URI.escape(ENV['YOUTUBE_API_KEY'])
+    end
+  end
+
+  before do
+    VCR.insert_cassette CASSETTE_FILE, record: :new_episodes
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe 'comment functions' do
+    it 'should has the abilit to find by comment id' do
+      comment = YoutubeVideo::Comment.find(comment_id: TEST_COMMENT_ID)
+      comment.must_be_instance_of YoutubeVideo::Comment
+      comment.comment_id.must_equal TEST_COMMENT_ID
+    end
+  end
+end