yt 0.4.10 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b768b3bf2f8df33d6464c3e5576d216eb56a40b6
-  data.tar.gz: 5d9157b38126cdae31aed2bd15192978a1656339
+  metadata.gz: 618a1921ea46452fc9fcb6cc28cf44ab44d3370a
+  data.tar.gz: 5fc33026503612fa0387a7ce7ceabc5251f254af
 SHA512:
-  metadata.gz: 536cbae00ed870974c980366668f9a87f0bc7c8e0f8d1cf506fe077b307a5fb1fcb1d49486e7d444f40af1fff1d86c30719c22934a338cc8fb45891c213193ba
-  data.tar.gz: f8df59e9464f5f771266136789fa73bd2faa6649422a183aaba54e4987b1ca12b1fe5fa79daaeb5b8af3bbb360691292269c90814caaddb09afd3a52db665a53
+  metadata.gz: 07759995fcf879ae9a3e4277882113eabb423bbc9da0a3f8fc0b815a06cdb61a0c72a5e69960c652e3d6127e004d94c18a120797097b78e6aaf7beb7148bdd44
+  data.tar.gz: c5c246314f34b478b7014a79277bdce941b69daeb9c25e61f6ad4551fd5b6cfacfad283fcfe70c7fda91bf3c0a60ea8ce82852699f31b99a47a20a8dd48a9809

data/Gemfile.lock

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

data/HISTORY.md

@@ -1,3 +1,13 @@
+v0.5 - 2014/05/16
+-----------------
+
+* More complete custom exception Yt::Error, with code, body and curl
+* Replace `:ignore_not_found` and `:ignore_duplicates` with `:ignore_errors`
+* Allow resources to be initialized with a url, such as Yt::Resource.new url: 'youtube.com/fullscreen'
+* Add `has_one :id` to resources, to retrieve the ID of resources initialized by URL
+* Raise an error if some `has_one` associations are not found (id, snippet, details set, user info)
+* Don't check for the right :scope if Account is initialized with credentials
+
 v0.4 - 2014/05/09
 --------------------
 

data/README.md

@@ -302,7 +302,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.4.10'
+    gem 'yt', '~> 0.5.3'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -389,8 +389,12 @@ export YT_TEST_DEVICE_CLIENT_SECRET="1234567890"
 export YT_TEST_SERVER_API_KEY="123456789012345678901234567890"
 ```
 
-[ TODO: Complete this section. Explain how get and store the refresh token,
-  making sure all the required scopes are authorized. ]
+[ TODO:
+  Complete this section.
+  Explain how get and store the refresh token, making sure all the required scopes are authorized:
+  'https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile'
+]
+
 
 
 How to contribute

data/TODO.md

@@ -1,3 +1,9 @@
+* methods like Yt::Account.new(params = {}) should use HashWithIndifferentAccess
+* add canonical_url to Resource, then use it in promo
+
+* once in a while, Google fails with 500 error and just retrying after some
+seconds fixes it, so we should retry every 500 at least
+
 * find by url (either video or channel or.. playlist)
 * Google accounts?
 * ENV support
@@ -7,5 +13,3 @@
 * operations like subscribe that require authentication should not fail if
 called on Yt::Channel without auth but, similarly to account, show the prompt
 or ask for the device code
-
-* scope

data/lib/yt/actions/delete.rb

@@ -1,4 +1,4 @@
-require 'yt/actions/request'
+require 'yt/models/request'
 
 module Yt
   module Actions

data/lib/yt/actions/delete_all.rb

@@ -1,5 +1,5 @@
 require 'yt/actions/list'
-require 'yt/actions/request'
+require 'yt/models/request'
 
 module Yt
   module Actions

data/lib/yt/actions/insert.rb

@@ -1,4 +1,4 @@
-require 'yt/actions/request'
+require 'yt/models/request'
 
 module Yt
   module Actions

data/lib/yt/actions/list.rb

@@ -1,12 +1,18 @@
-require 'yt/actions/request'
+require 'yt/models/request'
+require 'yt/errors/no_items'
 
 module Yt
   module Actions
     module List
-
       delegate :count, :first, :any?, :each, :map, :find, to: :list
       alias size count
 
+      def first!
+        first.tap do |item|
+          raise Errors::NoItems unless item
+        end
+      end
+
     private
 
       def list

data/lib/yt/actions/update.rb

@@ -1,4 +1,4 @@
-require 'yt/actions/request'
+require 'yt/models/request'
 
 module Yt
   module Actions

data/lib/yt/associations.rb

@@ -13,6 +13,7 @@ module Yt
     autoload :Annotations
     autoload :Channels
     autoload :DetailsSets
+    autoload :Ids
     autoload :PlaylistItems
     autoload :Playlists
     autoload :Ratings

data/lib/yt/associations/details_sets.rb

@@ -7,7 +7,7 @@ module Yt
     # YouTube resources with content details are: videos.
     module DetailsSets
       def details_set
-        @detail_set ||= details_sets.first
+        @detail_set ||= details_sets.first!
       end
 
     private

data/lib/yt/associations/ids.rb

@@ -0,0 +1,20 @@
+require 'yt/collections/ids'
+
+module Yt
+  module Associations
+    # Provides the `has_one :id` method to YouTube resources, which
+    # allows to retrieve the id of a resource knowing only its username.
+    # YouTube resources with ids are: resources.
+    module Ids
+      def id
+        @id ||= ids.first!
+      end
+
+    private
+
+      def ids
+        @ids ||= Collections::Ids.of self
+      end
+    end
+  end
+end

data/lib/yt/associations/snippets.rb

@@ -7,7 +7,7 @@ module Yt
     # YouTube resources with content details are: videos and channels.
     module Snippets
       def snippet
-        @snippet ||= snippets.first
+        @snippet ||= snippets.first!
       end
 
     private

data/lib/yt/associations/subscriptions.rb

@@ -15,7 +15,7 @@ module Yt
       end
 
       def subscribe
-        subscriptions.insert ignore_duplicates: true
+        subscriptions.insert ignore_errors: true
       end
 
       def subscribe!
@@ -23,7 +23,7 @@ module Yt
       end
 
       def unsubscribe
-        subscriptions.delete_all({}, ignore_not_found: true)
+        subscriptions.delete_all({}, ignore_errors: true)
       end
 
       def unsubscribe!

data/lib/yt/associations/user_infos.rb

@@ -7,7 +7,7 @@ module Yt
     # YouTube resources with user infos are: accounts.
     module UserInfos
       def user_info
-        @user_info ||= user_infos.first
+        @user_info ||= user_infos.first!
       end
 
     private

data/lib/yt/collections/base.rb

@@ -1,6 +1,7 @@
 require 'yt/actions/delete_all'
 require 'yt/actions/insert'
 require 'yt/actions/list'
+require 'yt/errors/error'
 
 module Yt
   module Collections

data/lib/yt/collections/details_sets.rb

@@ -14,7 +14,6 @@ module Yt
       def list_params
         super.tap do |params|
           params[:params] = {maxResults: 50, part: 'contentDetails', id: @parent.id}
-          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
           params[:path] = '/youtube/v3/videos'
         end
       end

data/lib/yt/collections/ids.rb

@@ -0,0 +1,22 @@
+require 'yt/collections/base'
+require 'yt/models/id'
+
+module Yt
+  module Collections
+    class Ids < Base
+
+    private
+
+      def new_item(data)
+        Yt::Id.new data['id']
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:params] = {forUsername: @parent.username, part: 'id'}
+          params[:path] = "/youtube/v3/#{@parent.kind.pluralize}"
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/playlist_items.rb

@@ -11,8 +11,9 @@ module Yt
         resource["#{attrs[:kind]}Id"] = attrs[:id]
         snippet = {playlistId: @parent.id, resourceId: resource}
         do_insert body: {snippet: snippet}, params: {part: 'snippet,status'}
-      rescue Yt::RequestError => error
-        raise error unless options[:ignore_errors] && (error.reasons.include?('videoNotFound') || error.reasons.include?('forbidden'))
+      rescue Errors::Base => error
+        ignorable_errors = error.reasons & ['videoNotFound', 'forbidden']
+        raise error unless options[:ignore_errors] && ignorable_errors.any?
       end
 
       def delete_all(params = {})
@@ -28,7 +29,6 @@ module Yt
       def list_params
         super.tap do |params|
           params[:params] = {maxResults: 50, part: 'snippet,status', playlistId: @parent.id}
-          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
         end
       end
 

data/lib/yt/collections/playlists.rb

@@ -32,7 +32,6 @@ module Yt
       def list_params
         super.tap do |params|
           params[:params] = {maxResults: 50, part: 'snippet,status', channelId: @parent.id}
-          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
         end
       end
 

data/lib/yt/collections/snippets.rb

@@ -15,7 +15,6 @@ module Yt
         parents_path = @parent.class.to_s.demodulize.underscore.pluralize
         super.tap do |params|
           params[:params] = {id: @parent.id, part: 'snippet'}
-          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
           params[:path] = "/youtube/v3/#{parents_path}"
         end
       end

data/lib/yt/collections/subscriptions.rb

@@ -8,8 +8,9 @@ module Yt
       def insert(options = {})
         throttle
         do_insert
-      rescue Yt::RequestError => error
-        raise error unless options[:ignore_duplicates] && error.reasons.include?('subscriptionDuplicate')
+      rescue Errors::Base => error
+        ignorable_errors = error.reasons & ['subscriptionDuplicate']
+        raise error unless options[:ignore_errors] && ignorable_errors.any?
       end
 
       def delete_all(params = {}, options = {})
@@ -28,7 +29,7 @@ module Yt
       # To overcome this, if we have just updated the subscription, we must
       # wait some time before requesting it again.
       #
-      def throttle(seconds = 9)
+      def throttle(seconds = 10)
         @last_changed_at ||= Time.now - seconds
         wait = [@last_changed_at - Time.now + seconds, 0].max
         sleep wait

data/lib/yt/collections/user_infos.rb

@@ -14,8 +14,6 @@ module Yt
       def list_params
         super.tap do |params|
           params[:path] = '/oauth2/v2/userinfo'
-          # TODO: Remove youtube from here, implement incremental scopes
-          params[:scope] = 'https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile'
         end
       end
 

data/lib/yt/collections/videos.rb

@@ -14,7 +14,6 @@ module Yt
       def list_params
         super.tap do |params|
           params[:params] = {channelId: @parent.id, type: :video, maxResults: 50, part: 'snippet'}
-          params[:scope] = 'https://www.googleapis.com/auth/youtube.readonly'
           params[:path] = '/youtube/v3/search'
         end
       end

data/lib/yt/errors/base.rb

@@ -0,0 +1,43 @@
+module Yt
+  module Errors
+    class Base < StandardError
+      def initialize(msg = nil)
+        @msg = msg
+        super msg
+      end
+
+      def reasons
+        errors = response_body.fetch('error', {}).fetch 'errors', []
+        errors.map{|e| e['reason']}
+      end
+
+    private
+
+      def response_code
+        Integer(response['code']) rescue nil
+      end
+
+      def response_body
+        body = response['body']
+        JSON(body) rescue {body: body}
+      end
+
+      def request_curl
+        # TODO.. continue
+        %Q{curl -X #{request['method'].to_s.upcase} "#{request['url']}"}
+      end
+
+      def request
+        json['request'] || {}
+      end
+
+      def response
+        json['response'] || {}
+      end
+
+      def json
+        JSON(@msg) rescue {}
+      end
+    end
+  end
+end

data/lib/yt/errors/error.rb

@@ -0,0 +1,8 @@
+require 'yt/errors/base'
+
+# Just an alias in the main namespace, so external code can `rescue Yt::Error`
+# rather than `rescue Yt::Error::Base`
+module Yt
+  class Error < Errors::Base
+  end
+end

data/lib/yt/errors/failed.rb

@@ -0,0 +1,17 @@
+require 'yt/errors/base'
+
+module Yt
+  module Errors
+    class Failed < Base
+      def message
+        <<-MSG.gsub(/^ {6}/, '')
+        A request to YouTube API V3 failed (code #{response_code}):
+        #{response_body}
+
+        You can retry the same request manually by running:
+        #{request_curl}
+        MSG
+      end
+    end
+  end
+end

data/lib/yt/errors/no_items.rb

@@ -0,0 +1,17 @@
+require 'yt/errors/base'
+
+module Yt
+  module Errors
+    class NoItems < Base
+      def message
+        <<-MSG.gsub(/^ {6}/, '')
+        A request to YouTube API V3 returned no items (but some were expected):
+        #{response_body}
+
+        You can retry the same request manually by running:
+        #{request_curl}
+        MSG
+      end
+    end
+  end
+end

data/lib/yt/errors/unauthenticated.rb

@@ -0,0 +1,34 @@
+require 'yt/errors/base'
+
+module Yt
+  module Errors
+    class Unauthenticated < Base
+      def message
+        <<-MSG.gsub(/^ {6}/, '')
+        A request to YouTube API V3 was sent without the required authentication:
+
+        #{request_curl}
+
+        In order to perform this request, you need to register your app with
+        Google Developers Console (https://console.developers.google.com).
+
+        Make sure your app has access to the Google+ and YouTube APIs.
+        Generate a client ID, client secret and server API key, then pass their
+        values to Yt. One way of doing this is through an initializer:
+
+        Yt.configure do |config|
+          config.client_id = '1234567890.apps.googleusercontent.com'
+          config.client_secret = '1234567890'
+          config.api_key = '123456789012345678901234567890'
+        end
+
+        An alternative (but equivalent) way is throught environment variables:
+
+        export YT_CLIENT_ID="1234567890.apps.googleusercontent.com"
+        export YT_CLIENT_SECRET="1234567890"
+        export YT_API_KEY="123456789012345678901234567890"
+        MSG
+      end
+    end
+  end
+end