yt 0.11.1 → 0.11.2

data/lib/yt/models/resumable_session.rb

@@ -39,6 +39,7 @@ module Yt
           params[:path] = @uri.path
           params[:expected_response] = Net::HTTPSuccess
           params[:headers] = @headers
+          params[:camelize_params] = false
           params[:params] = session_params
         end
       end

data/lib/yt/models/right_owner.rb

@@ -0,0 +1,69 @@
+require 'yt/models/description'
+
+module Yt
+  module Models
+    # Encapsulates information about the various types of owners of an asset.
+    # @see https://developers.google.com/youtube/partner/docs/v1/ownership#resource
+    class RightOwner
+      def initialize(options = {})
+        @data = options[:data]
+      end
+
+      # @return [Float] the percentage of the asset that the owner controls or
+      #   administers. For composition assets, the value can be any value
+      #   between 0 and 100 inclusive. For all other assets, the only valid
+      #   values are 100, which indicates that the owner completely owns the
+      #   asset in the specified territories, and 0, which indicates that you
+      #   are removing ownership of the asset in the specified territories.
+      def ratio
+        @ratio ||= @data['ratio'].to_f
+      end
+
+      # @return [String] the name of the asset’s owner or rights administrator.
+      def owner
+        @owner ||= @data['owner']
+      end
+
+      # @return [String] if the asset is a composition asset and the asset
+      #   owner is not known to have a formal relationship established with
+      #   YouTube, the name of the asset’s publisher or rights administrator.
+      # @return [nil] otherwise.
+      def publisher
+        @publisher ||= @data['publisher']
+      end
+
+      # Return the list of territories where the owner owns the asset.
+      # Each territory is an ISO 3166 two-letter country code.
+      # @return [Array<String>] if the ownership lists 'included' territories,
+      #   the territories where the owner owns the asset.
+      # @return [nil] if the ownership does not list 'included' territories,
+      def included_territories
+        territories if type == 'include'
+      end
+
+      # Return the list of territories where the owner does not own the asset.
+      # Each territory is an ISO 3166 two-letter country code.
+      # @return [Array<String>] if the ownership lists 'excluded' territories,
+      #   the territories where the owner does not own the asset.
+      # @return [nil] if the ownership does not list 'excluded' territories,
+      def excluded_territories
+        territories if type == 'exclude'
+      end
+
+      # @return [Boolean] whether the ownership applies to the whole world.
+      def everywhere?
+        excluded_territories == []
+      end
+
+    private
+
+      def type
+        @type ||= @data['type']
+      end
+
+      def territories
+        @territories ||= @data.fetch 'territories', []
+      end
+    end
+  end
+end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.11.1'
+  VERSION = '0.11.2'
 end

data/spec/models/asset_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'yt/models/asset'
+
+describe Yt::Asset do
+  subject(:asset) { Yt::Asset.new data: data }
+
+  describe '#id' do
+    context 'given fetching a asset returns an id' do
+      let(:data) { {"id"=>"A123456789012345"} }
+      it { expect(asset.id).to eq 'A123456789012345' }
+    end
+  end
+
+  describe '#type' do
+    context 'given fetching a asset returns an type' do
+      let(:data) { {"type"=>"web"} }
+      it { expect(asset.type).to eq 'web' }
+    end
+  end
+end

data/spec/models/ownership_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'yt/models/ownership'
+
+describe Yt::Ownership do
+  subject(:ownership) { Yt::Ownership.new data: data }
+  let(:data) { {} }
+
+  describe '#general_owners' do
+    context 'given fetching an ownership returns a general owner' do
+      let(:general) { '{"ratio":100.0,"owner":"FullScreen","type":"exclude"}' }
+      let(:data) { {"general"=>[general]} }
+      it { expect(ownership.general_owners.size).to be 1 }
+      it { expect(ownership.general_owners.first).to be_a Yt::RightOwner }
+    end
+
+    context 'given fetching an ownership does not return general owners' do
+      it { expect(ownership.general_owners).to be_empty }
+    end
+  end
+
+  describe '#performance_owners' do
+    context 'given fetching an ownership returns a performance owner' do
+      let(:performance) { '{"ratio":100.0,"owner":"FullScreen","type":"exclude"}' }
+      let(:data) { {"performance"=>[performance]} }
+      it { expect(ownership.performance_owners.size).to be 1 }
+      it { expect(ownership.performance_owners.first).to be_a Yt::RightOwner }
+    end
+
+    context 'given fetching an ownership does not return performance owners' do
+      it { expect(ownership.performance_owners).to be_empty }
+    end
+  end
+
+  describe '#synchronization_owners' do
+    context 'given fetching an ownership returns a synchronization owner' do
+      let(:synchronization) { '{"ratio":100.0,"owner":"FullScreen","type":"exclude"}' }
+      let(:data) { {"synchronization"=>[synchronization]} }
+      it { expect(ownership.synchronization_owners.size).to be 1 }
+      it { expect(ownership.synchronization_owners.first).to be_a Yt::RightOwner }
+    end
+
+    context 'given fetching an ownership does not return synchronization owners' do
+      it { expect(ownership.synchronization_owners).to be_empty }
+    end
+  end
+
+  describe '#mechanical_owners' do
+    context 'given fetching an ownership returns a mechanical owner' do
+      let(:mechanical) { '{"ratio":100.0,"owner":"FullScreen","type":"exclude"}' }
+      let(:data) { {"mechanical"=>[mechanical]} }
+      it { expect(ownership.mechanical_owners.size).to be 1 }
+      it { expect(ownership.mechanical_owners.first).to be_a Yt::RightOwner }
+    end
+
+    context 'given fetching an ownership does not return mechanical owners' do
+      it { expect(ownership.mechanical_owners).to be_empty }
+    end
+  end
+end

data/spec/models/right_owner_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'yt/models/right_owner'
+
+describe Yt::RightOwner do
+  subject(:right_owner) { Yt::RightOwner.new data: data }
+  let(:data) { {} }
+
+  describe '#ratio' do
+    context 'given fetching an owner returns a ratio' do
+      let(:data) { {"ratio"=>"20.0"} }
+      it { expect(right_owner.ratio).to eq 20 }
+    end
+  end
+
+  describe '#owner' do
+    context 'given fetching an owner returns an owner name' do
+      let(:data) { {"owner"=>"FullScreen"} }
+      it { expect(right_owner.owner).to eq 'FullScreen' }
+    end
+  end
+
+  describe '#owner' do
+    context 'given fetching an owner returns a publisher name' do
+      let(:data) { {"publisher"=>"Third Party"} }
+      it { expect(right_owner.publisher).to eq 'Third Party' }
+    end
+
+    context 'given fetching an owner does not return a publisher name' do
+      it { expect(right_owner.publisher).to be_nil }
+    end
+  end
+
+  describe '#included_territories' do
+    context 'given fetching an owner returns included territories' do
+      let(:data) { {"type"=>"include", "territories"=>["US", "CA"]} }
+      it { expect(right_owner.included_territories).to eq %w(US CA) }
+    end
+
+    context 'given fetching an owner does not return included territories' do
+      it { expect(right_owner.included_territories).to be_nil }
+    end
+  end
+
+  describe '#excluded_territories' do
+    context 'given fetching an owner returns excluded territories' do
+      let(:data) { {"type"=>"exclude", "territories"=>["US", "CA"]} }
+      it { expect(right_owner.excluded_territories).to eq %w(US CA) }
+    end
+
+    context 'given fetching an owner does not return excluded territories' do
+      it { expect(right_owner.excluded_territories).to be_nil }
+    end
+  end
+
+  describe '#everywhere?' do
+    context 'given fetching an owner returns zero excluded territories' do
+      let(:data) { {"type"=>"exclude", "territories"=>[]} }
+      it { expect(right_owner).to be_everywhere }
+    end
+
+    context 'given fetching an owner returns no excluded territories' do
+      let(:data) { {"type"=>"exclude"} }
+      it { expect(right_owner).to be_everywhere }
+    end
+
+    context 'given fetching an owner returns included territories' do
+      let(:data) { {"type"=>"include", "territories"=>[]} }
+      it { expect(right_owner).not_to be_everywhere }
+    end
+  end
+end

data/spec/requests/as_content_owner/advertising_options_set_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'yt/models/advertising_options_set'
+
+describe Yt::AdvertisingOptionsSet, :partner do
+  subject(:advertising_options_set) { Yt::AdvertisingOptionsSet.new video_id: video_id, auth: $content_owner }
+
+  context 'given a video managed by the authenticated Content Owner' do
+    let(:video_id) { ENV['YT_TEST_PARTNER_CLAIMABLE_VIDEO_ID'] }
+
+    describe 'the advertising options can be updated' do
+      let(:params) { {ad_formats: %w(standard_instream long)} }
+      it { expect(advertising_options_set.update params).to be true }
+    end
+  end
+end

data/spec/requests/as_content_owner/asset_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'yt/models/content_owner'
+
+describe Yt::Asset, :partner do
+  describe '.ownership' do
+    let(:asset) { Yt::Asset.new id: asset_id, auth: $content_owner }
+    describe 'given an asset administered by the content owner' do
+      let(:asset_id) { ENV['YT_TEST_PARTNER_ASSET_ID'] }
+      it { expect(asset.ownership).to be_a Yt::Ownership }
+    end
+  end
+end

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -10,8 +10,31 @@ describe Yt::ContentOwner, :partner do
     it { expect($content_owner.partnered_channels.size).to be > 0 }
   end
 
+  describe 'claims' do
+    let(:asset_id) { ENV['YT_TEST_PARTNER_ASSET_ID'] }
+    let(:policy_id) { ENV['YT_TEST_PARTNER_POLICY_ID'] }
+    let(:video_id) { ENV['YT_TEST_PARTNER_CLAIMABLE_VIDEO_ID'] }
+    let(:params) { {asset_id: asset_id, video_id: video_id, policy_id: policy_id, content_type: 'audiovisual'} }
+
+    specify 'can be added' do
+      begin
+        expect($content_owner.create_claim params).to be_a Yt::Claim
+      rescue Yt::Errors::RequestError => e
+        # @note: Every time this test runs, a claim is inserted for the same
+        #   video and asset, but YouTube does not allow this, and responds with
+        #   an error message like "Video is already claimed. Existing claims
+        #   on this video: AbCdEFg1234".
+        #   For the sake of testing, we delete the duplicate and try again.
+        raise unless e.reasons.include? 'alreadyClaimed'
+        id = e.kind['message'].match(/this video: (.*?)$/) {|re| re[1]}
+        Yt::Claim.new(id: id, auth: $content_owner).delete
+        expect($content_owner.create_claim params).to be_a Yt::Claim
+      end
+    end
+  end
+
   describe '.claims' do
-    describe 'given the content owner has policies' do
+    describe 'given the content owner has claims' do
       let(:claim) { $content_owner.claims.first }
 
       it 'returns valid metadata' do
@@ -43,7 +66,7 @@ describe Yt::ContentOwner, :partner do
       let(:count) { $content_owner.claims.where(asset_id: asset_id).count }
 
       context 'given the asset ID of a claim administered by the content owner' do
-        let(:asset_id) { ENV['YT_TEST_PARTNER_ASSET_ID'] }
+        let(:asset_id) { ENV['YT_TEST_PARTNER_ASSET_WITH_CLAIM_ID'] }
         it { expect(count).to be > 0 }
       end
 
@@ -175,4 +198,16 @@ describe Yt::ContentOwner, :partner do
       it { expect(policy).not_to be }
     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.
+  #   Therefore, the test is commented out, otherwise a new asset would
+  #   be created every time the test is run.
+  # describe 'assets can be added' do
+  #   let(:params) { {type: 'web'} }
+  #   before { @asset = $content_owner.create_asset params }
+  #   after { @asset.delete } # This does not seem to work
+  #   it { expect(@asset).to be_a Yt::Asset }
+  # end
 end

data/spec/requests/as_content_owner/ownership_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'yt/models/ownership'
+
+describe Yt::Ownership, :partner do
+  subject(:ownership) { Yt::Ownership.new asset_id: asset_id, auth: $content_owner }
+
+  context 'given an asset managed by the authenticated Content Owner' do
+    let(:asset_id) { ENV['YT_TEST_PARTNER_ASSET_ID'] }
+
+    describe 'the ownership can be updated' do
+      let(:general_owner) { {ratio: 100, owner: 'FullScreen', type: 'include', territories: ['US', 'CA']} }
+      it { expect(ownership.update general: [general_owner]).to be true }
+    end
+
+    describe 'the complete ownership can be obtained' do
+      it { expect(ownership.obtain!).to be true }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,7 +108,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -117,6 +116,7 @@ files:
 - gemfiles/Gemfile.activesupport-3.x
 - gemfiles/Gemfile.activesupport-4.x
 - lib/yt.rb
+- lib/yt/actions/base.rb
 - lib/yt/actions/delete.rb
 - lib/yt/actions/delete_all.rb
 - lib/yt/actions/insert.rb
@@ -130,6 +130,7 @@ files:
 - lib/yt/associations/has_reports.rb
 - lib/yt/associations/has_viewer_percentages.rb
 - lib/yt/collections/annotations.rb
+- lib/yt/collections/assets.rb
 - lib/yt/collections/authentications.rb
 - lib/yt/collections/base.rb
 - lib/yt/collections/channels.rb
@@ -140,6 +141,7 @@ files:
 - lib/yt/collections/device_flows.rb
 - lib/yt/collections/ids.rb
 - lib/yt/collections/live_streaming_details.rb
+- lib/yt/collections/ownerships.rb
 - lib/yt/collections/partnered_channels.rb
 - lib/yt/collections/playlist_items.rb
 - lib/yt/collections/playlists.rb
@@ -164,7 +166,9 @@ files:
 - lib/yt/errors/server_error.rb
 - lib/yt/errors/unauthorized.rb
 - lib/yt/models/account.rb
+- lib/yt/models/advertising_options_set.rb
 - lib/yt/models/annotation.rb
+- lib/yt/models/asset.rb
 - lib/yt/models/authentication.rb
 - lib/yt/models/base.rb
 - lib/yt/models/channel.rb
@@ -179,6 +183,7 @@ files:
 - lib/yt/models/iterator.rb
 - lib/yt/models/live_streaming_detail.rb
 - lib/yt/models/match_policy.rb
+- lib/yt/models/ownership.rb
 - lib/yt/models/playlist.rb
 - lib/yt/models/playlist_item.rb
 - lib/yt/models/policy.rb
@@ -188,6 +193,7 @@ files:
 - lib/yt/models/request.rb
 - lib/yt/models/resource.rb
 - lib/yt/models/resumable_session.rb
+- lib/yt/models/right_owner.rb
 - lib/yt/models/snippet.rb
 - lib/yt/models/statistics_set.rb
 - lib/yt/models/status.rb
@@ -210,6 +216,7 @@ files:
 - spec/errors/unauthorized_spec.rb
 - spec/models/account_spec.rb
 - spec/models/annotation_spec.rb
+- spec/models/asset_spec.rb
 - spec/models/channel_spec.rb
 - spec/models/claim_spec.rb
 - spec/models/configuration_spec.rb
@@ -217,6 +224,7 @@ files:
 - spec/models/content_owner_detail_spec.rb
 - spec/models/description_spec.rb
 - spec/models/live_streaming_detail_spec.rb
+- spec/models/ownership_spec.rb
 - spec/models/playlist_item_spec.rb
 - spec/models/playlist_spec.rb
 - spec/models/policy_rule_spec.rb
@@ -225,6 +233,7 @@ files:
 - spec/models/reference_spec.rb
 - spec/models/request_spec.rb
 - spec/models/resource_spec.rb
+- spec/models/right_owner_spec.rb
 - spec/models/snippet_spec.rb
 - spec/models/statistics_set_spec.rb
 - spec/models/status_spec.rb
@@ -241,9 +250,12 @@ files:
 - spec/requests/as_account/video.mp4
 - spec/requests/as_account/video_spec.rb
 - 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/channel_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb
 - spec/requests/as_content_owner/match_policy_spec.rb
+- spec/requests/as_content_owner/ownership_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb
@@ -295,6 +307,7 @@ test_files:
 - spec/errors/unauthorized_spec.rb
 - spec/models/account_spec.rb
 - spec/models/annotation_spec.rb
+- spec/models/asset_spec.rb
 - spec/models/channel_spec.rb
 - spec/models/claim_spec.rb
 - spec/models/configuration_spec.rb
@@ -302,6 +315,7 @@ test_files:
 - spec/models/content_owner_detail_spec.rb
 - spec/models/description_spec.rb
 - spec/models/live_streaming_detail_spec.rb
+- spec/models/ownership_spec.rb
 - spec/models/playlist_item_spec.rb
 - spec/models/playlist_spec.rb
 - spec/models/policy_rule_spec.rb
@@ -310,6 +324,7 @@ test_files:
 - spec/models/reference_spec.rb
 - spec/models/request_spec.rb
 - spec/models/resource_spec.rb
+- spec/models/right_owner_spec.rb
 - spec/models/snippet_spec.rb
 - spec/models/statistics_set_spec.rb
 - spec/models/status_spec.rb
@@ -326,9 +341,12 @@ test_files:
 - spec/requests/as_account/video.mp4
 - spec/requests/as_account/video_spec.rb
 - 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/channel_spec.rb
 - spec/requests/as_content_owner/content_owner_spec.rb
 - spec/requests/as_content_owner/match_policy_spec.rb
+- spec/requests/as_content_owner/ownership_spec.rb
 - spec/requests/as_content_owner/video_spec.rb
 - spec/requests/as_server_app/channel_spec.rb
 - spec/requests/as_server_app/playlist_item_spec.rb