yt-audit 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8594dc0bf20e108d230961aad4e689b71876b03f
-  data.tar.gz: 3878206cdf83f73895f035ff08077030e425faae
+  metadata.gz: 7da22a57ea6de80903cdfaedc43242975109e22b
+  data.tar.gz: 3e77764bc854359f62880bc4576a7ac86e667ac9
 SHA512:
-  metadata.gz: c63cbc249217242755ae6b86a8dfba002c0106531e5377643476755808794933b1ef925b6c3d5ce43b561d7a29a992bfcee5d3670c00027acd4c644443e460b8
-  data.tar.gz: 0f3c9ae069730d1f232431cd66540c75f55367a85846c6bad898ef9801b1828b4074ef3c6de3990c84870f61e28754a9f15c23637f9c54aade640049d0887c87
+  metadata.gz: 999786ef7ebdccbcbafe39c075105db541b5f6292022b2505d2e7df6fbde93dbfbcef176529de0b425f4b01b6ed8526fbe535142deab875b2ae1cfb6f7a4d42d
+  data.tar.gz: b0219b654d9e6a59bcec46a554690d1e7ce433b88f9374724ed45b9aa672564ab6ae59ce54630f955ad69e1ee72776915d8aac2c4275da5c418cd927030f2f9d

data/CHANGELOG.md

@@ -6,6 +6,19 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.2.0  - 2016.02.18
+
+**How to upgrade**
+
+If your code calls any of `has_end_cards?`, `has_link_to_own_channel?`, `has_subscribe_annotations?`, `has_brand_anchoring?`, or `has_info_cards?` method with a video id, they are removed. Instead, call `run` method from a `Yt::Audit` instance to get information of a channel.
+
+* [FEATURE] Add `run` method to audit a channel and count how many videos have each audit subject out of its recent 10 videos.
+* [REMOVAL] Remove `has_end_cards?`
+* [REMOVAL] Remove `has_link_to_own_channel?`
+* [REMOVAL] Remove `has_subscribe_annotations?`
+* [REMOVAL] Remove `has_brand_anchoring?`
+* [REMOVAL] Remove `has_info_cards?`
+
 ## 0.1.5  - 2016.02.17
 
 * [BUGFIX] Fix `has_end_cards?` for cases when Float `ends_at` is

data/README.md

@@ -1,6 +1,6 @@
 # Yt::Audit
 
-Welcome! This is a Ruby library you can audit a YouTube video.
+Welcome! This is a Ruby library you can audit a YouTube channel.
 
 The **source code** is available on [GitHub](https://github.com/Fullscreen/yt-audit) and the **documentation** on [RubyDoc](http://www.rubydoc.info/github/fullscreen/yt-audit/master/Yt/Audit).
 
@@ -16,7 +16,7 @@ The **source code** is available on [GitHub](https://github.com/Fullscreen/yt-au
 
     $ bin/setup
 
-    $ YT_API_KEY="123456789012345678901234567890" rake
+    $ YT_API_KEY="123456789012345678901234567890123456789" rake
     $ open coverage/index.html
 
     $ yardoc
@@ -24,15 +24,26 @@ The **source code** is available on [GitHub](https://github.com/Fullscreen/yt-au
 
 ## Usage
 
+`run` method returns an array of objects. It uses channel title as brand name, and 10 recent videos of channel, currently.
+
+```ruby
+audit = Yt::Audit.new(channel_id: 'UCPCk_8dtVyR1lLHMBEILW4g')
+# => #<Yt::Audit:0x007f94ec8050b0 @channel_id="UCPCk_8dtVyR1lLHMBEILW4g">
+audit.run
+# => [#<Yt::VideoAudit::InfoCard:0x007f94ec8c6f30 @videos=[...]>, #<Yt::VideoAudit::BrandAnchoring...>, #<Yt::VideoAudit::SubscribeAnnotation...>, #<Yt::VideoAudit::YoutubeAssociation...>, #<Yt::VideoAudit::EndCard...>]
+```
+
+You can call four available methods `total_count`, `valid_count`, `title`, and `description` from each `Yt::VideoAudit` object.
+
 ```ruby
-Yt::Audit.has_info_cards?('rF711XAtrVg')
-# => true
-Yt::Audit.has_brand_anchoring?('rF711XAtrVg', 'Budweiser')
-# => true
-Yt::Audit.has_subscribe_annotations?('rF711XAtrVg')
-# => false
-Yt::Audit.has_link_to_own_channel?('rF711XAtrVg')
-# => false
-Yt::Audit.has_end_cards?('rF711XAtrVg')
-# => false
+video_audit = audit.run[0]
+# => #<Yt::VideoAudit::InfoCard:0x007f94ec979ab8 @videos=[...]>
+video_audit.total_count
+# => 10
+video_audit.valid_count
+# => 10
+video_audit.title
+# => "Info Cards"
+video_audit.description
+# => "The number of videos with an info card"
 ```

data/bin/yt-audit

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'yt/audit'
+rescue LoadError
+  require 'rubygems'
+  require 'yt/audit'
+end
+
+channel_id = ARGV[0] || 'UCKM-eG7PBcw3flaBvd0q2TQ'
+audit = Yt::Audit.new(channel_id: channel_id)
+puts "Channel: https://www.youtube.com/channel/#{channel_id}"
+audit.run.each do |video_audit|
+  puts
+  puts "#{video_audit.description}"
+  puts "#{video_audit.title}: #{video_audit.valid_count} out of #{video_audit.total_count}"
+end
+

data/lib/yt/audit.rb

@@ -1,56 +1,35 @@
 require 'yt'
 require 'yt/annotations'
+require 'yt/video_audit/info_card'
+require 'yt/video_audit/brand_anchoring'
+require 'yt/video_audit/subscribe_annotation'
+require 'yt/video_audit/youtube_association'
+require 'yt/video_audit/end_card'
 
 module Yt
-  module Audit
-    # Audit any info card of a video
-    # @param [String] video_id the video to audit.
-    # @return [Boolean] if the video has any info card.
-    def self.has_info_cards?(video_id)
-      Yt::Annotations.for(video_id).any? do |annotation|
-        annotation.is_a? Yt::Annotations::Card
-      end
+  class Audit
+    def initialize(channel_id:)
+      @channel_id = channel_id
     end
 
-    # Audit brand anchoring of a video
-    # @param [String] video_id the video to audit.
-    # @param [String] brand name of the video to audit.
-    # @return [Boolean] if the video title includes brand name.
-    def self.has_brand_anchoring?(video_id, brand)
-      video_title = Yt::Video.new(id: video_id).title
-      !!video_title[/#{brand}/i]
+    def run
+      [
+        Yt::VideoAudit::InfoCard.new(videos: videos),
+        Yt::VideoAudit::BrandAnchoring.new(videos: videos, brand: channel.title),
+        Yt::VideoAudit::SubscribeAnnotation.new(videos: videos),
+        Yt::VideoAudit::YoutubeAssociation.new(videos: videos),
+        Yt::VideoAudit::EndCard.new(videos: videos)
+      ]
     end
 
-    # Audit any subscribe annotation of a video
-    # @param [String] video_id the video to audit.
-    # @return [Boolean] if the video has any link to subscribe in the annotations.
-    def self.has_subscribe_annotations?(video_id)
-      Yt::Annotations.for(video_id).any? do |annotation|
-        annotation.link && annotation.link[:type] == :subscribe
-      end
-    end
+  private
 
-    # Audit youtube association of a video
-    # @param [String] video_id the video to audit.
-    # @return [Boolean] if the video description has link to its own channel.
-    def self.has_link_to_own_channel?(video_id)
-      video = Yt::Video.new(id: video_id)
-      video.description.split(' ')
-           .select {|word| Yt::URL.new(word).kind == :channel }
-           .any? {|link| Yt::Channel.new(url: link).id == video.channel_id }
+    def videos
+      @videos ||= channel.videos.first 10
     end
 
-    # Audit end cards of a video
-    # @param [String] video_id of the video to audit.
-    # @return [Boolean] if the video has any annotation, other than info cards,
-    #   with a link in it, at the end of video, stays for more than 5 seconds.
-    def self.has_end_cards?(video_id)
-      video_duration = Yt::Video.new(id: video_id).duration
-      Yt::Annotations.for(video_id).any? do |annotation|
-        !annotation.is_a?(Yt::Annotations::Card) && annotation.link &&
-          (annotation.ends_at.floor..annotation.ends_at.ceil).include?(video_duration) &&
-          video_duration - annotation.starts_at > 5
-      end
+    def channel
+      @channel ||= Yt::Channel.new id: @channel_id
     end
   end
 end

data/lib/yt/audit/version.rb

@@ -1,5 +1,5 @@
 module Yt
-  module Audit
-    VERSION = "0.1.5"
+  class Audit
+    VERSION = "0.2.0"
   end
 end

data/lib/yt/video_audit/base.rb

@@ -0,0 +1,19 @@
+module Yt
+  module VideoAudit
+    class Base
+      def initialize(options = {})
+        @videos = options[:videos]
+      end
+
+      # @return [Fixnum] number of all given videos.
+      def total_count
+        @videos.size
+      end
+
+      # @return [Fixnum] number of videos satisfy given condition.
+      def valid_count
+        @videos.count {|video| valid? video}
+      end
+    end
+  end
+end

data/lib/yt/video_audit/brand_anchoring.rb

@@ -0,0 +1,27 @@
+require 'yt/video_audit/base'
+
+module Yt
+  module VideoAudit
+    # Count how many subject videos include its brand name in the title.
+    class BrandAnchoring < Base
+      def initialize(options = {})
+        super
+        @brand = options[:brand]
+      end
+
+      def title
+        'Brand Anchoring'
+      end
+
+      def description
+        'The number of videos with the brand name in the title'
+      end
+
+    private
+
+      def valid?(video)
+        !!video.title[/#{@brand}/i]
+      end
+    end
+  end
+end

data/lib/yt/video_audit/end_card.rb

@@ -0,0 +1,29 @@
+require 'yt/video_audit/base'
+
+module Yt
+  module VideoAudit
+    # Count how many subject videos have any end card. An end card
+    # can be described as an annotation, not an info card, with a link in it,
+    # at the end of video, stays for more than 5 seconds.
+    class EndCard < Base
+      def title
+        'Possible End Card Annotations'
+      end
+
+      def description
+        'The number of videos with a link annotation'\
+        ' longer than 5 seconds, not an info card, at the end of its duration'
+      end
+
+    private
+
+      def valid?(video)
+        Yt::Annotations.for(video.id).any? do |annotation|
+          !annotation.is_a?(Yt::Annotations::Card) && annotation.link &&
+            (annotation.ends_at.floor..annotation.ends_at.ceil).include?(video.duration) &&
+            video.duration - annotation.starts_at > 5
+        end
+      end
+    end
+  end
+end

data/lib/yt/video_audit/info_card.rb

@@ -0,0 +1,24 @@
+require 'yt/video_audit/base'
+
+module Yt
+  module VideoAudit
+    # Count how many subject videos have an info card.
+    class InfoCard < Base
+      def title
+        'Info Cards'
+      end
+
+      def description
+        'The number of videos with an info card'
+      end
+
+    private
+
+      def valid?(video)
+        Yt::Annotations.for(video.id).any? do |annotation|
+          annotation.is_a? Yt::Annotations::Card
+        end
+      end
+    end
+  end
+end

data/lib/yt/video_audit/subscribe_annotation.rb

@@ -0,0 +1,25 @@
+require 'yt/video_audit/base'
+
+module Yt
+  module VideoAudit
+    # Count how many subject videos have an annotation
+    # with a subscribe link.
+    class SubscribeAnnotation < Base
+      def title
+        'Subscribe Annotations'
+      end
+
+      def description
+        'The number of videos with a link to subscribe in its annotations'
+      end
+
+    private
+
+      def valid?(video)
+        Yt::Annotations.for(video.id).any? do |annotation|
+          annotation.link && annotation.link[:type] == :subscribe
+        end
+      end
+    end
+  end
+end

data/lib/yt/video_audit/youtube_association.rb

@@ -0,0 +1,25 @@
+require 'yt/video_audit/base'
+
+module Yt
+  module VideoAudit
+    # Count how many videos have video description includes
+    # a link to its own channel.
+    class YoutubeAssociation < Base
+      def title
+        'YouTube Association'
+      end
+
+      def description
+        'The number of videos with description has a link to its own channel'
+      end
+
+    private
+
+      def valid?(video)
+        video.description.split(' ')
+             .select {|word| Yt::URL.new(word).kind == :channel }
+             .any? {|link| Yt::Channel.new(url: link).id == video.channel_id }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt-audit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Kang-Kyu Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yt
@@ -126,8 +126,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/yt-audit
 - lib/yt/audit.rb
 - lib/yt/audit/version.rb
+- lib/yt/video_audit/base.rb
+- lib/yt/video_audit/brand_anchoring.rb
+- lib/yt/video_audit/end_card.rb
+- lib/yt/video_audit/info_card.rb
+- lib/yt/video_audit/subscribe_annotation.rb
+- lib/yt/video_audit/youtube_association.rb
 - yt-audit.gemspec
 homepage: https://github.com/fullscreen/yt-audit
 licenses: