lumiere 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e20f4a873d50e02f09619cd156bf79f2cc7cefb8
+  data.tar.gz: 7f7fe10f03c200211d4076111112d3c569112033
+SHA512:
+  metadata.gz: bfd62f901fd6c5216bcf70309604cb5c6c8f614f56d564f61be3aec64b1b89f0dbc5f273f259b8ae7fbfb2c285d42387601babe28cf6f8c25fd2995841179426
+  data.tar.gz: afe0be0945ea5f3eeac4c355041ffc821bb1cf44bdba6d7da7c449e92b80f5b0f9b345af132bd6a1c24a495ee751773f06b9196754169f1a51369f18e3b336cf

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Karl Entwistle
+
+MIT License
+
+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/lib/extended_uri.rb

@@ -0,0 +1,10 @@
+module Lumiere
+  module URISchemeless
+    def self.parse(url)
+      url = url[2..-1] if url[0..1] == '//' # TODO: make this better
+      uri = URI.parse(url)
+      uri = URI.parse("http://#{url}") unless uri.absolute?
+      uri
+    end
+  end
+end

data/lib/lumiere/version.rb

@@ -0,0 +1,3 @@
+module Lumiere
+  VERSION = "0.0.4"
+end

data/lib/lumiere.rb

@@ -0,0 +1,27 @@
+require "lumiere/version"
+require 'open-uri'
+require 'forwardable'
+require 'net/http'
+require 'json'
+require 'representable'
+require 'representable/coercion'
+require 'representable/json'
+require 'representable/json/collection'
+
+require_relative 'extended_uri'
+require_relative 'provider'
+
+class Elluminate
+  extend Forwardable
+
+  def initialize(url)
+    @provider ||= Lumiere::Provider.delegate(url)
+  end
+
+  def_delegators :@provider, :provider, :upload_date
+  def_delegators :@provider, :title, :description, :duration
+  def_delegators :@provider, :thumbnail_small, :thumbnail_medium, :thumbnail_large
+  def_delegators :@provider, :embed_code, :embed_url
+  def_delegators :@provider, :accessible?
+  def_delegators :@provider, :videos
+end

data/lib/provider/vimeo/representer.rb

@@ -0,0 +1,20 @@
+module Lumiere
+  module VimeoVideoRepresenter
+    include Representable::JSON
+    include Representable::Coercion
+
+    property :title
+    property :description
+    property :duration, type: Integer
+    property :upload_date, type: DateTime
+    property :thumbnail_small
+    property :thumbnail_medium
+    property :thumbnail_large
+  end
+
+  module VimeoVideosRepresenter
+    include Representable::JSON::Collection
+
+    items extend: VimeoVideoRepresenter, class: OpenStruct
+  end
+end

data/lib/provider/vimeo/vimeo.rb

@@ -0,0 +1,78 @@
+module Lumiere
+class Vimeo < Provider
+  attr_accessor :url
+
+  USEABLE = ['www.vimeo.com', 'vimeo.com', 'player.vimeo.com']
+
+  def self.useable?(url)
+    uri = URISchemeless.parse(url)
+    USEABLE.include?(uri.host.to_s)
+  end
+
+  def initialize(url)
+    @url = url
+  end
+
+  def provider
+    "Vimeo"
+  end
+
+  def video_id
+    @video_id ||= calculate_video_id
+  end
+
+  def api_url
+    "http://vimeo.com/api/v2/video/#{video_id}.json"
+  end
+
+  def embed_url
+    "http://player.vimeo.com/video/#{video_id}"
+  end
+
+  def embed_code
+    "<iframe src=\"//player.vimeo.com/video/#{video_id}\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>"
+  end
+
+  def title
+    fetch.title
+  end
+
+  def description
+    fetch.description
+  end
+
+  def duration
+    fetch.duration
+  end
+
+  def upload_date
+    fetch.upload_date
+  end
+
+  def thumbnail_small
+    fetch.thumbnail_small
+  end
+
+  def thumbnail_medium
+    fetch.thumbnail_medium
+  end
+
+  def thumbnail_large
+    fetch.thumbnail_large
+  end
+
+  private
+
+  def fetch
+    @fetch ||= [].extend(VimeoVideosRepresenter).from_json(raw_response)[0]
+  end
+
+  def calculate_video_id
+    uri = URISchemeless.parse(url)
+    uri.path.gsub!('/video/', '')
+    uri.path.delete!('/')
+    uri.path
+  end
+
+end
+end

data/lib/provider/youtube/representer.rb

@@ -0,0 +1,30 @@
+module Lumiere
+  module YouTubeVideoRepresenter
+    include Representable::JSON
+    self.representation_wrap = :entry
+
+    nested 'title' do
+      property :title, as: '$t'
+    end
+
+    nested 'published' do
+      include Representable::Coercion
+      property :upload_date, as: '$t', type: DateTime
+    end
+
+    nested 'media$group' do
+      nested 'media$description' do
+        property :description, as: '$t'
+      end
+
+      nested 'yt$duration' do
+        include Representable::Coercion
+        property :duration, as: :seconds, type: Integer
+      end
+
+      collection :thumbnails, class: OpenStruct, as: 'media$thumbnail' do
+        property :url
+      end
+    end
+  end
+end

data/lib/provider/youtube/youtube.rb

@@ -0,0 +1,91 @@
+module Lumiere
+class YouTube < Provider
+  attr_accessor :url
+
+  USEABLE = ['www.youtube.com', 'youtube.com', 'youtu.be']
+
+  def self.useable?(url)
+    uri = URISchemeless.parse(url)
+    USEABLE.include?(uri.host.to_s)
+  end
+
+  def self.new_from_video_id(video_id)
+    new("http://www.youtube.com/watch?v=#{video_id}")
+  end
+
+  def initialize(url)
+    @url = url
+  end
+
+  def provider
+    "YouTube"
+  end
+
+  def video_id
+    @video_id ||= calculate_video_id
+  end
+
+  def api_url
+    "http://gdata.youtube.com/feeds/api/videos/#{video_id}?v=2&alt=json"
+  end
+
+  def embed_url
+    "http://www.youtube.com/embed/#{video_id}"
+  end
+
+  def embed_code
+    "<iframe src=\"//www.youtube.com/embed/#{video_id}\" frameborder=\"0\" allowfullscreen></iframe>"
+  end
+
+  def thumbnail_small
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[0].url
+  end
+
+  def thumbnail_medium
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[1].url
+  end
+
+  def thumbnail_large
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[2].url
+  end
+
+  REMOTE_ATTRIBUTES = [:title, :description, :duration, :upload_date]
+
+  REMOTE_ATTRIBUTES.each do |attribute|
+    define_method(attribute) do
+      fetch! unless instance_variable_get("@#{attribute}")
+      instance_variable_get("@#{attribute}")
+    end
+  end
+
+  private
+
+  REMOTE_ATTRIBUTES.each do |attribute|
+    attr_writer attribute
+  end
+
+  attr_writer :thumbnails
+
+  def fetch!
+    self.extend(YouTubeVideoRepresenter).from_json(raw_response)
+  end
+
+  def calculate_video_id
+    uri = URISchemeless.parse(url)
+    if uri.query
+      params_hash = Hash[URI::decode_www_form(uri.query)]
+      params_hash['v']
+    else
+      uri.path.gsub!('/embed/', '')
+      uri.path.gsub!('/v/', '')
+      uri.path.gsub!('/e/', '')
+      uri.path.delete!('/')
+      uri.path
+    end
+  end
+
+end
+end

data/lib/provider/youtubeplaylist/representer.rb

@@ -0,0 +1,42 @@
+module Lumiere
+
+  module YouTubePlaylistRepresenter
+    include Representable::JSON
+    self.representation_wrap = :feed
+
+    nested 'openSearch$totalResults' do
+      include Representable::Coercion
+      property :total_results, as: '$t', type: Integer
+    end
+
+    nested 'title' do
+      property :title, as: '$t'
+    end
+
+    nested 'subtitle' do
+      property :description, as: '$t'
+    end
+
+    nested 'media$group' do
+      collection :thumbnails, class: OpenStruct, as: 'media$thumbnail' do
+        property :url
+      end
+    end
+
+    collection :videos, as: :entry, class: OpenStruct do
+
+      nested 'links' do
+        property :url, :reader => lambda { |doc, args| self.url = doc[0]['href'] }
+      end
+
+      nested 'media$group' do
+        nested 'yt$videoid' do
+          property :video_id, as: '$t'
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/provider/youtubeplaylist/youtubeplaylist.rb

@@ -0,0 +1,103 @@
+module Lumiere
+class YouTubePlaylist < Provider
+  attr_accessor :url
+
+  USEABLE = ['www.youtube.com', 'youtube.com', 'youtu.be']
+
+  def self.useable?(url)
+    uri = URISchemeless.parse(url)
+    USEABLE.include?(uri.host.to_s) && (uri.path == '/playlist' || uri.path == '/view_play_list')
+  end
+
+  def initialize(url, opts={})
+    @url = url
+    @start_index = opts[:start_index] || 1
+    @max_results = opts[:max_results] || 25
+  end
+
+  def provider
+    "YouTube"
+  end
+
+  def playlist_id
+    @playlist_id ||= calculate_playlist_id
+  end
+
+  def api_url
+    url = "http://gdata.youtube.com/feeds/api/playlists/#{playlist_id}"
+    url << "?max-results=#{@max_results}"
+    url << "&start-index=#{@start_index}"
+    url << "&v=2&alt=json"
+    url
+  end
+
+  def embed_url
+    "http://youtube.com/embed/?list=#{playlist_id}"
+  end
+
+  def embed_code
+    "<iframe src=\"//youtube.com/embed/?list=#{playlist_id}\" frameborder=\"0\" allowfullscreen></iframe>"
+  end
+
+  def videos
+    fetch! unless defined?(@videos)
+
+    while @start_index < @total_results && @videos.size < @total_results
+      @start_index =+ @videos.size + 1
+      fetch!
+    end
+
+    @all_videos = @videos.map do |video|
+      YouTube.new_from_video_id(video.video_id)
+    end
+  end
+
+  def thumbnail_small
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[0].url
+  end
+
+  def thumbnail_medium
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[1].url
+  end
+
+  def thumbnail_large
+    fetch! unless defined?(@thumbnails)
+    @thumbnails[2].url
+  end
+
+  REMOTE_ATTRIBUTES = [:title, :description, :total_results]
+
+  REMOTE_ATTRIBUTES.each do |attribute|
+    define_method(attribute) do
+      fetch! unless instance_variable_get("@#{attribute}")
+      instance_variable_get("@#{attribute}")
+    end
+  end
+
+  private
+
+  REMOTE_ATTRIBUTES.each do |attribute|
+    attr_writer attribute
+  end
+
+  attr_writer :thumbnails
+
+  def videos=(videos)
+    @videos ||= []
+    @videos += videos
+  end
+
+  def fetch!
+    self.extend(YouTubePlaylistRepresenter).from_json(raw_response)
+  end
+
+  def calculate_playlist_id
+    uri = URISchemeless.parse(url)
+    params_hash = Hash[URI::decode_www_form(uri.query)]
+    params_hash['list'] || params_hash['p']
+  end
+
+end
+end

data/lib/provider.rb

@@ -0,0 +1,86 @@
+module Lumiere
+  class Provider
+
+    PROVIDERS = %w(YouTubePlaylist YouTube Vimeo)
+    PROVIDERS.each do |provider|
+      require_relative "provider/#{provider.downcase}/#{provider.downcase}"
+      require_relative "provider/#{provider.downcase}/representer"
+    end
+
+    def self.delegate(url)
+      PROVIDERS.each do |provider|
+        provider_class = Object.const_get("Lumiere").const_get(provider)
+        if provider_class.useable?(url)
+          return provider_class.new(url)
+        end
+      end
+
+      raise NotImplementedError
+    end
+
+    def api_url
+      raise NotImplementedError
+    end
+
+    def embed_url
+      raise NotImplementedError
+    end
+
+    def embed_code
+      raise NotImplementedError
+    end
+
+    def provider
+      raise NotImplementedError
+    end
+
+    def title
+      raise NotImplementedError
+    end
+
+    def description
+      raise NotImplementedError
+    end
+
+    def duration
+      raise NotImplementedError
+    end
+
+    def upload_date
+      raise NotImplementedError
+    end
+
+    def thumbnail_small
+      raise NotImplementedError
+    end
+
+    def thumbnail_medium
+      raise NotImplementedError
+    end
+
+    def thumbnail_large
+      raise NotImplementedError
+    end
+
+    def videos
+      raise NotImplementedError
+    end
+
+    def accessible?
+      code = Net::HTTP.get_response(URI(api_url)).code
+      @remote_status ||= !%w[403 404].include?(code)
+    end
+
+    def ==(other)
+      if other.respond_to?(:url)
+        url == other.url
+      end
+    end
+
+    private
+
+    def raw_response
+      open(api_url).read
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: lumiere
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Karl Entwistle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: webmock
+  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: vcr
+  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: activesupport
+  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'
+description: Lumiere fetches metadata from video providers
+email: karl.entwistle@unboxedconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/extended_uri.rb
+- lib/lumiere.rb
+- lib/lumiere/version.rb
+- lib/provider.rb
+- lib/provider/vimeo/representer.rb
+- lib/provider/vimeo/vimeo.rb
+- lib/provider/youtube/representer.rb
+- lib/provider/youtube/youtube.rb
+- lib/provider/youtubeplaylist/representer.rb
+- lib/provider/youtubeplaylist/youtubeplaylist.rb
+homepage: https://github.com/karlentwistle/lumiere
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lumiere fetches metadata from video providers
+test_files: []