yt-annotations 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e68838daeb5a5768c0ec8c7836bc3085131498fe
-  data.tar.gz: 220f22ea8162ab35147ffbb4dd7993b25450cbbb
+  metadata.gz: 1a0c467d188f6e1240e4e4cac683ff2bad025eaf
+  data.tar.gz: 1c00e6cc2c9222098d2a2ef5b3be8bd22d400773
 SHA512:
-  metadata.gz: 9b068c9d62e220f86119f8c53ae0663eb2803964624f7405f2e8b8da3f95de9ced9cdb1b30c6f2a1de0353e8c062e905823256b07ee979a27dce3823b8c258b8
-  data.tar.gz: 4b87f181807c71e378f6ae2338966c6cb35206c5bd7b77d609b8dbfd581fb702e4c8d099764565c92752dba364183c66cdea59c2c074b81a6313ede752a015ce
+  metadata.gz: 9c8ee7bbd73cd7c776377e00168671810fdbb451295e05b3f1dfcbf34e6771cb1936640e8189c791024666c5ddf407665096a64d4918b421cacef4ec8371c017
+  data.tar.gz: 7dcc2d65c21a147d77a68a524f1be8d289ea45c80bd80047427ccc31fca122145f41241bb6d75db39d3fc65e13d258141d9e4f3ed59978bf64d9261691c4eb1e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+
+## 1.1.0 - 2015.11.12
+
+* [FEATURE] Fetches annotations and cards of YouTube videos

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yt-annotations.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Fullscreen, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+A Ruby gem to fetch YouTube annotations
+=======================================
+
+Yt::Annotations is a Ruby library to fetch annotations and cards 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/master/Elegant/Interface).
+
+[![Build Status](http://img.shields.io/travis/Fullscreen/yt-annotations/master.svg)](https://travis-ci.org/Fullscreen/yt-annotations)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/yt-annotations/master.svg)](https://coveralls.io/r/Fullscreen/yt-annotations)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/yt-annotations.svg)](https://gemnasium.com/Fullscreen/yt-annotations)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/yt-annotations.svg)](https://codeclimate.com/github/Fullscreen/yt-annotations)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/github/Fullscreen/yt-annotations/master/Elegant)
+[![Gem Version](http://img.shields.io/gem/v/yt-annotations.svg)](http://rubygems.org/gems/yt-annotations)
+
+How to use
+==========
+
+Simply call `Yt::Annotations.for` with the ID of a YouTube video:
+
+```ruby
+annotations = Yt::Annotations.for 'MESycYJytkU'
+# => [#<Yt::Annotations::Featured …>]
+annotations.first.text
+# => "Suggested by Fullscreen: What is Fullscreen?"
+annotations.first.starts_at
+# => 76.0
+annotations.first.ends_at
+# => 86.0
+annotations.first.link
+# {url: "https://www.youtube.com/watch?v=NeMlqbX2Ifg", new_window: true, type: :video}
+```
+
+How to install
+==============
+
+Elegant requires **Ruby 2.0 or higher**.
+
+To include in your project, add `gem 'yt-annotations', ~> '1.0'` to the `Gemfile` file of your Ruby project.
+
+How to contribute
+=================
+
+If you’ve made it this far in the README… thanks! :v:
+Feel free to try it the gem, explore the code, and send issues or pull requests.
+
+All pull requests will have to make Travis and Code Climate happy in order to be accepted. :kissing_smiling_eyes:
+
+You can also run the tests locally with `bundle exec rspec`.
+
+Happy hacking!

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+require "rspec/core/version"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new :spec
+
+task default: [:spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'yt/annotations'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yt/annotations.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+require 'json'
+require 'active_support' # required
+require 'active_support/core_ext/hash/conversions' # for Hash.from_xml
+require 'active_support/core_ext/string/inflections' # for demodulize
+
+require 'yt/annotations/for'
+
+module Yt
+  module Annotations
+    # Auto-load For to have the easy syntax Yt::Annotations.for(video_id).
+    extend For
+  end
+end

data/lib/yt/annotations/base.rb

@@ -0,0 +1,18 @@
+module Yt
+  module Annotations
+    # An abstract class with common attributes for every type of annotation.
+    class Base
+      # @return [String] the text of the annotation.
+      attr_reader :text
+
+      # @return [Float] when the annotation appears (in seconds).
+      attr_reader :starts_at
+
+      # @return [Float] when the annotation disappears (in seconds).
+      attr_reader :ends_at
+
+      # @return [Hash, nil] what the annotation links.
+      attr_reader :link
+    end
+  end
+end

data/lib/yt/annotations/branding.rb

@@ -0,0 +1,24 @@
+require 'yt/annotations/card'
+
+module Yt
+  module Annotations
+    # A Branding annotation is similar to a card, except that it does not have
+    # text, only a channel-linked image displayed in the bottom-right corner.
+    class Branding < Card
+    private
+      def text_in(data)
+        ''
+      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: :channel}
+      end
+    end
+  end
+end

data/lib/yt/annotations/card.rb

@@ -0,0 +1,42 @@
+require 'yt/annotations/base'
+
+module Yt
+  module Annotations
+    # A Card annotation is different from a Note annotation in the way data is
+    # represented in the XML under a new 'data' key with JSON-formatted content.
+    class Card < Base
+      # @param [Hash] data the Hash representation of the XML data returned by
+      #   YouTube for each card of a video.
+      def initialize(data = {})
+        json = JSON.parse data['data']
+        @text = text_in json
+        @starts_at = json['start_ms'] / 1000.0
+        @ends_at = ends_at_in json
+        @link = to_link data, json
+      end
+
+    private
+
+      def text_in(json)
+        json['teaser_text']
+      end
+
+      def ends_at_in(json)
+        (json['start_ms'] + json['teaser_duration_ms']) / 1000.0
+      end
+
+      def to_link(data, json)
+        link_type = case json['card_type']
+          when 'collaborator' then :channel
+          when 'playlist' then :playlist
+          when 'video' then :video
+          when 'merch' then :merch
+          when 'fundraising' then :crowdfunding
+          when 'associated' then :website
+        end
+
+        {url: json['url'], new_window: true, type: link_type}
+      end
+    end
+  end
+end

data/lib/yt/annotations/featured.rb

@@ -0,0 +1,32 @@
+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

data/lib/yt/annotations/for.rb

@@ -0,0 +1,57 @@
+require 'yt/annotations/branding'
+require 'yt/annotations/card'
+require 'yt/annotations/featured'
+require 'yt/annotations/label'
+require 'yt/annotations/note'
+require 'yt/annotations/speech'
+require 'yt/annotations/spotlight'
+require 'yt/annotations/title'
+
+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
+      end
+
+    private
+
+      def xml_to_annotations(xml)
+        annotations = xml['document']['annotations']
+        annotations = Array.wrap (annotations || {})['annotation']
+        annotations = merge_highlights annotations
+        annotations.map{|data| annotation_class(data).new data}
+      end
+
+
+      def annotation_class(data)
+        case data['style']
+          when 'anchored' then Annotations::Speech
+          when 'branding' then Annotations::Branding
+          when 'highlightText' then Annotations::Spotlight
+          when 'label' then Annotations::Label
+          when 'popup' then Annotations::Note
+          when 'title' then Annotations::Title
+          else case data['type']
+            when 'card' then Annotations::Card
+            when 'promotion' then Annotations::Featured
+          end
+        end
+      end
+
+      def merge_highlights(annotations)
+        highlights, others = annotations.partition{|a| a['type'] == 'highlight'}
+        highlights.each do |highlight|
+          match = others.find do |a|
+            a.fetch('segment', {})['spaceRelative'] == highlight['id']
+          end
+          match.merge! highlight if match
+        end
+        others
+      end
+    end
+  end
+end

data/lib/yt/annotations/label.rb

@@ -0,0 +1,10 @@
+require 'yt/annotations/note'
+
+module Yt
+  module Annotations
+    # A Label annotation is just a Note annotation with text, start/end time
+    # and an optional link, but shaped like a rectangle without borders.
+    class Label < Note
+    end
+  end
+end

data/lib/yt/annotations/note.rb

@@ -0,0 +1,45 @@
+require 'yt/annotations/base'
+
+module Yt
+  module Annotations
+    # A Note annotation is just a basic annotation with text, start/end time
+    # and an optional link. It's shaped like a Post-It with a curved corner.
+    class Note < Base
+      # @param [Hash] data the Hash representation of the XML data returned by
+      #   YouTube for each annotation of a video.
+      def initialize(data = {})
+        @text = data['TEXT']
+        @starts_at = to_seconds regions_of(data)[0]['t']
+        @ends_at = to_seconds regions_of(data)[1]['t']
+        @link = to_link data.fetch('action', {})['url']
+      end
+
+    private
+
+      def regions_of(data)
+        data['segment']['movingRegion']['rectRegion']
+      end
+
+      def to_seconds(timestamp)
+        timestamp.split(':').map(&:to_f).inject(0) {|sum, n| 60 * sum + n}
+      end
+
+      def to_link(url)
+        return unless url
+        new_window = url['target'] != 'current'
+        type = case url['link_class']
+          when '1' then :video
+          when '2' then :playlist
+          when '3' then :channel
+          when '4' then :profile
+          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
+    end
+  end
+end
+

data/lib/yt/annotations/speech.rb

@@ -0,0 +1,14 @@
+require 'yt/annotations/note'
+
+module Yt
+  module Annotations
+    # A Speech annotation is like a NOT annotation with text, start/end time
+    # and an optional link, but it's shaped like a speech bubble.
+    class Speech < Note
+    private
+      def regions_of(data)
+        data['segment']['movingRegion']['anchoredRegion']
+      end
+    end
+  end
+end

data/lib/yt/annotations/spotlight.rb

@@ -0,0 +1,10 @@
+require 'yt/annotations/note'
+
+module Yt
+  module Annotations
+    # A Spotlight annotation is like a Note annotation with text and start/end 
+    # time, but the text is below the click area.
+    class Spotlight < Note
+    end
+  end
+end

data/lib/yt/annotations/title.rb

@@ -0,0 +1,14 @@
+require 'yt/annotations/base'
+
+module Yt
+  module Annotations
+    # A Title annotation is like a Note annotation with text, start/end time,
+    # but cannot have a link. It's simply overlay text.
+    class Title < Note
+    private
+      def to_link(url)
+        nil
+      end
+    end
+  end
+end

data/lib/yt/annotations/version.rb

@@ -0,0 +1,5 @@
+module Yt
+  module Annotations
+    VERSION = '1.1.0'
+  end
+end

data/yt-annotations.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yt/annotations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yt-annotations'
+  spec.version       = Yt::Annotations::VERSION
+  spec.authors       = ['claudiob']
+  spec.email         = ['claudiob@gmail.com']
+
+  spec.summary       = %q{Fetch annotations and cards from YouTube videos.}
+  spec.description   = %q{A Ruby library to retrieve every type of annotation from
+    any YouTube video, including branding, featured content and info cards.}
+  spec.homepage      = 'https://github.com/fullscreen/yt-annotations'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'coveralls', '~> 0.8.2'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: yt-annotations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -102,7 +102,29 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yt/annotations.rb
+- lib/yt/annotations/base.rb
+- lib/yt/annotations/branding.rb
+- lib/yt/annotations/card.rb
+- lib/yt/annotations/featured.rb
+- lib/yt/annotations/for.rb
+- lib/yt/annotations/label.rb
+- lib/yt/annotations/note.rb
+- lib/yt/annotations/speech.rb
+- lib/yt/annotations/spotlight.rb
+- lib/yt/annotations/title.rb
+- lib/yt/annotations/version.rb
+- yt-annotations.gemspec
 homepage: https://github.com/fullscreen/yt-annotations
 licenses:
 - MIT