yt 0.9.8 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db90684e975d4957dfb63d6ae4dd5a7c4b48749c
-  data.tar.gz: a49f7815ae7a37e73ac6e26cb9f12cee97a011d2
+  metadata.gz: 15eb05d2e208d7879df8f1782afe21ce6180a00b
+  data.tar.gz: 6988cf951189228e648dab9af35584be0ba41370
 SHA512:
-  metadata.gz: 109d5c7feb5b3f1664b5f45a5618cbcbc75cda94cd44e7b0c7f86881ff9cbdf3959fffe2accdbcc1c6ae91bd5bf5f1173752c7a98a5eb5b83f85cfdafe6491fb
-  data.tar.gz: 49efcf9203a7f65e44aa28a498c860b6bde0afe64dbf648fcc9ab9d525dcfe968103238af05e70b855d6002523db3dc6a39683b49750c431ed394c534df160b8
+  metadata.gz: 800515d67a7c6b4a905d2fd2f70c65f51552a26848a540d0abd603dc2b7c65dc89c30a94ea079e0a1744594cbfe981e5359b8ac1780f97d94d26c3a6de7005f1
+  data.tar.gz: 0b97816f0f4dcefbb5fc50794abae380293f19cb1db44aa10ca0ccaa2af7056700809aff7fdcf6181a8b88db59ba5735d02c6bea397ae4f6de21d806fb1d8a38

data/CHANGELOG.md

@@ -6,6 +6,33 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.10.0 - 2014-08-11
+
+**How to upgrade**
+
+If your code never calls the `size` method to count how many items a list of
+results has (e.g., how many videos an account has), then you are good to go.
+
+If it does, then be aware that `size` will now return try to the number of
+items as specified in the "totalResults" field of the first page of the YouTube
+response, rather than loading *all* the pages (possibly thousands) and counting
+exactly how many items are returned.
+
+If this is acceptable, then you are good to go.
+If you want the old behavior, replace `size` with `count`:
+
+```ruby
+account = Yt::Account.new access_token: 'ya29...'
+# old behavior
+account.videos.size # => retrieved *all* the pages of the account’s videos
+# new behavior
+account.videos.size # => retrieves only the first page, returning the totalResults counter
+account.videos.count # => retrieves *all* the pages of the account’s videos
+```
+
+* [ENHANCEMENT] Calling `size` on a collection does not load all the pages of the collection
+* [ENHANCEMENT] Alias `policy.time_updated` to more coherent `policy.updated_at`
+
 ## 0.9.8 - 2014-08-11
 
 * [FEATURE] Add `.content_owner` and `.linked_at` to channels managed by a CMS content owner
@@ -117,18 +144,21 @@ If your code never declares instances of `Yt::Channel`, or never calls the
 
 If it does, then be aware that `subscribe` will not raise an error anymore if
 a YouTube user tries to subscribe to her/his own YouTube channel. Instead,
-`subscribe` will simply return `nil`. If this is acceptable, then you are good
-to go. If you want the old behavior, replace `subscribe` with `subscribe!`:
+`subscribe` will simply return `nil`.
+
+If this is acceptable, then you are good to go.
+If you want the old behavior, replace `subscribe` with `subscribe!`:
 
 ```ruby
 account = Yt::Account.new access_token: 'ya29...'
 channel = account.channel
 # old behavior
-channel.subscribe # => raise error
+channel.subscribe # => raised an error
 # new behavior
 channel.subscribe # => nil
-channel.subscribe! # => raise error
+channel.subscribe! # => raises an error
 ```
+
 * [ENHANCEMENT] `channel.subscribe` does not raise error when trying to subscribe to one’s own channel
 
 ## 0.7 - 2014/06/18

data/Gemfile.lock

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

data/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.9.8'
+    gem 'yt', '~> 0.10.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/actions/list.rb

@@ -4,8 +4,8 @@ require 'yt/errors/no_items'
 module Yt
   module Actions
     module List
-      delegate :count, :first, :any?, :each, :map, :flat_map, :find, to: :list
-      alias size count
+      delegate :count, :first, :any?, :each, :map, :flat_map, :find,
+        :size, to: :list
 
       def first!
         first.tap{|item| raise Errors::NoItems, last_request unless item}
@@ -15,7 +15,7 @@ module Yt
 
       def list
         @last_index, @page_token = 0, nil
-        Enumerator.new do |items|
+        Enumerator.new(-> {total_results}) do |items|
           while next_item = find_next
             items << next_item
           end
@@ -23,6 +23,15 @@ module Yt
         end
       end
 
+      # @private
+      # Returns the total number of items that YouTube can provide for the
+      # given request, either all in one page or in consecutive pages.
+      def total_results
+        response = request(list_params).run
+        total_results = response.body.fetch('pageInfo', {})['totalResults']
+        total_results ||= response.body.fetch(items_key, []).size
+      end
+
       def find_next
         @items ||= []
         if @items[@last_index].nil? && more_pages?

data/lib/yt/collections/annotations.rb

@@ -46,6 +46,15 @@ module Yt
         expected?(error) ? [] : raise(error)
       end
 
+      # @private
+      # @note Annotations overwrites +total_results+ since `items_key` is
+      #   not `items` for annotations.
+      # @todo Remove this function by extracting the keys used by annotations
+      #   in a method and reusing them both in `next_page` and `total_results`.
+      def total_results
+        count
+      end
+
       # Since there is no API endpoint, retrieving annotations of unknown
       # videos or of private videos (to which YouTube responds with 403)
       # should not raise an error, but simply not return any annotation.

data/lib/yt/models/policy.rb

@@ -29,9 +29,10 @@ module Yt
       end
 
       # @return [String] the time the policy was updated.
-      def time_updated
-        @time_updated ||= Time.parse @data['timeUpdated']
+      def updated_at
+        @updated_at ||= Time.parse @data['timeUpdated']
       end
+      alias time_updated updated_at
 
       # @return [Array<PolicyRule>] a list of rules that specify the action
       #   that YouTube should take and may optionally specify the conditions

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.9.8'
+  VERSION = '0.10.0'
 end

data/spec/collections/videos_spec.rb

@@ -6,9 +6,22 @@ describe Yt::Collections::Videos do
   subject(:collection) { Yt::Collections::Videos.new parent: channel }
   let(:channel) { Yt::Channel.new id: 'any-id' }
   let(:page) { {items: [], token: 'any-token'} }
-  let(:query) { {q: 'search string'} }
+
+  describe '#size' do
+    describe 'sends only one request and return the total results' do
+      let(:total_results) { 123456 }
+      before do
+        expect_any_instance_of(Yt::Request).to receive(:run).once do
+          double(body: {'pageInfo'=>{'totalResults'=>total_results}})
+        end
+      end
+      it { expect(collection.size).to be total_results }
+    end
+  end
 
   describe '#count' do
+    let(:query) { {q: 'search string'} }
+
     context 'called once with .where(query) and once without' do
       after do
         collection.where(query).count

data/spec/models/policy_spec.rb

@@ -25,10 +25,10 @@ describe Yt::Policy do
     end
   end
 
-  describe '#time_updated' do
+  describe '#updated_at' do
     context 'given fetching a policy returns a timeUpdated' do
       let(:data) { {"timeUpdated"=>"1970-01-16T20:33:03.675Z"} }
-      it { expect(policy.time_updated.year).to be 1970 }
+      it { expect(policy.updated_at.year).to be 1970 }
     end
   end
 

data/spec/requests/as_account/channel_spec.rb

@@ -42,12 +42,15 @@ describe Yt::Channel, :device_app do
       it { expect(channel.unsubscribe!).to be_truthy }
     end
 
-    # NOTE: These tests are slow because they go through multiple pages of
-    # results and do so to test that we can overcome YouTube’s limitation of
-    # only returning the first 500 results for each query.
+    # @note: these tests are slow because they go through multiple pages of
+    #   results and do so to test that we can overcome YouTube’s limitation of
+    #   only returning the first 500 results for each query.
+    # @note: in principle, the following three counters should match, but in
+    #   reality +video_count+ and +size+ are only approximations.
     context 'with more than 500 videos' do
       let(:id) { 'UCsmvakQZlvGsyjyOhmhvOsw' }
       it { expect(channel.video_count).to be > 500 }
+      it { expect(channel.videos.size).to be > 500 }
       it { expect(channel.videos.count).to be > 500 }
     end
   end
@@ -126,7 +129,8 @@ describe Yt::Channel, :device_app do
       # 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 }
+      it { expect(channel.videos.count).to be_zero }
+      it { expect(channel.videos.size).to be_zero }
     end
   end
 end

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -3,8 +3,7 @@ require 'yt/models/content_owner'
 
 describe Yt::ContentOwner, :partner do
   describe '.partnered_channels' do
-    # NOTE: Uncomment once size does not runs through *all* the pages
-    # it { expect($content_owner.partnered_channels.size).to be > 0 }
+    it { expect($content_owner.partnered_channels.size).to be > 0 }
     it { expect($content_owner.partnered_channels.first).to be_a Yt::Channel }
   end
 
@@ -129,7 +128,7 @@ describe Yt::ContentOwner, :partner do
       it 'returns valid metadata' do
         expect(policy.id).to be_a String
         expect(policy.name).to be_a String
-        expect(policy.time_updated).to be_a Time
+        expect(policy.updated_at).to be_a Time
         expect(rule.action).to  be_in Yt::PolicyRule::ACTIONS
         expect(rule.included_territories).to be_an Array
         expect(rule.excluded_territories).to be_an Array

data/spec/requests/as_server_app/channel_spec.rb

@@ -36,7 +36,8 @@ describe Yt::Channel, :server_app do
       # 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 }
+      it { expect(channel.videos.count).to be_zero }
+      it { expect(channel.videos.size).to be_zero }
     end
   end
 end

data/spec/requests/unauthenticated/video_spec.rb

@@ -9,6 +9,7 @@ describe Yt::Video do
 
     it { expect(video.annotations).to be_a Yt::Collections::Annotations }
     it { expect(video.annotations.first).to be_a Yt::Annotation }
+    it { expect(video.annotations.size).to be > 0 }
   end
 
   context 'given a private video' do
@@ -16,5 +17,6 @@ describe Yt::Video do
 
     it { expect(video.annotations).to be_a Yt::Collections::Annotations }
     it { expect(video.annotations.count).to be_zero }
+    it { expect(video.annotations.size).to be_zero }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.0
 platform: ruby
 authors:
 - Claudio Baccigalupo