yt 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bffd4b8b4a58a2b17033305eeeb4e4e3c6e517de
-  data.tar.gz: 23c5b423485af978fae17f0aea4fa99412df83ae
+  metadata.gz: ed082f94cdaa3fa496bd9ef6cffd95754fb292c1
+  data.tar.gz: 38a76b4cca68dcea1c70ab1bfe1423e6502a9922
 SHA512:
-  metadata.gz: a31c789b981109c7821771d861d86c00b69689703269e964770caceddf21c4d734dde0052bb1ac356b43182d5957e3e551ac9afdba09d54673cc56fb4eff39d9
-  data.tar.gz: 3618b8c13fb8344c7b26333524fa0fb628b81133435ce73b8fa9559cb4246a95a4a7861f09b727bb865656338f26192b0808b3ee3c209c0e18cb93d4b7257901
+  metadata.gz: c28709d46e78e6ed3b0b20d1c72d106b5330477e70088bd21193547963113b97594f44258c597a7b9203ba00e26defb838a748fb14bd958c59ea095fceb192f5
+  data.tar.gz: 535292f6eb80998cb0b46e6032eff963e7a0bae948b260d2be881c910f0e4eb5e664b72eff631155d6a1970e0e67c3210a3f5d9aa0053cb8d1d5094bda3c0680

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.10.3 - 2014-08-12
+
+* [FEATURE] Add methods to insert and delete ContentID references
+* [FEATURE] Add `.match_reference_id` to Claim model
+
 ## 0.10.2 - 2014-08-11
 
 * [FEATURE] Add `MatchPolicy` class with `.update` to change the policy used by an asset

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yt (0.10.2)
+    yt (0.10.3)
       activesupport
 
 GEM

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

data/lib/yt/collections/references.rb

@@ -7,11 +7,25 @@ module Yt
     #
     # Resources with references are: {Yt::Models::ContentOwner content owners}.
     class References < Base
+      def insert(attributes = {})
+        underscore_keys! attributes
+        body = {contentType: attributes[:content_type] }
+        params = {claimId: attributes[:claim_id], onBehalfOfContentOwner: @auth.owner_name}
+        do_insert(params: params, body: body)
+      end
 
     private
 
       def new_item(data)
-        Yt::Reference.new data: data
+        Yt::Reference.new data: data, auth: @auth
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to add a reference.
+      # @see https://developers.google.com/youtube/partner/docs/v1/references/insert
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/partner/v1/references'
+        end
       end
 
       # @return [Hash] the parameters to submit to YouTube to list references
@@ -27,6 +41,16 @@ module Yt
       def references_params
         apply_where_params! on_behalf_of_content_owner: @parent.owner_name
       end
+
+      # If we dropped support for ActiveSupport 3, then we could simply
+      # invoke transform_keys!{|key| key.to_s.underscore.to_sym}
+      def underscore_keys!(hash)
+        hash.dup.each_key{|key| hash[underscore key] = hash.delete key}
+      end
+
+      def underscore(value)
+        value.to_s.underscore.to_sym
+      end
     end
   end
 end

data/lib/yt/models/claim.rb

@@ -131,6 +131,12 @@ module Yt
       def block_outside_ownership?
         @block_outside_ownership ||= @data["blockOutsideOwnership"]
       end
+
+      # @return [String] The unique ID that YouTube uses to identify the
+      #   reference that generated the match.
+      def match_reference_id
+        @match_reference_id ||= @data.fetch('matchInfo', {})['referenceId']
+      end
     end
   end
 end

data/lib/yt/models/content_owner.rb

@@ -27,6 +27,10 @@ module Yt
         super options
         @owner_name = options[:owner_name]
       end
+
+      def create_reference(params = {})
+        references.insert params
+      end
     end
   end
 end

data/lib/yt/models/reference.rb

@@ -7,6 +7,21 @@ module Yt
     class Reference < Base
       def initialize(options = {})
         @data = options[:data]
+        @id = options[:id]
+        @auth = options[:auth]
+      end
+
+      # Soft-deletes the reference.
+      #
+      # @note YouTube API does not provide a +delete+ method for the Reference
+      #   resource, but only an +update+ method. Updating the +status+ of a
+      #   Reference to "inactive" can be considered a soft-deletion, since it
+      #   allows to successively create new references for the same claim.
+      # @return [Boolean] whether the reference is inactive.
+      def delete
+        body = {id: id, status: :inactive}
+        do_update(body: body) {|data| @data = data}
+        inactive?
       end
 
       # @return [String] the ID that YouTube assigns and uses to uniquely
@@ -173,6 +188,17 @@ module Yt
       def audiovisual?
         content_type == 'audiovisual'
       end
+
+    private
+
+      # @see https://developers.google.com/youtube/partner/docs/v1/references/update
+      def update_params
+        super.tap do |params|
+          params[:expected_response] = Net::HTTPOK
+          params[:path] = "/youtube/partner/v1/references/#{id}"
+          params[:params] = {onBehalfOfContentOwner: @auth.owner_name}
+        end
+      end
     end
   end
 end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.10.2'
+  VERSION = '0.10.3'
 end

data/spec/models/claim_spec.rb

@@ -190,6 +190,13 @@ describe Yt::Claim do
     end
   end
 
+  describe '#match_reference_id' do
+    context 'given fetching a claim returns matchInfo' do
+      let(:data) { {"matchInfo"=>{"referenceId"=>"0r3JDtcRLuQ"}} }
+      it { expect(claim.match_reference_id).to eq "0r3JDtcRLuQ" }
+    end
+  end
+
   describe '#third_party?' do
     context 'given fetching a claim returns thirdPartyClaim true' do
       let(:data) { {"thirdPartyClaim"=>true} }

data/spec/requests/as_account/video_spec.rb

@@ -334,7 +334,7 @@ describe Yt::Video, :device_app do
     let!(:old_privacy_status) { 'private' }
     after  { video.delete}
 
-    let!(:new_scheduled_at) { Yt::Timestamp.parse("#{rand 30 + 1} Jan 2020", Time.now) }
+    let!(:new_scheduled_at) { Yt::Timestamp.parse("#{rand(30) + 1} Jan 2020", Time.now) }
 
     context 'passing the parameter in underscore syntax' do
       let(:attrs) { {publish_at: new_scheduled_at} }

data/spec/requests/as_content_owner/content_owner_spec.rb

@@ -95,6 +95,33 @@ describe Yt::ContentOwner, :partner do
     end
   end
 
+  describe 'references' do
+    let(:claim_id) { ENV['YT_TEST_PARTNER_REFERENCE_CLAIM_ID'] }
+    let(:content_type) { ENV['YT_TEST_PARTNER_REFERENCE_CONTENT_TYPE'] }
+    let(:params) { {claim_id: claim_id, content_type: content_type} }
+
+    specify 'can be added' do
+      begin
+        expect($content_owner.create_reference params).to be_a Yt::Reference
+      rescue Yt::Errors::RequestError => e
+        # @note: Every time this test runs, a reference is inserted for the
+        #   same claim, but YouTube does not allow this, and responds with an
+        #   error message like "You attempted to create a reference using the
+        #   content of a previously claimed video, but such a reference already
+        #   exists. The ID of the duplicate reference is xhpACYclOdc."
+        #   For the sake of testing, we delete the duplicate and try again.
+        # @note: Deleting a reference does not work if the reference status is
+        #   "checking" or "pending" and it can take up to 4 minutes for a new
+        #   reference to be checked. The +sleep+ statement takes care of this
+        #   case in the only way allowed by YouTube: sadly waiting.
+        raise unless e.reasons.include? 'referenceAlreadyExists'
+        id = e.kind['message'].match(/reference is (.*?)\.$/) {|re| re[1]}
+        sleep 15 until Yt::Reference.new(id: id, auth: $content_owner).delete
+        expect($content_owner.create_reference params).to be_a Yt::Reference
+      end
+    end
+  end
+
   describe '.references' do
     describe '.where(id: reference_id)' do
       let(:reference) { $content_owner.references.where(id: reference_id).first }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Claudio Baccigalupo