yt 0.0.1 → 0.4.0

data/lib/yt/models/details_set.rb

@@ -0,0 +1,31 @@
+module Yt
+  class DetailsSet < Base
+
+    def initialize(options = {})
+      @data = options[:data]
+    end
+
+    # Return the duration of the YouTube video.
+    #
+    # @return [Integer] Duration in seconds of the YouTube video
+    def duration
+      @duration = to_seconds @data.fetch('duration', 0)
+    end
+    # also available: dimension, definition, caption, licensed_content?
+
+  private
+
+    # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S,
+    # in which the letters PT indicate that the value specifies a period of time, and
+    # the letters M and S refer to length in minutes and seconds, respectively. The #
+    # characters preceding the M and S letters are both integers that specify the number
+    # of minutes (or seconds) of the video. For example, a value of PT15M51S indicates
+    # that the video is 15 minutes and 51 seconds long.
+    def to_seconds(iso8601_duration)
+      match = iso8601_duration.match %r{^PT(?:|(?<min>\d*?)M)(?:|(?<sec>\d*?)S)$}
+      minutes = (match[:min] || '0').to_i
+      seconds = (match[:sec]).to_i
+      minutes * 60 + seconds
+    end
+  end
+end

data/lib/yt/models/playlist.rb

@@ -0,0 +1,65 @@
+require 'yt/models/base'
+
+module Yt
+  class Playlist < Base
+    attr_reader :id, :auth
+    has_one :snippet, delegate: [:title, :description, :tags, :thumbnail_url, :published_at]
+    has_one :status, delegate: [:privacy_status, :public?, :private?, :unlisted?]
+    has_many :playlist_items
+
+    def initialize(options = {})
+      @id = options[:id]
+      @snippet = Snippet.new(data: options[:snippet]) if options[:snippet]
+      @status = Status.new(data: options[:status]) if options[:status]
+      @auth = options[:auth]
+    end
+
+    def delete
+      do_delete {@id = nil}
+      !exists?
+    end
+
+    # Valid body (no defaults) are: title (string), description (string), privacy_status (string),
+    # tags (array of strings) - since title is required, we set it again if it's not passed
+    def update(options = {})
+      parts, body = [], {id: @id}
+
+      options[:title] ||= title
+      parts << :snippet
+      body[:snippet] = options.slice :title, :description, :tags
+
+      if status = options[:privacy_status]
+        parts << :status
+        body[:status] = {privacyStatus: status}
+      end
+
+      params = {params: {part: parts.join(',')}, body: body}
+      do_update(params, expect: Net::HTTPOK) do |data|
+        @id = data['id']
+        @snippet = Snippet.new data: data['snippet'] if data['snippet']
+        @status = Status.new data: data['status'] if data['status']
+        true
+      end
+    end
+
+    def exists?
+      !@id.nil?
+    end
+
+  private
+
+    def delete_params
+      super.tap do |params|
+        params[:path] = '/youtube/v3/playlists'
+        params[:params] = {id: @id}
+      end
+    end
+
+    def update_params
+      super.tap do |params|
+        params[:path] = '/youtube/v3/playlists'
+        params[:body_type] = :json
+      end
+    end
+  end
+end

data/lib/yt/models/playlist_item.rb

@@ -0,0 +1,42 @@
+require 'yt/models/base'
+
+module Yt
+  class PlaylistItem < Base
+    attr_reader :id, :video, :position
+
+    def initialize(options = {})
+      @id = options[:id]
+      @auth = options[:auth]
+      if options[:snippet]
+        @position = options[:snippet]['position']
+        @video = Video.new video_params_for options
+      end
+    end
+
+    def delete
+      do_delete {@id = nil}
+      !exists?
+    end
+
+    def exists?
+      !@id.nil?
+    end
+
+  private
+
+    def delete_params
+      super.tap do |params|
+        params[:path] = '/youtube/v3/playlistItems'
+        params[:params] = {id: @id}
+      end
+    end
+
+    def video_params_for(options = {})
+      {}.tap do |params|
+        params[:id] = options[:snippet].fetch('resourceId', {})['videoId']
+        params[:snippet] = options[:snippet].except 'resourceId'
+        params[:auth] = options[:auth]
+      end
+    end
+  end
+end

data/lib/yt/models/rating.rb

@@ -0,0 +1,28 @@
+require 'yt/models/base'
+
+module Yt
+  class Rating < Base
+    attr_reader :rating
+
+    def initialize(options = {})
+      @rating = options[:rating].to_sym if options[:rating]
+      @video_id = options[:video_id]
+      @auth = options[:auth]
+    end
+
+    def update(new_rating)
+      do_update(params: {rating: new_rating}) {@rating = new_rating}
+    end
+
+  private
+
+    def update_params
+      super.tap do |params|
+        params[:method] = :post
+        params[:path] = '/youtube/v3/videos/rate'
+        params[:params] = {id: @video_id}
+        params[:scope] = 'https://www.googleapis.com/auth/youtube'
+      end
+    end
+  end
+end

data/lib/yt/models/snippet.rb

@@ -0,0 +1,48 @@
+require 'yt/models/description'
+
+module Yt
+  class Snippet
+    def initialize(options = {})
+      @data = options[:data]
+    end
+
+    # Return the title of the YouTube resource.
+    #
+    # @return [String] Title of the YouTube resource
+    def title
+      @title ||= @data.fetch 'title', ''
+    end
+
+    # Return the description of a YouTube resource.
+    #
+    # @return [Yt::Description] A Yt::Description object for the YouTube resource
+    def description
+      @description ||= Description.new @data.fetch('description', '')
+    end
+
+    # Return the publication date of a YouTube resource.
+    #
+    # @return [Time or nil] The publication date for the YouTube resource
+    def published_at
+      @published_at ||= Time.parse @data['publishedAt']
+    end
+
+    # Return the tags of a YouTube resource.
+    #
+    # @return [Array] An array of Yt::Tag object, one for each tag of the resource.
+    #
+    # @note YouTube API only includes tags in a resource’s snippet if the
+    #       resource is a video belonging to the authenticated account.
+    def tags
+      @tags ||= @data.fetch 'tags', []
+    end
+
+    # Return the URL of a thumbnail image of the YouTube resource.
+    #
+    # @return [String] A URL.
+    def thumbnail_url(size = :default)
+      @thumbnails ||= @data.fetch 'thumbnails', {}
+      @thumbnails.fetch(size.to_s, {})['url']
+    end
+  end
+end

data/lib/yt/models/status.rb

@@ -0,0 +1,26 @@
+module Yt
+  class Status
+    def initialize(options = {})
+      @data = options[:data]
+    end
+
+    # @return [Boolean] Is the resource public?
+    def public?
+      privacy_status == 'public'
+    end
+
+    # @return [Boolean] Is the resource private?
+    def private?
+      privacy_status == 'private'
+    end
+
+    # @return [Boolean] Is the resource unlisted?
+    def unlisted?
+      privacy_status == 'unlisted'
+    end
+
+    def privacy_status
+      @privacy_status ||= @data['privacyStatus']
+    end
+  end
+end

data/lib/yt/models/subscription.rb

@@ -0,0 +1,35 @@
+require 'yt/models/base'
+
+module Yt
+  class Subscription < Base
+
+    attr_reader :id
+
+    def initialize(options = {})
+      @id = options[:id]
+      @auth = options[:auth]
+    end
+
+    def delete(options = {})
+      begin
+        do_delete {@id = nil}
+      rescue Yt::RequestError => error
+        raise error unless options[:ignore_not_found] && error.reasons.include?('subscriptionNotFound')
+      end
+      !exists?
+    end
+
+    def exists?
+      !@id.nil?
+    end
+
+  private
+
+    def delete_params
+      super.tap do |params|
+        params[:path] = '/youtube/v3/subscriptions'
+        params[:params] = {id: @id}
+      end
+    end
+  end
+end

data/lib/yt/models/user_info.rb

@@ -0,0 +1,66 @@
+require 'yt/models/base'
+
+module Yt
+  class UserInfo < Base
+    def initialize(options = {})
+      @data = options[:data]
+    end
+
+    # @return [String] User ID
+    def id
+      @id ||= @data.fetch 'id', ''
+    end
+
+    # Return the email of the YouTube account.
+    #
+    # @return [String] Email of the YouTube account
+    def email
+      @email ||= @data.fetch 'email', ''
+    end
+
+    # @return [Boolean] Email is verified?
+    def has_verified_email?
+      @verified_email ||= @data.fetch 'verified_email', false
+    end
+
+    # @return [String] name
+    def name
+      @name ||= @data.fetch 'name', ''
+    end
+
+    # @return [String] given_name
+    def given_name
+      @given_name ||= @data.fetch 'given_name', ''
+    end
+
+    # @return [String] family_name
+    def family_name
+      @family_name ||= @data.fetch 'family_name', ''
+    end
+
+    # @return [String] family_name
+    def profile_url
+      @profile_url ||= @data.fetch 'link', ''
+    end
+
+    # @return [String] avatar_url
+    def avatar_url
+      @avatar_url ||= @data.fetch 'picture', ''
+    end
+
+    # @return [String] gender
+    def gender
+      @gender ||= @data.fetch 'gender', ''
+    end
+
+    # @return [String] locale
+    def locale
+      @locale ||= @data.fetch 'locale', ''
+    end
+
+    # @return [String] hd
+    def hd
+      @hd ||= @data.fetch 'hd', ''
+    end
+  end
+end

data/lib/yt/models/video.rb

@@ -0,0 +1,16 @@
+module Yt
+  class Video < Base
+    has_many :annotations
+    has_one :details_set, delegate: [:duration]
+    has_one :rating
+    has_one :snippet, delegate: [:title, :description, :tags, :thumbnail_url, :published_at]
+
+    attr_reader :id, :auth
+
+    def initialize(options = {})
+      @id = options[:id]
+      @auth = options[:auth]
+      @snippet = Snippet.new(data: options[:snippet]) if options[:snippet]
+    end
+  end
+end

data/lib/yt/utils/request.rb

@@ -0,0 +1,85 @@
+require 'yt/config'
+
+require 'uri' # for URI.json
+require 'net/http' # for Net::HTTP.start
+require 'json' # for JSON.parse
+require 'active_support/core_ext/hash/conversions' # for Hash.from_xml
+
+module Yt
+  class RequestError < StandardError
+    def reasons
+      error.fetch('errors', []).map{|e| e['reason']}
+    end
+
+    def error
+      eval(message)['error'] rescue {}
+    end
+  end
+
+  class Request
+    def initialize(options = {})
+      options[:query] ||= options[:params].to_param
+      @uri = URI::HTTPS.build options.slice(:host, :path, :query)
+      @method = options[:method]
+      @format = options[:format]
+      @scope = options[:scope]
+      @body = options[:body]
+      @body_type = options[:body_type]
+      @auth = options[:auth]
+      @headers = {}
+    end
+
+    def run
+      add_authorization_to_request!
+      fetch_response.tap do |response|
+        response.body = parse_format response.body if response.body
+        unless response.is_a? Net::HTTPSuccess
+          # puts "You can try again running #{to_curl}"
+          raise RequestError, response.body
+        end
+      end
+    end
+
+  private
+
+    def add_authorization_to_request!
+      if @auth.respond_to? :access_token_for
+        @headers['Authorization'] = "Bearer #{@auth.access_token_for @scope}"
+      else # TODO: check if api_key was set in the first place!!
+        params = URI.decode_www_form @uri.query || ''
+        params << [:key, Yt.configuration.api_key]
+        @uri.query = URI.encode_www_form params
+      end
+    end
+
+    def fetch_response
+      Net::HTTP.start(@uri.host, @uri.port, use_ssl: true) do |http|
+        klass = "Net::HTTP::#{@method.capitalize}".constantize
+        request = if @body_type == :json
+          klass.new @uri, initheader = {'Content-Type' =>'application/json'}
+        else
+          klass.new @uri
+        end
+        @headers.each{|k,v| request.add_field k, v}
+        case @body_type
+          when :json then request.body = @body.to_json
+          when :form then request.set_form_data @body
+        end if @body
+
+        http.request request
+        # NOTE! Here refresh the token if the access is expired
+      end
+    end
+
+    def parse_format(body)
+      case @format
+        when :xml then Hash.from_xml body
+        when :json then JSON body
+      end
+    end
+
+    # def to_curl
+    #   %Q{curl -X #{@method.upcase} "#{@uri}"}
+    # end
+  end
+end