yt 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ab7c0d75dc3c575f9c55dd9e222505f70db290f
-  data.tar.gz: 1594d3e696c068d0a439396591e6a41efb292dd0
+  metadata.gz: 9d1eeefafcd75a3c1c5f93117c6f5d08ab882569
+  data.tar.gz: 48aafacb7c44c358ca7e4d32dd3cac022e50835a
 SHA512:
-  metadata.gz: 5205274ae1d25ce04a75f6d5cd92742e1cfa77930695795a13879f463dcbaf0c5d5d25e56ef799bf90506c0494a29e732133faab705da4c9c32d2cf54bbb7d38
-  data.tar.gz: 42810660757c546f295d1f8b038ce2b7cefb74b30c20327cc7d1548e19562c07c06cfc3e53b867d604ef0156edc4be96bfcdc656acaeda030c87d1ef89441f2a
+  metadata.gz: ff3234ddd12713b1ef8ab0d291cb154be0db0d673272c2aa50f602c358a8c9f0617ca1505b6a11f027f42b06fed5244346e0d85b9c429192d803da8ae49d0da6
+  data.tar.gz: 2cf90341fe38289cbcbabcb1e2543b347bd9ca00e6eed81d49fae81845b457df15e7dc429d89c98ed743de0c5a7b99819f2b4e16ccff1952fb36dab15283e28b

data/CHANGELOG.md

@@ -6,6 +6,10 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.14.3 - 2015-04-09
+
+* [BUGFIX] Don't let request errors crash Yt in Ruby 1.9.3.
+
 ## 0.14.2 - 2015-04-08
 
 * [FEATURE] Make `Annotation#text` a public method.

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.14.2'
+    gem 'yt', '~> 0.14.3'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -568,6 +568,30 @@ asset.ownership.release! #=> true
 asset.update metadata_mine: {notes: 'Some notes'} #=> true
 ```
 
+Yt::Claim
+---------
+
+Use [Yt::Claim](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Claim) to:
+
+* read the attributes of a claim
+* view the history of a claim
+* update the attributes of an claim
+
+```ruby
+
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+claim = Yt::Claim.new id: 'ABCD12345678', auth: content_owner
+claim.video_id #=> 'va141cJga2'
+claim.asset_id #=> 'A1234'
+claim.content_type #=> 'audiovisual'
+claim.active? #=> true
+
+claim.claim_history #=> #<Yt::Models::ClaimHistory ...>
+claim.claim_history.events[0].type #=> "claim_create"
+
+claim.delete #=> true
+```
+
 *The methods above require to be authenticated as the video’s content owner (see below).*
 
 Yt::Ownership

data/lib/yt.rb

@@ -2,6 +2,7 @@ require 'yt/config'
 require 'yt/models/account'
 require 'yt/models/channel'
 require 'yt/models/claim'
+require 'yt/models/claim_history'
 require 'yt/models/content_owner'
 require 'yt/models/match_policy'
 require 'yt/models/playlist'

data/lib/yt/collections/claim_histories.rb

@@ -0,0 +1,34 @@
+require 'yt/collections/resources'
+require 'yt/models/claim'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a the claim history options of a YouTube claim.
+    #
+    # Resources with claim history are: {Yt::Models::Claim claims}.
+    class ClaimHistories < Resources
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data, id: @parent.id, auth: @auth}
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get claim history.
+      # @see https://developers.google.com/youtube/partner/docs/v1/claimHistory/get
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/partner/v1/claimHistory/#{@parent.id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
+        end
+      end
+
+      # @private
+      # @note ClaimHistories overwrites +fetch_page+ since it’s a get.
+      def fetch_page(params = {})
+        response = list_request(params).run
+        {items: [response.body], token: nil}
+      end
+    end
+  end
+end

data/lib/yt/models/claim.rb

@@ -5,12 +5,18 @@ module Yt
     # Provides methods to interact with YouTube ContentID claims.
     # @see https://developers.google.com/youtube/partner/docs/v1/claims
     class Claim < Base
+      attr_reader :auth
+
       def initialize(options = {})
         @data = options[:data]
         @id = options[:id]
         @auth = options[:auth]
       end
 
+      # @!attribute [r] claim_history
+      #   @return [Yt::Collections::ClaimHistories] the claim's history.
+      has_one :claim_history
+
       # Soft-deletes the claim.
       # @note YouTube API does not provide a +delete+ method for the Asset
       #   resource, but only an +update+ method. Updating the +status+ of a
@@ -137,6 +143,7 @@ module Yt
         (match_info || {})['referenceId']
       end
 
+
     private
 
       # @see https://developers.google.com/youtube/partner/docs/v1/claims/update

data/lib/yt/models/claim_event.rb

@@ -0,0 +1,67 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    class ClaimEvent < Base
+      def initialize(options = {})
+        @data = options[:data]
+      end
+
+      REASONS = %w(asset_transfer_request audio_muted audio_replaced audioswap_removed
+        channel_transferred channel_whitelisted closed_audio_claim_on_visual_reference
+        closed_audio_revshare closed_by_admin closed_cover_revshare
+        closed_invalid_reference_segment closed_manually closed_partner_exclusion
+        closed_private_video closed_reference_conflict copyrighted_content_matched
+        counter_received dispute_resolution duplicate invalid_claim muting_audio
+        ownership_removed partner_deactivated pending_activation pending_adsense
+        pending_fingerprint pending_for_review reference_removed released replaced
+        review_expired revshare_disabled risk_of_error song_erased
+        suspended_monetization_on_channel video_classifier_rejecion video_content_modified
+        video_removed video_taken_down)
+
+      # @return [Time] the date and time when the event occurred.
+      has_attribute :time, type: Time
+
+      # @return [String] the reason an event occurred.
+      has_attribute :reason
+
+      # @return [String] the event's type.
+      has_attribute :type
+
+      # @return [String] the source type which triggered the event.
+      has_attribute :source_type, from: :source do |source|
+        (source || {})['type']
+      end
+
+      # @return [String] the ID of the content owner that initiated
+      #   the event.
+      has_attribute :source_content_owner_id, from: :source do |source|
+        (source || {})['contentOwnerId']
+      end
+
+      # @return [String] the email address of the user who initiated
+      #   the event.
+      has_attribute :source_user_email, from: :source do |source|
+        (source || {})['userEmail']
+      end
+
+      # @return [String] the reason that explains why a
+      #   dispute_create event occurred.
+      has_attribute :dispute_reason, from: :type_details do |type_details|
+        (type_details || {})['disputeReason']
+      end
+
+      # @return [String] a free-text explanation of the reason that a claim
+      #   was disputed. This property is returned for dispute_create events.
+      has_attribute :dispute_notes, from: :type_details do |type_details|
+        (type_details || {})['disputeNotes']
+      end
+
+      # @return [String] the event status that resulted from a claim_update
+      #   event.
+      has_attribute :update_status, from: :type_details do |type_details|
+        (type_details || {})['updateStatus']
+      end
+    end
+  end
+end

data/lib/yt/models/claim_history.rb

@@ -0,0 +1,29 @@
+require 'yt/models/base'
+require 'yt/models/claim_event'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube ContentID claims.
+    # @see https://developers.google.com/youtube/partner/docs/v1/claims
+    class ClaimHistory < Base
+      def initialize(options = {})
+        @data = options[:data]
+        @id = options[:id]
+        @auth = options[:auth]
+      end
+
+      # @return [String] the ID that YouTube assigns and uses to uniquely
+      #   identify the claim.
+      has_attribute :id
+
+      # @return [String] the unique YouTube channel ID of the channel to
+      #   which the claimed video was uploaded.
+      has_attribute :uploader_channel_id
+
+      # @return [Array<String>] the list of events associated with the claim.
+      has_attribute :events, from: :event do |event_info|
+        event_info.map{|event| ClaimEvent.new data: event}
+      end
+    end
+  end
+end

data/lib/yt/request.rb

@@ -202,12 +202,11 @@ module Yt
     def server_errors
       [
         OpenSSL::SSL::SSLError,
-        OpenSSL::SSL::SSLErrorWaitReadable,
         Errno::ETIMEDOUT,
         Errno::ENETUNREACH,
         Errno::ECONNRESET,
         Net::HTTPServerError
-      ]
+      ] + (RUBY_VERSION < '2' ? [] : [OpenSSL::SSL::SSLErrorWaitReadable])
     end
 
     # Sleeps for a while and returns true for the first +max_retries+ times,
@@ -265,4 +264,4 @@ module Yt
       {request_curl: as_curl, response_body: response_body}
     end
   end
-end
+end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.14.2'
+  VERSION = '0.14.3'
 end

data/spec/models/claim_event_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'yt/models/claim_event'
+
+describe Yt::ClaimEvent do
+  subject(:claim_event) { Yt::ClaimEvent.new data: data }
+
+  describe '#time' do
+    context 'given fetching a claim_event returns a time' do
+      let(:data) { {"time"=>"2015-04-08T21:52:13.000Z"} }
+      it { expect(claim_event.time).to be_a Time }
+    end
+  end
+
+  describe '#type' do
+    context 'given fetching a claim_event returns a type' do
+      let(:data) { {"type"=>"claim_create"} }
+      it { expect(claim_event.type).to eq 'claim_create' }
+    end
+  end
+
+  describe '#source_type' do
+    context 'given fetching a claim_event returns a source_type' do
+      let(:data) { {'source'=>{'type' => 'cms_user'}} }
+      it { expect(claim_event.source_type).to eq 'cms_user' }
+    end
+  end
+
+  describe '#source_content_owner_id' do
+    context 'given fetching a claim_event returns a source_content_owner_id' do
+      let(:data) { {'source'=>{'contentOwnerId' => 'C1234'}} }
+      it { expect(claim_event.source_content_owner_id).to eq 'C1234' }
+    end
+  end
+
+  describe '#source_user_email' do
+    context 'given fetching a claim_event returns a source_user_email' do
+      let(:data) { {'source'=>{'userEmail' => 'email@fullscreen.net'}} }
+      it { expect(claim_event.source_user_email).to eq 'email@fullscreen.net' }
+    end
+  end
+
+  describe '#dispute_reason' do
+    context 'given fetching a claim_event returns a dispute_reason' do
+      let(:data) { {'typeDetails'=>{'disputeReason' => 'fair_use'}} }
+      it { expect(claim_event.dispute_reason).to eq 'fair_use' }
+    end
+  end
+
+  describe '#dispute_notes' do
+    context 'given fetching a claim_event returns dispute_notes' do
+      let(:data) { {'typeDetails'=>{'disputeNotes' => 'User entered notes here.'}} }
+      it { expect(claim_event.dispute_notes).to eq 'User entered notes here.' }
+    end
+  end
+
+  describe '#update_status' do
+    context 'given fetching a claim_event returns an update_status' do
+      let(:data) { {'typeDetails'=>{'updateStatus' => 'active'}} }
+      it { expect(claim_event.update_status).to eq 'active' }
+    end
+  end
+end

data/spec/models/claim_history_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'yt/models/claim_history'
+
+describe Yt::ClaimHistory do
+  subject(:claim_history) { Yt::ClaimHistory.new data: data }
+
+  describe '#id' do
+    context 'given fetching claim_history with an id' do
+      let(:data) { {"id"=>"acbd1234"}}
+      it { expect(claim_history.id).to eq "acbd1234" }
+    end
+  end
+
+  describe '#uploader_channel_id' do
+    context 'given fetching claim_history with an uploader_channel_id' do
+      let(:data) { {"uploaderChannelId"=>"C1234"}}
+      it { expect(claim_history.uploader_channel_id).to eq "C1234" }
+    end
+  end
+
+  describe '#events' do
+    context 'given fetching claim_history with associated events' do
+      let(:data) { {"event"=>[{"time"=>"2015-03-21T21:35:42.000Z"},{"time"=>"2015-03-21T21:35:42.000Z"}]} }
+      it { expect(claim_history.events.size).to eq 2 }
+    end
+  end
+end

data/spec/models/request_spec.rb

@@ -120,7 +120,7 @@ describe Yt::Request do
       # NOTE: This test is just a reflection of YouTube irrational behavior of
       # being unavailable once in a while, and therefore causing Net::HTTP to
       # fail, although retrying after some seconds works.
-      context 'an OpenSSL::SSL::SSLErrorWaitReadable' do
+      context 'an OpenSSL::SSL::SSLErrorWaitReadable', ruby2: true do
         let(:http_error) { OpenSSL::SSL::SSLErrorWaitReadable.new }
 
         context 'every time' do
@@ -139,4 +139,4 @@ describe Yt::Request do
       end
     end
   end
-end
+end

data/spec/requests/as_content_owner/claim_history_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'yt/models/claim'
+require 'yt/models/claim_history'
+
+describe Yt::ClaimHistory, :partner do
+  subject(:claim) { Yt::Claim.new id: asset_id, auth: $content_owner }
+
+  context 'given a claim previously administered by the authenticated Content Owner' do
+    let(:asset_id) { ENV['YT_TEST_CLAIM_ID'] }
+
+    describe 'the claim history can be obtained' do
+      it { expect(claim.claim_history.events.size > 0).to eq true }
+    end
+
+    describe 'the claim_create event' do
+      let(:claim_create_event) { claim.claim_history.events.find {|e| e.type == 'claim_create'} }
+      it { expect(claim_create_event.time).to be_a Time }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,7 @@ files:
 - lib/yt/collections/authentications.rb
 - lib/yt/collections/base.rb
 - lib/yt/collections/channels.rb
+- lib/yt/collections/claim_histories.rb
 - lib/yt/collections/claims.rb
 - lib/yt/collections/content_details.rb
 - lib/yt/collections/content_owner_details.rb
@@ -179,6 +180,8 @@ files:
 - lib/yt/models/base.rb
 - lib/yt/models/channel.rb
 - lib/yt/models/claim.rb
+- lib/yt/models/claim_event.rb
+- lib/yt/models/claim_history.rb
 - lib/yt/models/configuration.rb
 - lib/yt/models/content_detail.rb
 - lib/yt/models/content_owner.rb
@@ -227,6 +230,8 @@ files:
 - spec/models/annotation_spec.rb
 - spec/models/asset_spec.rb
 - spec/models/channel_spec.rb
+- spec/models/claim_event_spec.rb
+- spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
@@ -264,6 +269,7 @@ files:
 - 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/claim_history_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
@@ -325,6 +331,8 @@ test_files:
 - spec/models/annotation_spec.rb
 - spec/models/asset_spec.rb
 - spec/models/channel_spec.rb
+- spec/models/claim_event_spec.rb
+- spec/models/claim_history_spec.rb
 - spec/models/claim_spec.rb
 - spec/models/configuration_spec.rb
 - spec/models/content_detail_spec.rb
@@ -362,6 +370,7 @@ test_files:
 - 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/claim_history_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