yt 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a618a834dfa7b3cecfc38f24ea9d7c7f42db9ca3
-  data.tar.gz: 8136067b0f3568ac059e4eacfe0eb812c3c9c4e2
+  metadata.gz: f2401a0d9b81d6da08424943a09b392870081fc6
+  data.tar.gz: b1fd60bb4f1426f34182730f73bdf4641e6025d0
 SHA512:
-  metadata.gz: adb13cd19177496972a8f43bf663716ce250ca8e0d53d8aa570efe82ae4b5b97371d9697bb3f90bdec1a1aa6d082f13a79096c9af777a70fe6f27e2a577819f9
-  data.tar.gz: 212188da7ddfd9dd7c17b62c6568ff51e1fcdc55cc63da4b13552bae96140338723a2fce7b82f025273bd3e538405fbb4da81fcf1d678f621feb4fc58da573e3
+  metadata.gz: 74acf5be09a43cdbb3f7da60d275c57b5db7fb9336c4f236c0db48257b0120ebb95619a4e5a5ae8eb77a5b6450c600d0cbed14bb015a43e1d2b474c813020caf
+  data.tar.gz: 7daada1a1bc24ddd581cacbb6f2171a5947f9c387b608222dae391b664bb944d1c22a8e6d6cbcfd7df3531ae90622e200eae61eaebfbe8bf00c8e333c0475523

data/Gemfile.lock

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

data/HISTORY.md

@@ -8,6 +8,7 @@ v0.9 - 2014/07/28
 * Add claim.third_party?
 * Add actual_start_time, actual_end_time, scheduled_start_time, scheduled_end_time for live-streaming videos
 * Add privacy_status, public_stats_viewable, publish_at to the options that Video#update accepts
+* Allow angle brackets when editing title, description, tags and replace them with similar characters allowed by YouTube
 
 v0.8 - 2014/07/18
 -----------------

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.9.5'
+    gem 'yt', '~> 0.9.6'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -287,7 +287,7 @@ video.like #=> true
 account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
 video = Yt::Video.new id: 'MESycYJytkU', auth: account
 
-video.update title: 'A title', description: 'A description', tags: ['a tag'], categoryId: '21'
+video.update title: 'A title', description: 'A description <with angle brackets>', tags: ['a tag'], categoryId: '21'
 
 video.views since: 7.days.ago #=> {Wed, 28 May 2014 => 12.0, Thu, 29 May 2014 => 3.0, …}
 video.comments until: 2.days.ago #=> {Wed, 28 May 2014 => 9.0, Thu, 29 May 2014 => 4.0, …}
@@ -353,7 +353,7 @@ playlist.playlist_items.first #=> #<Yt::Models::PlaylistItem @id=...>
 *The methods above do not require authentication.*
 
 ```ruby
-playlist.update title: 'title', description: 'desc', tags: ['new tag'], privacy_status: 'private'
+playlist.update title: 'A <title> with angle brackets', description: 'desc', tags: ['new tag'], privacy_status: 'private'
 playlist.add_video 'MESycYJytkU'
 playlist.add_videos ['MESycYJytkU', 'MESycYJytkU']
 playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]

data/lib/yt/actions/delete_all.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'yt/actions/list'
 require 'yt/models/request'
 
@@ -20,7 +21,8 @@ module Yt
             # TODO: could be symbol etc...
             item.respond_to?(method) && case value
             when Regexp then item.send(method) =~ value
-            else item.send(method) == value
+            when Array then item.send(method) == value.map{|item| item.to_s.gsub('<', '‹').gsub('>', '›')}
+            else item.send(method) == value.to_s.gsub('<', '‹').gsub('>', '›')
             end
           end
         end

data/lib/yt/collections/playlist_items.rb

@@ -4,12 +4,8 @@ module Yt
   module Collections
     class PlaylistItems < Resources
 
-      # attrs are id and kind
-      def insert(attrs = {}, options = {}) #
-        resource = {kind: "youtube##{attrs[:kind]}"}
-        resource["#{attrs[:kind]}Id"] = attrs[:id]
-        snippet = {playlistId: @parent.id, resourceId: resource}
-        do_insert body: {snippet: snippet}, params: {part: 'snippet,status'}
+      def insert(attributes = {}, options = {})
+        super attributes.merge(playlist_id: @parent.id), options
       rescue Yt::Error => error
         ignorable_errors = error.reasons & ['videoNotFound', 'forbidden']
         raise error unless options[:ignore_errors] && ignorable_errors.any?
@@ -17,8 +13,8 @@ module Yt
 
     private
 
-      # @return [Hash] the parameters to submit to YouTube to list channels.
-      # @see https://developers.google.com/youtube/v3/docs/channels/list
+      # @return [Hash] the parameters to submit to YouTube to list playlist items.
+      # @see https://developers.google.com/youtube/v3/docs/playlistItems/list
       def list_params
         super.tap{|params| params[:params] = playlist_items_params}
       end
@@ -26,6 +22,10 @@ module Yt
       def playlist_items_params
         resources_params.merge playlist_id: @parent.id
       end
+
+      def insert_parts
+        {snippet: {keys: [:playlist_id, :resource_id]}}
+      end
     end
   end
 end

data/lib/yt/collections/playlists.rb

@@ -4,20 +4,6 @@ module Yt
   module Collections
     class Playlists < Resources
 
-      # Valid body (no defaults) are: title (string), description (string), privacy_status (string),
-      # tags (array of strings)
-      def insert(options = {})
-        body = {}
-
-        snippet = options.slice :title, :description, :tags
-        body[:snippet] = snippet if snippet.any?
-
-        status = options[:privacy_status]
-        body[:status] = {privacyStatus: status} if status
-
-        do_insert body: body, params: {part: 'snippet,status'}
-      end
-
     private
 
       # @return [Hash] the parameters to submit to YouTube to list channels.
@@ -29,6 +15,12 @@ module Yt
       def playlists_params
         resources_params.merge channel_id: @parent.id
       end
+
+      def insert_parts
+        snippet = {keys: [:title, :description, :tags], sanitize_brackets: true}
+        status = {keys: [:privacy_status]}
+        {snippet: snippet, status: status}
+      end
     end
   end
 end

data/lib/yt/collections/resources.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'yt/collections/base'
 
 module Yt
@@ -7,6 +8,13 @@ module Yt
         do_delete_all params
       end
 
+      def insert(attributes = {}, options = {}) #
+        underscore_keys! attributes
+        body = build_insert_body attributes
+        params = {part: body.keys.join(',')}
+        do_insert(params: params, body: body)
+      end
+
     private
 
       # @return [resource_class] a new resource item initialized with
@@ -27,6 +35,54 @@ module Yt
         require "yt/models/#{resource_name.underscore}"
         "Yt::Models::#{resource_name}".constantize
       end
+
+      def build_insert_body(attributes = {})
+        {}.tap do |body|
+          insert_parts.each do |name, part|
+            if should_include_part_in_insert? part, attributes
+              body[name] = build_insert_body_part part, attributes
+              sanitize_brackets! body[name] if part[:sanitize_brackets]
+            end
+          end
+        end
+      end
+
+      def build_insert_body_part(part, attributes = {})
+        {}.tap do |body_part|
+          part[:keys].map do |key|
+            body_part[camelize key] = attributes[key]
+          end
+        end
+      end
+
+      def should_include_part_in_insert?(part, attributes = {})
+        (part[:keys] & attributes.keys).any?
+      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
+
+      # @return [Hash] the original hash with angle brackets characters in its
+      #   values replaced with similar Unicode characters accepted by Youtube.
+      # @see https://support.google.com/youtube/answer/57404?hl=en
+      def sanitize_brackets!(source)
+        case source
+          when String then source.gsub('<', '‹').gsub('>', '›')
+          when Array then source.map{|string| sanitize_brackets! string}
+          when Hash then source.each{|k,v| source[k] = sanitize_brackets! v}
+        end
+      end
+
+      def camelize(value)
+        value.to_s.camelize(:lower).to_sym
+      end
+
+      def underscore(value)
+        value.to_s.underscore.to_sym
+      end
     end
   end
 end

data/lib/yt/models/playlist.rb

@@ -68,13 +68,16 @@ module Yt
 
       # @see https://developers.google.com/youtube/v3/docs/playlists/update
       def update_parts
-        snippet = {keys: [:title, :description, :tags], required: true}
+        keys = [:title, :description, :tags]
+        snippet = {keys: keys, required: true, sanitize_brackets: true}
         status = {keys: [:privacy_status]}
         {snippet: snippet, status: status}
       end
 
+      # @todo: extend camelize to also camelize the nested hashes, so we
+      #   don’t have to write videoId
       def video_params(video_id)
-        {id: video_id, kind: :video}
+        {resource_id: {kind: 'youtube#video', videoId: video_id}}
       end
     end
   end

data/lib/yt/models/resource.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'yt/models/base'
 require 'yt/models/url'
 
@@ -56,13 +58,22 @@ module Yt
       end
 
       def build_update_body(attributes = {})
-        body = {}
-        update_parts.each do |name, part|
-          body[name] = {}.tap do |hash|
-            part[:keys].map{|k| hash[camelize k] = attributes.fetch k, send(k)}
-          end if should_include_part_in_update?(part, attributes)
+        {}.tap do |body|
+          update_parts.each do |name, part|
+            if should_include_part_in_update? part, attributes
+              body[name] = build_update_body_part part, attributes
+              sanitize_brackets! body[name] if part[:sanitize_brackets]
+            end
+          end
+        end
+      end
+
+      def build_update_body_part(part, attributes = {})
+        {}.tap do |body_part|
+          part[:keys].map do |key|
+            body_part[camelize key] = attributes.fetch key, send(key)
+          end
         end
-        body
       end
 
       def should_include_part_in_update?(part, attributes = {})
@@ -75,6 +86,17 @@ module Yt
         hash.dup.each_key{|key| hash[underscore key] = hash.delete key}
       end
 
+      # @return [Hash] the original hash with angle brackets characters in its
+      #   values replaced with similar Unicode characters accepted by Youtube.
+      # @see https://support.google.com/youtube/answer/57404?hl=en
+      def sanitize_brackets!(source)
+        case source
+          when String then source.gsub('<', '‹').gsub('>', '›')
+          when Array then source.map{|string| sanitize_brackets! string}
+          when Hash then source.each{|k,v| source[k] = sanitize_brackets! v}
+        end
+      end
+
       def camelize(value)
         value.to_s.camelize(:lower).to_sym
       end

data/lib/yt/models/video.rb

@@ -161,9 +161,10 @@ module Yt
       # @todo: Add recording details keys
       def update_parts
         snippet_keys = [:title, :description, :tags, :category_id]
+        snippet = {keys: snippet_keys, sanitize_brackets: true}
         status_keys = [:privacy_status, :embeddable, :license,
           :public_stats_viewable, :publish_at]
-        {snippet: {keys: snippet_keys}, status: {keys: status_keys}}
+        {snippet: snippet, status: {keys: status_keys}}
       end
     end
   end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.9.5'
+  VERSION = '0.9.6'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -54,9 +54,9 @@ describe Yt::Channel, :device_app do
 
   context 'given my own channel' do
     let(:id) { $account.channel.id }
-    let(:title) { 'Yt Test title' }
-    let(:description) { 'Yt Test description' }
-    let(:tags) { ['Yt Test Tag 1', 'Yt Test Tag 2'] }
+    let(:title) { 'Yt Test <title>' }
+    let(:description) { 'Yt Test <description>' }
+    let(:tags) { ['Yt Test Tag 1', 'Yt Test <Tag> 2'] }
     let(:privacy_status) { 'unlisted' }
     let(:params) { {title: title, description: description, tags: tags, privacy_status: privacy_status} }
 

data/spec/requests/as_account/playlist_spec.rb

@@ -91,6 +91,17 @@ describe Yt::Playlist, :device_app do
       end
     end
 
+    context 'given I update title, description and/or tags using angle brackets' do
+      let(:attrs) { {title: "Yt Test < >", description: '< >', tags: ['<tag>']} }
+
+      specify 'updates them replacing angle brackets with similar unicode characters accepted by YouTube' do
+        expect(update).to be true
+        expect(playlist.title).to eq 'Yt Test ‹ ›'
+        expect(playlist.description).to eq '‹ ›'
+        expect(playlist.tags).to eq ['‹tag›']
+      end
+    end
+
     context 'given I update the privacy status' do
       let!(:new_privacy_status) { old_privacy_status == 'private' ? 'unlisted' : 'private' }
 

data/spec/requests/as_account/video_spec.rb

@@ -194,6 +194,17 @@ describe Yt::Video, :device_app do
       end
     end
 
+    context 'given I update title, description and/or tags using angle brackets' do
+      let(:attrs) { {title: "Example Yt Test < >", description: '< >', tags: ['<tag>']} }
+
+      specify 'updates them replacing angle brackets with similar unicode characters accepted by YouTube' do
+        expect(update).to be true
+        expect(video.title).to eq 'Example Yt Test ‹ ›'
+        expect(video.description).to eq '‹ ›'
+        expect(video.tags).to eq ['‹tag›']
+      end
+    end
+
     # note: 'scheduled' videos cannot be set to 'unlisted'
     context 'given I update the privacy status' do
       before { video.update publish_at: nil if video.scheduled? }
@@ -347,5 +358,4 @@ describe Yt::Video, :device_app do
       end
     end
   end
-
 end

metadata

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