yt 0.10.5 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b514aef834131736bd47325d004cd67c38f3fcaa
-  data.tar.gz: 1939130b4afa95148532b4f04aa97d0e09c87ef4
+  metadata.gz: 20c3426083692b2c9726ef4c76119e2ad252f51d
+  data.tar.gz: 3e03a4ab33ee8de7c5ea9e9786b05b3bc953790e
 SHA512:
-  metadata.gz: 6ec9dbfb86d648c0b76ccc70f62bc203a76bc38ac5496c8aaaf032b00e7620e61c50d710463e9997ca3a0b13c2d414bfb05f40ae51547e86ea5929c8257c3850
-  data.tar.gz: 88f5254c83f8c689568d8dca5b6acb21711b68cc9812b7e9631e45f8a58709694ecc3c392146de63d743e0fcc9b906fc705a76be8f25fdff50e7a2357169ba86
+  metadata.gz: d4f963fe983113861da21a13f2cca84011d8a717601c53f5009a6e0304354ea30d605ed31cc14ff8959107592ab6cb913387d27285ff63bf640a26fc08c8e968
+  data.tar.gz: 4ef695b291cb1b97884acdfc26a92130a83c6ed169319add5c9e901e8bb9067e515b992b6250750aeb71053dc1756f53e56a240c4c5fe1aa292a3f26559cf447

data/.travis.yml

@@ -5,5 +5,30 @@ matrix:
   include:
   - rvm: 1.9.3
     gemfile: gemfiles/Gemfile.activesupport-3.x
+    env:
+    - secure: OsmWyhhYNILEb1lhqxPX+iEfbWzC3dELuxQ7JGP9iN/FhqBtlV51cu+u2cBBdql6Gzuqi4VlMEeJSX0PQUmzOsMb0vHhOJDyp4a32NE+xry8LOT8XdCwni20ZBcUeFxC5hMUVebPuhqBTFjBWbXQKwKSXIdPnNWz31d9kyGIsxk=
   - rvm: 2.0.0
-    gemfile: gemfiles/Gemfile.activesupport-4.x
+    gemfile: gemfiles/Gemfile.activesupport-4.x
+    env:
+    - secure: FrmFA2BE0FYyuKsf0FEO0EAXY+h048HbD1p3lu5XPo9/lxpAl7wM5m12HsnJQuNY6UlUmZ5bp9f8upCBZpz7cLZK5e/FWLWSvkv3Fts+NVsbAcVtFgvBKOCgTznZi/qgUtqbWBevkM3gyXyylzdB+c4wWjoOO/xSDVR227m8nMA=
+env:
+  global:
+  - secure: MKvaid8oW+io0vtzTUL6jNDBrgoxBe9RLEiFh/gKyVw8cj6bvRPBmYXrZfsNGZfns1i75/GaLCLNMl60ZJkfaN4twdPsh2ju6OnsrKW684G7Ha8Jv6GuaEYEwURBAGULW9EHylW5BlYE7H8SNRjtT8RLyIdjpFphuuiOuUO0/tE=
+  - secure: K3f1RUzLByFOH44M50U02+hDNxFXNts6jWTI6PIP6DAn+j1QyQdvlm55kQ1/otf8L/ypH6GqxF/OQhEOK2xr72MVgFBh0wn4iF7U93Q6xX1ZBNwIGJ6lFWaJ6AP3M0y/Y4Qj3xVQpE6Ofq9TflqeGbuIplQv81z8FV+euq6l+XI=
+  - secure: HyjaCM/coZiZJuIhIBSI+/1Uprs4NvcWAPcCAKtLClZtKLuqNQtKP+pF6aYabOQNFNFyLvcaooygx1VEESx0Hxb6V7OloJlrdt87xc0DxswNBxsZUUJifDW42HXLu5Mkq37fUvNAOKalRpn2mp0y87qJJGyYzo6KKDEvO9fH6HI=
+  - secure: TIhkYLhm8jWq5syGQXknXq1UmBGqQr9BbQwr97ZMAZDHh9GR4WZ27r8R4h+P6a98NfUcl8B72c2TgNpV8Ix8IpAUPrysVmhnSu7LSskevRiEYUsKRKGRK3kgSzawjrxosclEOn4RbWcO/BUjN/2kvT1WZUyRgI8/eZ0WcMjvsP0=
+  - secure: cY0QRvVWriQDvCN1+ntGme1YJfR+LlfXlaXOd7kGSw+JHXUMK49FAcdYXrN+lDA0lY8K2nBvHLvk62oWGvGbYmvqzXrNjljsHQWqtbiuI7AlGjcGDAqyrRcWRQhu+MppLTfduxGrgx+wqZZ9i+3bLiHod8HLa2tyO8P09A7groc=
+  - secure: OeAZwuU8lwaU6h5UgUZ1qyPit6SlnqGifeR3C7+qV7JEFczaz4AckwgEaVcmIptQDO/QTa+kfyJVFkCA8tlPZffUarT7dVEyEfahTTFQTW0oOMXAxrY50MwAQ2ENWMXcoklClug5KiHvaaVtNMMA7HGGASMxBGyzgpniKRc4oN8=
+  - secure: Z3dEcgRE4iC1LAnP2/mvcCygXwRWL4WglhWJEZrj84R+893Be2apXT/HpG5XRGrQ2LRXHfyXbA86TgIeZPTI/TRuopRAipesUjbshyjfO7hsGB0IY44trsn9ZFzJmtMArWiNljQBu+JArIkHLcIyXeoFoXxXw8Q7DHK/r1X6zjQ=
+  - secure: Xqgy14pqYdYqXCzJMS5fFG7U0ihb7EofNAeY/CcsX6zR/ji8kSokbs3mT04amOhmh/nDYqd9dxgLhpqIs7GYOfK8rhyhq44byroM/zbA7+ZgB/bmul1DIEJxNc02CYiZIWMlz43DcnJHYpZe6uZvrU9m3KPkeaQOHXk4MUleUXc=
+  - secure: Cc4GzjWnegDjcta/m74sZ+k/8s1UHHp8yMGn5PfPJLlQcNl/X1IfPtgGTObqhZipJuZAlrl6zfjzaOY2zjqlpd06zW0ed8YCO7n4QsYGy9/S/GNaItvRIAvfRuB0QIOeTTKnp6SsvklT0izCSHmiGK3jukTmFcNY3f4OmLSZfzk=
+  - secure: PsvtNvJjqT46wQ9vwC0vcYruFORR31KU4CYoUjW7cOgQRcUgdLF8Te7hVOsLr1xQtMiVJwOgrcIznAFNkAau6RICpMlqvG68GKddpk6mCbxuI3RlWmHxdlRjUwEVxUyV57tLS6KWaIj6koa4S2RF8RAbUX+3yiI+iLLACm0vu68=
+  - secure: RBDqdSnd8Y3uMmtbqdPpJ96TEP12dqmoJu3ecBhOgnTMsQ/Gsfx+rD2s5MMZdErY+8mmGduMH8NCnw3RIWtBWu7tYAelFjqDzhvZo1de0uJzmCw/zA+KqNceP5s4FwVvwmFj7mr7SKyNMJ0FZjwqR4tcXhX28c3Zi6Fq2hULmQQ=
+  - secure: V3cOMG0aPefKiuKAlrfZb6cMJLMAv8A538qf0Ouw1MN6ngL6uqDaQqissp+/sGp4wUfTJdjVtQn/j4IA1gmk9vdRydILhOryL4X0w2uV1Ip33PEawi+EOOZO2W1vxNrLQO4LvOZmz376sifXwPN3d0aethnHhZ4DiuJrZRT/BUA=
+  - secure: CFmPvFamKLdyaTEAHbtNAOStc4nIjbHcF2g2fyH/s4kxBWCwUlUdEN9/K7Fa9SX6orf/PUA4R08t6o3NLyt/S1dC9DKezZmfTYKuhRNzTOHCiSjeIoDpgdY/lglnTHvr7kuT9ceGAgWk/hmEw7/wQ6ASK4g6G+zRaYi4KDlcM94=
+  - secure: DjWReu3fGGGlk0B2k3sfM5HwRkxNqKo9QNaXYAZa8mJuZs990U7LjfvFEPKHaYTsxPCv1ANEiBGHQYjmlFnKh6B+FmAz5JCtrxRbSARzQ9DBjxyWGNIK064fcFHqYb309OYH8NhCc8WYxr/gn7FJjDb5NCoCIGQ2sYrk4pSormM=
+  - secure: BCr8OowszYHLieino4Zr/E/I8rJujRFFmsY12WovoQiILIbEBonBoTHV1duVcCZyh4MFsdH8rH7NFNCYpeNuETwcU5DPbr3hsALS/4FzBe4J1WixI7jN1wyVWPtSbwfSje8rGMjQmwlML1dgm1QtmI/5MD6mpybwHFrQB9RSV/k=
+  - secure: FwxY5FMyWDyNkHbiZf3odst2kC5iIb00n0lRFU97Ywj8jioqjzKr/x4JCXjKbqFUz4a32mM72fBoj3hqhKnL6/cdnTdhigt3yegR3ozzidcu2SFeZTEDqsHGN0hhqjQIzMI6oKHyqWafSeYtgE18FtxsNpeefZWnRWcQytIMxAI=
+  - secure: CFkNT5WI2ATF3TKehTSuCwzG4EENnoVXaddL0PqpuH4Ss82k0k0xcJBhKbmD3Qkf7nw8y0g4s3jCepHssB2ZwzqQinKcYvamzIbsNPuhsuvlc9rMvT9ZosT5CHsiRJANl+OeZ8l2SqGu6kCMDx45h+fL7YZEtn3jjVZYEAXQSig=
+  - secure: WWuYLNKcTM+fjgFrRT4qa3y4IlwO6xeSkM16jbDG05FUIThMfWRVQHhs5JThw/M3SByWGWySmz74sNpGV6V/yt9jw8o1u6F81j0ec2oeHDCwkZ8xK8ubPv3Pmg14PGr1Awu04zfhTEY9KzJt6HrFSYzek/MpV5Prg4J1l6SgqyU=
+  - secure: YuWrOwaqBT0tLVe90OkfCLX/7tzrLhsOBn7LnqH0Ifw6T+EddNDmQLriWLRny8uNQSg7j/AhPOuEvR/ImOibK3a003LyxQZUx9KrEOkgIa5c82OlOLdcvmXw/8wnQ/SEdTDs8r2l1aZ2NxiieCA3fl7oxR1Lt/O+lS/vgqQY+uM=

data/CHANGELOG.md

@@ -6,6 +6,26 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.11.0 - 2014-08-17
+
+**How to upgrade**
+
+When a request to YouTube fails, Yt used to print out a verbose error message,
+including the response body and the request that caused the error (in curl
+format). This output could include sensitive data (such as the authentication
+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
+```
+
+* [ENHANCEMENT] Add `log_level` to Yt.configuration
+
 ## 0.10.5 - 2014-08-17
 
 * [ENHANCEMENT] Use PATCH rather than PUT to partially update a MatchPolicy

data/Gemfile.lock

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

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.10.5'
+    gem 'yt', '~> 0.11.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/yt/errors/request_error.rb

@@ -1,3 +1,5 @@
+require 'yt/config'
+
 module Yt
   module Errors
     class RequestError < StandardError
@@ -9,11 +11,7 @@ module Yt
       def message
         <<-MSG.gsub(/^ {8}/, '')
         #{explanation}:
-        #{response_body}
-
-        You can retry the same request manually by running:
-        #{request_curl}
-        #{more_details}
+        #{Yt.configuration.debugging? ? details : no_details }
         MSG
       end
 
@@ -31,6 +29,27 @@ module Yt
         'A request to YouTube API failed'
       end
 
+
+      def details
+        <<-MSG.gsub(/^ {8}/, '')
+        #{response_body}
+
+        You can retry the same request manually by running:
+        #{request_curl}
+        #{more_details}
+        MSG
+      end
+
+      def no_details
+        <<-MSG.gsub(/^ {8}/, '')
+        To display more verbose errors, change the configuration of Yt with:
+
+        Yt.configure do |config|
+          config.log_level = :debug
+        end
+        MSG
+      end
+
       def more_details
       end
 

data/lib/yt/models/configuration.rb

@@ -20,6 +20,7 @@ module Yt
     # * +YT_CLIENT_ID+ to store the Client ID for web/device apps
     # * +YT_CLIENT_SECRET+ to store the Client Secret for web/device apps
     # * +YT_API_KEY+ to store the API key for server/browser apps
+    # * +YT_LOG_LEVEL+ to store the verbosity level of the logs
     #
     # In case both methods are used together,
     # {Yt::Config#configure Yt.configure} takes precedence.
@@ -41,12 +42,28 @@ module Yt
       # @see https://console.developers.google.com Google Developers Console
       attr_accessor :api_key
 
+      # @return [String] the level of output to print for debugging purposes.
+      attr_accessor :log_level
+
       # Initialize the global configuration settings, using the values of
       # the specified following environment variables by default.
       def initialize
         @client_id = ENV['YT_CLIENT_ID']
         @client_secret = ENV['YT_CLIENT_SECRET']
         @api_key = ENV['YT_API_KEY']
+        @log_level = ENV['YT_LOG_LEVEL']
+      end
+
+      # @return [Boolean] whether the logging output is extra-verbose.
+      #   Useful when developing (e.g., to print the curl of every request).
+      def developing?
+        log_level.to_s.in? %w(devel)
+      end
+
+      # @return [Boolean] whether the logging output is verbose.
+      #   Useful when debugging (e.g., to print the curl of failing requests).
+      def debugging?
+        log_level.to_s.in? %w(devel debug)
       end
     end
   end

data/lib/yt/models/request.rb

@@ -28,6 +28,8 @@ module Yt
       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

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.10.5'
+  VERSION = '0.11.0'
 end

data/spec/errors/request_error_spec.rb

@@ -2,10 +2,36 @@ require 'spec_helper'
 require 'yt/errors/request_error'
 
 describe Yt::Errors::RequestError do
+  subject(:error) { raise Yt::Errors::RequestError, params }
+  let(:params) { {} }
   let(:msg) { %r{^A request to YouTube API failed} }
 
   describe '#exception' do
-    it { expect{raise Yt::Errors::RequestError}.to raise_error msg }
+    it { expect{error}.to raise_error msg }
+
+    context 'given the exception includes sensitive data' do
+      let(:body) { 'some secret token' }
+      let(:curl) { 'curl -H "Authorization: secret-token"' }
+      let(:params) { {response_body: body, request_curl: curl}.to_json }
+
+      describe 'given a log level of :debug or :devel' do
+        before(:all) { Yt.configuration.log_level = :debug }
+        specify 'exposes sensitive data' do
+          expect{error}.to raise_error do |error|
+            expect(error.message).to include 'secret'
+          end
+        end
+      end
+
+      describe 'given a different log level' do
+        before(:all) { Yt.configuration.log_level = :info }
+        specify 'hides sensitive data' do
+          expect{error}.to raise_error do |error|
+            expect(error.message).not_to include 'secret'
+          end
+        end
+      end
+    end
   end
 end
 

data/spec/requests/as_account/account_spec.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'spec_helper'
 require 'yt/models/account'
 

data/spec/support/global_hooks.rb

@@ -23,12 +23,14 @@ RSpec.configure do |config|
     Yt.configure do |config|
       config.client_id = ENV['YT_TEST_DEVICE_CLIENT_ID']
       config.client_secret = ENV['YT_TEST_DEVICE_CLIENT_SECRET']
+      config.log_level = ENV['YT_LOG_LEVEL']
     end
   end
 
   config.before :all, server_app: true do
     Yt.configure do |config|
       config.api_key = ENV['YT_TEST_SERVER_API_KEY']
+      config.log_level = ENV['YT_LOG_LEVEL']
     end
   end
 
@@ -36,6 +38,7 @@ RSpec.configure do |config|
     Yt.configure do |config|
       config.client_id = ENV['YT_TEST_PARTNER_CLIENT_ID']
       config.client_secret = ENV['YT_TEST_PARTNER_CLIENT_SECRET']
+      config.log_level = ENV['YT_LOG_LEVEL']
     end
     # Create one Youtube Partner channel, authenticated as the content owner
     attrs = {refresh_token: ENV['YT_TEST_CONTENT_OWNER_REFRESH_TOKEN']}

metadata

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