yt 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec366e6612cd8a61ec3067f58c819426b4da21ad
-  data.tar.gz: 3708e2efffd1b660afe370630d2f9b86e23f9e59
+  metadata.gz: 8c7f28e1adc91466df73429cd2e12988092acabd
+  data.tar.gz: a66cb8c64a3764ffcad1e1988fa025ca5a9d5094
 SHA512:
-  metadata.gz: 33b816e4a002b24218b08b602c1faf999c854e04fa2edd3a3c84127ee0860463fe68ef8a07577d18830443497347ce55f968320503e5f27706b9e558be3cd884
-  data.tar.gz: 7e802cf425854455fd936424312f1343ce82a7bd35032b373cfb17df6b2c811525668013e91e2d7b7c3999725cf93d211e042981ff8dbbe55d58e7a3fa0eace5
+  metadata.gz: b422e2ac62121f98113de5a65f53c2925009ddc3dc78737ffa9c145427201eb53df3723ebe0cdde108f5dfcfa05655c3bea9413ec03309e363075214a01b760a
+  data.tar.gz: 90bcf64d69cbb1161f694d22b5782cedcc0668f34025824fdea4da2e396af80a28b263abf9f52b0508cf14f7fe14c8f75ae49788cdc520e6b0395d9e5f4ada08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yt (0.6.4)
+    yt (0.6.5)
       activesupport
 
 GEM

data/HISTORY.md

@@ -7,6 +7,7 @@ v0.6 - 2014/06/05
 * Allow account.videos to be chained with .where, such as in account.videos.where(q: 'query')
 * Retry request once when YouTube times out
 * Handle annotations with "never" as the timestamp, without text, singleton positions, of private videos
+* New methods for Video: hd?, stereoscopic?, captioned?, licensed?
 
 v0.5 - 2014/05/16
 -----------------

data/README.md

@@ -27,6 +27,10 @@ video = Yt::Video.new id: 'MESycYJytkU'
 video.title #=> "Fullscreen Creator Platform"
 video.public? #=> true
 video.duration #=> 86
+video.hd? #=> true
+video.stereoscopic? #=> false
+video.captioned? #=> true
+video.licensed? #=> false
 video.annotations.count #=> 1
 ```
 
@@ -332,7 +336,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.6.4'
+    gem 'yt', '~> 0.6.5'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/TODO.md

@@ -1,13 +1,58 @@
 * methods like Yt::Account.new(params = {}) should use HashWithIndifferentAccess
 * add canonical_url to Resource, then use it in promo
 
-* once in a while, Google fails with 500 error and just retrying after some
-seconds fixes it, so we should retry every 500 at least
+List of supported methods
+=========================
 
-* find by url (either video or channel or.. playlist)
-* Google accounts?
-* ENV support
+YouTube Data API V3 (https://developers.google.com/youtube/v3/docs)
+-------------------------------------------------------------------
 
-* operations like subscribe that require authentication should not fail if
-called on Yt::Channel without auth but, similarly to account, show the prompt
-or ask for the device code
+- [ ] Activities
+  - [ ] list
+  - [ ] insert
+- [ ] ChannelBanners
+  - [ ] insert
+- [ ] Channels
+  - [ ] list
+  - [ ] update
+- [ ] ChannelSections
+  - [ ] list
+  - [ ] insert
+  - [ ] update
+  - [ ] delete
+- [ ] GuideCategories
+  - [ ] list
+- [ ] I18nLanguages
+  - [ ] list
+- [ ] I18nRegions
+  - [ ] list
+- [ ] PlaylistItems
+  - [ ] list
+  - [ ] insert
+  - [ ] update
+  - [ ] delete
+- [ ] Playlists
+  - [ ] list
+  - [ ] insert
+  - [ ] update
+  - [ ] delete
+- [ ] Search
+  - [ ] list
+- [ ] Subscriptions
+  - [ ] list
+  - [ ] insert
+  - [ ] delete
+- [ ] Thumbnails
+  - [ ] set
+- [ ] VideoCategories
+  - [ ] list
+- [ ] Videos
+  - [ ] list
+  - [ ] insert
+  - [ ] update
+  - [ ] rate
+  - [ ] getRating
+  - [ ] delete
+- [ ] Watermarks
+  - [ ] set
+  - [ ] unset

data/bin/yt

@@ -23,4 +23,8 @@ channel.videos.each do |video|
   puts "  Description: #{video.description}"
   puts "  Thumbnail: #{video.thumbnail_url}"
   puts "  Public? #{video.public?}"
+  puts "  hd? #{video.hd?}"
+  puts "  stereoscopic? #{video.stereoscopic?}"
+  puts "  captioned? #{video.captioned?}"
+  puts "  licensed? #{video.licensed?}"
 end

data/lib/yt/actions/delete_all.rb

@@ -8,9 +8,9 @@ module Yt
 
     private
 
-      def do_delete_all(params = {})
+      def do_delete_all(params = {}, options = {})
         list_all(params).map do |item|
-          item.delete
+          item.delete options
         end.tap { @items = [] }
       end
 

data/lib/yt/actions/list.rb

@@ -8,7 +8,7 @@ module Yt
       alias size count
 
       def first!
-        first.tap{|item| raise Errors::NoItems unless item}
+        first.tap{|item| raise Errors::NoItems, last_request unless item}
       end
 
     private
@@ -48,13 +48,20 @@ module Yt
       end
 
       def fetch_page(params = {})
-        request = Yt::Request.new params
-        response = request.run
+        response = request(params).run
         token = response.body['nextPageToken']
         items = response.body.fetch items_key, []
         {items: items, token: token}
       end
 
+      def request(params = {})
+        @last_request = Yt::Request.new params
+      end
+
+      def last_request
+        @last_request.request_error_message if @last_request
+      end
+
       def list_params
         path = "/youtube/v3/#{list_resources.to_s.demodulize.camelize :lower}"
 

data/lib/yt/collections/reports.rb

@@ -40,9 +40,10 @@ module Yt
         data.last
       end
 
-      def metrics
-        ''
-      end
+      # To be overriden by superclasses
+      # def metrics
+      #   ''
+      # end
 
       def items_key
         'rows'

data/lib/yt/collections/subscriptions.rb

@@ -15,7 +15,7 @@ module Yt
 
       def delete_all(params = {}, options = {})
         throttle
-        do_delete_all params
+        do_delete_all params, options
       end
 
     private

data/lib/yt/models/channel.rb

@@ -4,7 +4,7 @@ require 'yt/associations/views'
 
 module Yt
   module Models
-    # Provides methods to interact with YouTube channels.
+    # A channel resource contains information about a YouTube channel.
     # @see https://developers.google.com/youtube/v3/docs/channels
     class Channel < Resource
       include Associations::Earnings

data/lib/yt/models/details_set.rb

@@ -2,8 +2,8 @@ require 'yt/models/base'
 
 module Yt
   module Models
-    # Encapsulates information about the content of a resource, for
-    # instance a video.
+    # Encapsulates information about the video content, including the length
+    # of the video and an indication of whether captions are available.
     # @see https://developers.google.com/youtube/v3/docs/videos#resource
     class DetailsSet < Base
 
@@ -11,9 +11,30 @@ module Yt
         @data = options[:data]
       end
 
-      # @return [Integer] the duration of the resource (in seconds).
+      # @return [Integer] the duration of the video (in seconds).
       def duration
-        @duration = to_seconds @data.fetch('duration', 0)
+        @duration ||= to_seconds @data.fetch('duration', 0)
+      end
+
+      # @return [Boolean] whether the video is available in 3D.
+      def stereoscopic?
+        @stereoscopic ||= @data['dimension'] == '3d'
+      end
+
+      # @return [Boolean] whether the video is available in high definition.
+      def hd?
+        @hd ||= @data['definition'] == 'hd'
+      end
+
+      # @return [Boolean] whether captions are available for the video.
+      def captioned?
+        @hd ||= @data['caption'] == 'true'
+      end
+
+      # @return [Boolean] whether the video represents licensed content, which
+      #   means that the content has been claimed by a YouTube content partner.
+      def licensed?
+        @licensed ||= @data.fetch 'licensedContent', false
       end
 
     private

data/lib/yt/models/playlist.rb

@@ -17,7 +17,7 @@ module Yt
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an account with permissions to delete the playlist.
       # @return [Boolean] whether the playlist does not exist anymore.
-      def delete
+      def delete(options = {})
         do_delete {@id = nil}
         !exists?
       end

data/lib/yt/models/playlist_item.rb

@@ -24,7 +24,7 @@ module Yt
         end
       end
 
-      def delete
+      def delete(options = {})
         do_delete {@id = nil}
         !exists?
       end

data/lib/yt/models/request.rb

@@ -19,7 +19,7 @@ module Yt
         @body_type = options.fetch :body_type, :json
         @expected_response = options.fetch :expected_response, Net::HTTPSuccess
         @format = options.fetch :format, :json
-        @headers = options.fetch :headers, {}
+        @headers = options.fetch :headers, gzip_headers
         @host = options.fetch :host, google_api_host
         @method = options.fetch :method, :get
         @path = options[:path]
@@ -34,6 +34,13 @@ module Yt
         end
       end
 
+      def request_error_message
+        {}.tap do |message|
+          message[:request_curl] = as_curl
+          message[:response_body] = JSON(response.body) rescue response.inspect
+        end.to_json
+      end
+
     private
 
       def response
@@ -59,6 +66,19 @@ module Yt
         @headers.each{|name, value| request.add_field name, value}
       end
 
+      # To receive a gzip-encoded response you must do two things:
+      # - Set the Accept-Encoding HTTP request header to gzip.
+      # - Modify your user agent to contain the string gzip.
+      # Note that HTTP headers are case-insensitive.
+      # @see https://developers.google.com/youtube/v3/getting-started#gzip
+      # @see http://www.ietf.org/rfc/rfc2616.txt
+      def gzip_headers
+        @gzip_headers ||= {}.tap do |headers|
+          headers['accept-encoding'] = 'gzip'
+          headers['user-agent'] = 'Yt (gzip)'
+        end
+      end
+
       def set_body!(request)
         case @body_type
           when :json then request.body = @body.to_json
@@ -157,17 +177,11 @@ module Yt
         end
       end
 
-      def request_error_message
-        {}.tap do |message|
-          message[:request_curl] = as_curl
-          message[:response_body] = JSON(response.body) rescue response.inspect
-        end.to_json
-      end
-
       def as_curl
         'curl'.tap do |curl|
           curl <<  " -X #{http_request.method}"
           http_request.each_header do |name, value|
+            next if gzip_headers.has_key? name
             curl << %Q{ -H "#{name}: #{value}"}
           end
           curl << %Q{ -d '#{http_request.body}'} if http_request.body

data/lib/yt/models/subscription.rb

@@ -19,6 +19,7 @@ module Yt
         rescue Yt::Error => error
           ignorable_errors = error.reasons & ['subscriptionNotFound']
           raise error unless options[:ignore_errors] && ignorable_errors.any?
+          @id = nil
         end
         !exists?
       end

data/lib/yt/models/video.rb

@@ -8,7 +8,7 @@ module Yt
       # @!attribute [r] details_set
       #   @return [Yt::Models::DetailsSet] the video’s content details.
       has_one :details_set
-      delegate :duration, to: :details_set
+      delegate :duration, :hd?, :stereoscopic?, :captioned?, :licensed?, to: :details_set
 
       # @!attribute [r] rating
       #   @return [Yt::Models::Rating] the video’s rating.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.6.4'
+  VERSION = '0.6.5'
 end

data/spec/models/details_set_spec.rb

@@ -25,4 +25,52 @@ describe Yt::DetailsSet do
       it { expect(details_set.duration).to eq 51 }
     end
   end
+
+  describe '#stereoscopic?' do
+    context 'given a 3D video' do
+      let(:data) { {"dimension"=>"3d"} }
+      it { expect(details_set).to be_stereoscopic }
+    end
+
+    context 'given a 2D video' do
+      let(:data) { {"dimension"=>"2d"} }
+      it { expect(details_set).not_to be_stereoscopic }
+    end
+  end
+
+  describe '#hd?' do
+    context 'given a high-definition video' do
+      let(:data) { {"definition"=>"hd"} }
+      it { expect(details_set).to be_hd }
+    end
+
+    context 'given a standard-definition video' do
+      let(:data) { {"definition"=>"sd"} }
+      it { expect(details_set).not_to be_hd }
+    end
+  end
+
+  describe '#captioned?' do
+    context 'given a video with captions' do
+      let(:data) { {"caption"=>"true"} }
+      it { expect(details_set).to be_captioned }
+    end
+
+    context 'given a video without captions' do
+      let(:data) { {"caption"=>"false"} }
+      it { expect(details_set).not_to be_captioned }
+    end
+  end
+
+  describe '#captioned?' do
+    context 'given a video with licensed content' do
+      let(:data) { {"licensedContent"=>true} }
+      it { expect(details_set).to be_licensed }
+    end
+
+    context 'given a video without licensed content' do
+      let(:data) { {"licensedContent"=>false} }
+      it { expect(details_set).not_to be_licensed }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport