yt 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe40139d2888a20c31bda3e4a1fecd43ddebe6d6
-  data.tar.gz: b4f3a450be5b5ac46206fa3365109ee44f42be16
+  metadata.gz: d001dddb418e4e74f6de7356d350befaaec179d1
+  data.tar.gz: 2356e2a5fa9861028411c6f8b0ca99b94d79f735
 SHA512:
-  metadata.gz: cfeb6a2919c6eec4fdbf5e1b13aba3dd267b02ab1b727a1a236c1bce6848bf3327f3ce93b153413b6553cf0078e2cef0fb049cb5f90478036ba09fc1e6d25510
-  data.tar.gz: 0917d9c6dab13d21710165497bf5f5f03124bfa6ba8394e18e7ba6e7b68a39c8aa7972e0c74be8f1fd51441884f6a4707a0cad9cb285841d4ea2b9252460081a
+  metadata.gz: 4de11d3034cba5ec8702c2c747c8689142f915bb4e8d17d6dc21e65e583359ff5b6bba94f9f2f855229227cc7a6c8ec76a325a2af8ac49edf24e145954850352
+  data.tar.gz: bfcd0d23ea29ed718595bf6e71a9bc6552cc1fa748aa1d1f76dafd73e76c37708b126b83f5539cd716c9740e013f4e67c7f6109c34c0f1f56f151c16402160f2

data/.travis.yml

@@ -6,13 +6,13 @@ matrix:
   - rvm: 1.9.3
     gemfile: gemfiles/Gemfile.activesupport-3.x
     env:
-    - secure: LuOkhCrHJomwu/Y/l/DIJjKn4zLMRDjtTThJxlANeY4w4S5sac5eGHMD1xxPeWLI7HI8ZIzdqcfOIaVpxts0jeHLLsPCErFl9gWxADCOeC1YSn/07vPhi7KxMEjkR1KbXk1coY4KFZqCByRGYi3s2DnH1HSAKks3ZVs12yhdn6A=
+    - secure: MRWnEbchfgv+FLXLDzkc5rqqiZ/fE/9zQVYRUlTtwHYWKRacl45RDzv0ns7avz/tGGyL/3CMQabOvRiErhN5FWoaRdQV3kBl+gAgSvV910dC+gb/dEpTxU8KGRFLBOFG5oT2WF9eTDjUOxNRiR0jEw/+wD/FltxHEuoc5EixdSI=
   - rvm: 2.0.0
     gemfile: gemfiles/Gemfile.activesupport-4.x
     env:
-    - secure: XfoZvb34Vma3tCI5EuV/Pw0V8ISD/QQt9Rda4nTmSRYYSoqjPgrgJhAywnfDTR24ydEpoWJB9jlBq4kk1EywO9jHYoZ/gydzmAoBZ1riDqGvD1muK15gyHLsQu1KMk9jZTtTQ/qpi91rA4qrBWtARfcbhxayTyYjl9zcI8lPmzI=
+    - secure: fxPlgZJcWnJZcsQYfLm5EQI4kt9Ohikwi5YugcU+daT43ZacrK0MWAnPhYBXnwNbfsot1udSFnN8DADxbL6/0DxVGVVuQUB4hT59kh8im58Rfim6uCDbgsPLeCzMrWuE2Mj+SBcwVlJ2i0zWqFv6nz4TCi007E/4BOLjjmTsOSo=
 env:
   global:
-  - secure: KFozlRmcSFzZIl8nXPZ5HIf+MAvgK4I7FYsTYyAMW7LsRJJ4NAJJCHAbWZUfmbqygUN188zj2y0TbQUu47lEf7v2XvJu6DFCYw+e4sk6lSW8V5jRzWl1f6DOKb1z+FBpUgJHj9OKykqjdtm3zVLWr56xm3fhB+ULDj8XVOVxyLk=
-  - secure: e/p7BLWhc8BBiXkxM3zXPj3x/8PqUT0ERRfUFYXAnZRZ0gmACtig590nZY7FLeNhBQMORuHt/ZE5DCuNZRaOIdauQqV4rP46U5CJBWe2RNzDi1L+nctUCSKDwVDIVl/r5yEP22om4g5s1xhWfc8wlJF2VEnfLcq80ca1vK+e1ds=
-  - secure: VpOIZVcckArwpoVs/fppUFEJEOI3e6zv2L5rP/vj0Uxl1hOHgg1emedjzM7x2wxKMi/L2g5ot9Oz6H9N1Y0FXzB1L49Hy3hla2nKBcecgvqk1z5InTpx6eiBDQqJAoZurCCmkdfKjVtWfb0CAdOX9Euio5DxqcnIcIVIiWpD5BE=
+  - secure: QEKPYkbA9ejUZTYz4p8xWMKqZ+2KpiKa2c6eu79ISQcGsp3gRvnvAzEVByVxrr+K7Igtj/jeRUE8xXMDh6d6wCcguNkTy9BVNevlo12qESpM8oP0iEmnQJL0TtYWEvqivJMg/FSXOaRj4kifB1sfTQjJLdTKVMM52r5qR9K60bs=
+  - secure: DznIfIfJN5c0lad7FPf8TVqbMDFFajcDyWPDA55KtlDgpMrjgmLh7z1ZEhQMLvu+HAdvnxx7jEiroeMCT724hXS3ex4MsQnn9fohuM4bsjeqxgxCtdL3urFGBwGx3wMmisY3Jn+5WEQkeqrfMgnUGIyXMp8K1VvjJ6r4GrW6yEk=
+  - secure: NeI3iyIAY3ZKAQ+AGo8+uFxdaMmf9zYkVDJMbHsXZLkHxsF1UAMnFic8EEsktfx+zobykQFarwBFeN7LtEvMjpIHeL0caKas0NiUmvnXjCh7CfK9lqY1rjZSYuNSA8uSR1Bl7GOxBjQD8xtRoUdaYAF8MLPVtEs76l0tSVwHQ6Q=

data/Gemfile.lock

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

data/HISTORY.md

@@ -7,6 +7,7 @@ v0.4 - 2014/05/09
 * Fix parsing annotation and timestamps longer than 1 hour
 * Fix delegating tags from resources to snippets
 * Two options to add videos to a playlist: fail or not if a video is missing
+* Allow to configure Yt credentials through environment variables
 
 v0.3.0 - 2014/04/16
 --------------------

data/README.md

@@ -154,7 +154,7 @@ annotation.has_link_to_playlist? #=> true
 
 *Annotations do not require authentication.*
 
-Registering your app
+Configuring your app
 ====================
 
 In order to use Yt you must register your app in the [Google Developers Console](https://console.developers.google.com).
@@ -164,8 +164,8 @@ Apps that do not require user interactions
 ------------------------------------------
 
 If you are building a read-only app that fetches public data from YouTube, then
-generate a **Public API access** key in the Google Console, then add the following
-snippet of code to the initializer of your app:
+generate a **Public API access** key in the Google Console.
+Next, add the following snippet of code to the initializer of your app:
 
 ```ruby
 Yt.configure do |config|
@@ -265,6 +265,32 @@ account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account
 Scenario 3. If you don’t have the account’s refresh token, then [..TODO..]
 
 
+Configuring your app through environment variables
+==================================================
+
+As an alternative to the approach above, you can configure Yt using environment
+variables. Setting the following environment variables:
+
+```bash
+export YT_CLIENT_SCENARIO="device_app"
+export YT_CLIENT_ID="1234567890.apps.googleusercontent.com"
+export YT_CLIENT_SECRET="1234567890"
+export YT_API_KEY="123456789012345678901234567890"
+```
+
+is equivalent to configuration your app with the initializer:
+
+```ruby
+Yt.configure do |config|
+  config.scenario = :device_app
+  config.client_id = '1234567890.apps.googleusercontent.com'
+  config.client_secret = '1234567890'
+  config.api_key = '123456789012345678901234567890'
+end
+```
+
+so use the approach that you prefer.
+If a variable is set in both places, then `Yt.configure` takes precedence.
 
 
 How to install
@@ -276,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.7'
+    gem 'yt', '~> 0.4.8'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -301,7 +327,70 @@ Google API!
 How to test
 ===========
 
-[ TO DO ]
+Yt comes with two different sets of tests:
+
+1. tests in `spec/models` and `spec/collections` **do not hit** the YouTube API
+1. tests in `spec/associations` **hit** the YouTube API and require authentication
+
+To run all the tests, type:
+
+```bash
+rspec
+```
+
+The reason why some tests actually hit the YouTube API is because they are
+meant to really integrate Yt with YouTube. YouTube API is not exactly
+*the most reliable* API out there, so we need to make sure that the responses
+match the documentation.
+
+You don’t have to run all the tests every time you change code.
+Travis CI is already set up to do this for when whenever you push a branch
+or create a pull request for this project.
+
+Testing models and collections
+------------------------------
+
+To only run tests against models and collections (which do not hit the API), type:
+
+```bash
+rspec spec/models spec/collections
+```
+
+Testing associations
+--------------------
+
+To only run tests against associations (which hit the API), type:
+
+```bash
+rspec spec/associations
+```
+
+This test will fail at first. As documented by the error message, you will need
+an app registered in the [Google Developers Console](https://console.developers.google.com)
+to proceed.
+
+Browse to the Console, then create a new app that you will only use for testing.
+
+Under the "APIs" tab of this app, enable 'Google+ API', 'Youtube Analytics
+API' and 'YouTube Data API v3'.
+
+Under the "Credentials" tab of this app, create a new 'Key for server
+application' and a new 'Client ID' and 'Client Secret' for **native** application.
+
+It’s important that you pick 'native application' instead of 'web application',
+otherwise running your tests will require you to open a browser and launch a
+local webserver… and you don’t need to do any of that.
+
+Finally, copy the given values and set the following environment variables:
+
+```bash
+export YT_TEST_DEVICE_CLIENT_ID="1234567890.apps.googleusercontent.com"
+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. ]
 
 
 How to contribute

data/lib/yt/actions/request.rb

@@ -21,7 +21,7 @@ module Yt
     end
 
     def run
-      add_authorization_to_request!
+      add_authorization_to_request! if requires_authorization?
       fetch_response.tap do |response|
         response.body = parse_format response.body if response.body
         # puts "You can try again running #{to_curl}"
@@ -43,13 +43,19 @@ module Yt
     def add_authorization_to_request!
       if @auth.respond_to? :access_token_for
         @headers['Authorization'] = "Bearer #{@auth.access_token_for @scope}"
-      else # TODO: check if api_key was set in the first place!!
+      elsif Yt.configuration.api_key
         params = URI.decode_www_form @uri.query || ''
         params << [:key, Yt.configuration.api_key]
         @uri.query = URI.encode_www_form params
+      else
+        raise RequestError, missing_credentials
       end
     end
 
+    def requires_authorization?
+      @uri.host == Request.default_params[:host]
+    end
+
     def fetch_response
       Net::HTTP.start(@uri.host, @uri.port, use_ssl: true) do |http|
         klass = "Net::HTTP::#{@method.capitalize}".constantize
@@ -75,6 +81,30 @@ module Yt
       end
     end
 
+    def missing_credentials
+      <<-MSG
+      In order to perform this request, you need to register your app with the
+      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
+
     # def to_curl
     #   %Q{curl -X #{@method.upcase} "#{@uri}"}
     # end

data/lib/yt/models/configuration.rb

@@ -23,7 +23,18 @@ module Yt
     attr_accessor :scenario, :api_key, :client_id, :client_secret, :account
 
     def initialize
-      @scenario = :web_app
+      @scenario = set_scenario ENV['YT_CLIENT_SCENARIO']
+      @client_id = ENV['YT_CLIENT_ID']
+      @client_secret = ENV['YT_CLIENT_SECRET']
+      @api_key = ENV['YT_API_KEY']
+    end
+
+  private
+
+    def set_scenario(value)
+      valid_scenarios = [:web_app, :device_app, :server_app]
+      scenario = valid_scenarios.find{|scenario| scenario.to_s == value}
+      scenario || :web_app
     end
   end
 end

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.4.7'
+  VERSION = '0.4.8'
 end

data/spec/models/configuration_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Yt::Configuration do
+  subject(:config) { Yt::Configuration.new }
+
+  describe '#scenario' do
+    context 'by default' do
+      it {expect(config.scenario).to be :web_app }
+    end
+
+    context 'given an invalid environment variable YT_CLIENT_SCENARIO' do
+      before { ENV['YT_CLIENT_SCENARIO'] = 'not-a-scenario'}
+      it {expect(config.scenario).to be :web_app }
+    end
+
+    context 'given a valid environment variable YT_CLIENT_SCENARIO' do
+      before { ENV['YT_CLIENT_SCENARIO'] = 'device_app'}
+      it {expect(config.scenario).to be :device_app }
+    end
+  end
+
+  describe '#client_id' do
+    context 'by default' do
+      it {expect(config.client_id).to be_nil }
+    end
+
+    context 'given an environment variable YT_CLIENT_ID' do
+      let(:client_id) { '1234567890.apps.googleusercontent.com' }
+      before { ENV['YT_CLIENT_ID'] = client_id}
+      it {expect(config.client_id).to eq client_id }
+    end
+  end
+
+  describe '#client_secret' do
+    context 'by default' do
+      it {expect(config.client_secret).to be_nil }
+    end
+
+    context 'given an environment variable YT_CLIENT_SECRET' do
+      let(:client_secret) { '1234567890' }
+      before { ENV['YT_CLIENT_SECRET'] = client_secret}
+      it {expect(config.client_secret).to eq client_secret }
+    end
+  end
+
+  describe '#api_key' do
+    context 'by default' do
+      it {expect(config.api_key).to be_nil }
+    end
+
+    context 'given an environment variable YT_API_KEY' do
+      let(:api_key) { '123456789012345678901234567890' }
+      before { ENV['YT_API_KEY'] = api_key}
+      it {expect(config.api_key).to eq api_key }
+    end
+  end
+end

data/spec/support/device_app.rb

@@ -6,9 +6,8 @@ RSpec.configure do |config|
     unless Yt.configuration.scenario == :device_app
       Yt.configure do |config|
         config.scenario = :device_app
-        config.client_id = ENV['YT_TEST_APP_DEVICE_CLIENT_ID']
-        config.client_secret = ENV['YT_TEST_APP_DEVICE_CLIENT_SECRET']
-        # Note: makes sure ALL the scopes are authorized in YT_TEST_DEVICE_REFRESH_TOKEN
+        config.client_id = ENV['YT_TEST_DEVICE_CLIENT_ID']
+        config.client_secret = ENV['YT_TEST_DEVICE_CLIENT_SECRET']
         config.account = Yt::Account.new refresh_token: ENV['YT_TEST_DEVICE_REFRESH_TOKEN']
       end
     end

data/spec/support/server_app.rb

@@ -4,7 +4,7 @@ RSpec.configure do |config|
   config.before :all, scenario: :server_app do
     Yt.configure do |config|
       config.scenario = :server_app
-      config.api_key = ENV['YT_TEST_APP_SERVER_API_KEY']
+      config.api_key = ENV['YT_TEST_SERVER_API_KEY']
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -197,6 +197,7 @@ files:
 - spec/collections/videos_spec.rb
 - spec/models/annotation_spec.rb
 - spec/models/channel_spec.rb
+- spec/models/configuration_spec.rb
 - spec/models/description_spec.rb
 - spec/models/details_set_spec.rb
 - spec/models/playlist_item_spec.rb
@@ -268,6 +269,7 @@ test_files:
 - spec/collections/videos_spec.rb
 - spec/models/annotation_spec.rb
 - spec/models/channel_spec.rb
+- spec/models/configuration_spec.rb
 - spec/models/description_spec.rb
 - spec/models/details_set_spec.rb
 - spec/models/playlist_item_spec.rb