YPBT 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efa96df6ef895c6f7666e5dd9e641d4ac271521e
-  data.tar.gz: fc3c537161216660c1b60389fcb2c1beeae1b5ab
+  metadata.gz: 61ca8e47aa6832f4964feb5183284194e1eb1ba3
+  data.tar.gz: 031b9c6f56a7e5c12b9083ac7e8037e04f66a9aa
 SHA512:
-  metadata.gz: 71d3ad3d07a30b13bf2fb8782a00a17ef604d6b53d6e0a6fbfb24d4e0c4b51836ee781c470ef67462ce9772fbb8ed06471aee9ba9f4a71d412b283d59cbc87a2
-  data.tar.gz: d9b29bda32feb134b6cbaaf09dee19d546a9fa5ffdf3865a91a1e7c85b609c6d74750d59fef1340c544836c695a8c8fa700b41691edb54d0bc961807eeeb38fc
+  metadata.gz: dad8c87e97632e19d7af64ea144e8ddb39d946eed78f968f8ea087cf18e49af0f006ae1b000c5d3b9a7bf7c08980f09d2853a44ddd91b6e084ce600a510abae0
+  data.tar.gz: 3f8942eeb84ade640a7c48b1cdc6627cee180c67be553cff9ec24d752051192f2b8a8d4984d479be9fd307ede7c94ec2ac43af09ce6f95b553be8f634a5d2925

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2
+  - 2.1
+branches:
+  only:
+    - master
+script: bundle exec rake spec

data/Gemfile

@@ -1,14 +1,4 @@
 # frozen_string_literal: true
 source 'https://rubygems.org'
-gem 'http'
 
-gem 'minitest'
-gem 'minitest-rg'
-gem 'rake'
-gem 'vcr'
-gem 'webmock'
-gem 'simplecov'
-
-gem 'flog'
-gem 'flay'
-gem 'rubocop'
+gemspec

data/LICENSE

@@ -1,6 +1,7 @@
 MIT LICENSE
 
-Copyright (c)  
+Copyright (c)  Yi-Min <b37582000@gmail.com>, Yuan-Yu <tearsgundam@gmail.com>, 
+               Kun-Lin <orange6318@hotmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,13 +1,47 @@
 # Youtube Progress Bar Tagger
+[![Gem Version](https://badge.fury.io/rb/YPBT.svg)](https://badge.fury.io/rb/YPBT)
+[![Build Status](https://travis-ci.org/RubyStarts3/YPBT.svg?branch=master)](https://travis-ci.org/RubyStarts3/YPBT)
 
-## Youtube data_api exploration
-### Quick Start  
-  Export your [Youtube api key](https://console.developers.google.com/apis/credentials)  
-  
-    export YOUTUBE_API_KEY='Your_Youtube_API_Key'
-  Install essential gem  
-  
-    bundle install
-  Then do a basic test for our module  
-  
-    rake spec
+Youtube Progress Bar Tagger (YPBT) is a gem that tracks the comments following a youtube movie and captures the time points of popularity.
+
+## Installation
+
+If you are working on a project, add this to your Gemfile: `gem 'YPBT'`
+
+For ad hoc installation from command line:
+
+`$ gem install YPBT`
+
+## Quick Start  
+Export your [Youtube api key](https://console.developers.google.com/apis/credentials)  
+  ```
+    $ export YOUTUBE_API_KEY='Your_Youtube_API_Key'
+  ```
+Install essential gem  
+  ```
+    $ bundle install
+  ```
+Then do a basic test for our module  
+  ```
+    $ rake spec
+  ```
+Now, try to extract data from YouTube's video
+=> `https://www.youtube.com/watch?v=[video_id]`
+```
+    $ YPBT [video_id]
+```
+## Usage
+```ruby
+video = YoutubeVideo::Video.find(
+  video_id: video_id
+)
+
+puts video.title
+
+video.commentthreads.each. do |comment|
+  puts comment.author.author_name
+  puts comment.text_display
+  puts comment.author.like_count if comment.author.like_count
+  puts comment.author.author_channel_url
+end
+```

data/YPBT.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     =  YoutubeVideo::VERSION
 
   s.summary     =  'Gets comment from public Youtube videos'
-  s.description =  'Youtube Progress Bar Tagger '\
+  s.description =  'Youtube Progress Bar Tagger'\
                    'extracts comment threads, comments, and '\
                    'comment of author from Youtube videos'
   s.authors     =  ['Yi-Min'], ['Yuan-Yu'], ['Kun-Lin']

data/bin/YPBT

@@ -2,23 +2,6 @@
 # frozen_string_literal: true
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
 require 'YPBT'
+require_relative '../lib/YPBT/runner.rb'
 
-video_id = ARGV[0]
-unless video_id
-  puts 'USAGE: YPBT [video_id]'
-  exit(1)
-end
-
-video = YoutubeVideo::Video.find(video_id: video_id)
-puts video.title
-
-puts Array.new(video.title.length) { '-' }.join
-video.commentthreads.first(3).each.with_index do |comment, index|
-  print "#{index + 1}. "
-  puts comment.author.author_name + ':'
-  puts comment.text_display
-  print 'LIKE: '
-  puts comment.author.like_count if comment.author.like_count
-  puts "AuthorChannelUrl: #{comment.author.author_channel_url}"
-  puts
-end
+puts YoutubeVideo::Runner.run!(ARGV)

data/lib/YPBT/author.rb

@@ -9,7 +9,7 @@ module YoutubeVideo
       @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']
+      @like_count = data[0]['snippet']['likeCount'].to_i
     end
   end
 end

data/lib/YPBT/runner.rb

@@ -0,0 +1,37 @@
+# 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.commentthreads.first(3).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"\
+      "  Autor: #{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/version.rb

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

data/lib/YPBT/video.rb

@@ -5,11 +5,17 @@ require_relative 'youtube_api'
 module YoutubeVideo
   # Main class to setup a Video
   class Video
-    attr_reader :title
+    attr_reader :title, :description, :dislike_count, :like_count,
+                :comment_count, :view_count
 
     def initialize(data:)
-      @title = data['snippet']['title']
       @id = data['id']
+      @title = data['snippet']['title']
+      @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
     end
 
     def commentthreads
@@ -22,6 +28,11 @@ module YoutubeVideo
       end
     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 = YoutubeVideo::YtApi.video_info(video_id)
       new(data: video_data)

data/lib/YPBT/youtube_api.rb

@@ -16,12 +16,17 @@ module YoutubeVideo
       @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))'
+      field = 'items(id,snippet(channelId,description,publishedAt,title),'\
+              'statistics)'
       video_response = HTTP.get(yt_resource_url('videos'),
                                 params: { id:     video_id,
                                           key:    api_key,
-                                          part:   'snippet',
+                                          part:   'snippet,statistics',
                                           fields: field })
       JSON.parse(video_response.to_s)['items'].first
     end