yt-annotations 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f1975d4c1a40fe0912df7629828d26a268ae5c7
-  data.tar.gz: 10b9e600b187b9e1116e63e0260e1056e8cb6eb6
+  metadata.gz: b11e5000de51c3368ae436830f73718c62ee3c79
+  data.tar.gz: 9c423d7614330f65be5dc065c773929219612162
 SHA512:
-  metadata.gz: 125f6b584f591e0248fa719fc966ea616c3a00692df928075932fa23a2b79c6a7bfa4cac6f829234d09efd4890f047fccfd6735f91124ca67e24e0dd8a26be74
-  data.tar.gz: 6062fe651de36ea7c683d9e8cecba7988609bb3c9dd21fe3c5143d9b5d2537ebfcd70eb69c256f58f66352c38017398fdbbb7b3eaf70294974073faa60104f2d
+  metadata.gz: 6627dc40354ae491ee2db22b372f6ef5dd610a70112838066bdd12e2af703cc3338378d589dd7ccaa1bb7410930d00af60ddad392c9f73e7407c333a379022c8
+  data.tar.gz: 267e86f1fbb728fa20d9059cf2cbdbd639d0045287261059160989f74eaf6c12781839a9f5365883221e5ade4258ca888557eafac2b33028e3212ee042cb6040

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -7,6 +7,10 @@ For more information about changelogs, check
 [Vandamme](http://tech-angels.github.io/vandamme).
 
 
+## 1.4.0 - 2017.01.13
+
+* [FEATURE] Add End Screens
+
 ## 1.3.2 - 2016.09.08
 
 * [BUGFIX] Do not raise errors from videos with 'speech' style

data/README.md

@@ -1,7 +1,7 @@
 A Ruby gem to fetch YouTube annotations
 =======================================
 
-Yt::Annotations is a Ruby library to fetch annotations and cards of YouTube videos.
+Yt::Annotations is a Ruby library to fetch annotations, cards and end screens of YouTube videos.
 
 The **source code** is available on [GitHub](https://github.com/fullscreen/yt-annotations) and the **documentation** on [RubyDoc](http://www.rubydoc.info/github/fullscreen/yt-annotations/Yt/Annotations).
 

data/lib/yt/annotations/end_screen.rb

@@ -0,0 +1,43 @@
+require 'yt/annotations/base'
+
+module Yt
+  module Annotations
+    # An end screen annotation shows in the last 5 to seconds of the video.
+    class EndScreen < Base
+      # @param [Hash] data the Hash representation of the XML data returned by
+      #   YouTube for each end screen of a video.
+      def initialize(json = {})
+        @text = json['title']
+        @starts_at = json['startMs'] / 1000.0
+        @ends_at = ends_at_in json
+        @link = to_link json
+      end
+
+    private
+
+      def ends_at_in(json)
+        (json['startMs'] + json['durationMs']) / 1000.0
+      end
+
+      def to_link(json)
+        {
+          url: json['targetUrl'], new_window: new_window(json['type']), 
+          type: link_type(json)
+        }
+      end
+      
+      def link_type(json)
+        case json['type']
+          when 'WEBSITE' then :website
+          when 'PLAYLIST' then :playlist
+          when 'VIDEO' then :video
+          when 'CHANNEL' then (json['isSubscribe'] ? :subscribe : :channel)
+        end
+      end
+      
+      def new_window(type)
+        %w(WEBSITE CHANNEL).include? type
+      end
+    end
+  end
+end

data/lib/yt/annotations/for.rb

@@ -1,5 +1,6 @@
 require 'yt/annotations/branding'
 require 'yt/annotations/card'
+require 'yt/annotations/end_screen'
 require 'yt/annotations/featured'
 require 'yt/annotations/label'
 require 'yt/annotations/note'
@@ -12,14 +13,29 @@ module Yt
   module Annotations
     module For
       def for(video_id)
-        request = Net::HTTP::Get.new "/annotations_invideo?video_id=#{video_id}"
-        options = ['www.youtube.com', 443, {use_ssl: true}]
-        response = Net::HTTP.start(*options) {|http| http.request request}
-        xml_to_annotations(Hash.from_xml response.body).sort_by &:starts_at
+        (annotations(video_id) + end_screens(video_id)).sort_by &:starts_at
       end
 
     private
 
+      def annotations(video_id)
+        data = fetch "/annotations_invideo?video_id=#{video_id}"
+        xml_to_annotations(Hash.from_xml data)
+      end
+
+      def end_screens(video_id)
+        data = fetch "/get_endscreen?v=#{video_id}"
+        data = data.partition("\n").last
+        data.present? ? json_to_annotations(JSON data) : []
+      end
+
+      def fetch(path)
+        request = Net::HTTP::Get.new path
+        options = ['www.youtube.com', 443, {use_ssl: true}]
+        response = Net::HTTP.start(*options) {|http| http.request request}
+        response.body
+      end
+
       def xml_to_annotations(xml)
         annotations = xml['document']['annotations']
         annotations = Array.wrap (annotations || {})['annotation']
@@ -28,6 +44,10 @@ module Yt
         annotations.map{|data| annotation_class(data).new data}
       end
 
+      def json_to_annotations(json)
+        annotations = json['elements']
+        annotations.map{|data| Annotations::EndScreen.new data}
+      end
 
       def annotation_class(data)
         case data['style']

data/lib/yt/annotations/version.rb

@@ -1,5 +1,5 @@
 module Yt
   module Annotations
-    VERSION = '1.3.2'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt-annotations
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,6 +110,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -122,6 +123,7 @@ files:
 - lib/yt/annotations/base.rb
 - lib/yt/annotations/branding.rb
 - lib/yt/annotations/card.rb
+- lib/yt/annotations/end_screen.rb
 - lib/yt/annotations/featured.rb
 - lib/yt/annotations/for.rb
 - lib/yt/annotations/label.rb