youtube_data_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a6e3d0fdb7667728341ea8d7385c736a70c3441
+  data.tar.gz: fe3f599a362401cfe7dddeb5f22eef8dc97f3170
+SHA512:
+  metadata.gz: 66d86d1053fe4205d5f5eee0e38096541f3614b3f185d224d8aa5022b021f51d618ed41e28a1103882b09e21ab21832cdf04575bb214812f4cf70967bb30093f
+  data.tar.gz: 41f9b57dd0d55b4188605c41a6a9e53f72a1be314d23c1a02a7b0d658a2b9bc157ca35e5280ceba62203add54fa07a2fdcdf6024624bf838436c34f14b0b0e09

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.5

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in youtube_data_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MJ Rossetti (@s2t2)
+
+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,103 @@
+# YoutubeDataApi
+
+A ruby library interface to the [YouTube Data API](https://developers.google.com/youtube/v3/docs/). Parses channel, playlist, and video data.
+
+## Installation
+
+```` rb
+gem install youtube_data_api
+````
+
+Or install with bundler
+ by adding `gem youtube_data_api, '~> 3.0'` to your application's Gemfile
+ before performing a `bundle install`.
+
+## Usage
+
+Parse Youtube data.
+
+```` rb
+
+# CHANNELS
+
+channel_url = "https://www.youtube.com/user/CSPAN"
+YoutubeDataApi.channel(channel_url)
+YoutubeDataApi.channel_playlists(channel_url)
+
+# PLAYLISTS
+
+playlist_url = "https://www.youtube.com/playlist?list=PLf0o4wbW8SXqTSo6iJkolKCKJYBnpo9NZ"
+YoutubeDataApi.playlist(playlist_url)
+YoutubeDataApi.playlist_items(playlist_url)
+
+# VIDEOS
+
+video_url = "https://www.youtube.com/watch?v=oBM7DIeMsP0"
+YoutubeDataApi.video(video_url)
+````
+
+### Prerequisites
+
+#### YouTube-API-enabled Application
+
+Create a new application in the [google developer console](https://console.developers.google.com), and note its name. Navigate to the **APIs & Auth > APIs** menu and enable the *YouTube Data API v3* by searching for it. Refer to the
+ [YouTube API Application Registration Guide](https://developers.google.com/youtube/registering_an_application)
+for more support.
+
+#### Youtube API Key
+
+Navigate to the **APIs & Auth > Credentials** menu and add credentials for an API Key, specifically, a **Server Key**. Note the value of your API Key. Refer to the [YouTube API Key Generation Guide](https://developers.google.com/youtube/registering_an_application#Create_API_Keys)
+for more support.
+
+### Configuration
+
+Configure the library
+ to make requests on behalf of your YouTube API Key
+ by
+   assigning it to an environment variable or
+   passing it as a request parameter.
+
+#### Environment Variable
+
+If using the environment variable configuration approach,
+ add a variable called `YOUTUBE_DATA_API_KEY` to your **.bash_profile**:
+
+```` sh
+export YOUTUBE_DATA_API_KEY="my-key-123"
+````
+
+#### Request Parameter
+
+If using the request parameter configuration approach, pass the `:api_key` parameter to any request:
+
+```` rb
+channel_url = "https://www.youtube.com/user/CSPAN"
+options = {:api_key => "my-key-123"}
+YoutubeDataApi.channel(channel_url, options)
+````
+
+## Contributing
+
+Browse existing [issues](https://github.com/debate-watch/youtube-data-api-ruby/issues) or create a new issue to communicate bugs, desired features, etc.
+ After forking the repo and pushing your changes, create a pull request referencing the applicable issue(s).
+
+### Developing
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+### Testing
+
+Run `rake rspec` or `bundle exec rspec spec/` to run the tests.
+ Optionally run `bin/console` for an interactive prompt that will allow you to experiment.
+
+NOTE: tests expect you to specify your YouTube API Key using the [environment variable configuration approach](#environment-variable).
+
+### Releasing
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+When bumping the gem version,
+ please keep the major version number in sync with
+ the YouTube API version (currently **v3**).
+
+## [License](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "youtube_data_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/youtube_data_api.rb

@@ -0,0 +1,212 @@
+require 'google/api_client'
+
+require "youtube_data_api/version"
+
+# todo: refactor!
+
+module YoutubeDataApi
+
+  def self.initialize_service(options)
+    client = Google::APIClient.new(
+      :key => options[:api_key] || ENV['YOUTUBE_DATA_API_KEY'] || "my-key-123",
+      :application_name => options[:app_name] || "my-app",
+      :application_version => options[:app_version] || "0.0.1"
+    )
+    client.authorization = nil
+    youtube_api = client.discovered_api('youtube', 'v3')
+    return client, youtube_api
+  end
+
+  #
+  # CHANNELS
+  #
+
+  CHANNEL_URL_PREFIX = "https://www.youtube.com/channel/"
+  USER_URL_PREFIX = "https://www.youtube.com/user/"
+  CHANNEL_PARTS = "id, contentDetails, contentOwnerDetails, snippet, statistics"
+
+  def self.channel_request_params(channel_url, options)
+    request_params = {
+      :part => options[:request_parts] || CHANNEL_PARTS,
+      :pageToken => options[:page_token]
+    }
+    if channel_url.include?(CHANNEL_URL_PREFIX)
+      request_params.merge!({:id => channel_url.gsub(CHANNEL_URL_PREFIX,'')})
+    elsif channel_url.include?(USER_URL_PREFIX)
+      request_params.merge!({:forUsername => channel_url.gsub(USER_URL_PREFIX,'')})
+    else
+      raise ChannelUrlError.new("could not recognize the channel_url #{channel_url}. try a url that contains either #{CHANNEL_URL_PREFIX} or #{USER_URL_PREFIX} ...")
+    end
+    return request_params
+  end
+
+  class ChannelUrlError ; end
+
+  # Get channel (user).
+  #
+  # @param [String] channel_url "https://www.youtube.com/user/CSPAN" The url representing a specific youtube channel or user.
+  # @param [Hash] options
+  # @param [Hash] options [String] api_key
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] app_version
+  # @param [Hash] options [String] request_parts A comma separated string of response parts which you would like to request. Limit api usage by only requesting the parts you need.
+  # @param [Hash] options [String] page_token
+  #
+  # @example YoutubeDataApi.channel("https://www.youtube.com/user/CSPAN")
+  #
+  def self.channel(channel_url, options = {})
+    client, youtube_api = self.initialize_service(options)
+    response = client.execute(
+      :api_method => youtube_api.channels.list,
+      :parameters => self.channel_request_params(channel_url, options)
+    )
+    result = JSON.parse(response.data.to_json)
+  end
+
+  PLAYLIST_PARTS = "id, contentDetails, player, snippet, status"
+
+  def self.channel_id(channel_url)
+    channel_response = self.channel(channel_url)
+    channel_response["items"].first["id"]
+  end
+
+  def self.channel_playlists_request_params(channel_url, options)
+    {
+      :part => options[:request_parts] || PLAYLIST_PARTS,
+      :pageToken => options[:page_token],
+      :channelId => self.channel_id(channel_url) #todo: obviate this call if channel_id param is present...
+    }
+  end
+
+  # List channel playlists.
+  #
+  # @param [String] channel_url "https://www.youtube.com/user/CSPAN" The url representing a specific youtube channel or user.
+  # @param [Hash] options
+  # @param [Hash] options [String] api_key
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] app_version
+  # @param [Hash] options [String] request_parts A comma separated string of response parts which you would like to request. Limit api usage by only requesting the parts you need.
+  # @param [Hash] options [String] page_token
+  #
+  # @example YoutubeDataApi.channel_playlists("https://www.youtube.com/user/CSPAN")
+  #
+  def self.channel_playlists(channel_url, options = {})
+    client, youtube_api = self.initialize_service(options)
+    response = client.execute(
+      :api_method => youtube_api.playlists.list,
+      :parameters => self.channel_playlists_request_params(channel_url, options)
+    )
+    result = JSON.parse(response.data.to_json)
+  end
+
+  #
+  # PLAYLISTS
+  #
+
+  PLAYLIST_URL_PREFIX = "https://www.youtube.com/playlist?list="
+
+  def self.playlist_id(playlist_url)
+    playlist_url.gsub(PLAYLIST_URL_PREFIX,'')
+  end
+
+  def self.playlist_request_params(playlist_url, options)
+    {
+      :part => options[:part] || PLAYLIST_PARTS,
+      :pageToken => options[:page_token],
+      :id => self.playlist_id(playlist_url) #todo: obviate this call if playlist_id param is present...,
+    }
+  end
+
+  # Get playlist.
+  #
+  # @param [String] playlist_url "https://www.youtube.com/playlist?list=PLf0o4wbW8SXqTSo6iJkolKCKJYBnpo9NZ" The url representing a specific youtube playlist.
+  # @param [Hash] options
+  # @param [Hash] options [String] api_key
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] app_version
+  # @param [Hash] options [String] request_parts A comma separated string of response parts which you would like to request. Limit api usage by only requesting the parts you need.
+  # @param [Hash] options [String] page_token
+  #
+  # @example YoutubeDataApi.playlist("https://www.youtube.com/playlist?list=PLf0o4wbW8SXqTSo6iJkolKCKJYBnpo9NZ")
+  #
+  def self.playlist(playlist_url, options = {})
+    client, youtube_api = self.initialize_service(options)
+    response = client.execute(
+      :api_method => youtube_api.playlists.list,
+      :parameters => self.playlist_request_params(playlist_url, options)
+    )
+    result = JSON.parse(response.data.to_json)
+  end
+
+  PLAYLIST_ITEM_PARTS = "id, contentDetails, snippet, status"
+
+  def self.playlist_items_request_params(playlist_url, options)
+    {
+      :part => options[:part] || PLAYLIST_ITEM_PARTS,
+      :pageToken => options[:page_token],
+      :playlistId => self.playlist_id(playlist_url) #todo: obviate this call if playlist_id param is present...,
+    }
+  end
+
+  # List playlist items (videos).
+  #
+  # @param [String] playlist_url "https://www.youtube.com/playlist?list=PLf0o4wbW8SXqTSo6iJkolKCKJYBnpo9NZ" The url representing a specific youtube playlist.
+  # @param [Hash] options
+  # @param [Hash] options [String] api_key
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] app_version
+  # @param [Hash] options [String] request_parts A comma separated string of response parts which you would like to request. Limit api usage by only requesting the parts you need.
+  # @param [Hash] options [String] page_token
+  #
+  # @example YoutubeDataApi.playlist_items("https://www.youtube.com/playlist?list=PLf0o4wbW8SXqTSo6iJkolKCKJYBnpo9NZ")
+  #
+  def self.playlist_items(playlist_url, options = {})
+    client, youtube_api = self.initialize_service(options)
+    response = client.execute(
+      :api_method => youtube_api.playlist_items.list,
+      :parameters => self.playlist_items_request_params(playlist_url, options)
+    )
+    result = JSON.parse(response.data.to_json)
+  end
+
+  #
+  # VIDEOS
+  #
+
+  VIDEO_URL_PREFIX = "https://www.youtube.com/watch?v="
+  VIDEO_PARTS = "id, contentDetails, liveStreamingDetails, player, recordingDetails, snippet, statistics, status, topicDetails"
+  #VIDEO_PRIVATE_PARTS = "fileDetails, processingDetails, suggestions" # :-) can't request these unless authenticated
+
+  def self.video_id(video_url)
+    video_url.gsub(VIDEO_URL_PREFIX,'')
+  end
+
+  def self.video_request_params(video_url, options)
+    {
+      :part => options[:part] || VIDEO_PARTS,
+      :pageToken => options[:page_token],
+      :id => self.video_id(video_url) #todo: obviate this call if video_id param is present...,
+    }
+  end
+
+  # Get video.
+  #
+  # @param [String] video_url "https://www.youtube.com/watch?v=oBM7DIeMsP0" The url representing a specific youtube video.
+  # @param [Hash] options
+  # @param [Hash] options [String] api_key
+  # @param [Hash] options [String] app_name
+  # @param [Hash] options [String] app_version
+  # @param [Hash] options [String] request_parts A comma separated string of response parts which you would like to request. Limit api usage by only requesting the parts you need.
+  # @param [Hash] options [String] page_token
+  #
+  # @example YoutubeDataApi.video("https://www.youtube.com/watch?v=oBM7DIeMsP0")
+  #
+  def self.video(video_url, options = {})
+    client, youtube_api = self.initialize_service(options)
+    response = client.execute(
+      :api_method => youtube_api.videos.list,
+      :parameters => self.video_request_params(video_url, options)
+    )
+    result = JSON.parse(response.data.to_json)
+  end
+end

data/lib/youtube_data_api/version.rb

@@ -0,0 +1,3 @@
+module YoutubeDataApi
+  VERSION = "0.1.0"
+end

data/youtube_data_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'youtube_data_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "youtube_data_api"
+  spec.version       = YoutubeDataApi::VERSION
+  spec.authors       = ["MJ Rossetti (@s2t2)"]
+  spec.email         = ["s2t2mail+git@gmail.com"]
+
+  spec.summary       = %q{A ruby library interface to the YouTube Data API.}
+  spec.description   = %q{A ruby library interface to the YouTube Data API. Parses channel, playlist, and video data.}
+  spec.homepage      = "https://github.com/debate-watch/youtube-data-api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "github-markup"
+  spec.add_dependency "google-api-client"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: youtube_data_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MJ Rossetti (@s2t2)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library interface to the YouTube Data API. Parses channel, playlist,
+  and video data.
+email:
+- s2t2mail+git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/youtube_data_api.rb
+- lib/youtube_data_api/version.rb
+- youtube_data_api.gemspec
+homepage: https://github.com/debate-watch/youtube-data-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby library interface to the YouTube Data API.
+test_files: []
+has_rdoc: