yt 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed6567aa70134861a5d5267d15be4492828e43f3
-  data.tar.gz: d4bdab518b596e713bd176aec6b8433717f33770
+  metadata.gz: c4e025834f30276ff685e3ff61e3bd1330fc42b4
+  data.tar.gz: 725a5254897a04ff2ff0694125b58101dd6689aa
 SHA512:
-  metadata.gz: 06c0762ba2dad8a2cef8e02484e8b1640c83b247e1f3137dbf13fdd7822be95602cdcb6aab7adba763bd69e853c86727daa171c8491ba55922d6098e17585202
-  data.tar.gz: 54c741b87f443665ba64a14133d2816616ae0f3abc82794e42a2233e6ea7534a78e658cc3128cae5d324001f68bf2485764f9d61f2baf866331ecf486f754dce
+  metadata.gz: 582c36cde9977d2d0b7585fea15950ee1f09292ed373e39a9b99f53ae8ce32a8bdb198106d8afe00d78c60f28890eab1d9ec81f2ba5d6e9495fbc9f60c35943d
+  data.tar.gz: 3e9bb4cda3a7fec3d604c92d3c8d609b7463a20a8e833cb01ff8b8c09e40b0bf05e106d35bfc68d76a7655e6b3095e09e650244c1293555e45ae54de2175deba

data/.travis.yml

@@ -22,3 +22,4 @@ env:
   - secure: Ejj8tsuwyrRVmCc/R9ubKWCHWhCGpe0Dy6fc1UuPCkcMZyXq9ZC02v2obWsTQQ7epEgsCYZAO4v/gWpuv1b1huGcWdfJzMW7RCoY87cEf9HnAK0lSwGx4+/pYkEMe8y5p149C3vAR8nqczvEavN1fUq/WwPUqp+JyDP7kwFTs2Y=
   - secure: gE5kAT1R54hmS+W3YYGcUtlD8ZskvTctVR3sr+C5CUjVPdq6Ktx5Q/a6EJyAVVrhxpaCOuk3LG+VkzdQIVFUNRiDPcOulkond4HkSQDoy+IJ/wTXvUS+lIJ1ERUnWega+APrQUjH5s2WayPGZUBqWt/u8Tt9EmSUZfuKZSEXqZk=
   - secure: ZUx5v/wHW/TENg8NfFINiiMoe2D031ntDTiuIBdf88c/bMClkEtRRgomtK9RBkFonEyGEOkXxUm2SLzRf340V3eIXWQhil7ab1lcYs8X59aVS/NK/GqChH8Nia17gc3OTQ9k6rYvj4Lp60Dh9WG1cijLPd4/OvPmf6qX9uYfJMw=
+  - secure: DumQVO01Y3Ki1skuOYOZzosDb6jS0XyG1O8Agy3mVxXGJzQE+s1z2UFz4gMpsU9o/gmiNMddp7I6+RtbZjo9hN3H7vlRRwEeB7tuUMiDyomSx1FlHcCFfPdTmhxGg8X78SErMWqNC6eReGrCTgBdIq1ho7dIu53qJNxTEFqx7eI=

data/Gemfile.lock

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

data/HISTORY.md

@@ -2,6 +2,9 @@ v0.6 - 2014/06/05
 -----------------
 
 * [breaking change] Rename Channel#earning to Channel#earnings_on
+* [breaking change] Account#videos shows *all* videos owned by account (public and private)
+* Add the .status association to *every* type of resource (Channel, Video, Playlist)
+* Allow account.videos to be chained with .where, such as in account.videos.where(q: 'query')
 
 v0.5 - 2014/05/16
 -----------------

data/README.md

@@ -16,12 +16,14 @@ After [registering your app](#configuring-your-app), you can run commands like:
 channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
 channel.title #=> "Fullscreen"
 channel.description #=> "The first media company for the connected generation."
+channel.public? #=> true
 channel.videos.count #=> 12
 ```
 
 ```ruby
 video = Yt::Video.new id: 'MESycYJytkU'
 video.title #=> "Fullscreen Creator Platform"
+video.public? #=> true
 video.duration #=> 86
 video.annotations.count #=> 1
 ```
@@ -84,6 +86,7 @@ Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Chan
 channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
 channel.title #=> "Fullscreen"
 channel.description.has_link_to_playlist? #=> false
+channel.public? #=> true
 
 channel.videos.count #=> 12
 channel.videos.first #=> #<Yt::Video @id=...>
@@ -136,6 +139,7 @@ video = Yt::Video.new id: 'MESycYJytkU'
 video.title #=> "Fullscreen Creator Platform"
 video.duration #=> 63
 video.description.has_link_to_subscribe? #=> false
+video.public? #=> true
 
 video.annotations.count #=> 1
 video.annotations.first #=> #<Yt::Annotation @id=...>
@@ -326,7 +330,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.6.1'
+    gem 'yt', '~> 0.6.2'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/TODO.md

@@ -8,8 +8,6 @@ seconds fixes it, so we should retry every 500 at least
 * Google accounts?
 * ENV support
 
-* add has_one :status to video
-
 * 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

data/bin/yt

@@ -14,6 +14,7 @@ channel = Yt::Channel.new id: ARGV[0] || 'UCxO1tY8h1AhOz0T4ENwmpow'
 puts "Title: #{channel.title}"
 puts "Description: #{channel.description}"
 puts "Thumbnail: #{channel.thumbnail_url}"
+puts "Public? #{channel.public?}"
 puts "Videos: "
 channel.videos.each do |video|
   puts "  Annotations: #{video.annotations.count}"
@@ -21,4 +22,5 @@ channel.videos.each do |video|
   puts "  Title: #{video.title}"
   puts "  Description: #{video.description}"
   puts "  Thumbnail: #{video.thumbnail_url}"
+  puts "  Public? #{video.public?}"
 end

data/lib/yt/actions/delete_all.rb

@@ -9,12 +9,12 @@ module Yt
     private
 
       def do_delete_all(params = {})
-        where(params).map do |item|
+        list_all(params).map do |item|
           item.delete
         end.tap { @items = [] }
       end
 
-      def where(params = {})
+      def list_all(params = {})
         list.find_all do |item|
           params.all? do |method, value|
             # TODO: could be symbol etc...

data/lib/yt/associations/authentications.rb

@@ -5,10 +5,25 @@ require 'yt/errors/unauthorized'
 
 module Yt
   module Associations
-    # Provides the `has_one :access_token` method to YouTube resources, which
+    # Provides authentication methods to YouTube resources, which
     # allows to access to content detail set-specific methods like `access_token`.
-    # YouTube resources with access tokens are: accounts.
+    # YouTube resources with authentication are: accounts.
     module Authentications
+      delegate :access_token, :refresh_token, :expires_at, to: :authentication
+
+      def initialize(options = {})
+        @access_token = options[:access_token]
+        @refresh_token = options[:refresh_token]
+        @expires_at = options[:expires_at]
+        @authorization_code = options[:authorization_code]
+        @redirect_uri = options[:redirect_uri]
+        @scopes = options[:scopes]
+      end
+
+      def auth
+        self
+      end
+
       def authentication
         @authentication = current_authentication
         @authentication ||= new_authentication || refreshed_authentication!

data/lib/yt/collections/base.rb

@@ -18,6 +18,12 @@ module Yt
       def self.of(parent)
         new parent: parent, auth: parent.auth
       end
+
+      def where(conditions = {})
+        @items = []
+        @extra_params = conditions
+        self
+      end
     end
   end
 end

data/lib/yt/collections/statuses.rb

@@ -0,0 +1,22 @@
+require 'yt/collections/base'
+require 'yt/models/status'
+
+module Yt
+  module Collections
+    class Statuses < Base
+
+    private
+
+      def new_item(data)
+        Yt::Status.new data: data['status']
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {id: @parent.id, part: 'status'}
+          params[:path] = "/youtube/v3/#{@parent.kind.pluralize}"
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/subscriptions.rb

@@ -29,7 +29,7 @@ module Yt
       # To overcome this, if we have just updated the subscription, we must
       # wait some time before requesting it again.
       #
-      def throttle(seconds = 10)
+      def throttle(seconds = 11)
         @last_changed_at ||= Time.now - seconds
         wait = [@last_changed_at - Time.now + seconds, 0].max
         sleep wait

data/lib/yt/collections/videos.rb

@@ -13,10 +13,15 @@ module Yt
 
       def list_params
         super.tap do |params|
-          params[:params] = {channelId: @parent.id, type: :video, maxResults: 50, part: 'snippet'}
+          params[:params] = @parent.videos_params.merge videos_params
           params[:path] = '/youtube/v3/search'
         end
       end
+
+      def videos_params
+        @extra_params ||= {}
+        {type: :video, maxResults: 50, part: 'snippet'}.merge @extra_params
+      end
     end
   end
 end

data/lib/yt/models/account.rb

@@ -1,24 +1,18 @@
 require 'yt/models/base'
+require 'yt/associations/authentications'
 
 module Yt
   module Models
     # Provides methods to access a YouTube account.
     class Account < Base
+      include Associations::Authentications
+
       has_one :channel, delegate: [:videos, :playlists, :create_playlist, :delete_playlists, :update_playlists]
       has_one :user_info, delegate: [:id, :email, :has_verified_email?, :gender, :name, :given_name, :family_name, :profile_url, :avatar_url, :locale, :hd]
-      has_one :authentication, delegate: [:access_token, :refresh_token, :expires_at]
-
-      def initialize(options = {})
-        @access_token = options[:access_token]
-        @refresh_token = options[:refresh_token]
-        @expires_at = options[:expires_at]
-        @authorization_code = options[:authorization_code]
-        @redirect_uri = options[:redirect_uri]
-        @scopes = options[:scopes]
-      end
+      has_many :videos
 
-      def auth
-        self
+      def videos_params
+        {forMine: true}
       end
     end
   end

data/lib/yt/models/base.rb

@@ -1,14 +1,40 @@
-require 'yt/associations'
 require 'yt/actions/delete'
 require 'yt/actions/update'
 require 'yt/errors/request_error'
 
+require 'active_support/core_ext/module/delegation' # for delegate
+require 'active_support/core_ext/string/inflections' # for camelize
+
+
 module Yt
   module Models
     class Base
-      extend Associations
       include Actions::Delete
       include Actions::Update
+
+      def self.has_many(attributes)
+        attributes = attributes.to_s
+        require "yt/collections/#{attributes}"
+        mod = attributes.sub(/.*\./, '').camelize
+        collection = "Yt::Collections::#{mod.pluralize}".constantize
+
+        define_method attributes do
+          ivar = instance_variable_get "@#{attributes}"
+          instance_variable_set "@#{attributes}", ivar || collection.of(self)
+        end
+      end
+
+      def self.has_one(attribute, options = {})
+        delegate *options[:delegate], to: attribute if options[:delegate]
+
+        attributes = attribute.to_s.pluralize
+        has_many attributes
+
+        define_method attribute do
+          ivar = instance_variable_get "@#{attribute}"
+          instance_variable_set "@#{attribute}", ivar || send(attributes).first!
+        end
+      end
     end
   end
 

data/lib/yt/models/channel.rb

@@ -1,13 +1,48 @@
 require 'yt/models/resource'
+require 'yt/associations/earnings'
+require 'yt/associations/views'
 
 module Yt
   module Models
     class Channel < Resource
+      include Associations::Earnings
+      include Associations::Views
+
       has_many :subscriptions
       has_many :videos
       has_many :playlists
-      has_many :earnings
-      has_many :views
+
+      def subscribed?
+        subscriptions.any?{|s| s.exists?}
+      end
+
+      def subscribe
+        subscriptions.insert ignore_errors: true
+      end
+
+      def subscribe!
+        subscriptions.insert
+      end
+
+      def unsubscribe
+        subscriptions.delete_all({}, ignore_errors: true)
+      end
+
+      def unsubscribe!
+        subscriptions.delete_all
+      end
+
+      def create_playlist(params = {})
+        playlists.insert params
+      end
+
+      def delete_playlists(attrs = {})
+        playlists.delete_all attrs
+      end
+
+      def videos_params
+        {channelId: id}
+      end
     end
   end
 end

data/lib/yt/models/playlist.rb

@@ -32,6 +32,26 @@ module Yt
         !@id.nil?
       end
 
+      def add_video(video_id)
+        playlist_items.insert video_params(video_id), ignore_errors: true
+      end
+
+      def add_video!(video_id)
+        playlist_items.insert video_params(video_id)
+      end
+
+      def add_videos(video_ids = [])
+        video_ids.map{|video_id| add_video video_id}
+      end
+
+      def add_videos!(video_ids = [])
+        video_ids.map{|video_id| add_video! video_id}
+      end
+
+      def delete_playlist_items(attrs = {})
+        playlist_items.delete_all attrs
+      end
+
     private
 
       def delete_params
@@ -48,6 +68,10 @@ module Yt
           params[:expected_response] = Net::HTTPOK
         end
       end
+
+      def video_params(video_id)
+        {id: video_id, kind: :video}
+      end
     end
   end
 end

data/lib/yt/models/video.rb

@@ -6,6 +6,25 @@ module Yt
       has_one :details_set, delegate: [:duration]
       has_one :rating
       has_many :annotations
+
+      def liked?
+        rating.rating == :like
+      end
+
+      def like
+        rating.update :like
+        liked?
+      end
+
+      def dislike
+        rating.update :dislike
+        !liked?
+      end
+
+      def unlike
+        rating.update :none
+        !liked?
+      end
     end
   end
 end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/spec/associations/device_auth/account_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'yt/models/account'
+
+describe Yt::Account, :device_app do
+  describe '.channel' do
+    it { expect($account.channel).to be_a Yt::Channel }
+  end
+
+  describe '.user_info' do
+    it { expect($account.user_info).to be_a Yt::UserInfo }
+  end
+
+  describe '.videos' do
+    it { expect($account.videos).to be_a Yt::Collections::Videos }
+    it { expect($account.videos.first).to be_a Yt::Video }
+
+    describe '.where(q: query_string)' do
+      let(:count) { $account.videos.where(q: query).count }
+
+      context 'given a query string that matches any video owned by the account' do
+        let(:query) { ENV['YT_TEST_MATCHING_QUERY_STRING'] }
+        it { expect(count).to be > 0 }
+      end
+
+      context 'given a query string that does not match any video owned by the account' do
+        let(:query) { '--not-a-matching-query-string--' }
+        it { expect(count).to be_zero }
+      end
+    end
+  end
+end

data/spec/associations/device_auth/channel_spec.rb

@@ -0,0 +1,114 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'yt/models/channel'
+
+describe Yt::Channel, :device_app do
+  let(:channel) { Yt::Channel.new id: id, auth: $account }
+
+  describe '.snippet of existing channel' do
+    let(:id) { 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    it { expect(channel.snippet).to be_a Yt::Snippet }
+  end
+
+  describe '.snippet of unknown channel' do
+    let(:id) { 'not-a-channel-id' }
+    it { expect{channel.snippet}.to raise_error Yt::Errors::NoItems }
+  end
+
+  describe '.status of existing channel' do
+    let(:id) { 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    it { expect(channel.status).to be_a Yt::Status }
+  end
+
+  describe '.status of unknown channel' do
+    let(:id) { 'not-a-channel-id' }
+    it { expect{channel.status}.to raise_error Yt::Errors::NoItems }
+  end
+
+  describe '.videos of existing channel' do
+    let(:id) { 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    it { expect(channel.videos).to be_a Yt::Collections::Videos }
+  end
+
+  describe '.videos of unknown channel starting with UC' do
+    let(:id) { 'UC-not-a-channel-id' }
+
+    # NOTE: This test is just a reflection of YouTube irrational behavior of
+    # returns 0 results if the name of an unknown channel starts with UC, but
+    # returning 100,000 results otherwise (ignoring the channel filter).
+    it { expect(channel.videos.count).to be 0 }
+  end
+
+  describe '.subscriptions to an existing channel' do
+    let(:id) { 'UCxO1tY8h1AhOz0T4ENwmpow' }
+    it { expect(channel.subscriptions).to be_a Yt::Collections::Subscriptions }
+
+    # NOTE: These tests are slow because we *must* wait some seconds between
+    # subscribing and unsubscribing to a channel, otherwise YouTube will show
+    # wrong (cached) data, such as a user is subscribed when he is not.
+    context 'can be added', :slow do
+      before { channel.unsubscribe }
+      it { expect(channel.subscribed?).to be false }
+      it { expect(channel.subscribe!).to be_truthy }
+    end
+
+    context 'can be removed', :slow do
+      before { channel.subscribe }
+      it { expect(channel.subscribed?).to be true }
+      it { expect(channel.unsubscribe!).to be_truthy }
+    end
+  end
+
+  describe '.subscriptions to an unknown channel' do
+    let(:id) { 'not-a-channel-id' }
+    it { expect{channel.subscribe}.to raise_error Yt::Errors::RequestError }
+  end
+
+  describe '.subscriptions to my own channel' do
+    let(:id) { $account.channel.id }
+
+    # NOTE: This test is just a reflection of YouTube irrational behavior of
+    # raising a 500 error when you try to subscribe to your own channel, rather
+    # than a more logical 4xx error. Hopefully this will get fixed and this
+    # code (and test) removed.
+    it { expect{channel.subscribe}.to raise_error Yt::Errors::ServerError }
+  end
+
+  describe '.playlists of my own channel' do
+    let(:id) { $account.channel.id }
+    let(:title) { 'Yt Test title' }
+    let(:description) { 'Yt Test description' }
+    let(:tags) { ['Yt Test Tag 1', 'Yt Test Tag 2'] }
+    let(:privacy_status) { 'unlisted' }
+    let(:params) { {title: title, description: description, tags: tags, privacy_status: privacy_status} }
+
+    it { expect(channel.playlists).to be_a Yt::Collections::Playlists }
+
+    describe 'can be created' do
+      after { channel.delete_playlists params }
+      it { expect(channel.create_playlist params).to be_a Yt::Playlist }
+      it { expect{channel.create_playlist params}.to change{channel.playlists.count}.by(1) }
+    end
+
+    describe 'can be deleted' do
+      let(:title) { "Yt Test Delete All Playlists #{rand}" }
+      before { channel.create_playlist params }
+
+      it { expect(channel.delete_playlists title: %r{#{params[:title]}}).to eq [true] }
+      it { expect(channel.delete_playlists params).to eq [true] }
+      it { expect{channel.delete_playlists params}.to change{channel.playlists.count}.by(-1) }
+    end
+  end
+
+  describe '.playlists of someone else’s channel' do
+    let(:id) { 'UCxO1tY8h1AhOz0T4ENwmpow' }
+
+    it { expect(channel.playlists).to be_a Yt::Collections::Playlists }
+
+    describe 'cannot be created or destroyed' do
+      it { expect{channel.create_playlist}.to raise_error Yt::Errors::RequestError }
+      it { expect{channel.delete_playlists}.to raise_error Yt::Errors::RequestError }
+    end
+  end
+end