yt 0.23.1 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 004e3876d58c7c369d0e2a215d41234ad37f7b57
-  data.tar.gz: c4cc02ed5cf02d23858e7de931d5bc1bea63c932
+  metadata.gz: aa3a856cfe1b488850e6af5bf28d463fda5b1dde
+  data.tar.gz: 65d075b87a03e753b232d923966fb12b0a947d7e
 SHA512:
-  metadata.gz: 691d6757cb7112eb8993d6c81b98cc44bd15a31a50e73c1294761563ba15117adde788c04d89003f23eb23f24bead8ca0aa5d4d0b7856da4287969c5836ab9fd
-  data.tar.gz: 3f488e8e0c4bbffe17c9b78177f61a4ee7ed535ba483217d7f71980bcd11f9939ddf52588a5f2dd0e244fae15023af9449b8539de930c7ed2bba43f15d8953c7
+  metadata.gz: aeee94c2369c21e724f251f013b049c300350b476f884deffde9252f422af8764670137bc52439993cf8d36c7203e4b75e1f7e9eaaba6227a0309a8befc5561b
+  data.tar.gz: a95ae747c8b4dc774a7e6c498355bb0019806360ab85bbef9da91fffc56c2e9afa4a7c81fece144a21504db5ec1e5e59686bf6b38ff796de39cbee31829f3339

data/CHANGELOG.md

@@ -6,6 +6,10 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.23.2 - 2015-05-20
+
+* [FEATURE] Accept `:includes` in reports by video, related video and playlist to preload parts.
+
 ## 0.23.1 - 2015-05-19
 
 * [FEATURE] New `by: :month` option for reports.

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

data/lib/yt/associations/has_reports.rb

@@ -95,10 +95,10 @@ module Yt
       #     # => {embedded: 53.0, watch: 467.0, …}
       #   @return [Hash<Yt::Video, $2>] if grouped by related video, the
       #     $1 for each related video.
-      #   @example Get yesterday’s $1 by related video:
-      #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :related_video
+      #   @example Get yesterday’s $1 by related video, eager-loading the snippet of each video::
+      #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :related_video, includes: [:snippet]
       #     # => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}
-      #   @return [Hash<Yt::Video, $2>] if grouped by device type, the
+      #   @return [Hash<Symbol, $2>] if grouped by device type, the
       #     $1 for each device type.
       #   @example Get yesterday’s $1 by search term:
       #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :search_term
@@ -108,7 +108,7 @@ module Yt
       #   @example Get yesterday’s $1 by device type:
       #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :device_type
       #     # => {mobile: 133.0, tv: 412.0, …}
-      #   @return [Hash<Yt::Video, $2>] if grouped by traffic source, the
+      #   @return [Hash<Symbol, $2>] if grouped by traffic source, the
       #     $1 for each traffic source.
       #   @example Get yesterday’s $1 by traffic source:
       #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :traffic_source
@@ -121,6 +121,10 @@ module Yt
       #     Accepted values are: +:day+, +:month+, +:range+, +:traffic_source+,
       #     +:search_term+, +:playback_location+, +:related_video+,
       #     +:embedded_player_location+.
+      #   @option options [Array<Symbol>] :includes ([:id]) if grouped by
+      #     related video, the parts of each video to eager-load. Accepted
+      #     values are: +:id+, +:snippet+, +:status+, +:statistics+,
+      #     +:content_details+.
       #   @return [Hash<Symbol, $2>] if grouped by embedded player location,
       #     the $1 for each embedded player location.
       #   @example Get yesterday’s $1 by embedded player location:
@@ -130,16 +134,20 @@ module Yt
       #   @macro report_with_country_and_state
 
       # @!macro [new] report_with_channel_dimensions
+      #   @option options [Array<Symbol>] :includes ([:id]) if grouped by
+      #     video, related video, or playlist, the parts of each video or
+      #     playlist to eager-load. Accepted values are: +:id+, +:snippet+,
+      #     +:status+, +:statistics+, +:content_details+.
       #   @return [Hash<Yt::Video, $2>] if grouped by video, the
       #     $1 for each video.
-      #   @example Get yesterday’s $1 by video:
-      #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :video
+      #   @example Get yesterday’s $1 by video, eager-loading the status and statistics of each video:
+      #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :video, includes: [:status, :statistics]
       #     # => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}
-      #   @return [Hash<Yt::Video, $2>] if grouped by playlist, the
+      #   @return [Hash<Yt::Playlist, $2>] if grouped by playlist, the
       #     $1 for each playlist.
       #   @example Get yesterday’s $1 by playlist:
       #     resource.$1 since: 1.day.ago, until: 1.day.ago, by: :playlist
-      #     # => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}
+      #     # => {#<Yt::Playlist @id=…> => 33.0, #<Yt::Playlist @id=…> => 12.0, …}
       #   @macro report_with_video_dimensions
 
       # @!macro [new] report_by_channel_dimensions
@@ -253,7 +261,7 @@ module Yt
 
           ivar = instance_variable_get "@#{metric}_#{dimension}_#{country}_#{state}"
           instance_variable_set "@#{metric}_#{dimension}_#{country}_#{state}", ivar || {}
-          case dimension
+          results = case dimension
           when :day
             Hash[*range.flat_map do |date|
               [date, instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[date] ||= send("range_#{metric}", range, dimension, country, state)[date]]
@@ -261,6 +269,17 @@ module Yt
           else
             instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[range] ||= send("range_#{metric}", range, dimension, country, state)
           end
+          lookup_class = case options[:by]
+            when :video, :related_video then Yt::Collections::Videos
+            when :playlist then Yt::Collections::Playlists
+          end
+          if lookup_class
+            includes = options.fetch(:includes, [:id]).join(',').camelize(:lower)
+            items = lookup_class.new(auth: auth).where(part: includes, id: results.keys.join(','))
+            results.transform_keys{|id| items.find{|item| item.id == id}}.reject{|k, _| k.nil?}
+          else
+            results
+          end
         end
       end
 

data/lib/yt/collections/playlists.rb

@@ -13,7 +13,9 @@ module Yt
       end
 
       def playlists_params
-        resources_params.merge channel_id: @parent.id
+        params = resources_params
+        params.merge! channel_id: @parent.id if @parent
+        apply_where_params! params
       end
 
       def insert_parts

data/lib/yt/collections/reports.rb

@@ -10,10 +10,10 @@ module Yt
         hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(source, *values) { @metrics.keys.zip(values.map{|v| {TRAFFIC_SOURCES.key(source) => v}}).to_h} }
         hash[:playback_location] = {name: 'insightPlaybackLocationType', parse: ->(location, *values) { @metrics.keys.zip(values.map{|v| {PLAYBACK_LOCATIONS.key(location) => v}}).to_h} }
         hash[:embedded_player_location] = {name: 'insightPlaybackLocationDetail', parse: ->(url, *values) {@metrics.keys.zip(values.map{|v| {url => v}}).to_h} }
-        hash[:related_video] = {name: 'insightTrafficSourceDetail', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {Yt::Video.new(id: video_id, auth: @auth) => v}}).to_h} }
+        hash[:related_video] = {name: 'insightTrafficSourceDetail', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {video_id => v}}).to_h} }
         hash[:search_term] = {name: 'insightTrafficSourceDetail', parse: ->(search_term, *values) {@metrics.keys.zip(values.map{|v| {search_term => v}}).to_h} }
-        hash[:video] = {name: 'video', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {Yt::Video.new(id: video_id, auth: @auth) => v}}).to_h} }
-        hash[:playlist] = {name: 'playlist', parse: ->(playlist_id, *values) { @metrics.keys.zip(values.map{|v| {Yt::Playlist.new(id: playlist_id, auth: @auth) => v}}).to_h} }
+        hash[:video] = {name: 'video', parse: ->(video_id, *values) { @metrics.keys.zip(values.map{|v| {video_id => v}}).to_h} }
+        hash[:playlist] = {name: 'playlist', parse: ->(playlist_id, *values) { @metrics.keys.zip(values.map{|v| {playlist_id => v}}).to_h} }
         hash[:device_type] = {name: 'deviceType', parse: ->(type, *values) {@metrics.keys.zip(values.map{|v| {type.downcase.to_sym => v}}).to_h} }
         hash[:country] = {name: 'country', parse: ->(country_code, *values) { @metrics.keys.zip(values.map{|v| {country_code => v}}).to_h} }
         hash[:state] = {name: 'province', parse: ->(country_and_state_code, *values) { @metrics.keys.zip(values.map{|v| {country_and_state_code[3..-1] => v}}).to_h} }

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.23.1'
+  VERSION = '0.23.2'
 end

data/spec/requests/as_content_owner/channel_spec.rb

@@ -330,6 +330,12 @@ describe Yt::Channel, :partner do
           views = channel.views range.merge by: :related_video
           expect(views.keys).to all(be_instance_of Yt::Video)
         end
+
+        specify 'and provided with an :includes option to preload parts' do
+          views = channel.views range.merge by: :related_video, includes: [:statistics]
+          expect(views.keys.map{|v| v.instance_variable_defined? :@status}).to all(be false)
+          expect(views.keys.map{|v| v.instance_variable_defined? :@statistics_set}).to all(be true)
+        end
       end
 
       describe 'views can be grouped by search term' do
@@ -348,6 +354,12 @@ describe Yt::Channel, :partner do
           views = channel.views range.merge by: :video
           expect(views.keys).to all(be_instance_of Yt::Video)
         end
+
+        specify 'and provided with an :includes option to preload parts' do
+          views = channel.views range.merge by: :video, includes: [:statistics]
+          expect(views.keys.map{|v| v.instance_variable_defined? :@status}).to all(be false)
+          expect(views.keys.map{|v| v.instance_variable_defined? :@statistics_set}).to all(be true)
+        end
       end
 
       describe 'views can be grouped by playlist' do
@@ -357,6 +369,12 @@ describe Yt::Channel, :partner do
           views = channel.views range.merge by: :playlist
           expect(views.keys).to all(be_instance_of Yt::Playlist)
         end
+
+        specify 'and provided with an :includes option to preload parts' do
+          views = channel.views range.merge by: :playlist, includes: [:status]
+          expect(views.keys.map{|playlist| playlist.instance_variable_defined? :@content_details}).to all(be false)
+          expect(views.keys.map{|playlist| playlist.instance_variable_defined? :@status}).to all(be true)
+        end
       end
 
       describe 'views can be grouped by device type' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.23.2
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport