Merge pull request #20 from Fullscreen/bu

Bundle update dependencies

Author: claudiofullscreen

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!

lib/yt/annotations/end_screen.rb

@@ -4,7 +4,7 @@ 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']

lib/yt/annotations/for.rb

@@ -9,11 +9,16 @@
 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

lib/yt/annotations/version.rb

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

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         = ['[email protected]']
+  spec.authors       = ['Claudio Baccigalupo', 'Kang-Kyu Lee']
+  spec.email         = ['[email protected]', '[email protected]']
 
   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