yt 0.4.10 → 0.5.3

data/lib/yt/models/account.rb

@@ -10,28 +10,12 @@ module Yt
       :name, :given_name, :family_name, :profile_url, :avatar_url, :locale, :hd]
 
     def initialize(options = {})
-      # By default is someone passes a refresh_token but not a scope, we can assume it's a youtube one
-      @scope = options.fetch :scope, 'https://www.googleapis.com/auth/youtube'
       @access_token = options[:access_token]
       @refresh_token = options[:refresh_token]
       @redirect_url = options[:redirect_url]
     end
 
-    def access_token_for(scope)
-      # TODO incremental scope
-
-      # HERE manage the fact that we must change some scope on device,
-      # like 'https://www.googleapis.com/auth/youtube.readonly' is not accepted
-      if Yt.configuration.scenario == :device_app && scope == 'https://www.googleapis.com/auth/youtube.readonly'
-        scope = 'https://www.googleapis.com/auth/youtube'
-      end
-
-      # TODO !! include? is not enough, because (for instance) 'youtube' also includes 'youtube.readonly'
-
-      # unless (@scope == scope) || (scope == 'https://www.googleapis.com/auth/youtube.readonly' && @scope =='https://www.googleapis.com/auth/youtube')
-      #   @scope = scope
-      #   @access_token = @refresh_token = nil
-      # end
+    def access_token
       @access_token ||= refresh_access_token || get_access_token
     end
 

data/lib/yt/models/base.rb

@@ -1,6 +1,7 @@
 require 'yt/associations'
 require 'yt/actions/delete'
 require 'yt/actions/update'
+require 'yt/errors/error'
 
 module Yt
   class Base

data/lib/yt/models/description.rb

@@ -1,3 +1,5 @@
+require 'yt/models/url'
+
 module Yt
   # Provides read-only access to the description of a YouTube resource.
   # Resources with descriptions are: videos and channels.
@@ -20,79 +22,53 @@ module Yt
     def has_link_to_video?
       # TODO: might take as an option WHICH video to link to
       # in order to check if it's my own video
-      regex? :video_long_url, :video_short_url
+      links.any?{|link| link.kind == :video}
     end
 
     # Returns whether the description includes a YouTube channel URL
     #
     # @example
     #
-    # description = Yt::Description.new Link to channel: youtube.com/fullscreen
+    # description = Yt::Description.new 'Link to channel: youtube.com/fullscreen'
     # description.has_link_to_channel? #=> true
     #
     # @return [Boolean] Whether the description includes a link to a channel
     def has_link_to_channel?(options = {}) # TODO: which channel
       # TODO: might take as an option WHICH channel to link to
       # in order to check if it's my own channel
-      regex? :channel_long_url, :channel_short_url, :channel_user_url
+      links.any?{|link| link.kind == :channel}
     end
 
     # Returns whether the description includes a YouTube subscription URL
     #
     # @example
     #
-    # description = Yt::Description.new Link to subscribe: youtube.com/subscription_center?add_user=fullscreen
+    # description = Yt::Description.new 'Link to subscribe: youtube.com/subscription_center?add_user=fullscreen'
     # description.has_link_to_subscribe? #=> true
     #
     # @return [Boolean] Whether the description includes a link to subscribe
     def has_link_to_subscribe?(options = {}) # TODO: which channel
       # TODO: might take as an option WHICH channel to subscribe to
       # in order to check if it's my own channel
-      regex? :subscribe_center_url, :subscribe_widget_url, :subscribe_confirm_url
+      links.any?{|link| link.kind == :subscription}
     end
 
     # Returns whether the description includes a YouTube playlist URL
     #
     # @example
     #
-    # description = Yt::Description.new Link to playlist: youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow
+    # description = Yt::Description.new 'Link to playlist: youtube.com/playlist?list=LLxO1tY8h1AhOz0T4ENwmpow'
     # description.has_link_to_playlist? #=> true
     #
     # @return [Boolean] Whether the description includes a link to a playlist
     def has_link_to_playlist?
-      regex? :playlist_long_url, :playlist_embed_url
+      links.any?{|link| link.kind == :playlist}
     end
 
   private
 
-    def regex?(*keys)
-      keys.find{|key| self =~ regex_for(key)}
-    end
-
-    def regex_for(key)
-      host, name = '(?:https?://)?(?:www\.)?', '([a-zA-Z0-9_-]+)'
-      case key
-      when :video_long_url
-        %r{#{host}youtube\.com/watch\?v=#{name}}
-      when :video_short_url
-        %r{#{host}youtu\.be/#{name}}
-      when :channel_long_url
-        %r{#{host}youtube\.com/channel/#{name}}
-      when :channel_short_url
-        %r{#{host}youtube\.com/#{name}}
-      when :channel_user_url
-        %r{#{host}youtube\.com/user/#{name}}
-      when :subscribe_center_url
-        %r{#{host}youtube\.com/subscription_center\?add_user=#{name}}
-      when :subscribe_widget_url
-        %r{#{host}youtube\.com/subscribe_widget\?p=#{name}}
-      when :subscribe_confirm_url
-        %r{#{host}youtube\.com/channel/(?:[a-zA-Z0-9&_=-]*)\?sub_confirmation=1}
-      when :playlist_long_url
-        %r{#{host}youtube\.com/playlist\?list=#{name}}
-      when :playlist_embed_url
-        %r{#{host}youtube\.com/watch\?v=(?:[a-zA-Z0-9&_=-]*)&list=#{name}}
-      end
+    def links
+      @links ||= self.split(' ').map{|word| URL.new word}
     end
   end
 end

data/lib/yt/models/id.rb

@@ -0,0 +1,4 @@
+module Yt
+  class Id < String
+  end
+end

data/lib/yt/models/request.rb

@@ -0,0 +1,102 @@
+require 'net/http' # for Net::HTTP.start
+require 'uri' # for URI.json
+require 'json' # for JSON.parse
+require 'active_support/core_ext' # for Hash.from_xml, Hash.to_param
+
+require 'yt/config'
+require 'yt/errors/failed'
+require 'yt/errors/unauthenticated'
+
+module Yt
+  class Request
+    def initialize(options = {})
+      options[:query] ||= options[:params].to_param
+      @uri = URI::HTTPS.build options.slice(:host, :path, :query)
+      @method = options.fetch :method, :get
+      @format = options[:format]
+      @body = options[:body]
+      @body_type = options[:body_type]
+      @auth = options[:auth]
+      @headers = {}
+    end
+
+    def run
+      add_authorization_to_request! if requires_authorization?
+      fetch_response.tap do |response|
+        if response.is_a? Net::HTTPSuccess
+          response.body = parse_format response.body
+        else
+          raise Errors::Failed, to_error(response)
+        end
+      end
+    end
+
+    def self.default_params
+      {}.tap do |params|
+        params[:format] = :json
+        params[:host] = 'www.googleapis.com'
+        params[:body_type] = :json
+      end
+    end
+
+  private
+
+    def add_authorization_to_request!
+      if @auth.respond_to? :access_token
+        @headers['Authorization'] = "Bearer #{@auth.access_token}"
+      elsif Yt.configuration.api_key
+        params = URI.decode_www_form @uri.query || ''
+        params << [:key, Yt.configuration.api_key]
+        @uri.query = URI.encode_www_form params
+      else
+        raise Errors::Unauthenticated, to_error
+      end
+    end
+
+    def requires_authorization?
+      @uri.host == Request.default_params[:host]
+    end
+
+    def fetch_response
+      klass = "Net::HTTP::#{@method.capitalize}".constantize
+      request = klass.new @uri.request_uri
+      case @body_type
+      when :json
+        request.initialize_http_header 'Content-Type' => 'application/json'
+        request.initialize_http_header 'Content-length' => '0' unless @body
+        request.body = @body.to_json if @body
+      when :form
+        request.set_form_data @body if @body
+      end
+      @headers.each{|k,v| request.add_field k, v}
+
+      Net::HTTP.start(@uri.host, @uri.port, use_ssl: true) do |http|
+        http.request request
+      end
+    end
+
+    def parse_format(body)
+      case @format
+        when :xml then Hash.from_xml body
+        when :json then JSON body
+      end if body
+    end
+
+    def to_error(response = nil)
+      request_msg = {}.tap do |msg|
+        msg[:method] = @method
+        msg[:headers] = @headers
+        msg[:url] = @uri.to_s
+        msg[:body] = @body
+      end
+
+      response_msg = {}.tap do |msg|
+        msg[:code] = response.code
+        msg[:headers] = {}.tap{|h| response.each_header{|k,v| h[k] = v }}
+        msg[:body] = response.body
+      end if response
+
+      {request: request_msg, response: response_msg}.to_json
+    end
+  end
+end

data/lib/yt/models/resource.rb

@@ -1,16 +1,27 @@
 require 'yt/models/base'
+require 'yt/models/url'
 
 module Yt
   class Resource < Base
-    attr_reader :id, :auth
+    attr_reader :auth
+    has_one :id
     has_one :snippet, delegate: [:title, :description, :thumbnail_url, :published_at, :tags]
     has_one :status, delegate: [:privacy_status, :public?, :private?, :unlisted?]
 
     def initialize(options = {})
-      @id = options[:id]
+      @url = URL.new(options[:url]) if options[:url]
+      @id = options[:id] || (@url.id if @url)
       @auth = options[:auth]
       @snippet = Snippet.new(data: options[:snippet]) if options[:snippet]
       @status = Status.new(data: options[:status]) if options[:status]
     end
+
+    def kind
+      @url ? @url.kind.to_s : self.class.to_s.demodulize.underscore
+    end
+
+    def username
+      @url.username if @url
+    end
   end
 end

data/lib/yt/models/subscription.rb

@@ -13,8 +13,9 @@ module Yt
     def delete(options = {})
       begin
         do_delete {@id = nil}
-      rescue Yt::RequestError => error
-        raise error unless options[:ignore_not_found] && error.reasons.include?('subscriptionNotFound')
+      rescue Errors::Base => error
+        ignorable_errors = error.reasons & ['subscriptionNotFound']
+        raise error unless options[:ignore_errors] && ignorable_errors.any?
       end
       !exists?
     end

data/lib/yt/models/url.rb

@@ -0,0 +1,88 @@
+module Yt
+  class URL
+    attr_reader :kind
+
+    def initialize(url)
+      @url = url
+      @kind ||= parse url
+      @match_data ||= {}
+    end
+
+    def id
+      @match_data[:id]
+    rescue IndexError
+    end
+
+    def username
+      @match_data[:username]
+    rescue IndexError
+    end
+
+  private
+
+    def parse(url)
+      matching_pattern = patterns.find do |pattern|
+        @match_data = url.match pattern[:regex]
+      end
+      matching_pattern[:kind] if matching_pattern
+    end
+
+    def patterns
+      # @note: :video *must* be the last since one of its regex eats the
+      # remaining patterns. In short, don't change the following order
+
+      @patterns ||= patterns_for :playlist, :subscription, :channel, :video
+    end
+
+    def patterns_for(*kinds)
+      prefix = '^(?:https?://)?(?:www\.)?'
+      suffix = '(?:|/)$'
+      kinds.map do |kind|
+        patterns = send "#{kind}_patterns" # meta programming :/
+        patterns.map do |pattern|
+          {kind: kind, regex: %r{#{prefix}#{pattern}#{suffix}}}
+        end
+      end.flatten
+    end
+
+    def subscription_patterns
+      name = '(?:[a-zA-Z0-9&_=-]*)'
+
+      %W{
+        subscription_center\\?add_user=#{name}
+        subscribe_widget\\?p=#{name}
+        channel/#{name}\\?sub_confirmation=1
+      }.map{|path| "youtube\\.com/#{path}"}
+    end
+
+    def playlist_patterns
+      playlist_id = '(?<id>[a-zA-Z0-9_-]+)'
+      video_id = '(?:[a-zA-Z0-9&_=-]*)'
+
+      %W{
+        playlist\\?list=#{playlist_id}
+        watch\\?v=#{video_id}&list=#{playlist_id}
+      }.map{|path| "youtube\\.com/#{path}"}
+    end
+
+    def video_patterns
+      video_id = '(?<id>[a-zA-Z0-9_-]+)'
+
+      %W{
+        youtube\\.com/watch\\?v=#{video_id}
+        youtu\\.be/#{video_id}
+      }
+    end
+
+    def channel_patterns
+      channel_id = '(?<id>[a-zA-Z0-9_-]+)'
+      username = '(?<username>[a-zA-Z0-9_-]+)'
+
+      %W{
+        channel/#{channel_id}
+        user/#{username}
+        #{username}
+      }.map{|path| "youtube\\.com/#{path}"}
+    end
+  end
+end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.4.10'
+  VERSION = '0.5.3'
 end

data/spec/associations/device_auth/details_sets_spec.rb

@@ -13,7 +13,7 @@ describe Yt::Associations::DetailsSets, scenario: :device_app do
 
     context 'given an unknown video' do
       let(:video) { Yt::Video.new id: 'not-a-video-id', auth: account }
-      it { expect(video.details_set).to be_nil }
+      it { expect{video.details_set}.to raise_error Yt::Errors::NoItems }
     end
   end
 end

data/spec/associations/device_auth/ids_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'yt/associations/ids'
+
+describe Yt::Associations::Ids, scenario: :device_app do
+  let(:account) { Yt.configuration.account }
+  subject(:resource) { Yt::Resource.new url: url, auth: account.auth }
+
+  describe '#id' do
+    context 'given a URL containing an existing username' do
+      let(:url) { 'youtube.com/fullscreen' }
+      it { expect(resource.id).to eq 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    end
+
+    context 'given a URL containing an unknown username' do
+      let(:url) { 'youtube.com/--not--a--valid--username' }
+      it { expect{resource.id}.to raise_error Yt::Errors::NoItems }
+    end
+  end
+end

data/spec/associations/device_auth/playlist_items_spec.rb

@@ -46,12 +46,12 @@ describe Yt::Associations::PlaylistItems, scenario: :device_app do
 
     context 'given an unknown video' do
       let(:video_id) { 'not-a-video' }
-      it { expect{@playlist.add_video! video_id}.to raise_error Yt::RequestError }
+      it { expect{@playlist.add_video! video_id}.to fail.with 'videoNotFound' }
     end
 
     context 'given a video of a terminated account' do
       let(:video_id) { 'kDCpdKeTe5g' }
-      it { expect{@playlist.add_video! video_id}.to raise_error Yt::RequestError }
+      it { expect{@playlist.add_video! video_id}.to fail.with 'forbidden' }
     end
   end
 
@@ -66,7 +66,7 @@ describe Yt::Associations::PlaylistItems, scenario: :device_app do
   describe '#add_videos!' do
     context 'given one existing and one unknown video' do
       let(:video_ids) { ['MESycYJytkU', 'not-a-video'] }
-      it { expect{@playlist.add_videos! video_ids}.to raise_error Yt::RequestError }
+      it { expect{@playlist.add_videos! video_ids}.to fail.with 'videoNotFound'}
     end
   end
 

data/spec/associations/device_auth/snippets_spec.rb

@@ -14,7 +14,7 @@ describe Yt::Associations::Snippets, scenario: :device_app do
 
     context 'given an unknown video resource' do
       let(:video) { Yt::Video.new id: 'not-a-video-id', auth: account }
-      it { expect(video.snippet).to be_nil }
+      it { expect{video.snippet}.to raise_error Yt::Errors::NoItems }
     end
 
     context 'given an existing channel resource' do
@@ -24,7 +24,7 @@ describe Yt::Associations::Snippets, scenario: :device_app do
 
     context 'given an unknown channel resource' do
       let(:channel) { Yt::Channel.new id: 'not-a-channel-id', auth: account }
-      it { expect(channel.snippet).to be_nil }
+      it { expect{channel.snippet}.to raise_error Yt::Errors::NoItems }
     end
   end
 end