yt 0.12.2 → 0.13.0

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.12.2'
+  VERSION = '0.13.0'
 end

data/spec/collections/reports_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'yt/collections/reports'
+require 'yt/models/content_owner'
+
+describe Yt::Collections::Reports do
+  subject(:reports) { Yt::Collections::Reports.new parent: content_owner }
+  let(:content_owner) { Yt::ContentOwner.new owner_name: 'any-name' }
+  let(:error){ {reason: reason, message: message} }
+  let(:msg) { {response_body: {error: {errors: [error]}}}.to_json }
+
+  describe '#within' do
+    let(:result) { reports.within Range.new(5.days.ago, 4.days.ago) }
+    context 'given the request raises error 400 with "Invalid Query" message' do
+      let(:reason) { 'badRequest' }
+      let(:message) { 'Invalid query. Query did not conform to the expectations' }
+      before { expect(reports).to receive(:list).once.and_raise Yt::Error, msg }
+      let(:try_again) { expect(reports).to receive(:list).at_least(:once) }
+
+      context 'every time' do
+        before { try_again.and_raise Yt::Error, msg }
+        it { expect{result}.to fail }
+      end
+
+      context 'but returns a success code 2XX the second time' do
+        before { try_again.and_return [1,2] }
+        it { expect{result}.not_to fail }
+      end
+    end
+  end
+end

data/spec/models/request_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'yt/models/request'
+require 'yt/request'
 
 
 describe Yt::Request do
@@ -37,28 +37,6 @@ describe Yt::Request do
         end
       end
 
-      context 'an error code 400 with "Invalid Query" message' do
-        let(:response_class) { Net::HTTPBadRequest }
-        let(:response_body) { {error: {errors: [message: message]}}.to_json }
-        let(:message) { 'Invalid query. Query did not conform to the expectations' }
-
-        let(:retry_response) { retry_response_class.new nil, nil, nil }
-        before { allow(retry_response).to receive(:body) }
-        before { expect(Net::HTTP).to receive(:start).at_least(:once).and_return retry_response }
-
-        context 'every time' do
-          let(:retry_response_class) { Net::HTTPBadRequest }
-
-          it { expect{request.run}.to fail }
-        end
-
-        context 'but returns a success code 2XX the second time' do
-          let(:retry_response_class) { Net::HTTPOK }
-
-          it { expect{request.run}.not_to fail }
-        end
-      end
-
       context 'an error code 401' do
         let(:response_class) { Net::HTTPUnauthorized }
 

data/spec/requests/as_account/account_spec.rb

@@ -3,6 +3,13 @@ require 'spec_helper'
 require 'yt/models/account'
 
 describe Yt::Account, :device_app do
+  describe 'can create playlists' do
+    let(:params) { {title: 'Test Yt playlist', privacy_status: 'unlisted'} }
+    before { @playlist = $account.create_playlist params }
+    it { expect(@playlist).to be_a Yt::Playlist }
+    after { @playlist.delete }
+  end
+
   describe '.channel' do
     it { expect($account.channel).to be_a Yt::Channel }
   end
@@ -45,7 +52,7 @@ describe Yt::Account, :device_app do
   end
 
   describe '.upload_video' do
-    let(:video_params) { {title: 'Test Yt upload', privacy_status: 'private'} }
+    let(:video_params) { {title: 'Test Yt upload', privacy_status: 'private', category_id: 17} }
     let(:video) { $account.upload_video path_or_url, video_params }
     after { video.delete }
 

data/spec/requests/as_account/authentications_spec.rb

@@ -13,7 +13,7 @@ describe Yt::Account, :device_app do
       # same second, refreshing the token returns the same token. Still,
       # testing that *expires_at* changes is a guarantee that we attempted
       # to get a new token, which is what refresh is meant to do.
-      it { expect{account.refresh}.to change{account.expires_at} }
+      it { expect{account.refreshed_access_token?}.to change{account.expires_at} }
     end
   end
 

data/spec/requests/as_account/channel_spec.rb

@@ -23,7 +23,6 @@ describe Yt::Channel, :device_app do
 
     it { expect(channel.videos.first).to be_a Yt::Video }
     it { expect(channel.playlists.first).to be_a Yt::Playlist }
-    it { expect{channel.create_playlist}.to raise_error Yt::Errors::RequestError }
     it { expect{channel.delete_playlists}.to raise_error Yt::Errors::RequestError }
 
     specify 'with a public list of subscriptions' do
@@ -105,15 +104,9 @@ describe Yt::Channel, :device_app do
       expect(channel.subscriptions.size).to be
     end
 
-    describe 'playlists can be added' do
-      after { channel.delete_playlists params }
-      it { expect(channel.create_playlist params).to be_a Yt::Playlist }
-      it { expect{channel.create_playlist params}.to change{channel.playlists.count}.by(1) }
-    end
-
     describe 'playlists can be deleted' do
       let(:title) { "Yt Test Delete All Playlists #{rand}" }
-      before { channel.create_playlist params }
+      before { $account.create_playlist params }
 
       it { expect(channel.delete_playlists title: %r{#{params[:title]}}).to eq [true] }
       it { expect(channel.delete_playlists params).to eq [true] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- TODO.md
+- YOUTUBE_IT.md
 - bin/yt
 - gemfiles/Gemfile.activesupport-3.x
 - gemfiles/Gemfile.activesupport-4.x
@@ -193,7 +193,6 @@ files:
 - lib/yt/models/policy_rule.rb
 - lib/yt/models/rating.rb
 - lib/yt/models/reference.rb
-- lib/yt/models/request.rb
 - lib/yt/models/resource.rb
 - lib/yt/models/resumable_session.rb
 - lib/yt/models/right_owner.rb
@@ -205,12 +204,14 @@ files:
 - lib/yt/models/url.rb
 - lib/yt/models/user_info.rb
 - lib/yt/models/video.rb
+- lib/yt/request.rb
 - lib/yt/version.rb
 - spec/collections/claims_spec.rb
 - spec/collections/playlist_items_spec.rb
 - spec/collections/playlists_spec.rb
 - spec/collections/policies_spec.rb
 - spec/collections/references_spec.rb
+- spec/collections/reports_spec.rb
 - spec/collections/subscriptions_spec.rb
 - spec/collections/videos_spec.rb
 - spec/errors/forbidden_spec.rb
@@ -304,6 +305,7 @@ test_files:
 - spec/collections/playlists_spec.rb
 - spec/collections/policies_spec.rb
 - spec/collections/references_spec.rb
+- spec/collections/reports_spec.rb
 - spec/collections/subscriptions_spec.rb
 - spec/collections/videos_spec.rb
 - spec/errors/forbidden_spec.rb

data/TODO.md

@@ -1,58 +0,0 @@
-* methods like Yt::Account.new(params = {}) should use HashWithIndifferentAccess
-* add canonical_url to Resource, then use it in promo
-
-List of supported methods
-=========================
-
-YouTube Data API V3 (https://developers.google.com/youtube/v3/docs)
--------------------------------------------------------------------
-
-- [ ] Activities
-  - [ ] list
-  - [ ] insert
-- [ ] ChannelBanners
-  - [ ] insert
-- [ ] Channels
-  - [ ] list
-  - [ ] update
-- [ ] ChannelSections
-  - [ ] list
-  - [ ] insert
-  - [ ] update
-  - [ ] delete
-- [ ] GuideCategories
-  - [ ] list
-- [ ] I18nLanguages
-  - [ ] list
-- [ ] I18nRegions
-  - [ ] list
-- [ ] PlaylistItems
-  - [ ] list
-  - [ ] insert
-  - [ ] update
-  - [ ] delete
-- [ ] Playlists
-  - [ ] list
-  - [ ] insert
-  - [ ] update
-  - [ ] delete
-- [ ] Search
-  - [ ] list
-- [ ] Subscriptions
-  - [ ] list
-  - [ ] insert
-  - [ ] delete
-- [ ] Thumbnails
-  - [ ] set
-- [ ] VideoCategories
-  - [ ] list
-- [ ] Videos
-  - [ ] list
-  - [ ] insert
-  - [ ] update
-  - [ ] rate
-  - [ ] getRating
-  - [ ] delete
-- [ ] Watermarks
-  - [ ] set
-  - [ ] unset

data/lib/yt/models/request.rb

@@ -1,223 +0,0 @@
-require 'net/http' # for Net::HTTP.start
-require 'uri' # for URI.json
-require 'json' # for JSON.parse
-require 'active_support' # does not load anything by default  but is required
-require 'active_support/core_ext' # for Hash.from_xml, Hash.to_param
-
-require 'yt/config'
-require 'yt/errors/unauthorized'
-require 'yt/errors/request_error'
-require 'yt/errors/server_error'
-require 'yt/errors/forbidden'
-
-module Yt
-  module Models
-    class Request
-      def initialize(options = {})
-        @auth = options[:auth]
-        @file = options[:file]
-        @body_type = options.fetch :body_type, :json
-        @expected_response = options.fetch :expected_response, Net::HTTPSuccess
-        @format = options.fetch :format, :json
-        @headers = options.fetch :headers, gzip_headers
-        @host = options.fetch :host, google_api_host
-        @method = options.fetch :method, :get
-        @path = options[:path]
-        @body = options[:body]
-        camelize_keys! @body if options.fetch(:camelize_body, true)
-        params = options.fetch :params, {}
-        camelize_keys! params if options.fetch(:camelize_params, true)
-        @query = params.to_param
-      end
-
-
-      def run
-        p as_curl if Yt.configuration.developing?
-
-        if response.is_a? @expected_response
-          response.tap{|response| response.body = parse_format response.body}
-        else
-          run_again? ? run : raise(response_error, request_error_message)
-        end
-      end
-
-      def request_error_message
-        {}.tap do |message|
-          message[:request_curl] = as_curl
-          message[:response_body] = JSON(response.body) rescue response.inspect
-        end.to_json
-      end
-
-    private
-
-      def response
-        @response ||= send_http_request
-      rescue OpenSSL::SSL::SSLError, Errno::ETIMEDOUT, Errno::ENETUNREACH, Errno::ECONNRESET => e
-        @response ||= e
-      end
-
-      def send_http_request
-        ActiveSupport::Notifications.instrument 'request.yt' do |payload|
-          payload[:method] = @method
-          payload[:request_uri] = uri
-          payload[:response] = Net::HTTP.start(*net_http_options) do |http|
-            http.request http_request
-          end
-        end
-      end
-
-      def http_request
-        @http_request ||= net_http_class.new(uri.request_uri).tap do |request|
-          set_headers! request
-          set_body! request
-        end
-      end
-
-      def set_headers!(request)
-        case @body_type
-        when :json
-          request.initialize_http_header 'Content-Type' => 'application/json'
-          request.initialize_http_header 'Content-length' => '0' unless @body
-        when :file
-          request.initialize_http_header 'Content-Length' => @body.size.to_s
-          request.initialize_http_header 'Transfer-Encoding' => 'chunked'
-        end
-        @headers.each{|name, value| request.add_field name, value}
-      end
-
-      # To receive a gzip-encoded response you must do two things:
-      # - Set the Accept-Encoding HTTP request header to gzip.
-      # - Modify your user agent to contain the string gzip.
-      # Net::HTTP already sets the Accept-Encoding header, so all it’s left
-      # to do is to specify an appropriate User Agent.
-      # @see https://developers.google.com/youtube/v3/getting-started#gzip
-      # @see http://www.ietf.org/rfc/rfc2616.txt
-      def gzip_headers
-        @gzip_headers ||= {}.tap do |headers|
-          headers['user-agent'] = 'Yt (gzip)'
-        end
-      end
-
-      def set_body!(request)
-        case @body_type
-          when :json then request.body = @body.to_json
-          when :form then request.set_form_data @body
-          when :file then request.body_stream = @body
-        end if @body
-      end
-
-      def net_http_options
-        [uri.host, uri.port, use_ssl: true]
-      end
-
-      def net_http_class
-        "Net::HTTP::#{@method.capitalize}".constantize
-      end
-
-      def uri
-        @uri ||= build_uri
-      end
-
-      def build_uri
-        add_authorization! if @host == google_api_host
-        URI::HTTPS.build host: @host, path: @path, query: @query
-      end
-
-      def add_authorization!
-        if @auth.respond_to? :access_token
-          @headers['Authorization'] = "Bearer #{@auth.access_token}"
-        elsif Yt.configuration.api_key
-          params = URI.decode_www_form @query || ''
-          params << [:key, Yt.configuration.api_key]
-          @query = URI.encode_www_form params
-        end
-      end
-
-      def google_api_host
-        'www.googleapis.com'
-      end
-
-      def parse_format(body)
-        case @format
-          when :xml then Hash.from_xml body
-          when :json then JSON body
-        end if body
-      end
-
-      def camelize_keys!(object)
-        return object unless object.is_a?(Hash)
-        object.dup.each_key do |key|
-          object[key.to_s.camelize(:lower).to_sym] = object.delete key
-        end
-      end
-
-      # There are two cases to run a request again: YouTube responds with a
-      # random error that can be fixed by waiting for some seconds and running
-      # the exact same query, or the access token needs to be refreshed.
-      def run_again?
-        refresh_token_and_retry? || server_error? && sleep_and_retry?
-      end
-
-      # Once in a while, YouTube responds with 500, or 503, or 400 Error and
-      # the text "Invalid query. Query did not conform to the expectations.".
-      # In all these cases, running the same query after some seconds fixes
-      # the issue. This it not documented by YouTube and hardly testable, but
-      # trying again is a workaround that works and hardly causes any damage.
-      def sleep_and_retry?(max_retries = 1)
-        @retries_so_far ||= -1
-        @retries_so_far += 1
-        if (@retries_so_far < max_retries)
-          @response = @http_request = @uri = nil
-          sleep 3
-        end
-      end
-
-      def server_error?
-        case response
-          when OpenSSL::SSL::SSLError then true
-          when Errno::ETIMEDOUT then true
-          when Errno::ENETUNREACH then true
-          when Net::HTTPServerError then true
-          when Net::HTTPBadRequest then response.body =~ /did not conform/
-          else false
-        end
-      end
-
-      # If a request authorized with an access token returns 401, then the
-      # access token might have expired. If a refresh token is also present,
-      # try to run the request one more time with a refreshed access token.
-      # If it's not present, then don't raise the returned MissingAuth, just
-      # let the original error bubble up.
-      def refresh_token_and_retry?
-        if response.is_a? Net::HTTPUnauthorized
-          @auth.refresh.tap { @response = @http_request = @uri = nil }
-        end if @auth.respond_to? :refresh
-      rescue Errors::MissingAuth
-        false
-      end
-
-      def response_error
-        if server_error?
-          Errors::ServerError
-        else case response
-          when Net::HTTPUnauthorized then Errors::Unauthorized
-          when Net::HTTPForbidden then Errors::Forbidden
-          else Errors::RequestError
-          end
-        end
-      end
-
-      def as_curl
-        'curl'.tap do |curl|
-          curl <<  " -X #{http_request.method}"
-          http_request.each_header do |name, value|
-            next if gzip_headers.has_key? name
-            curl << %Q{ -H "#{name}: #{value}"}
-          end
-          curl << %Q{ -d '#{http_request.body}'} if http_request.body
-          curl << %Q{ "#{@uri.to_s}"}
-        end
-      end
-    end
-  end
-end