yt 0.0.1 → 0.4.0

data/lib/yt/associations/subscriptions.rb

@@ -0,0 +1,38 @@
+require 'yt/collections/subscriptions'
+
+module Yt
+  module Associations
+    # Provides the `has_one :subscription` method to YouTube resources, which
+    # allows to invoke subscription-related methods, such as .subscribe.
+    # YouTube resources with subscription are: channels.
+    module Subscriptions
+      def subscriptions
+        @subscriptions ||= Collections::Subscriptions.by_channel self
+      end
+
+      def subscribed?
+        subscriptions.any?{|s| s.exists?}
+      end
+
+      def subscribe
+        subscriptions.insert ignore_duplicates: true
+        subscribed?
+      end
+
+      def subscribe!
+        subscriptions.insert
+        subscribed?
+      end
+
+      def unsubscribe
+        subscriptions.delete_all({}, ignore_not_found: true)
+        !subscribed?
+      end
+
+      def unsubscribe!
+        subscriptions.delete_all
+        !subscribed?
+      end
+    end
+  end
+end

data/lib/yt/associations/user_infos.rb

@@ -0,0 +1,21 @@
+require 'yt/collections/user_infos'
+
+module Yt
+  module Associations
+    # Provides the `has_one :user_info` method to YouTube resources, which
+    # allows to access to user_info-specific methods like `email`.
+    # YouTube resources with user infos are: accounts.
+    module UserInfos
+      def user_info
+        @user_info ||= user_infos.first
+      end
+
+    private
+
+      def user_infos
+        @user_infos ||= Collections::UserInfos.by_account self
+      end
+    end
+  end
+end
+

data/lib/yt/associations/videos.rb

@@ -0,0 +1,14 @@
+require 'yt/collections/videos'
+
+module Yt
+  module Associations
+    # Provides the `has_many :videos` method to YouTube resources, which
+    # allows to access only the videos that belong to a specific resource.
+    # YouTube resources with videos are: channels.
+    module Videos
+      def videos
+        @videos ||= Collections::Videos.by_channel self
+      end
+    end
+  end
+end

data/lib/yt/collections/annotations.rb

@@ -0,0 +1,43 @@
+require 'yt/collections/base'
+require 'yt/models/annotation'
+
+module Yt
+  module Collections
+    class Annotations < Base
+
+      def initialize(options = {})
+        @video = options[:video]
+        @auth = options[:auth]
+      end
+
+      def self.by_video(video)
+        new video: video, auth: video.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Annotation.new data: data
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:format] = :xml
+          params[:host] = 'www.youtube.com'
+          params[:path] = '/annotations_invideo'
+          params[:params] = {video_id: @video.id}
+        end
+      end
+
+      def next_page
+        request = Request.new list_params
+        response = request.run
+        raise unless response.is_a? Net::HTTPOK
+        @page_token = nil
+
+        document = response.body.fetch('document', {})['annotations'] || {}
+        Array.wrap document.fetch 'annotation', []
+      end
+    end
+  end
+end

data/lib/yt/collections/base.rb

@@ -0,0 +1,13 @@
+require 'yt/actions/delete_all'
+require 'yt/actions/insert'
+require 'yt/actions/list'
+
+module Yt
+  module Collections
+    class Base
+      include Actions::DeleteAll
+      include Actions::Insert
+      include Actions::List
+    end
+  end
+end

data/lib/yt/collections/channels.rb

@@ -0,0 +1,32 @@
+require 'yt/collections/base'
+require 'yt/models/channel'
+
+module Yt
+  module Collections
+    class Channels < Base
+
+      def initialize(options = {})
+        @account = options[:account]
+        @auth = options[:auth]
+      end
+
+      def self.by_account(account)
+        new account: account, auth: account.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Channel.new id: data['id'], snippet: data['snippet'], auth: @auth
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {maxResults: 50, part: 'snippet', mine: true}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube'
+          params[:path] = '/youtube/v3/channels'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/details_sets.rb

@@ -0,0 +1,32 @@
+require 'yt/collections/base'
+require 'yt/models/details_set'
+
+module Yt
+  module Collections
+    class DetailsSets < Base
+
+      def initialize(options = {})
+        @video = options[:video]
+        @auth = options[:auth]
+      end
+
+      def self.by_video(video)
+        new video: video, auth: video.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::DetailsSet.new data: data['contentDetails']
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {maxResults: 50, part: 'contentDetails', id: @video.id}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
+          params[:path] = '/youtube/v3/videos'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/playlist_items.rb

@@ -0,0 +1,50 @@
+require 'yt/collections/base'
+require 'yt/models/playlist_item'
+
+module Yt
+  module Collections
+    class PlaylistItems < Base
+
+      def initialize(options = {})
+        @playlist = options[:playlist]
+        @auth = options[:auth]
+      end
+
+      def self.by_playlist(playlist)
+        new playlist: playlist, auth: playlist.auth
+      end
+
+      # options are id and kind
+      def insert(options = {}) #
+        resource = {kind: "youtube##{options[:kind]}"}
+        resource["#{options[:kind]}Id"] = options[:id]
+        snippet = {playlistId: @playlist.id, resourceId: resource}
+        do_insert body: {snippet: snippet}, params: {part: 'snippet,status'}
+      end
+
+      def delete_all(params = {})
+        do_delete_all params
+      end
+
+    private
+
+      def new_item(data)
+        Yt::PlaylistItem.new id: data['id'], snippet: data['snippet'], status: data['status'], auth: @auth
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {maxResults: 50, part: 'snippet,status', playlistId: @playlist.id}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
+          params[:path] = '/youtube/v3/playlistItems'
+        end
+      end
+
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/v3/playlistItems'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/playlists.rb

@@ -0,0 +1,56 @@
+require 'yt/collections/base'
+require 'yt/models/playlist'
+
+module Yt
+  module Collections
+    class Playlists < Base
+
+      def initialize(options = {})
+        @channel = options[:channel]
+        @auth = options[:auth]
+      end
+
+      def self.by_channel(channel)
+        new channel: channel, auth: channel.auth
+      end
+
+      # Valid body (no defaults) are: title (string), description (string), privacy_status (string),
+      # tags (array of strings)
+      def insert(options = {})
+        body = {}
+
+        snippet = options.slice :title, :description, :tags
+        body[:snippet] = snippet if snippet.any?
+
+        status = options[:privacy_status]
+        body[:status] = {privacyStatus: status} if status
+
+        do_insert body: body, params: {part: 'snippet,status'}
+      end
+
+      def delete_all(params = {})
+        do_delete_all params
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Playlist.new id: data['id'], snippet: data['snippet'], status: data['status'], auth: @auth
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {maxResults: 50, part: 'snippet,status', channelId: @channel.id}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
+          params[:path] = '/youtube/v3/playlists'
+        end
+      end
+
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/v3/playlists'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/ratings.rb

@@ -0,0 +1,32 @@
+require 'yt/collections/base'
+require 'yt/models/rating'
+
+module Yt
+  module Collections
+    class Ratings < Base
+
+      def initialize(options = {})
+        @video = options[:video]
+        @auth = options[:auth]
+      end
+
+      def self.by_video(video)
+        new video: video, auth: video.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Rating.new rating: data['rating'], video_id: @video.id, auth: @auth
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:path] = '/youtube/v3/videos/getRating'
+          params[:params] = {id: @video.id}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/snippets.rb

@@ -0,0 +1,38 @@
+require 'yt/collections/base'
+require 'yt/models/snippet'
+
+module Yt
+  module Collections
+    class Snippets < Base
+
+      def initialize(options = {})
+        @resource = options[:resource]
+        @auth = options[:auth]
+      end
+
+      # @note Google API must have some caching layer by which if we try to
+      # delete a snippet that we just created, we encounter an error.
+      # To overcome this, if we have just updated the snippet, we must
+      # wait some time before requesting it again.
+      #
+      def self.by_resource(resource)
+        new resource: resource, auth: resource.auth
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Snippet.new data: data['snippet']
+      end
+
+      def list_params
+        resources_path = @resource.class.to_s.demodulize.underscore.pluralize
+        super.tap do |params|
+          params[:params] = {id: @resource.id, part: 'snippet'}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
+          params[:path] = "/youtube/v3/#{resources_path}"
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/subscriptions.rb

@@ -0,0 +1,67 @@
+require 'yt/collections/base'
+require 'yt/models/subscription'
+
+module Yt
+  module Collections
+    class Subscriptions < Base
+
+      def initialize(options = {})
+        @channel = options[:channel]
+        @auth = options[:auth]
+      end
+
+      def self.by_channel(channel)
+        new channel: channel, auth: channel.auth
+      end
+
+      def insert(options = {})
+        throttle
+        do_insert
+      rescue Yt::RequestError => error
+        raise error unless options[:ignore_duplicates] && error.reasons.include?('subscriptionDuplicate')
+      end
+
+      def delete_all(params = {}, options = {})
+        do_delete_all(params) {throttle}
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Subscription.new id: data['id'], auth: @auth
+      end
+
+      # @note Google API must have some caching layer by which if we try to
+      # delete a subscription that we just created, we encounter an error.
+      # To overcome this, if we have just updated the subscription, we must
+      # wait some time before requesting it again.
+      #
+      def throttle(seconds = 8)
+        wait = [(@last_changed_at ||= Time.now) - Time.now + seconds, 0].max
+        sleep wait
+        @last_changed_at = Time.now
+      end
+
+      def fetch_page(params = {})
+        throttle
+        super params
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {maxResults: 50, forChannelId: @channel.id, mine: true, part: 'snippet'}
+          params[:scope] = 'https://www.googleapis.com/auth/youtube'
+          params[:path] = '/youtube/v3/subscriptions'
+        end
+      end
+
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/v3/subscriptions'
+          params[:params] = {part: 'snippet'}
+          params[:body] = {snippet: {resourceId: {channelId: @channel.id}}}
+        end
+      end
+    end
+  end
+end