yt 0.30.1 → 0.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85dc2f5c2b7be22fbac90192e295572b04c55a42
-  data.tar.gz: 4936ddb4ad8fecf00ea6da4a50816543ffae0e13
+  metadata.gz: a91b5314ec281538331cb88409f06f7f40c35480
+  data.tar.gz: f1efe786ae1b22c549374e7cf9530c02066e9864
 SHA512:
-  metadata.gz: 0b13072d264a684c8985a4c992546b6f6656ad63658378a735b640384838b51cd33230f1480a49af385a94ead440d9f9fd4a70817eae2faa8f40dd8d3a13484b
-  data.tar.gz: 863c77c4356e5da31f0ab40dbd3ce6bf1d56ac7225a359a1cccf05733b2dfb1b5176b5087de7fecbdf22ef3c2766b5dcc918a308ceae9d856930e4fd4bbe074a
+  metadata.gz: 296e9759c4daefafb703eaa4522a4171a026997acbbc643c6b758fbfca35b75073377fdc92cfc178b27a29b010b7a3ffea3cbc5cc91dadcc3ef7efc7d8b13149
+  data.tar.gz: 83eea64183b8516e94050821269a0f444698c5c0e75f32d0f8d5e9f93e43987c7116175ec02619fb774183e87e7d551c319b7dc8cc8543a11c7004e0121959d2

data/CHANGELOG.md

@@ -6,6 +6,21 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.31.1 - 2017-06-03
+
+* [FEATURE] Add `by: :youtube_product` option for reports.
+* [FEATURE] Add `Yt::Collections::Reports::YOUTUBE_PRODUCTS` to list all YouTube products (KIDS, GAMING, etc) supported by YouTube Analytics API.
+* [FEATURE] Add more operating system dimensions to `Yt::Collections::Reports::OPERATING_SYSTEMS`.
+
+## 0.31.0 - 2017-06-02
+
+**How to upgrade**
+
+If your code calls `.uniques` it should be removed because this metric has been
+no longer supported by YouTube API as of [October 31, 2016](https://developers.google.com/youtube/analytics/revision_history#september-27-2016).
+
+* [REMOVAL] Remove `#uniques` method for channels, videos and video groups.
+
 ## 0.30.1 - 2017-04-14
 
 * [IMPROVEMENT] Retry 3 times if YouTube responds with 503 Backend Error
@@ -44,7 +59,7 @@ Finally note that this also remove the class `Yt::Description`. This class
 was private API, so this change should not affect developers.
 
 * [REMOVAL] Remove the option to initialize resources by URL.
-* [REMOVAL] Remove 'Yt::Resource.username`
+* [REMOVAL] Remove `Yt::Resource.username`
 * [REMOVAL] Remove `Yt::URL` (extracted into separate gem)
 * [REMOVAL] Remove `Yt::Description` (now simply a String).
 

data/lib/yt/associations/has_reports.rb

@@ -243,7 +243,7 @@ module Yt
 
           only = options.fetch :only, []
           reports = Collections::Reports.of(self).tap do |reports|
-            reports.metrics =  self.class.instance_variable_get(:@metrics).select{|k, v| k.in? only}
+            reports.metrics = self.class.instance_variable_get(:@metrics).select{|k, v| k.in? only}
           end
           reports.within date_range, country, state, dimension, videos
         end unless defined?(reports)
@@ -310,4 +310,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/reports.rb

@@ -19,6 +19,7 @@ module Yt
         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| {DEVICE_TYPES.key(type) => v}}).to_h} }
         hash[:operating_system] = {name: 'operatingSystem', parse: ->(os, *values) {@metrics.keys.zip(values.map{|v| {OPERATING_SYSTEMS.key(os) => v}}).to_h} }
+        hash[:youtube_product] = {name: 'youtubeProduct', parse: ->(product, *values) {@metrics.keys.zip(values.map{|v| {YOUTUBE_PRODUCTS.key(product) => 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} }
         hash[:gender_age_group] = {name: 'gender,ageGroup', parse: ->(gender, *values) { [gender.downcase.to_sym, *values] }}
@@ -68,6 +69,14 @@ module Yt
         unsubscribed: 'UNSUBSCRIBED'
       }
 
+      # @see https://developers.google.com/youtube/analytics/v1/dimsmets/dims#youtubeProduct
+      YOUTUBE_PRODUCTS = {
+        core: 'CORE',
+        gaming: 'GAMING',
+        kids: 'KIDS',
+        unknown: 'UNKNOWN'
+      }
+
       # @see https://developers.google.com/youtube/analytics/v1/dimsmets/dims#Device_Dimensions
       DEVICE_TYPES = {
         desktop: 'DESKTOP',
@@ -85,6 +94,7 @@ module Yt
         blackberry: 'BLACKBERRY',
         chromecast: 'CHROMECAST',
         docomo: 'DOCOMO',
+        firefox: 'FIREFOX',
         hiptop: 'HIPTOP',
         ios: 'IOS',
         linux: 'LINUX',
@@ -94,8 +104,10 @@ module Yt
         other: 'OTHER',
         playstation: 'PLAYSTATION',
         playstation_vita: 'PLAYSTATION_VITA',
+        realmedia: 'REALMEDIA',
         smart_tv: 'SMART_TV',
         symbian: 'SYMBIAN',
+        tizen: 'TIZEN',
         webos: 'WEBOS',
         wii: 'WII',
         windows: 'WINDOWS',
@@ -107,9 +119,9 @@ module Yt
 
       def within(days_range, country, state, dimension, videos, max_retries = 3)
         @days_range = days_range
-        @dimension = dimension
         @country = country
         @state = state
+        @dimension = dimension
         @videos = videos
         if dimension == :gender_age_group # array of array
           Hash.new{|h,k| h[k] = Hash.new 0.0}.tap do |hash|

data/lib/yt/models/channel.rb

@@ -114,9 +114,6 @@ module Yt
       # @macro report_by_channel_dimensions
       has_report :views, Integer
 
-      # @macro report_by_day
-      has_report :uniques, Integer
-
       # @macro report_by_channel_dimensions
       has_report :estimated_minutes_watched, Integer
 
@@ -317,4 +314,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/video.rb

@@ -402,9 +402,6 @@ module Yt
       # @macro report_by_video_dimensions
       has_report :views, Integer
 
-      # @macro report_by_day
-      has_report :uniques, Integer
-
       # @macro report_by_video_dimensions
       has_report :estimated_minutes_watched, Integer
 

data/lib/yt/models/video_group.rb

@@ -37,9 +37,6 @@ module Yt
       # @macro report_by_video_dimensions
       has_report :views, Integer
 
-      # @macro report_by_day
-      has_report :uniques, Integer
-
       # @macro report_by_video_dimensions
       has_report :estimated_minutes_watched, Integer
 

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.30.1'
+  VERSION = '0.31.1'
 end

data/spec/requests/as_content_owner/channel_spec.rb

@@ -11,7 +11,7 @@ describe Yt::Channel, :partner do
       let(:id) { ENV['YT_TEST_PARTNER_CHANNEL_ID'] }
 
       describe 'multiple reports can be retrieved at once' do
-        metrics = {views: Integer, uniques: Integer,
+        metrics = {views: Integer,
           estimated_minutes_watched: Integer, comments: Integer, likes: Integer,
           dislikes: Integer, shares: Integer, subscribers_gained: Integer,
           subscribers_lost: Integer,
@@ -59,7 +59,7 @@ describe Yt::Channel, :partner do
         end
       end
 
-      [:views, :uniques, :comments, :likes, :dislikes, :shares,
+      [:views, :comments, :likes, :dislikes, :shares,
        :subscribers_gained, :subscribers_lost,
        :videos_added_to_playlists, :videos_removed_from_playlists,
        :estimated_minutes_watched, :average_view_duration,
@@ -487,56 +487,6 @@ describe Yt::Channel, :partner do
         end
       end
 
-      describe 'uniques can be retrieved for a single country' do
-        let(:country_code) { 'US' }
-        let(:uniques) { channel.uniques since: date, by: by, in: location }
-        let(:date) { 4.days.ago }
-
-        context 'and grouped by day' do
-          let(:by) { :day }
-
-          context 'with the :in option set to the country code' do
-            let(:location) { country_code }
-            it { expect(uniques.keys.min).to eq date.to_date }
-          end
-
-          context 'with the :in option set to {country: country code}' do
-            let(:location) { {country: country_code} }
-            it { expect(uniques.keys.min).to eq date.to_date }
-          end
-        end
-      end
-
-      describe 'uniques can be retrieved for a single US state' do
-        let(:state_code) { 'NY' }
-        let(:result) { channel.uniques since: date, by: by, in: location }
-        let(:date) { 4.days.ago }
-
-        context 'and grouped by day' do
-          let(:by) { :day }
-
-          context 'with the :in option set to {state: state code}' do
-            let(:location) { {state: state_code} }
-            it { expect(result.keys.min).to eq date.to_date }
-          end
-
-          context 'with the :in option set to {country: "US", state: state code}' do
-            let(:location) { {country: 'US', state: state_code} }
-            it { expect(result.keys.min).to eq date.to_date }
-          end
-        end
-      end
-
-      describe 'uniques can be grouped by day' do
-        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
-        let(:keys) { range.values }
-
-        specify 'with the :by option set to :day' do
-          uniques = channel.uniques range.merge by: :day
-          expect(uniques.keys).to eq range.values
-        end
-      end
-
       describe 'comments can be retrieved for a single country' do
         let(:country_code) { 'US' }
         let(:comments) { channel.comments since: date, by: by, in: location }

data/spec/requests/as_content_owner/video_group_spec.rb

@@ -62,7 +62,7 @@ describe Yt::VideoGroup, :partner do
       end
 
       describe 'multiple reports can be retrieved at once' do
-        metrics = {views: Integer, uniques: Integer,
+        metrics = {views: Integer,
           estimated_minutes_watched: Integer, comments: Integer, likes: Integer,
           dislikes: Integer, shares: Integer, subscribers_gained: Integer,
           subscribers_lost: Integer,

data/spec/requests/as_content_owner/video_spec.rb

@@ -13,7 +13,7 @@ describe Yt::Video, :partner do
         it { expect{video.advertising_options_set}.not_to raise_error }
       end
 
-      [:views, :uniques, :comments, :likes, :dislikes, :shares,
+      [:views, :comments, :likes, :dislikes, :shares,
        :subscribers_gained, :subscribers_lost,
        :videos_added_to_playlists, :videos_removed_from_playlists,
        :estimated_minutes_watched, :average_view_duration,
@@ -174,7 +174,7 @@ describe Yt::Video, :partner do
       end
 
       describe 'multiple reports can be retrieved at once' do
-        metrics = {views: Integer, uniques: Integer,
+        metrics = {views: Integer,
           estimated_minutes_watched: Integer, comments: Integer, likes: Integer,
           dislikes: Integer, shares: Integer, subscribers_gained: Integer,
           subscribers_lost: Integer,
@@ -369,6 +369,16 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'views can be grouped by YouTube product' do
+        let(:keys) { Yt::Collections::Reports::YOUTUBE_PRODUCTS.keys }
+
+        specify 'with the :by option set to :youtube_product' do
+          views = video.views by: :youtube_product
+          expect(views.keys - keys).to be_empty
+          expect(views.values).to all(be_an Integer)
+        end
+      end
+
       describe 'views can be grouped by country' do
         let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE']} }
 
@@ -412,36 +422,6 @@ describe Yt::Video, :partner do
         end
       end
 
-      describe 'uniques can be retrieved for a single US state' do
-        let(:state_code) { 'NY' }
-        let(:result) { video.uniques since: date, by: by, in: location }
-        let(:date) { 4.days.ago }
-
-        context 'and grouped by day' do
-          let(:by) { :day }
-
-          context 'with the :in option set to {state: state code}' do
-            let(:location) { {state: state_code} }
-            it { expect(result.keys.min).to eq date.to_date }
-          end
-
-          context 'with the :in option set to {country: "US", state: state code}' do
-            let(:location) { {country: 'US', state: state_code} }
-            it { expect(result.keys.min).to eq date.to_date }
-          end
-        end
-      end
-
-      describe 'uniques can be grouped by day' do
-        let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
-        let(:keys) { range.values }
-
-        specify 'with the :by option set to :day' do
-          uniques = video.uniques range.merge by: :day
-          expect(uniques.keys).to eq range.values
-        end
-      end
-
       describe 'comments can be grouped by day' do
         let(:range) { {since: 4.days.ago.to_date, until: 3.days.ago.to_date} }
         let(:keys) { range.values }

data/yt.gemspec

@@ -30,4 +30,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake' #, '~> 10.0'
   spec.add_development_dependency 'yard' #, '~> 0.8.0'
   spec.add_development_dependency 'coveralls' #, '~> 0.7.0'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.31.1
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport