yt-annotations 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e90f02ea969bbc11df732a40a5e2f943b24507f1
-  data.tar.gz: 05bbc8a4ba7fb944e4e77cd211406cdd4fa07b3c
+  metadata.gz: b130653190cc8af5a6d295992c1cccb9808479a8
+  data.tar.gz: cab1d2dc04906c8eb8dd614f784042bd292c3dc4
 SHA512:
-  metadata.gz: 8a20ea07b37fb8e6a6545dc49233084907f368fbb01265b1f95bedb86e046fa438f370cda210f8e0e22c663e757731d269e52232804c9bd0fc601eeeda7b13c6
-  data.tar.gz: 2d3675386a5c15030081f27b4f4d27dfddce214166a10f397e74cf17f3b54f5637625dd04ab0a722182c9e0628102c37cbfd13d4e59c9f84f3cdd9835dd40199
+  metadata.gz: a4323711e52413a2684b820f16335c37f4072a0b124b210c81e0b4bfe6e541b6c75c80979fc185719244d3061a74450c7ab6cda7041c0c687889dc8ca180130b
+  data.tar.gz: 4c2033365f7ac3c806e769dfaa9ca12e793f4b8e68590b011e4e5011a04039c5c5f0ebec712942becded609ce427b5381c5c6d037c6c2513629be94575ebd372

data/CHANGELOG.md

@@ -6,6 +6,16 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 2.0.0 - 2018.02.08
+
+**How to upgrade**
+
+If your code calls `Yt::Annotation::Featured` object, you should not use it because it is removed.
+
+* [REMOVAL] Remove Yt::Annotation::Featured annotation because YouTube removed it (as of 12-14-2017).
+https://developers.google.com/youtube/v3/revision_history?id=november-27-2017
+* [BUGFIX] Do not raise errors from end screens with different URL format
+* [ENHANCEMENT] Fetch 'promotion' type annotation without errors.
 
 ## 1.4.2 - 2017.05.24
 

data/lib/yt/annotations/end_screen.rb

@@ -16,11 +16,7 @@ module Yt
     private
 
       def text_in(json)
-        if json['title']['runs'].nil?
-          json['title']['simpleText']
-        else
-          json['title']['runs'][0]['text']
-        end
+        json['title']['simpleText']
       end
 
       def ends_at_in(json)
@@ -32,13 +28,21 @@ module Yt
           when 'WEBSITE'
             json['endpoint']['urlEndpoint']['url']
           when 'PLAYLIST'
-            "https://www.youtube.com/watch?v=" +
-            json['endpoint']['watchEndpoint']['videoId'] +
-            "&list=" +
-            json['endpoint']['watchEndpoint']['playlistId']
+            if json['endpoint']['watchEndpoint']
+              "https://www.youtube.com/watch?v=" +
+              json['endpoint']['watchEndpoint']['videoId'] +
+              "&list=" +
+              json['endpoint']['watchEndpoint']['playlistId']
+            else
+              "https://www.youtube.com" + json['endpoint']['urlEndpoint']['url']
+            end
           when 'VIDEO'
-            "https://www.youtube.com/watch?v=" +
-            json['endpoint']['watchEndpoint']['videoId']
+            if json['endpoint']['watchEndpoint']
+              "https://www.youtube.com/watch?v=" +
+              json['endpoint']['watchEndpoint']['videoId']
+            else
+              "https://www.youtube.com" + json['endpoint']['urlEndpoint']['url']
+            end
           when 'CHANNEL'
             if json['isSubscribe']
               "https://www.youtube.com/channel/" +

data/lib/yt/annotations/for.rb

@@ -1,13 +1,13 @@
 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'
 require 'yt/annotations/speech'
 require 'yt/annotations/spotlight'
 require 'yt/annotations/title'
 require 'yt/annotations/pause'
+require 'yt/annotations/promotion'
 
 # An object-oriented Ruby client for YouTube.
 # @see http://www.rubydoc.info/gems/yt/
@@ -64,8 +64,8 @@ module Yt
           when 'title' then Annotations::Title
           else case data['type']
             when 'card' then Annotations::Card
-            when 'promotion' then Annotations::Featured
             when 'pause' then Annotations::Pause
+            when 'promotion' then Annotations::Promotion
           end
         end
       end

data/lib/yt/annotations/note.rb

@@ -35,7 +35,6 @@ module Yt
           when '5' then :subscribe
           when '6' then :website
           when '8' then :crowdfunding
-          when '12' then :website
         end
         {url: url['value'], new_window: new_window, type: type}
       end

data/lib/yt/annotations/promotion.rb

@@ -0,0 +1,30 @@
+require 'yt/annotations/base'
+
+module Yt
+  module Annotations
+    # A Promotion annotation. The CTA overlay is used more for paid campaigns
+    # because the video has to be attached to an adsense account to be used.
+    class Promotion < Base
+      # @param [Hash] data the Hash representation of the XML data returned by
+      #   YouTube for each annotation of a video.
+      def initialize(data = {})
+        json = JSON.parse data['data']
+        @text = text_in json
+        @starts_at = json['start_ms'].to_i / 1000.0
+        @ends_at = json['end_ms'].to_i / 1000.0
+        @link = to_link data.fetch('action', {})['url'], data
+      end
+
+    private
+
+      def text_in(json)
+        json.values_at('text_line_1', 'text_line_2').join(': ')
+      end
+
+      def to_link(url, data)
+        new_window = url['target'] == 'new'
+        {url: url['value'], new_window: new_window, type: :website}
+      end
+    end
+  end
+end

data/lib/yt/annotations/version.rb

@@ -3,6 +3,6 @@ module Yt
   module Annotations
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = '1.4.2'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt-annotations
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,11 +140,11 @@ files:
 - 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
 - lib/yt/annotations/note.rb
 - lib/yt/annotations/pause.rb
+- lib/yt/annotations/promotion.rb
 - lib/yt/annotations/speech.rb
 - lib/yt/annotations/spotlight.rb
 - lib/yt/annotations/title.rb
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Fetch annotations and cards from YouTube videos.

data/lib/yt/annotations/featured.rb

@@ -1,32 +0,0 @@
-require 'yt/annotations/card'
-
-module Yt
-  module Annotations
-    # A Featured annotation is similar to a card, except that it displays in
-    # the bottom-left corner and only shows if no cards are present.
-    class Featured < Card
-    private
-      def text_in(json)
-        json.values_at('text_line_1', 'text_line_2').join(': ')
-      end
-
-      def ends_at_in(data)
-        data['end_ms'] / 1000.0
-      end
-
-      def to_link(data, json)
-        return unless url = data.fetch('action', {})['url']
-        new_window = url['target'] != 'current'
-        {url: url['value'], new_window: new_window, type: link_type(json)}
-      end
-
-      def link_type(json)
-        if json['playlist_length']
-          :playlist
-        elsif json['video_duration']
-          :video
-        end
-      end
-    end
-  end
-end