yt 0.31.2 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52267a5041f8e6b5325f5b863500712c3e3acf2e
-  data.tar.gz: a0706b064d97e65d28de1be5db48a2c1e42d917d
+  metadata.gz: f06db796f31fee245ad83b3d20908c1e652d61fb
+  data.tar.gz: d1d811649caf2f5c4ef4dc689d71b97ef2290c5d
 SHA512:
-  metadata.gz: 07c021f0ce1d41deb5f158a173f5ee404c566ae738a69a1e012216337af7eafe869e6a53998bdb8b9529b9377a993ccdea8965eebdeeeea63c15ce81fb21928a
-  data.tar.gz: 841b3504f1d1add89536edda857c1dc0ae55a831bfff2a873ceb5290be7961ae118405a4fe729bcbe98b189b54a2cfabaf04c5e50212a706ed56bcfaa9d6eed0
+  metadata.gz: 76902d316c6b13754da0501c52740faf226784e9f47ee002ad0552a1571a61f604caad50bad5b9c560abcbc6a0b863ad234b2b9e56620acf6cdba2aeca723a1a
+  data.tar.gz: 3a91d3dbbe592a8b189c301d2a122fb522a32dcb012b82ed5d6c9e3f306be283969b7c6bff01eaf34bb4605e2997fece355245f669cc8d117b89a021f8a16696

data/CHANGELOG.md

@@ -6,6 +6,14 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.32.0 - 2017-07-05
+
+**How to upgrade**
+
+If your code is expecting data from `reports` methods to always include historical data (the data from the period before joining), now you have to set `historical: true` specifically. It will not include historical data by default.
+
+* [IMPROVEMENT] Include historical data with `historical: true` option.
+
 ## 0.31.2 - 2017-06-29
 
 * [BUGFIX] Return lifetime data correctly even when the channel joined content owner after a while since it's created.

data/lib/yt/associations/has_reports.rb

@@ -235,6 +235,7 @@ module Yt
           state = location[:state] if location.is_a?(Hash)
           dimension = options[:by] || (metric == :viewer_percentage ? :gender_age_group : :range)
           videos = options[:videos]
+          historical = options[:historical].to_s if [true, false].include?(options[:historical])
           if dimension == :month
             from = from.to_date.beginning_of_month
             to = to.to_date.beginning_of_month
@@ -245,7 +246,7 @@ module Yt
           reports = Collections::Reports.of(self).tap do |reports|
             reports.metrics = self.class.instance_variable_get(:@metrics).select{|k, v| k.in? only}
           end
-          reports.within date_range, country, state, dimension, videos
+          reports.within date_range, country, state, dimension, videos, historical
         end unless defined?(reports)
       end
 
@@ -258,6 +259,7 @@ module Yt
           state = location[:state] if location.is_a?(Hash)
           dimension = options[:by] || (metric == :viewer_percentage ? :gender_age_group : :range)
           videos = options[:videos]
+          historical = options[:historical].to_s if [true, false].include?(options[:historical])
           if dimension == :month
             from = from.to_date.beginning_of_month
             to = to.to_date.beginning_of_month
@@ -269,10 +271,10 @@ module Yt
           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, videos)[date]]
+              [date, instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[date] ||= send("range_#{metric}", range, dimension, country, state, videos, historical)[date]]
             end]
           else
-            instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[range] ||= send("range_#{metric}", range, dimension, country, state, videos)
+            instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[range] ||= send("range_#{metric}", range, dimension, country, state, videos, historical)
           end
           lookup_class = case options[:by]
             when :video, :related_video then Yt::Collections::Videos
@@ -289,10 +291,10 @@ module Yt
       end
 
       def define_range_metric_method(metric)
-        define_method "range_#{metric}" do |date_range, dimension, country, state, videos|
+        define_method "range_#{metric}" do |date_range, dimension, country, state, videos, historical|
           ivar = instance_variable_get "@range_#{metric}_#{dimension}_#{country}_#{state}"
           instance_variable_set "@range_#{metric}_#{dimension}_#{country}_#{state}", ivar || {}
-          instance_variable_get("@range_#{metric}_#{dimension}_#{country}_#{state}")[date_range] ||= send("all_#{metric}").within date_range, country, state, dimension, videos
+          instance_variable_get("@range_#{metric}_#{dimension}_#{country}_#{state}")[date_range] ||= send("all_#{metric}").within date_range, country, state, dimension, videos, historical
         end
         private "range_#{metric}"
       end

data/lib/yt/collections/reports.rb

@@ -117,12 +117,13 @@ module Yt
 
       attr_writer :metrics
 
-      def within(days_range, country, state, dimension, videos, max_retries = 3)
+      def within(days_range, country, state, dimension, videos, historical, max_retries = 3)
         @days_range = days_range
         @country = country
         @state = state
         @dimension = dimension
         @videos = videos
+        @historical = historical
         if dimension == :gender_age_group # array of array
           Hash.new{|h,k| h[k] = Hash.new 0.0}.tap do |hash|
             each{|gender, age_group, value| hash[gender][age_group[3..-1]] = value}
@@ -157,7 +158,7 @@ module Yt
       # same query is a workaround that works and can hardly cause any damage.
       # Similarly, once in while YouTube responds with a random 503 error.
       rescue Yt::Error => e
-        (max_retries > 0) && rescue?(e) ? sleep(3) && within(days_range, country, state, dimension, videos, max_retries - 1) : raise
+        (max_retries > 0) && rescue?(e) ? sleep(3) && within(days_range, country, state, dimension, videos, historical, max_retries - 1) : raise
       end
 
     private
@@ -188,7 +189,7 @@ module Yt
           params['end-date'] = @days_range.end
           params['metrics'] = @metrics.keys.join(',').to_s.camelize(:lower)
           params['dimensions'] = DIMENSIONS[@dimension][:name] unless @dimension == :range
-          params['include-historical-channel-data'] = 'true'
+          params['include-historical-channel-data'] = @historical if @historical
           params['max-results'] = 50 if @dimension.in? [:playlist, :video]
           params['max-results'] = 25 if @dimension.in? [:embedded_player_location, :related_video, :search_term, :referrer]
           if @dimension.in? [:video, :playlist, :embedded_player_location, :related_video, :search_term, :referrer]

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.31.2'
+  VERSION = '0.32.0'
 end

data/spec/collections/reports_spec.rb

@@ -9,7 +9,7 @@ describe Yt::Collections::Reports do
   let(:msg) { {response_body: {error: {errors: [error]}}}.to_json }
 
   describe '#within' do
-    let(:result) { reports.within Range.new(5.days.ago, 4.days.ago), nil, nil, :day, nil }
+    let(:result) { reports.within Range.new(5.days.ago, 4.days.ago), nil, nil, :day, nil, nil }
     context 'given the request raises error 400 with "Invalid Query" message' do
       let(:reason) { 'badRequest' }
       let(:message) { 'Invalid query. Query did not conform to the expectations' }
@@ -27,4 +27,4 @@ describe Yt::Collections::Reports do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.31.2
+  version: 0.32.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -337,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Yt makes it easy to interact with Youtube V3 API by providing a modular,
@@ -421,4 +421,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/fail_matcher.rb
 - spec/support/global_hooks.rb
-has_rdoc: