yt 0.0.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36146da0ad2ff44d4eb98e9d50cbcdfd0a607b88
-  data.tar.gz: b8f821d810f1d979e33d7f2945862b2f7b88b0b0
+  metadata.gz: 267ed97d1f7857b28aa9577a8e5b06f30beb6d49
+  data.tar.gz: 7ebaddc635450434a4087c1bff77c25b5721c1ae
 SHA512:
-  metadata.gz: b321488f8ad80489cf8b32af60e1e2e8fa10da37cb2b62a9e8a7bdbdd1ca3cbe9922f0850e57f07cb1ea67bb7fbd21075cb2befeccaf25ec87771b3a95338b1e
-  data.tar.gz: d50ba00dca5c3007b2d7b691105325c161db30089bd9020338cb0a6b5f1ca9c44c5fd036037ba35b0bfc9ada7f30f4efe91daf02ec9e7f4fbd95f09f98425908
+  metadata.gz: d5e4615ed9ec50327686a37c2a4f1c8b4cd1646666e841d0d2e1ebaf0aece040fe2da04793642a010d0293996e2c960cd284711e214a76f1d912b2ac8fdd22a4
+  data.tar.gz: d7694945db65f5cf0a5287473c1a18184cdec831fca1714bba6b286fef841acf766134108fb7cc724ad4170d696d82eaf3fa184d0a802aec50c25cf79774163f

data/.gitignore

@@ -0,0 +1,24 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+coverage/
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+**/tmp
+*.gem
+*.sqlite3
+
+doc/
+.yardoc/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 2.0.0
+notifications:
+  email: false
+env:
+  global:
+    secure: FC19i/qIjqV7dzd8bZS+yc5HC3XbssU/lBn7+pNsfhsXZp2FpZ4u3v2HPCRZPZ7IsCpsLtUraq6rub290dXecEr1gzSwmaMdfvJz8f2lr1YR58BF9xnTwBUinZOcv9auhWHwCzYRQMHyILUa2NvmVqq0QzYbWVa9X1gwejqyoaQ=
+  matrix:
+    secure: EX0FinqK+va3hTUWNVk7HeFIZqwC0OFlmvW7GX+vJ//vs1Bvsqxqbo1bdqwieMVYxcRwt9cOZU8QapPPc4+v7Awo7ASCgNUo4Y7yrIkjfQdY6b2UyPo6yJw7+Mcyj9gej5hD0mBm+E/KCvvirVfDXfWedPy3Z1FovK1sVW9RqPs=

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Add 'binding.pry'_remote to debug your code, then use 'next', 'continue', ...
+gem 'pry', require: 'pry'
+gem 'pry-nav'
+gem 'pry-remote'
+
+# Specify your gem's dependencies in yt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    yt (0.4.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    method_source (0.8.2)
+    mime-types (2.2)
+    minitest (5.3.3)
+    multi_json (1.9.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.3.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tins (1.1.0)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coveralls
+  pry
+  pry-nav
+  pry-remote
+  rake
+  rspec
+  yard
+  yt!

data/HISTORY.md

@@ -0,0 +1,37 @@
+v0.4.0 - 2014/05/09
+--------------------
+
+* Complete rewrite, using ActiveSupport and separating models and collections
+* New methods to handle annotations, details sets
+
+v0.3.0 - 2014/04/16
+--------------------
+
+* New and improved methods to handle subscriptions, playlists, playlist items
+* `find_or_create_playlist_by` does not yield a block anymore
+* `account.subscribe_to!` raises error in case of duplicate subscription, but `account.subscribe_to` does not
+
+v0.2.1 - 2014/04/10
+--------------------
+
+* `account.subscribe_to!` does not raise error in case of duplicate subscription
+* Accountable objects can be initialized with the OAuth access token if there's no need to get a fresh one with a refresh token
+
+v0.2.0 - 2014/04/09
+--------------------
+
+* Replaced `account.perform!` with `account.like!`, `account.subscribe_to!`
+* Added `account.add_to!` to add a video to an account’s playlist
+* Added `account.find_or_create_playlist_by` to find or create an account’s playlist
+
+v0.1.1 - 2014/04/09
+--------------------
+
+* Added support for Ruby 2.0.0
+
+v0.1.0  - 2014/04/08
+--------------------
+
+* Support for authenticated resources: Youtube accounts and Google accounts
+* Support for public Youtube resources: channels and videos
+* Available actions for authenticated Youtube accounts: like a video, subscribe to a channel

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Fullscreen, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,325 @@
+Yt
+==
+
+Yt helps you write apps that need to interact with the YouTube API V3.
+
+[![Gem Version](https://badge.fury.io/rb/yt.svg)](http://badge.fury.io/rb/yt)
+[![Dependency Status](https://gemnasium.com/fullscreeninc/yt.png)](https://gemnasium.com/fullscreeninc/yt)
+[![Build Status](https://travis-ci.org/fullscreeninc/yt.png?branch=master)](https://travis-ci.org/fullscreeninc/yt)
+[![Coverage Status](https://coveralls.io/repos/fullscreeninc/yt/badge.png)](https://coveralls.io/r/fullscreeninc/yt)
+[![Code Climate](https://codeclimate.com/github/fullscreeninc/yt.png)](https://codeclimate.com/github/fullscreeninc/yt)
+
+After [registering your app], you can run commands like:
+
+```ruby
+channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
+channel.title #=> "Fullscreen"
+channel.description #=> "The first media company for the connected generation."
+channel.videos.count #=> 12
+```
+
+```ruby
+video = Yt::Video.new id: 'MESycYJytkU'
+video.title #=> "Fullscreen Creator Platform"
+video.duration #=> 86
+video.annotations.count #=> 1
+```
+
+The **full documentation** is available at [rubydoc.info](http://rubydoc.info/github/fullscreeninc/yt/master/frames).
+
+Available resources
+===================
+
+Yt::Account
+-----------
+
+Use [Yt::Account](link to doc) to:
+
+* authenticate as a YouTube account
+* read attributes of the account
+* access the YouTube channel of the account
+
+```ruby
+account = Yt::Account.new
+
+# An OAuth2 prompt will appear before the following commands
+account.email #=> .. your e-mail address..
+account.channel #=> #<Yt::Channel @id=...>
+```
+
+*All the above methods require authentication (see below).*
+
+Yt::Channel
+-----------
+
+Use [Yt::Channel](link to doc) to:
+
+* read attributes of a channel
+* access the videos of a channel
+* access the playlists of a channel
+* subscribe to and unsubscribe from a channel
+* create and delete playlists from a channel
+
+```ruby
+channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
+channel.title #=> "Fullscreen"
+channel.description.has_link_to_playlist? #=> false
+
+channel.videos.count #=> 12
+channel.videos.first #=> #<Yt::Video @id=...>
+
+channel.playlists.count #=> 2
+channel.playlists.first #=> #<Yt::Playlist @id=...>
+
+# An OAuth2 prompt will appear before the following commands
+channel.subscribed? #=> false
+channel.subscribe #=> true
+
+channel.create_playlist title: 'New playlist' #=> true
+channel.delete_playlists title: 'New playlist' #=> [true]
+
+```
+
+*Subscribing to and unsubscribing from a channel requires authentication (see below).*
+
+Yt::Video
+-----------
+
+Use [Yt::Video](link to doc) to:
+
+* read attributes of a video
+* access the annotations of a video
+* like and dislike a video
+
+```ruby
+video = Yt::Video.new id: 'MESycYJytkU'
+video.title #=> "Fullscreen Creator Platform"
+video.duration #=> 63
+video.description.has_link_to_subscribe? #=> false
+
+video.annotations.count #=> 1
+video.annotations.first #=> #<Yt::Annotation @id=...>
+
+# An OAuth2 prompt will appear before the following commands
+video.liked? #=> false
+video.like #=> true
+```
+
+*Liking and disliking a video requires authentication (see below).*
+
+Yt::Playlist
+------------
+
+Use [Yt::Playlist](link to doc) to:
+
+* read attributes of a playlist
+* access the items of a playlist
+* add one or multiple videos to a playlist
+* delete items from a playlist
+
+```ruby
+playlist = Yt::Playlist.new id: 'PLSWYkYzOrPMRCK6j0UgryI8E0NHhoVdRc'
+playlist.title #=> "Fullscreen Features"
+playlist.public? #=> true
+
+playlist.playlist_items.count #=> 1
+playlist.playlist_items.first #=> #<Yt::PlaylistItem @id=...>
+playlist.playlist_items.first.position #=> 0
+playlist.playlist_items.first.video.title #=> "Fullscreen Creator Platform"
+playlist.delete_playlist_items title: 'Fullscreen Creator Platform' #=> [true]
+
+# An OAuth2 prompt will appear before the following commands
+playlist.add_video 'MESycYJytkU'
+playlist.add_videos ['MESycYJytkU', 'MESycYJytkU']
+```
+
+*Adding videos requires authentication (see below).*
+
+
+Yt::Annotation
+--------------
+
+Use [Yt::Annotation](link to doc) to:
+
+* read attributes of an annotation
+
+```ruby
+video = Yt::Video.new id: 'MESycYJytkU'
+annotation = video.annotations.first
+
+annotation.below? 70 #=> false
+annotation.has_link_to_subscribe? #=> false
+annotation.has_link_to_playlist? #=> true
+```
+
+*Annotations do not require authentication.*
+
+Registering your app
+====================
+
+In order to use Yt you must register your app in the [Google Developers Console](https://console.developers.google.com).
+Depending on the nature of your app, you should pick one of the following strategies.
+
+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:
+
+```ruby
+Yt.configure do |config|
+  config.scenario = :server_app
+  config.api_key = '123456789012345678901234567890'
+end
+```
+
+replacing the value above with your own key for server application.
+
+Remember: this kind of app is not allowed to perform any destructive operation,
+so you won’t be able to like a video, subscribe to a channel or delete a
+playlist from a specific account. You will only be able to retrieve read-only
+data.
+
+Web apps that do require user interactions
+------------------------------------------
+
+If you are building a web app that manages YouTube accounts, you need the
+owner of each account to authorize your app. There are three scenarios:
+
+Scenario 1. If you already have the account’s **access token**, then you are ready to go.
+Just pass that access token to the account initializer, such as:
+
+```ruby
+account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
+account.email #=> (retrieves the account’s e-mail address)
+account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
+```
+
+Scenario 2. If you don’t have the account’s access token, but you have the
+**refresh token**, then it’s almost as easy.
+Open the [Google Developers Console](https://console.developers.google.com),
+find the client ID and client secret of the **web application** that you used to obtain the
+refresh token, then add the following snippet of code to the initializer of your app:
+
+```ruby
+Yt.configure do |config|
+  config.client_id = '1234567890.apps.googleusercontent.com
+  config.client_secret = '1234567890'
+end
+```
+
+replacing the values above with the client ID and secret for web application.
+Then you can manage a YouTube account by passing the refresh token to the
+account initializer, such as:
+
+```ruby
+account = Yt::Account.new refresh_token: '1/1234567890'
+account.email #=> (retrieves the account’s e-mail address)
+account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
+```
+
+Scenario 3. If you don’t have the account’s refresh token, then [..TODO..]
+
+
+Device apps that do require user interactions
+---------------------------------------------
+
+These apps are equivalent to web apps. The only difference is the interface
+that Google uses to ask people to authenticate.
+
+
+Scenario 1. If you already have the account’s **access token**, then you are ready to go.
+Just pass that access token to the account initializer, such as:
+
+```ruby
+account = Yt::Account.new access_token: 'ya29.1.ABCDEFGHIJ'
+account.email #=> (retrieves the account’s e-mail address)
+account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
+```
+
+Scenario 2. If you don’t have the account’s access token, but you have the
+**refresh token**, then it’s almost as easy.
+Open the [Google Developers Console](https://console.developers.google.com),
+find the client ID and client secret of the **native application** that you used to obtain the
+refresh token, then add the following snippet of code to the initializer of your app:
+
+```ruby
+Yt.configure do |config|
+  config.scenario = :device_app
+  config.client_id = '1234567890.apps.googleusercontent.com
+  config.client_secret = '1234567890'
+end
+```
+
+replacing the values above with the client ID and secret for web application.
+Then you can manage a YouTube account by passing the refresh token to the
+account initializer, such as:
+
+```ruby
+account = Yt::Account.new refresh_token: '1/1234567890'
+account.email #=> (retrieves the account’s e-mail address)
+account.playlists.first.add_video 'MESycYJytkU' #=> (adds a video to an account’s playlist)
+```
+
+Scenario 3. If you don’t have the account’s refresh token, then [..TODO..]
+
+
+
+
+How to install
+==============
+
+To install on your system, run
+
+    gem install yt
+
+To use inside a bundled Ruby project, add this line to the Gemfile:
+
+    gem 'yt', '~> 0.4.0'
+
+Since the gem follows [Semantic Versioning](http://semver.org),
+indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
+guarantees that your project won’t occur in any error when you `bundle update`
+and a new version of Yt is released.
+
+Why you should use Yt…
+-----------------------
+
+… and not [youtube_it](https://github.com/kylejginavan/youtube_it)?
+Because youtube_it does not support Google API V3 and the previous version
+has already been deprecated by Google and will soon be dropped.
+
+… and not [Google Api Client](https://github.com/google/google-api-ruby-client)?
+Because Google Api Client is poorly coded, poorly documented and adds many
+dependencies, bloating the size of your project.
+
+… and not your own code? Because Yt is fully tested, well documented,
+has few dependencies and helps you forget about the burden of dealing with
+Google API!
+
+How to test
+===========
+
+[ TO DO ]
+
+
+How to contribute
+=================
+
+Before you submit a pull request, make sure all the tests are passing and the
+code is fully test-covered.
+
+To release an updated version of the gem to Rubygems, run:
+
+    rake release
+
+Remember to *bump the version* before running the command, and to document
+your changes in HISTORY.md and README.md if required.
+
+The yt gem follows [Semantic Versioning](http://semver.org).
+Any new release that is fully backward-compatible should bump the *patch* version (0.0.x).
+Any new version that breaks compatibility should bump the *minor* version (0.x.0)
+
+Don’t hesitate to send code comments, issues or pull requests through GitHub!
+All feedback is appreciated. A [googol](http://en.wikipedia.org/wiki/Googol) of thanks! :)