yt-annotations 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5af7335a71c02853df3dc551ac1644636fbfeb08
-  data.tar.gz: 972ddc78ffc07d534dc907218a3187bcb8bc0b89
+  metadata.gz: e90f02ea969bbc11df732a40a5e2f943b24507f1
+  data.tar.gz: 05bbc8a4ba7fb944e4e77cd211406cdd4fa07b3c
 SHA512:
-  metadata.gz: ab38e436b2323ee00fbd2d9643c44138f9c4b3dabbb7f12ae787a2ab47002b44eafc19765519559954f49bdbe43b685939a5886f63239b248c76f3f7258efc48
-  data.tar.gz: 72cc855dea18be49d1a17db7662eecbd6874c5cb536936847d3a72900e4639fb569462e599dd06332fbce59b04824d1e1b3a0c19208314473391ad35a7748421
+  metadata.gz: 8a20ea07b37fb8e6a6545dc49233084907f368fbb01265b1f95bedb86e046fa438f370cda210f8e0e22c663e757731d269e52232804c9bd0fc601eeeda7b13c6
+  data.tar.gz: 2d3675386a5c15030081f27b4f4d27dfddce214166a10f397e74cf17f3b54f5637625dd04ab0a722182c9e0628102c37cbfd13d4e59c9f84f3cdd9835dd40199

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 cache: bundler
 rvm:
   - 2.2.2
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/CHANGELOG.md

@@ -7,6 +7,10 @@ For more information about changelogs, check
 [Vandamme](http://tech-angels.github.io/vandamme).
 
 
+## 1.4.2 - 2017.05.24
+
+* [BUGFIX] Do not raise errors from endscreens with different title format
+
 ## 1.4.1 - 2017.03.31
 
 * [BUGFIX] Change `EndScreen` according to its endpoint change on YouTube

data/README.md

@@ -37,14 +37,17 @@ Yt::Annotations requires **Ruby 2.2.2 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.
+Contribute to the code by forking the project, adding the missing code,
+writing the appropriate tests and submitting a pull request.
 
-All pull requests will have to make Travis and Code Climate happy in order to be accepted. :kissing_smiling_eyes:
+In order for a PR to be approved, all the tests need to pass and all the public
+methods need to be documented and listed in the guides. Remember:
 
-You can also run the tests locally with `bundle exec rspec`.
+- to run all tests locally: `bundle exec rspec`
+- to generate the docs locally: `bundle exec yard`
+- to list undocumented methods: `bundle exec yard stats --list-undoc`
 
-Happy hacking!

data/lib/yt/annotations/end_screen.rb

@@ -4,10 +4,10 @@ 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
+      # @param [Hash] json the Hash representation of the XML data returned by
       #   YouTube for each end screen of a video.
       def initialize(json = {})
-        @text = json['title']['runs'][0]['text']
+        @text = text_in json
         @starts_at = json['startMs'].to_i / 1000.0
         @ends_at = ends_at_in json
         @link = to_link json
@@ -15,6 +15,14 @@ module Yt
 
     private
 
+      def text_in(json)
+        if json['title']['runs'].nil?
+          json['title']['simpleText']
+        else
+          json['title']['runs'][0]['text']
+        end
+      end
+
       def ends_at_in(json)
         json['endMs'].to_i / 1000.0
       end

data/lib/yt/annotations/for.rb

@@ -9,11 +9,16 @@ require 'yt/annotations/spotlight'
 require 'yt/annotations/title'
 require 'yt/annotations/pause'
 
+# An object-oriented Ruby client for YouTube.
+# @see http://www.rubydoc.info/gems/yt/
 module Yt
   module Annotations
+    # Provides a method to fetch annotations and cards for a YouTube video.
     module For
+      # @param [String] video_id the unique ID of a YouTube video.
+      # @return [Array<Yt::Annotation>] the annotations/end cards of the video.
       def for(video_id)
-        (annotations(video_id) + end_screens(video_id)).sort_by &:starts_at
+        (annotations(video_id) + end_screens(video_id)).sort_by(&:starts_at)
       end
 
     private

data/lib/yt/annotations/version.rb

@@ -1,5 +1,8 @@
 module Yt
+  # Provides functionality to fetch annotations and cards from YouTube videos.
   module Annotations
-    VERSION = '1.4.1'
+    # @return [String] the SemVer-compatible gem version.
+    # @see http://semver.org
+    VERSION = '1.4.2'
   end
 end

data/yt-annotations.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ['Claudio Baccigalupo', 'Kang-Kyu Lee']
+  spec.email         = ['claudio@fullscreen.net', 'kang-kyu.lee@fullscreen.net']
 
   spec.summary       = %q{Fetch annotations and cards from YouTube videos.}
   spec.description   = %q{A Ruby library to retrieve every type of annotation from
@@ -17,16 +17,19 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4', '< 6'
 
-  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.10'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.20'
   spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'yard', '~> 0.9.8'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yt-annotations
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
-- claudiob
+- Claudio Baccigalupo
+- Kang-Kyu Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,56 +37,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.10
+        version: 0.8.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.10
+        version: 0.8.20
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -100,11 +101,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
 description: |-
   A Ruby library to retrieve every type of annotation from
       any YouTube video, including branding, featured content and info cards.
 email:
-- claudiob@gmail.com
+- claudio@fullscreen.net
+- kang-kyu.lee@fullscreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Fetch annotations and cards from YouTube videos.