yt 0.32.0 → 0.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f06db796f31fee245ad83b3d20908c1e652d61fb
-  data.tar.gz: d1d811649caf2f5c4ef4dc689d71b97ef2290c5d
+  metadata.gz: 9b8170d3a7debea512ed16ea94625623a4189a93
+  data.tar.gz: eaa9f9146b89cb1bf686176299433c57d8ca0c64
 SHA512:
-  metadata.gz: 76902d316c6b13754da0501c52740faf226784e9f47ee002ad0552a1571a61f604caad50bad5b9c560abcbc6a0b863ad234b2b9e56620acf6cdba2aeca723a1a
-  data.tar.gz: 3a91d3dbbe592a8b189c301d2a122fb522a32dcb012b82ed5d6c9e3f306be283969b7c6bff01eaf34bb4605e2997fece355245f669cc8d117b89a021f8a16696
+  metadata.gz: 0a7892632cc6eb1660a675736690ea4efa55f77af26dcbd9e1c9a657662925b352b714a0da14ab95fa842908b89ecca7b01b48adcccbe277ec5e79473b2f3698
+  data.tar.gz: 811a28e571213a03359b3b1fbeb2c8d0498a664196238594c91e0f0de4ae5000d524356c631d3f84e36a76e0c226117f0026bd4123bdfbee3dc9a1bdbe617111

data/CHANGELOG.md

@@ -6,6 +6,11 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.32.1 - 2017-08-14
+
+* [FEATURE] Add `Yt::ContentOwner#bulk_report_jobs`
+* [FEATURE] Add `Yt::BulkReportJob#bulk_reports`
+
 ## 0.32.0 - 2017-07-05
 
 **How to upgrade**

data/README.md

@@ -166,6 +166,37 @@ comment.updated_at #=> 2016-03-22 12:56:56 UTC
 comment.parent_id #=> "abc1234" (return nil if the comment is not a reply)
 ```
 
+Yt::BulkReportJob
+----------------
+
+Use [Yt::BulkReportJob](http://www.rubydoc.info/gems/yt/Yt/Models/BulkReportJob) to:
+
+* Get details of a bulk report job.
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+bulk_report_job = content_owner.bulk_report_jobs.first
+
+bulk_report_job.report_type_id #=> "content_owner_demographics_a1"
+```
+
+Yt::BulkReport
+----------------
+
+Use [Yt::BulkReport](http://www.rubydoc.info/gems/yt/Yt/Models/BulkReport) to:
+
+* Get details of a bulk report.
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+bulk_report_job = content_owner.bulk_report_jobs.first
+bulk_report = bulk_report_job.bulk_reports.first
+
+bulk_report.start_time #=> 2017-08-11 07:00:00 UTC
+bulk_report.end_time #=> 2017-08-12 07:00:00 UTC
+bulk_report.download_url #=> "https://youtubereporting.googleapis.com/v1/..."
+```
+
 Yt::Collections::Videos
 -----------------------
 

data/lib/yt/collections/bulk_report_jobs.rb

@@ -0,0 +1,28 @@
+require 'yt/collections/base'
+require 'yt/models/bulk_report_job'
+
+module Yt
+  module Collections
+    # @private
+    class BulkReportJobs < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {id: data['id'], auth: @auth, report_type_id: data['reportTypeId']}
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'youtubereporting.googleapis.com'
+          params[:path] = "/v1/jobs"
+          params[:params] = {on_behalf_of_content_owner: @parent.owner_name}
+        end
+      end
+
+      def items_key
+        'jobs'
+      end
+    end
+  end
+end

data/lib/yt/collections/bulk_reports.rb

@@ -0,0 +1,24 @@
+require 'yt/collections/base'
+require 'yt/models/bulk_report'
+
+module Yt
+  module Collections
+    # @private
+    class BulkReports < Base
+
+    private
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'youtubereporting.googleapis.com'
+          params[:path] = "/v1/jobs/#{@parent.id}/reports"
+          params[:params] = {on_behalf_of_content_owner: @parent.auth.owner_name}
+        end
+      end
+
+      def items_key
+        'reports'
+      end
+    end
+  end
+end

data/lib/yt/models/bulk_report.rb

@@ -0,0 +1,23 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube Analytics bulk reports.
+    # @see https://developers.google.com/youtube/reporting/v1/reference/rest/v1/jobs.reports
+    class BulkReport < Base
+      # @private
+      attr_reader :auth
+
+      has_attribute :id
+      has_attribute :start_time, type: Time
+      has_attribute :end_time, type: Time
+      has_attribute :download_url
+
+      # @private
+      def initialize(options = {})
+        @data = options.fetch(:data, {})
+        @auth = options[:auth]
+      end
+    end
+  end
+end

data/lib/yt/models/bulk_report_job.rb

@@ -0,0 +1,23 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube Analytics bulk report jobs.
+    # @see https://developers.google.com/youtube/reporting/v1/reference/rest/v1/jobs
+    class BulkReportJob < Base
+      # @private
+      attr_reader :id, :auth, :report_type_id
+
+      # @private
+      def initialize(options = {})
+        @id = options[:id]
+        @auth = options[:auth]
+        @report_type_id = options[:report_type_id]
+      end
+
+      # @!attribute [r] bulk_reports
+      #   @return [Yt::Collections::BulkReports] the bulk reports of this job.
+      has_many :bulk_reports
+    end
+  end
+end

data/lib/yt/models/content_owner.rb

@@ -35,6 +35,11 @@ module Yt
       #     content owner.
       has_many :video_groups
 
+      # @!attribute [r] bulk_report_jobs
+      #   @return [Yt::Collections::BulkReportJobs] the bulk reporting jobs managed by the
+      #     content owner.
+      has_many :bulk_report_jobs
+
       def initialize(options = {})
         super options
         @owner_name = options[:owner_name]

data/lib/yt/version.rb

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

data/spec/requests/as_content_owner/bulk_report_job_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'yt/models/bulk_report_job'
+
+describe Yt::BulkReportJob, :partner do
+
+  describe '.bulk_reports' do
+    describe 'given the bulk report job has bulk reports' do
+      let(:job) { $content_owner.bulk_report_jobs.first }
+      let(:report) { job.bulk_reports.first }
+
+      it 'returns valid bulk reports' do
+        expect(report.id).to be_a String
+        expect(report.start_time).to be_a Time
+        expect(report.end_time).to be_a Time
+        expect(report.download_url).to be_a String
+      end
+    end
+  end
+end

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -305,6 +305,16 @@ describe Yt::ContentOwner, :partner do
     end
   end
 
+  describe '.bulk_report_jobs' do
+    describe 'given the content owner has bulk report jobs' do
+      let(:job) { $content_owner.bulk_report_jobs.first }
+
+      it 'returns valid job' do
+        expect(job.id).to be_a String
+        expect(job.report_type_id).to be_a String
+      end
+    end
+  end
   # @note: The following test works, but YouTube API endpoint to mark
   #   an asset as 'invalid' (soft-delete) does not work, and apparently
   #   there is no way to update the status of a asset.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.32.1
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,6 +148,8 @@ files:
 - lib/yt/collections/assets.rb
 - lib/yt/collections/authentications.rb
 - lib/yt/collections/base.rb
+- lib/yt/collections/bulk_report_jobs.rb
+- lib/yt/collections/bulk_reports.rb
 - lib/yt/collections/channels.rb
 - lib/yt/collections/claim_histories.rb
 - lib/yt/collections/claims.rb
@@ -198,6 +200,8 @@ files:
 - lib/yt/models/asset_snippet.rb
 - lib/yt/models/authentication.rb
 - lib/yt/models/base.rb
+- lib/yt/models/bulk_report.rb
+- lib/yt/models/bulk_report_job.rb
 - lib/yt/models/channel.rb
 - lib/yt/models/claim.rb
 - lib/yt/models/claim_event.rb
@@ -296,6 +300,7 @@ files:
 - spec/requests/as_content_owner/account_spec.rb
 - spec/requests/as_content_owner/advertising_options_set_spec.rb
 - spec/requests/as_content_owner/asset_spec.rb
+- spec/requests/as_content_owner/bulk_report_job_spec.rb
 - spec/requests/as_content_owner/channel_spec.rb
 - spec/requests/as_content_owner/claim_history_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb
@@ -401,6 +406,7 @@ test_files:
 - spec/requests/as_content_owner/account_spec.rb
 - spec/requests/as_content_owner/advertising_options_set_spec.rb
 - spec/requests/as_content_owner/asset_spec.rb
+- spec/requests/as_content_owner/bulk_report_job_spec.rb
 - spec/requests/as_content_owner/channel_spec.rb
 - spec/requests/as_content_owner/claim_history_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb