yt 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bca9a6106823c8817aef8eb024c9b54ae1a684d
-  data.tar.gz: a4dd91d6a9be61e077ab502b4268cf7362383142
+  metadata.gz: 623d648b88a71c977785d91777067b7fe749b9ec
+  data.tar.gz: 41516787a905b8c36b1ce390c6850bffefed8a53
 SHA512:
-  metadata.gz: 5bcd46f496c2a4cd43a280da1bcea6b54d5527152ed2cf73cae7797ba4eb7033a20f998caf9208d19bc665f9ac9e6ebd2421df48e6f07d4c4171d37414c156f7
-  data.tar.gz: 5da86f76c045a7760ab56ed9022029332c6f2bc75ad2fe10d9750545a0900388f52db27be88e88907e9d893798bd3927de587ce9e5376dbd52eb192104a59ff2
+  metadata.gz: c75aa4a2de0bbfae680c25edaff8ec2be11aa5e946577a1a55d94dce55a0690f67fb1ad57f794e979a22cf8170dcb664375a8fcd6890b223fe7ad70bb4f8413f
+  data.tar.gz: eb62845c855fae0565a52755b53cbebbae108c7c952d7162943de3901fbe84195756076d4b7c9de1f5be5befdb75e65ac8d2409ac537f5fba7954b8cc6ffa7c3

data/.gitignore

@@ -12,6 +12,7 @@
 /db/*.sqlite3-journal
 
 coverage/
+Gemfile.lock
 
 # Ignore all logfiles and tempfiles.
 /log/*.log

data/.travis.yml

@@ -32,3 +32,5 @@ env:
   - secure: CFkNT5WI2ATF3TKehTSuCwzG4EENnoVXaddL0PqpuH4Ss82k0k0xcJBhKbmD3Qkf7nw8y0g4s3jCepHssB2ZwzqQinKcYvamzIbsNPuhsuvlc9rMvT9ZosT5CHsiRJANl+OeZ8l2SqGu6kCMDx45h+fL7YZEtn3jjVZYEAXQSig=
   - secure: WWuYLNKcTM+fjgFrRT4qa3y4IlwO6xeSkM16jbDG05FUIThMfWRVQHhs5JThw/M3SByWGWySmz74sNpGV6V/yt9jw8o1u6F81j0ec2oeHDCwkZ8xK8ubPv3Pmg14PGr1Awu04zfhTEY9KzJt6HrFSYzek/MpV5Prg4J1l6SgqyU=
   - secure: YuWrOwaqBT0tLVe90OkfCLX/7tzrLhsOBn7LnqH0Ifw6T+EddNDmQLriWLRny8uNQSg7j/AhPOuEvR/ImOibK3a003LyxQZUx9KrEOkgIa5c82OlOLdcvmXw/8wnQ/SEdTDs8r2l1aZ2NxiieCA3fl7oxR1Lt/O+lS/vgqQY+uM=
+  - secure: VlE28fpY6cy6a9HYq+cdGmSXM54bZkbGzqSAqvgxTIJubMzSPSvQ7p5zdLtWPG9yQqYUOXyhKItZE/Eno0VemHDyV9qj0mo0JKb2c4OmX3aupIYTh38LZodkGmW+NGxa8GaebqYeDJeH33ZLtl9aumahzgUtGykKOkNIPH6Igy4=
+  - secure: YcjKPgsmOFbAeJrxl/d7idji/TX9/EZLXuO3ZYy3NLljy0GXdXtFBiAaE7DDTEG4PNLp+EJTpc/XbEu8yL1ozeH3lpGPeRU+Mk2LTFI2GAjpz6DeOucEx+sFEJJHr+eqsavQrNMzgOBii3TTmMP66Dp/T1L0HlcWT3v680jfS6A=

data/CHANGELOG.md

@@ -6,16 +6,22 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.11.2 - 2014-08-20
+
+* [FEATURE] Add AdvertisingOptionsSet with `update` to change the advertising settings of a video
+* [FEATURE] Add `content_owner.create_claim` and `claim.delete`
+* [FEATURE] Add `update` method to Ownership to change owners of an asset
+* [FEATURE] Add `asset.ownership` to list the owners of an asset
+* [FEATURE] Add `content_owner.create_asset` and Asset model
+
 ## 0.11.1 - 2014-08-17
 
 * [ENHANCEMENT] Add Video search even without a parent account or channel
 
 For instance, to search for the most viewed video on the whole YouTube, run:
 
-```ruby
-videos = Yt::Collections::Videos.new
-videos.where(order: 'viewCount').first.title #=>  "PSY - GANGNAM STYLE"
-```
+    videos = Yt::Collections::Videos.new
+    videos.where(order: 'viewCount').first.title #=>  "PSY - GANGNAM STYLE"
 
 ## 0.11.0 - 2014-08-17
 
@@ -29,11 +35,9 @@ token). For security reasons, Yt will not print it out anymore by default.
 If this is acceptable, then you are good to go.
 If you want the old behavior, set the `log_level` of Yt to `:debug`:
 
-```ruby
-Yt.configure do |config|
-  config.log_level = :debug
-end
-```
+    Yt.configure do |config|
+      config.log_level = :debug
+    end
 
 * [ENHANCEMENT] Add `log_level` to Yt.configuration
 
@@ -73,14 +77,12 @@ exactly how many items are returned.
 If this is acceptable, then you are good to go.
 If you want the old behavior, replace `size` with `count`:
 
-```ruby
-account = Yt::Account.new access_token: 'ya29...'
-# old behavior
-account.videos.size # => retrieved *all* the pages of the account’s videos
-# new behavior
-account.videos.size # => retrieves only the first page, returning the totalResults counter
-account.videos.count # => retrieves *all* the pages of the account’s videos
-```
+    account = Yt::Account.new access_token: 'ya29...'
+    # old behavior
+    account.videos.size # => retrieved *all* the pages of the account’s videos
+    # new behavior
+    account.videos.size # => retrieves only the first page, returning the totalResults counter
+    account.videos.count # => retrieves *all* the pages of the account’s videos
 
 * [ENHANCEMENT] Calling `size` on a collection does not load all the pages of the collection
 * [ENHANCEMENT] Alias `policy.time_updated` to more coherent `policy.updated_at`
@@ -148,13 +150,11 @@ If your code never declares instances of `Yt::Rating`, or never calls the
 
 If it does, then *simply replace `update` with `set`*:
 
-```ruby
-rating = Yt::Rating.new
-# old syntax
-rating.update :like
-# new syntax
-rating.set :like
-```
+    rating = Yt::Rating.new
+    # old syntax
+    rating.update :like
+    # new syntax
+    rating.set :like
 
 * [ENHANCEMENT] `rating.set` replaces `rating.update` to rate a video
 
@@ -201,15 +201,13 @@ a YouTube user tries to subscribe to her/his own YouTube channel. Instead,
 If this is acceptable, then you are good to go.
 If you want the old behavior, replace `subscribe` with `subscribe!`:
 
-```ruby
-account = Yt::Account.new access_token: 'ya29...'
-channel = account.channel
-# old behavior
-channel.subscribe # => raised an error
-# new behavior
-channel.subscribe # => nil
-channel.subscribe! # => raises an error
-```
+    account = Yt::Account.new access_token: 'ya29...'
+    channel = account.channel
+    # old behavior
+    channel.subscribe # => raised an error
+    # new behavior
+    channel.subscribe # => nil
+    channel.subscribe! # => raises an error
 
 * [ENHANCEMENT] `channel.subscribe` does not raise error when trying to subscribe to one’s own channel
 

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.11.1'
+    gem 'yt', '~> 0.11.2'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -95,6 +95,9 @@ Use [Yt::ContentOwner](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models
 * authenticate as a YouTube content owner
 * list the channels partnered with a YouTube content owner
 * list the claims administered by the content owner
+* list and delete the references administered by the content owner
+* list the policies and policy rules administered by the content owner
+* create assets
 
 ```ruby
 # Content owners can be initialized with access token, refresh token or an authorization code
@@ -105,9 +108,19 @@ content_owner.partnered_channels.first #=> #<Yt::Models::Channel @id=...>
 
 content_owner.claims.where(q: 'Fullscreen').count #=> 24
 content_owner.claims.first #=> #<Yt::Models::Claim @id=...>
+content_owner.claims.first.video_id #=> 'MESycYJytkU'
+content_owner.claims.first.status #=> "active"
 
-content_owner.references.where(asset_id: "ABCDEFG").first => #<Yt::Models::Reference @id=...>
-content_owner.policies.first => #<Yt::Models::Policy @id=...>
+reference = content_owner.references.where(asset_id: "ABCDEFG").first #=> #<Yt::Models::Reference @id=...>
+reference.delete #=> true
+
+content_owner.policies.first #=> #<Yt::Models::Policy @id=...>
+content_owner.policies.first.name #=> "Track in all countries"
+content_owner.policies.first.rules.first #=> #<Yt::Models::PolicyRule @id=...>
+content_owner.policies.first.rules.first.action #=> "monetize"
+content_owner.policies.first.rules.first.included_territories #=> ["US", "CA"]
+
+content_owner.create_asset type: 'web' #=> #<Yt::Models::Asset @id=...>
 ```
 
 *All the above methods require authentication (see below).*
@@ -398,6 +411,22 @@ item.delete #=> true
 *The methods above require to be authenticated as the playlist’s owner (see below).*
 
 
+Yt::Collections::Videos
+-----------------------
+
+Use [Yt::Collections::Videos](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Collections/Videos) to:
+
+* search for videos
+
+```ruby
+videos = Yt::Collections::Videos.new
+videos.where(order: 'viewCount').first.title #=>  "PSY - GANGNAM STYLE"
+videos.where(q: 'Fullscreen CreatorPlatform', safe_search: 'none').size #=> 324
+```
+
+*The methods above do not require authentication.*
+
+
 Yt::Annotation
 --------------
 
@@ -416,6 +445,68 @@ annotation.has_link_to_playlist? #=> true
 
 *Annotations do not require authentication.*
 
+Yt::MatchPolicy
+---------------
+
+Use [Yt::MatchPolicy](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/MatchPolicy) to:
+
+* update the policy used by an asset
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+match_policy = Yt::MatchPolicy.new asset_id: 'ABCD12345678', auth: content_owner
+match_policy.update policy_id: 'aBcdEF6g-HJ' #=> true
+
+Yt::Asset
+---------
+
+Use [Yt::Asset](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Asset) to:
+
+* read the ownership of an asset
+
+```ruby
+
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+asset = Yt::Asset.new id: 'ABCD12345678', auth: content_owner
+asset.ownership #=> #<Yt::Models::Ownership @general=...>
+asset.general_owners.first.owner #=> 'FullScreen'
+asset.general_owners.first.everywhere? #=> true
+```
+
+*The methods above require to be authenticated as the video’s content owner (see below).*
+
+Yt::Ownership
+-------------
+
+Use [Yt::Ownership](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Ownership) to:
+
+* update the ownership of an asset
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+ownership = Yt::Ownership.new asset_id: 'ABCD12345678', auth: $content_owner
+new_general_owner_attrs = {ratio: 100, owner: 'FullScreen', type: 'include', territories: ['US', 'CA']}
+ownership.update general: [new_general_owner_attrs]
+```
+
+*The methods above require to be authenticated as the video’s content owner (see below).*
+
+Yt::AdvertisingOptionsSet
+-------------------------
+
+Use [Yt::AdvertisingOptionsSet](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/AdvertisingOptionsSet) to:
+
+* update the advertising settings of a video
+
+```ruby
+content_owner = Yt::ContentOwner.new owner_name: 'CMSname', access_token: 'ya29.1.ABCDEFGHIJ'
+ad_options = Yt::AdvertisingOptionsSet.new video_id: 'MESycYJytkU', auth: $content_owner
+ad_options.update ad_formats: %w(standard_instream long) #=> true
+```
+
+*The methods above require to be authenticated as the video’s content owner (see below).*
+
+
 Configuring your app
 ====================
 

data/lib/yt.rb

@@ -7,6 +7,7 @@ require 'yt/models/match_policy'
 require 'yt/models/playlist'
 require 'yt/models/playlist_item'
 require 'yt/models/video'
+require 'yt/models/ownership'
 
 # An object-oriented Ruby client for YouTube.
 # Helps creating applications that need to interact with YouTube objects.

data/lib/yt/actions/base.rb

@@ -0,0 +1,19 @@
+module Yt
+  module Actions
+    # Abstract module that contains methods common to every action
+    module Base
+
+    private
+
+      # 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/actions/insert.rb

@@ -1,8 +1,10 @@
 require 'yt/models/request'
+require 'yt/actions/base'
 
 module Yt
   module Actions
     module Insert
+      include Base
 
     private
 

data/lib/yt/actions/list.rb

@@ -66,7 +66,6 @@ module Yt
       end
 
       def request(params = {})
-        camelize_keys! params[:params] if params.fetch(:camelize_params, true)
         @last_request = Yt::Request.new params
       end
 
@@ -92,12 +91,6 @@ module Yt
       def list_resources
         self.class
       end
-
-      def camelize_keys!(hash = {})
-        hash.dup.each_key do |key|
-          hash[key.to_s.camelize(:lower).to_sym] = hash.delete key
-        end
-      end
     end
   end
 end

data/lib/yt/actions/modify.rb

@@ -1,9 +1,11 @@
 require 'yt/models/request'
+require 'yt/actions/base'
 
 module Yt
   module Actions
     # Abstract module that contains methods common to Delete and Update
     module Modify
+      include Base
 
     private
 

data/lib/yt/collections/assets.rb

@@ -0,0 +1,32 @@
+require 'yt/collections/base'
+require 'yt/models/asset'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of Content ID assets.
+    #
+    # Resources with assets are: {Yt::Models::ContentOwner content owners}.
+    class Assets < Base
+      def insert(attributes = {})
+        underscore_keys! attributes
+        body = {type: attributes[:type]}
+        params = {on_behalf_of_content_owner: @auth.owner_name}
+        do_insert(params: params, body: body)
+      end
+
+    private
+
+      def new_item(data)
+        Yt::Asset.new data: data, auth: @auth
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to add a asset.
+      # @see https://developers.google.com/youtube/partner/docs/v1/assets/insert
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/partner/v1/assets'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/authentications.rb

@@ -21,6 +21,7 @@ module Yt
           params[:method] = :post
           params[:auth] = nil
           params[:body] = auth_params
+          params[:camelize_body] = false
         end
       end
 

data/lib/yt/collections/claims.rb

@@ -7,11 +7,18 @@ module Yt
     #
     # Resources with claims are: {Yt::Models::ContentOwner content owners}.
     class Claims < Base
+      def insert(attributes = {})
+        underscore_keys! attributes
+        body = attributes.slice :asset_id, :video_id, :content_type
+        body[:policy] = {id: attributes[:policy_id]} if attributes[:policy_id]
+        params = {on_behalf_of_content_owner: @auth.owner_name}
+        do_insert(params: params, body: body)
+      end
 
     private
 
       def new_item(data)
-        Yt::Claim.new data: data
+        Yt::Claim.new data: data, auth: @auth
       end
 
       # @return [Hash] the parameters to submit to YouTube to list claims
@@ -25,6 +32,14 @@ module Yt
         end
       end
 
+      # @return [Hash] the parameters to submit to YouTube to add a claim.
+      # @see https://developers.google.com/youtube/partner/docs/v1/claims/insert
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/partner/v1/claims'
+        end
+      end
+
       def claims_params
         apply_where_params! on_behalf_of_content_owner: @parent.owner_name
       end

data/lib/yt/collections/ownerships.rb

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