Merge pull request #28 from Fullscreen/add-status-fields

Add all the video-related fields to Status

Gemfile.lock

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

HISTORY.md

@@ -2,6 +2,7 @@ v0.8 - 2014/07/18
 -----------------
 
 * [breaking change] channel.subscribe returns nil (not raise an error) when trying to subscribe to your own channel
+* Add all the status fields to Video (upload status, failure reason, rejection reason, scheduled time, license, embeddable, public stats viewable)
 
 v0.7 - 2014/06/18
 -----------------

README.md

@@ -41,7 +41,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.8.0'
+    gem 'yt', '~> 0.8.1'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -201,13 +201,40 @@ video.description #=> "The new Fullscreen Creator Platform gives creators and br
 video.description.has_link_to_channel? #=> true
 video.thumbnail_url #=> "https://i1.ytimg.com/vi/MESycYJytkU/default.jpg"
 video.published_at #=> 2013-07-09 16:27:32 UTC
-video.public? #=> true
 video.tags #=> []
 video.channel_id #=> "UCxO1tY8h1AhOz0T4ENwmpow"
 video.channel_title #=> "Fullscreen"
 video.category_id #=> "22"
 video.live_broadcast_content #=> "none"
 
+video.public? #=> true
+video.uploaded? #=> false
+video.rejected? #=> false
+video.failed? #=> true
+video.processed? #=> false
+video.deleted? #=> false
+video.uses_unsupported_codec? #=> true
+video.has_failed_conversion? #=> false
+video.empty? #=> false
+video.invalid? #=> false
+video.too_small? #=> false
+video.aborted? #=> false
+video.claimed? #=> false
+video.infringes_copyright? #=> false
+video.duplicate? #=> false
+video.inappropriate? #=> false
+video.too_long? #=> false
+video.violates_terms_of_use? #=> false
+video.infringes_trademark? #=> false
+video.belongs_to_closed_account? #=> false
+video.belongs_to_suspended_account? #=> false
+video.scheduled? #=> true
+video.scheduled_at #=> Tue, 27 May 2014 12:50:00
+video.licensed_as_creative_commons? #=> true
+video.licensed_as_standard_youtube? #=> false
+video.embeddable? #=> false
+video.has_public_stats_viewable? #=> false
+
 video.duration #=> 86
 video.hd? #=> true
 video.stereoscopic? #=> false

lib/yt/models/status.rb

@@ -1,8 +1,14 @@
 module Yt
   module Models
-    # Encapsulates information about the privacy status of a resource, for
-    # instance a channel.
+    # Contains information about the status of a resource. The details of the
+    # status are different for the different types of resources.
+    #
+    # Resources with a
+    # status are: channels, playlists, playlist items and videos.
     # @see https://developers.google.com/youtube/v3/docs/channels#resource
+    # @see https://developers.google.com/youtube/v3/docs/videos#resource
+    # @see https://developers.google.com/youtube/v3/docs/playlists#resource
+    # @see https://developers.google.com/youtube/v3/docs/playlistItems#resource
     class Status
       def initialize(options = {})
         @data = options[:data]
@@ -32,6 +38,282 @@ def private?
       def unlisted?
         privacy_status == 'unlisted'
       end
+
+# Upload status (Video only)
+
+      # Returns the upload status of a video.
+      # @return [String] if the resource is a video, the status of the
+      #   uploaded video. Valid values are: deleted, failed, processed,
+      #   rejected, uploaded.
+      # @return [nil] if the resource is not a video.
+      def upload_status
+        @upload_status ||= @data['uploadStatus']
+      end
+
+      # Returns whether an uploaded video was deleted.
+      # @return [Boolean] if the resource is a video, whether the uploaded
+      #   video was deleted by the user.
+      # @return [nil] if the resource is not a video.
+      def deleted?
+        upload_status == 'deleted' if video?
+      end
+
+      # Returns whether a video failed to upload. If true, the reason why
+      # the video upload failed can be obtained with +failure_reason+.
+      # @return [Boolean] if the resource is a video, whether the video failed
+      #   to upload.
+      # @return [nil] if the resource is not a video.
+      def failed?
+        upload_status == 'failed' if video?
+      end
+
+      # Returns whether an uploaded video is being processed by YouTube.
+      # @return [Boolean] if the resource is a video, whether the uploaded
+      #   video is being processed by YouTube.
+      # @return [nil] if the resource is not a video.
+      def processed?
+        upload_status == 'processed' if video?
+      end
+
+      # Returns whether the video was rejected by YouTube. If true, the reason
+      # why the video was rejected can be obtained with +rejection_reason+.
+      # @return [Boolean] if the resource is a video, whether the video was
+      #  rejected by YouTube.
+      # @return [nil] if the resource is not a video.
+      def rejected?
+        upload_status == 'rejected' if video?
+      end
+
+      # Returns whether a video was successfully uploaded to YouTube.
+      # @return [Boolean] if the resource is a video, whether the video was
+      #   successfully uploaded.
+      # @return [nil] if the resource is not a video.
+      def uploaded?
+        upload_status == 'uploaded' if video?
+      end
+
+# Failure reason (Video only)
+
+      # Returns the reason why a video failed to upload.
+      # @return [String] if resource is a video with a 'failed' upload status,
+      #   the reason why the video failed to upload. Valid values are: codec,
+      #   conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      def failure_reason
+        @failure_reason ||= @data['failureReason']
+      end
+
+      # Returns whether a video upload failed because of the codec.
+      # @return [Boolean] if the resource is a video, whether the video uses
+      #   a codec not supported by YouTube.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      # @see https://support.google.com/youtube/answer/1722171
+      def uses_unsupported_codec?
+        failure_reason == 'codec' if video?
+      end
+
+      # Returns whether YouTube was unable to convert an uploaded video.
+      # @return [Boolean] if the resource is a video, whether YouTube was
+      #   unable to convert the video.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      def has_failed_conversion?
+        failure_reason == 'conversion' if video?
+      end
+
+      # Returns whether a video upload failed because the file was empty.
+      # @return [Boolean] if the resource is a video, whether the video file
+      #   is empty.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      def empty?
+        failure_reason == 'emptyFile' if video?
+      end
+
+      # Returns whether a video upload failed because of the file format.
+      # @return [Boolean] if the resource is a video, whether the video uses
+      #   a file format not supported by YouTube.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      # @see https://support.google.com/youtube/troubleshooter/2888402?hl=en
+      def invalid?
+        failure_reason == 'invalidFile' if video?
+      end
+
+      # Returns whether a video upload failed because the file was too small.
+      # @return [Boolean] if the resource is a video, whether the video file
+      #   is too small for YouTube.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      def too_small?
+        failure_reason == 'tooSmall' if video?
+      end
+
+      # Returns whether a video upload failed because the upload was aborted.
+      # @return [Boolean] if the resource is a video, whether the uploading
+      #   process was aborted.
+      # @return [nil] if the resource is not a video or upload has not failed.
+      def aborted?
+        failure_reason == 'uploadAborted' if video?
+      end
+
+# Rejection reason (Video only)
+
+      # Returns the reason why a video was rejected by YouTube.
+      # @return [String] if resource is a video with a 'rejected' upload
+      #   status, the reason why the video was rejected. Valid values are:
+      #   claim, copyright, duplicate, inappropriate, length, termsOfUse,
+      #   trademark, uploaderAccountClosed, uploaderAccountSuspended.
+      # @return [nil] if the resource is not a rejected video.
+      def rejection_reason
+        @rejection_reason ||= @data['rejectionReason']
+      end
+
+      # Returns whether a video was rejected because it was claimed.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video was claimed by a different account.
+      # @return [nil] if the resource is not a rejected video.
+      def claimed?
+        rejection_reason == 'claim' if video?
+      end
+
+      # Returns whether a video was rejected because of copyright infringement.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video commits a copyright infringement.
+      # @return [nil] if the resource is not a rejected video.
+      def infringes_copyright?
+        rejection_reason == 'copyright' if video?
+      end
+
+      # Returns whether a video was rejected because it is a duplicate.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video is a duplicate of another uploaded video.
+      # @return [nil] if the resource is not a rejected video.
+      def duplicate?
+        rejection_reason == 'duplicate' if video?
+      end
+
+      # Returns whether a video was rejected because of inappropriate content.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video contains inappropriate content.
+      # @return [nil] if the resource is not a rejected video.
+      def inappropriate?
+        rejection_reason == 'inappropriate' if video?
+      end
+
+      # Returns whether a video was rejected because it is too long.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video exceeds the maximum duration.
+      # @return [nil] if the resource is not a rejected video.
+      # @see https://support.google.com/youtube/answer/71673?hl=en
+      def too_long?
+        rejection_reason == 'length' if video?
+      end
+
+      # Returns whether a video was rejected because it violates terms of use.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video commits a terms of use violation.
+      # @return [nil] if the resource is not a rejected video.
+      def violates_terms_of_use?
+        rejection_reason == 'termsOfUse' if video?
+      end
+
+      # Returns whether a video was rejected because of trademark infringement.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   video commits a trademark infringement.
+      # @return [nil] if the resource is not a rejected video.
+      # @see https://support.google.com/youtube/answer/2801979?hl=en
+      def infringes_trademark?
+        rejection_reason == 'trademark' if video?
+      end
+
+      # Returns whether a video was rejected because the account was closed.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   account associated with the video has been closed.
+      # @return [nil] if the resource is not a rejected video.
+      def belongs_to_closed_account?
+        rejection_reason == 'uploaderAccountClosed' if video?
+      end
+
+      # Returns whether a video was rejected because the account was suspended.
+      # @return [Boolean] if the resource is a rejected video, whether the
+      #   account associated with the video has been suspended.
+      # @return [nil] if the resource is not a rejected video.
+      def belongs_to_suspended_account?
+        rejection_reason == 'uploaderAccountSuspended' if video?
+      end
+
+# Scheduled publication (Video only)
+
+      # Returns the date and time when a video is scheduled to be published.
+      # @return [Time] if resource is a private video scheduled to be
+      #   published, the date and time when the video is scheduled to publish.
+      # @return [nil] if the resource is not a private video scheduled to be
+      #   published.
+      def scheduled_at
+        @scheduled_at ||= Time.parse @data['publishAt'] if scheduled?
+      end
+
+      # Returns whether the video is scheduled to be published.
+      # @return [Boolean] if the resource is a video, whether it is currently
+      #   private and is scheduled to become public in the future.
+      # @return [nil] if the resource is not a video.
+      def scheduled?
+        private? && @data['publishAt'] if video?
+      end
+
+# License (Video only)
+
+      # Returns the video’s license.
+      # @return [String] if resource is a video, its license. Valid values are:
+      #   creativeCommon, youtube.
+      # @return [nil] if the resource is not a video.
+      def license
+        @license ||= @data['license']
+      end
+
+      # Returns whether the video uses a Creative Commons license.
+      # @return [Boolean] if the resource is a video, whether it uses a
+      #   Creative Commons license.
+      # @return [nil] if the resource is not a video.
+      # @see https://support.google.com/youtube/answer/2797468?hl=en
+      def licensed_as_creative_commons?
+        license == 'creativeCommon' if video?
+      end
+
+      # Returns whether the video uses the Standard YouTube license.
+      # @return [Boolean] if the resource is a video, whether it uses the
+      #   Standard YouTube license.
+      # @return [nil] if the resource is not a video.
+      # @see https://www.youtube.com/static?template=terms
+      def licensed_as_standard_youtube?
+        license == 'youtube' if video?
+      end
+
+# Embed (Video only)
+
+      # Returns whether the video can be embedded on another website.
+      # @return [Boolean] if the resource is a video, whether it can be
+      #   embedded on another website.
+      # @return [nil] if the resource is not a video.
+      def embeddable?
+        @embeddable ||= @data['embeddable']
+      end
+
+# Public stats (Video only)
+
+      # Returns whether the video statistics are publicly viewable.
+      # @return [Boolean] if the resource is a video, whether the extended
+      #   video statistics on the video’s watch page are publicly viewable.
+      #   By default, those statistics are viewable, and statistics like a
+      #   video’s viewcount and ratings will still be publicly visible even
+      #   if this property’s value is set to false.
+      # @return [nil] if the resource is not a video.
+      def has_public_stats_viewable?
+        @public_stats_viewable ||= @data['publicStatsViewable']
+      end
+
+    private
+
+      def video?
+        upload_status.present?
+      end
     end
   end
 end

lib/yt/models/video.rb

@@ -8,6 +8,15 @@ class Video < Resource
       delegate :tags, :channel_id, :channel_title, :category_id,
         :live_broadcast_content, to: :snippet
 
+      delegate :deleted?, :failed?, :processed?, :rejected?, :uploaded?,
+        :uses_unsupported_codec?, :has_failed_conversion?, :empty?, :invalid?,
+        :too_small?, :aborted?, :claimed?, :infringes_copyright?, :duplicate?,
+        :scheduled_at, :scheduled?, :too_long?, :violates_terms_of_use?,
+        :inappropriate?, :infringes_trademark?, :belongs_to_closed_account?,
+        :belongs_to_suspended_account?, :licensed_as_creative_commons?,
+        :licensed_as_standard_youtube?, :has_public_stats_viewable?,
+        :embeddable?, to: :status
+
       # @!attribute [r] content_detail
       #   @return [Yt::Models::ContentDetail] the video’s content details.
       has_one :content_detail

lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end