videodrome 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Linking Paths
+
+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,74 @@
+# Videodrome
+
+Access metadata of **public videos** on Youtube using YouTube Data API v3. Please see the documentation for this API at https://developers.google.com/youtube/v3/.
+
+Videodrome is designed to be minimal on its features and dependencies and to work with all Ruby versions (>= 1.8.6). Videodrome can only access public information since it **does not provides** any authentication method to access to [private user data](https://developers.google.com/youtube/v3/guides/authentication). 
+
+If you want a fully featured YouTube API client please check the excelent [yt](https://github.com/Fullscreen/yt) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'videodrome'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install videodrome
+
+## Setup
+
+Although Videodrome does not require any user authentication, the new Youtube API requires to sign all calls with an API key, even if you are accessing only public data. Please follow the steps at [Obtaining authorization credentials](https://developers.google.com/youtube/registering_an_application) to generate a server key. 
+
+Once you have the API key, the easiest to provide it to Videodrome is to set it up in your environment:
+
+``` sh
+VIDEODROME_YOUTUBE_API_KEY="AIzaS…wGhuD"
+```
+
+## Usage
+
+Once the API Key is available to Videodrome, retrieve the metadata of a video using its URL:
+
+``` ruby
+video = Videodrome::Video.new("https://youtube.com/watch?v=NZ8RiLLt6yg")
+video.title # "The Mercedes-Benz CLA (a car commercial)"
+video.published_at # Thu Sep 05 21:01:57 UTC 2013
+video.thumbnail["url"] # "https://i.ytimg.com/vi/NZ8RiLLt6yg/sddefault.jpg"
+video.embed_html # <iframe type='text/html' src='http://www.youtube.com/embed/NZ8RiLLt6yg' … />
+```
+
+URL short versions are also supported:
+
+``` ruby
+Videodrome::Video.new("https://youtu.be/NZ8RiLLt6yg")
+```
+
+Customize the API call by proving an option hash to the initialization. For details on the parameters you can use please check [the Videos:list documentation](https://developers.google.com/youtube/v3/docs/videos/list#part).
+
+``` ruby
+Videodrome::Video.new("https://youtu.be/NZ8RiLLt6yg", :part => "snippet,player,contentDetails,status,fileDetails")
+```
+
+This customization can be used too to explictly provide the API key to sign the calls:
+
+``` ruby
+Videodrome::Video.new("https://youtu.be/NZ8RiLLt6yg", :key => "AIzaS…wGhuD")
+```
+
+
+## To-do
+
+Provide mocks to prevent real requests to the Youtube API when running the specs.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/videodrome/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "videodrome"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/videodrome/connection.rb

@@ -0,0 +1,31 @@
+module Videodrome
+  # Connection class to make the requests to Youtube API.
+  class Connection
+    API_SERVER  = "https://www.googleapis.com"
+    API_SERVICE = "youtube"
+    API_VERSION = "v3"
+
+    def get(params = {})
+      defaults = {
+        :part => "snippet,player,contentDetails,status"
+      }
+      defaults[:key] = ENV["VIDEODROME_YOUTUBE_API_KEY"] if ENV["VIDEODROME_YOUTUBE_API_KEY"]
+      response = connection.get(search_path, defaults.merge(params))
+      JSON.parse(response.body)
+    end
+
+    protected
+
+    def connection
+      @connection ||= Faraday.new(:url => API_SERVER) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger if ENV["VIDEODROME_DEBUG"]
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def search_path
+      "/#{API_SERVICE}/#{API_VERSION}/videos"
+    end
+  end
+end

data/lib/videodrome/errors/invalid_url.rb

@@ -0,0 +1,10 @@
+module Videodrome
+  module Errors
+    # :nodoc
+    class InvalidURL < StandardError
+      def message
+        "The URL provided is not a valid Youtube Video URL."
+      end
+    end
+  end
+end

data/lib/videodrome/errors/request_error.rb

@@ -0,0 +1,7 @@
+module Videodrome
+  module Errors
+    # :nodoc
+    class RequestError < StandardError
+    end
+  end
+end

data/lib/videodrome/url.rb

@@ -0,0 +1,30 @@
+module Videodrome
+  # ID extraction utility class for Youtube video URLs
+  class URL
+    def initialize(url)
+      @url = url
+      match_url(url)
+    end
+
+    def id
+      @match_data[1]
+    end
+
+    protected
+
+    def match_url(url)
+      found = patterns.find do |pattern|
+        @match_data = url.match(pattern)
+      end
+      raise Videodrome::Errors::InvalidURL unless found
+    end
+
+    def patterns
+      prefix = "^(?:https?://)?(?:www\.)?"
+      suffix = "(?:|/)"
+      video_id = "([a-zA-Z0-9_-]+)"
+      domains = ["youtube\\.com/watch\\?v=#{video_id}", "youtu\\.be/#{video_id}"]
+      domains.map { |domain| %r{#{prefix}#{domain}#{suffix}} }
+    end
+  end
+end

data/lib/videodrome/version.rb

@@ -0,0 +1,3 @@
+module Videodrome
+  VERSION = "0.0.1"
+end

data/lib/videodrome/video.rb

@@ -0,0 +1,59 @@
+require "ostruct"
+require "time"
+
+module Videodrome
+  # Video wrapper for Youtube info
+  class Video
+    attr_reader :id, :raw_data, :snippet, :details, :player, :status
+
+    def initialize(url, options = {})
+      @url = URL.new(url)
+      @id = @url.id
+      @raw_data = Videodrome.connection.get(options.merge(:id => @id))
+      parse_raw_data
+    end
+
+    def published_at
+      Time.iso8601(snippet.publishedAt)
+    end
+
+    def title
+      snippet.title
+    end
+
+    def description
+      snippet.description
+    end
+
+    def thumbnails
+      snippet.thumbnails
+    end
+
+    def thumbnail(size = "standard")
+      thumbnails.find { |k, _| k == size }[1]
+    end
+
+    def embed_html
+      player.embedHtml if embeddable
+    end
+
+    def duration
+      details.duration
+    end
+
+    def embeddable
+      status.embeddable
+    end
+
+    protected
+
+    def parse_raw_data
+      raise Videodrome::Errors::RequestError, @raw_data["error"]["message"] if @raw_data["error"]
+      item = @raw_data["items"][0]
+      @snippet = OpenStruct.new(item["snippet"])
+      @details = OpenStruct.new(item["contentDetails"])
+      @player = OpenStruct.new(item["player"])
+      @status = OpenStruct.new(item["status"])
+    end
+  end
+end

data/lib/videodrome.rb

@@ -0,0 +1,16 @@
+require "videodrome/version"
+require "videodrome/errors/invalid_url"
+require "videodrome/errors/request_error"
+require "videodrome/connection"
+require "videodrome/video"
+require "videodrome/url"
+
+require "faraday"
+require "json"
+
+# nodoc
+module Videodrome
+  def self.connection
+    @connection ||= Videodrome::Connection.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "videodrome"

data/spec/url_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Videodrome::URL do
+  context "given an valid video URL" do
+    subject(:parser) { Videodrome::URL.new(url) }
+    describe "parsing a long video URL" do
+      let(:url) { "https://youtube.com/watch?v=NZ8RiLLt6yg" }
+      it { expect(parser.id).to eq "NZ8RiLLt6yg" }
+    end
+
+    context "parsing a short video URL" do
+      let(:url) { "https://youtu.be/NZ8RiLLt6yg" }
+      it { expect(parser.id).to eq "NZ8RiLLt6yg" }
+    end
+
+    context "parsing a URL with a trailing slash" do
+      let(:url) { "https://youtube.com/watch?v=NZ8RiLLt6yg" }
+      it { expect(parser.id).to eq "NZ8RiLLt6yg" }
+    end
+  end
+
+  #context "given an invalid video URL" do
+  #  #subject(:parser) { Videodrome::URL.new(url) }
+  #  let(:url) { "https://vimeo.com" }
+  #  #it { expect(Videodrome::URL.new("")).to raise_error Videodrome::Errors::InvalidURL }
+  #  it { expect(Videodrome::URL.new("")).to raise_error }
+  #end
+end

data/spec/video_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+
+describe Videodrome::Video do
+  subject(:video) { Videodrome::Video.new(url) }
+
+  context "given a valid URL" do
+    let(:url) { "https://youtube.com/watch?v=NZ8RiLLt6yg" }
+    let(:attrs) do
+      {
+        :published_at => Time.iso8601("2013-09-05T21:01:57.000Z"),
+        :title => "The Mercedes-Benz CLA (a car commercial)",
+        :thumbnails => {
+          "default" => { "url" => "https://i.ytimg.com/vi/NZ8RiLLt6yg/default.jpg", "width" => 120, "height" => 90 },
+          "medium" => { "url" => "https://i.ytimg.com/vi/NZ8RiLLt6yg/mqdefault.jpg", "width" => 320, "height" => 180 },
+          "high" => { "url" => "https://i.ytimg.com/vi/NZ8RiLLt6yg/hqdefault.jpg", "width" => 480, "height" => 360 },
+          "standard" => { "url" => "https://i.ytimg.com/vi/NZ8RiLLt6yg/sddefault.jpg", "width" => 640, "height" => 480 }
+        },
+        :embeddable => true,
+        :embed_html => "<iframe type='text/hftml' src='http://www.youtube.com/embed/NZ8RiLLt6yg' width='640' height='360' frameborder='0' allowfullscreen='true'/>"
+      }
+    end
+    describe "#published_at" do
+      it { expect(video.published_at).to eq attrs[:published_at] }
+    end
+    describe "#title" do
+      it { expect(video.title).to eq attrs[:title] }
+    end
+    describe "#thumbnails" do
+      it("returns multiple thumbnails") { expect(video.thumbnails.size).to eq attrs[:thumbnails].size }
+    end
+    describe "#thumbnail" do
+      it { expect(video.thumbnail["width"]).to eq attrs[:thumbnails]["standard"]["width"] }
+      it { expect(video.thumbnail["height"]).to eq attrs[:thumbnails]["standard"]["height"] }
+      it { expect(video.thumbnail["url"]).to eq attrs[:thumbnails]["standard"]["url"] }
+    end
+    describe "#embeddable" do
+      it { expect(video.embeddable).to be attrs[:embeddable] }
+    end
+    describe "#embed_html" do
+      it("returns the embeddable player iframe") { expect(video.embed_html).to eq attrs[:embed_html] }
+    end
+  end
+
+end

data/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require "rspec/core/rake_task"
+
+desc "Run all tests"
+RSpec::Core::RakeTask.new(:spec)

data/videodrome.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'videodrome/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "videodrome"
+  spec.version       = Videodrome::VERSION
+  spec.authors       = ["Aitor García"]
+  spec.email         = ["aitor@linkingpaths.com"]
+  spec.summary       = %q{Access metadata of public videos on Youtube.}
+  spec.homepage      = "http://github.com/linkingpaths/videodrome"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: videodrome
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Aitor Garc\xC3\xADa"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-05-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: faraday
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: json
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  version_requirements: *id003
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rake
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rspec
+description: 
+email: 
+- aitor@linkingpaths.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/videodrome.rb
+- lib/videodrome/connection.rb
+- lib/videodrome/errors/invalid_url.rb
+- lib/videodrome/errors/request_error.rb
+- lib/videodrome/url.rb
+- lib/videodrome/version.rb
+- lib/videodrome/video.rb
+- spec/spec_helper.rb
+- spec/url_spec.rb
+- spec/video_spec.rb
+- tasks/rspec.rake
+- videodrome.gemspec
+homepage: http://github.com/linkingpaths/videodrome
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Access metadata of public videos on Youtube.
+test_files: 
+- spec/spec_helper.rb
+- spec/url_spec.rb
+- spec/video_spec.rb