RubyGems - tubemp - Versions diffs - 0.5.0 - Mend

tubemp 0.5.0

Files changed (27) hide show

data/assets/overlay.png +0 -0
data/bin/tubemp +3 -0
data/lib/public/css/foundation.min.css +1 -0
data/lib/public/img/.gitkeep +1 -0
data/lib/public/img/logo.png +0 -0
data/lib/public/js/foundation.min.js +14 -0
data/lib/public/js/foundation/foundation.forms.js +395 -0
data/lib/public/js/foundation/foundation.js +372 -0
data/lib/public/js/vendor/custom.modernizr.js +4 -0
data/lib/public/js/vendor/jquery.js +9597 -0
data/lib/public/js/vendor/zepto.js +1884 -0
data/lib/public/zeroclipboard/LICENSE +8 -0
data/lib/public/zeroclipboard/ZeroClipboard.js +359 -0
data/lib/public/zeroclipboard/ZeroClipboard.swf +0 -0
data/lib/thumbnail.rb +61 -0
data/lib/tubemp.rb +35 -0
data/lib/views/index.erb +40 -0
data/lib/views/layout.erb +73 -0
data/lib/views/not_found.erb +3 -0
data/lib/views/tags.erb +17 -0
data/lib/youtube.rb +78 -0
data/spec/fixtures/thumb.jpg +0 -0
data/spec/spec_helper.rb +21 -0
data/spec/thumbnail_spec.rb +92 -0
data/spec/tubemp_spec.rb +47 -0
data/spec/youtube_spec.rb +123 -0
metadata +190 -0

@@ -0,0 +1,40 @@
+<div class="large-12 columns">
+  <form method="get" action="/tags">
+    <div class="row collapse">
+      <div class="large-10 columns">
+        <input type="text" name="v" placeholder="Youtube URL, ID, or embed-code">
+      </div>
+      <div class="large-2 columns">
+        <input type="submit" class="button prefix" value="Create code" />
+      </div>
+    </div>
+    <p class="message">For example <em>http://youtu.be/D80QdsFWdcQ</em>.</p>
+  </form>
+</div>
+<div class="large-12 columns">
+  <h2>How does it work?</h2>
+</div>
+<div class="large-4 columns">
+  <div class="panel">
+  <h2>1. <small>Provide the YouTube-code</small></h2>
+  <p>Paste your originial YouTube embed-code, the ID or the video URL in the field above, and press the button.</p>
+  <p>tubemp detects what video you want, downloads the thumbnail for it and re-creates a thumbnail from it.</p>
+  <p>There is a simple <a href="https://github.com/berkes/tubemp#json">JSON API version</a></p>
+  </div>
+</div>
+<div class="large-4 columns"><div class="panel">
+  <h2>2. <small>tubemp creates an image that looks like a youtube-player</small></h2>
+  <p>Copy and paste the code you get onto your site. You can either choose to place a simple image, or one that has a YouTube play icon sticked to it.<br/>
+  This code links to the original video-page on YouTube. The image is served from the tubemp server and domain.
+  </p>
+  </div>
+</div>
+<div class="large-4 columns"><div class="panel">
+  <h2>3. <small>Third party trackers?</small></h2>
+  <p>When you place the default YouTube-embed-code on your site, Google (who owns YouTube) can, and will, track all the visitors of <em>your</em> site!<br />
+  You, or your users may not like that. In many countries there are even laws and regulations that don't allow you to place things (like embed-codes, ads) on your
+  site that allow <em>third parties</em> to track your visitors.<br />
+  </p>
+  </div>
+</div>

data/lib/views/layout.erb ADDED

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<!--[if IE 8]> 				 <html class="no-js lt-ie9" lang="en"> <![endif]-->
+  <!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
+    <head>
+      <meta charset="utf-8" />
+      <meta name="viewport" content="width=device-width" />
+      <title>tubemp | <%= title %></title>
+      <link rel="stylesheet" href="css/foundation.min.css" />
+      <script src="js/vendor/custom.modernizr.js"></script>
+    </head>
+    <body>
+      <div class="row">
+        <div class="large-4 large-centered columns">
+          <a href="/"><img src="img/logo.png" alt="tubemp logo" title="tubemp" class="logo" id="name" /></a>
+        </div>
+        <div class="large-6 large-centered columns">
+          <h2 class="subheader"><small>YouTube embeds without third party trackers.</small></h2>
+        </div>
+      </div>
+      <div class="row">
+        <div class="large-12 columns">
+          <hr />
+          <h2><%= title %></h2>
+        </div>
+        <%= yield %>
+      </div>
+      <div class="footer row">
+        <hr/>
+        <div class="large-6 columns">
+          <h2><small>Install it yourself...</small></h2>
+          <p>Only the site who created the new embed-code can track your visitors, because this site serves the images. You probably don't want that either,
+          so you probably want to <a href="https://github.com/berkes/tubemp#installation">install this tubemp</a> on your own server and domain, because it is <a href="https://github.com/berkes/tubemp">Open Source Software</a>.
+          </p>
+        </div>
+        <div class="large-6 columns">
+          <h2><small>...or, get me to install it for you.</small></h2>
+          <p>You can find my contact details at <a href="http://berk.es/about.html">my website</a>. Or you can email me at <a href='ma&#105;lto&#58;be&#114;&#64;&#37;77%65&#98;&#37;73ch%&#55;5u%72&#46;c%6Fm'>be&#114;&#64;we&#98;schuu&#114;&#46;c&#111;m</a> to discuss the options.</p>
+          <p>I can assist in anything, from getting a server or hoster to installation and customisation.</p>
+        </div>
+        <div class="large-12 columns">
+          <p>The name tubemp is a play on the word <a href="https://en.wikipedia.org/wiki/Electromagnetic_pulse">EMP</a> and tube. Tube, referring to YouTube, EMP being a military (side)effect, which disables many electronic devises, also electronics that spy on you.</p>
+        </div>
+      </div>
+      <script>
+        document.write('<script src=' +
+          ('__proto__' in {} ? 'js/vendor/zepto' : 'js/vendor/jquery') +
+          '.js><\/script>')
+        </script>
+        <script src="js/foundation.min.js"></script>
+        <!--
+        <script src="js/foundation/foundation.js"></script>
+        <script src="js/foundation/foundation.forms.js"></script>
+        -->
+        <script>
+          $(document).foundation();
+        </script>
+        <script type="text/javascript" src="zeroclipboard/ZeroClipboard.js"></script>
+        <script>
+          ZeroClipboard.setDefaults( { moviePath: '/zeroclipboard/ZeroClipboard.swf' } );
+          $(document).ready(function() {
+            /* Init zero-clipboard */
+            $("input.copy_button").each(function() { new ZeroClipboard($(this)); });
+          });
+        </script>
+      </body>
+    </html>

data/lib/views/not_found.erb ADDED

@@ -0,0 +1,3 @@
+  <div class="large-12 columns">
+    Youtube video with id <em><%=h id %></em> not found.
+  </div>

data/lib/views/tags.erb ADDED

@@ -0,0 +1,17 @@
+<% tags.each do |key, tag| %>
+  <div class="large-6 columns">
+    <%= tag %><br />
+    <div class="row collapse">
+      <div class="large-10 columns">
+        <input type="text" class="copy_value" id="copy_tag_<%= key %>" value="<%= html_escape tag %>" />
+      </div>
+      <div class="large-2 columns">
+        <input type="button" class="button prefix copy_button" id="copy_button_<%= key %>" data-clipboard-target="copy_tag_<%= key %>" value="Copy" />
+      </div>
+    </div>
+  </div>
+<% end %>
+<div class="large-12 columns">
+  <a href="/">Create another one</a>
+</div>

data/lib/youtube.rb ADDED

@@ -0,0 +1,78 @@
+require 'RMagick'
+require 'video_info'
+require 'net/http'
+class YouTube
+  def initialize identifier
+    @id = find_id(identifier)
+    @meta = nil
+  end
+  def title
+    parse
+    @meta.title
+  end
+  def href
+    "http://www.youtube.com/watch?v=#{@id}"
+  end
+  def tags(uri)
+    parse
+    thumbs = get_thumbs.map do |key,thumb|
+      uri.path = thumb.uri_path
+      [key, %Q{<a href="#{href}"><img src="#{uri}" alt="#{title}"/></a>}]
+    end
+    Hash[thumbs]
+  end
+  def valid?
+    parse
+    not @meta.nil?
+  end
+  def id
+    @id
+  end
+  private
+  def find_id identifier
+    id_part  = "[a-zA-Z0-9]{4,16}"
+    if matches = identifier.match("^#{id_part}$")
+      matches[0]
+    elsif matches = identifier.match("^http(?:s)?:\/\/(?:www\.)?youtube\.com\/watch\\?v=(#{id_part})")
+      matches[1]
+    elsif matches = identifier.match("^http(?:s)?:\/\/youtu.be\/(#{id_part})")
+      matches[1]
+    elsif matches = identifier.match("\<iframe(?:.*)src=\"http://www.youtube.com/embed/(#{id_part}).+")
+      matches[1]
+    else
+      nil
+    end
+  end
+  def parse
+    @meta ||= VideoInfo.get(href)
+  end
+  def get_thumbs
+    img = Net::HTTP.get(URI(@meta.thumbnail_large))
+    tmpfile = Tempfile.new(["tubemp", ".jpg"])
+    thumbs = {}
+    begin
+      tmpfile.binmode
+      tmpfile.write(img)
+      tmpfile.close
+      thumbs["basic"]   = Thumbnail.new(id, tmpfile).write
+      thumbs["overlay"] = Thumbnail.new(id, tmpfile).add_overlay(File.join(File.dirname(__FILE__), "..", "assets","overlay.png")).write(@uri)
+    ensure
+      images = nil
+      tmpfile.unlink
+    end
+    thumbs
+  end
+end

data/spec/fixtures/thumb.jpg ADDED

Binary file

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,21 @@
+require 'rack/test'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'tubemp.rb')
+module RSpecMixin
+  include Rack::Test::Methods
+  def app() Tubemp end
+  def root_path()
+    Pathname.new(File.realpath(File.join(File.dirname(__FILE__), '..')))
+  end
+  def stub_info
+    info = mock("video");
+    info.stub(:title).and_return("Tony Tribe , Red Red Wine")
+    info.stub(:thumbnail_large).and_return("http://i.ytimg.com/vi/D80QdsFWdcQ/hqdefault.jpg")
+    VideoInfo.stub(:get).and_return info
+  end
+end
+RSpec.configure { |c| c.include RSpecMixin }

data/spec/thumbnail_spec.rb ADDED

@@ -0,0 +1,92 @@
+require "spec_helper"
+require File.join(File.dirname(__FILE__), "..", "lib", "thumbnail")
+describe Thumbnail do
+  before do
+    @id = "D80QdsFWdcQ"
+    @slice = @id.slice(0,2)
+    @container = File.join("lib", "public", "thumbs", @slice)
+    @filename = File.join(@container, "#{@id}.png")
+    @tmpfile    = File.open(File.join(File.dirname(__FILE__), "fixtures", "thumb.jpg"))
+    @thumbnail = Thumbnail.new(@id, @tmpfile)
+  end
+  describe "#write" do
+    it 'should create a simple png' do
+      @thumbnail.write
+      File.should exist(@filename)
+    end
+    it 'should include overlay filenames in filename' do
+      @thumbnail.add_overlay @tmpfile #contains the name "thumb"
+      @thumbnail.write
+      File.should exist(File.join(@container, "#{@id}_thumb.png"))
+    end
+    it 'should be chainable' do
+      @thumbnail.write.should be_kind_of(Thumbnail)
+    end
+    it 'should overwrite existing files' do
+      FileUtils.cp(root_path.join("spec", "fixtures", "thumb.jpg"), @filename)
+      existing = File.stat(@filename)
+      @thumbnail.write
+      existing.should_not eq File.stat(@filename)
+    end
+    describe 'subdirs' do
+      before do
+        @container = File.join("lib", "public", "thumbs")
+        FileUtils.rm_rf(@container)
+      end
+      it 'should create the thumbs container dir' do
+        @thumbnail.write
+        File.should exist(@container)
+      end
+      it 'to a subdirectory of the first two characters of the id' do
+        @thumbnail.write
+        File.should exist(File.join(@container, @slice))
+      end
+    end
+  end
+  describe "#images" do
+    it 'should be an ImageList' do
+      @thumbnail.images.should be_kind_of Magick::ImageList
+    end
+    it 'should include the tmpfile' do
+      expected = Magick::ImageList.new(@tmpfile.path)[0]
+      @thumbnail.images.should include expected
+    end
+  end
+  describe "#add_overlay" do
+    before do
+      @overlay_name = File.join("assets", "overlay.png")
+      @expected = Magick::ImageList.new(@overlay_name)[0]
+      @thumbnail.add_overlay @overlay_name
+    end
+    it 'should add files to ImageList stack' do
+      @thumbnail.images.should include @expected
+    end
+    it 'should call combine the images to one' do
+      Magick::Image.any_instance.should_receive(:composite).once.and_return(@expected)
+      @thumbnail.write
+    end
+    it 'should be chainable' do
+      @thumbnail.add_overlay(@overlay_name).should be_kind_of(Thumbnail)
+    end
+  end
+  describe "uri_path" do
+    it 'should return an absolute path from within "/public".' do
+      @thumbnail.uri_path.should eq "/thumbs/#{@slice}/#{@id}.png"
+    end
+  end
+end

data/spec/tubemp_spec.rb ADDED

@@ -0,0 +1,47 @@
+require 'spec_helper'
+describe "tubemp tags" do
+  it "should have a page for a youtube ID" do
+    get '/tags?v=D80QdsFWdcQ'
+    last_response.should be_ok
+  end
+  it 'should give a 404 on an invalid ID' do
+    get 'tags?v=INVALID'
+    last_response.should be_not_found
+  end
+end
+describe 'tubemp tags.json' do
+  before do
+    get 'tags.json?v=D80QdsFWdcQ'
+  end
+  it 'should have a json-version' do
+    last_response.should be_ok
+  end
+  it 'should send json content-type' do
+    last_response.content_type.should match /.*application\/json.*/
+  end
+  it 'should return the tags in json' do
+    tags = JSON.parse(last_response.body.strip)
+    tags.should be_kind_of(Hash)
+    ["basic", "overlay"].each do |variation|
+      tags[variation].should match IMAGE_RE
+    end
+  end
+end
+describe "tubemp /" do
+  before do
+    get '/'
+  end
+  it 'should have an index page' do
+    last_response.should be_ok
+  end
+end

data/spec/youtube_spec.rb ADDED

@@ -0,0 +1,123 @@
+require "spec_helper"
+require File.join(File.dirname(__FILE__), "..", "lib", "youtube")
+require File.join(File.dirname(__FILE__), "..", "lib", "thumbnail")
+IMAGE_RE = /\<img.*src="(.*)".*alt="(.*).*\/\>/
+LINK_RE  = /\<a.*href="(.*)".*\>/
+describe YouTube do
+  context "valid ID" do
+    before do
+      stub_info
+      @id = "D80QdsFWdcQ"
+      @yt = YouTube.new @id
+      @filename = File.join("public", "thumbs", "#{@id}.png")
+      @thumb = mock(Thumbnail)
+      @thumb.stub(:uri_path => "/thumbs/#{@id}.png")
+      @thumb.stub(:add_overlay).and_return @thumb
+      @thumb.stub(:write).and_return @thumb
+      @uri = URI("http://example.com")
+    end
+    describe '#tags' do
+      before do
+        @tags = @yt.tags(@uri)
+        @basic = @tags["basic"]
+      end
+      it 'should render a list of valid image tags' do
+        @tags.each {|key,t| t.should match IMAGE_RE }
+      end
+      it 'should have an overlayed image' do
+        Thumbnail.any_instance.should_receive(:add_overlay).and_return @thumb
+        @yt.tags(@uri)
+      end
+      it 'should link to a thumbnail in PNG format' do
+        @basic.match(IMAGE_RE)[1].should match /#{@id}\.png/
+      end
+      it 'should link to an absolute URL' do
+        @basic.match(IMAGE_RE)[1].should match /^http:\/\/.*$/
+      end
+      it 'should have the title as alt attribute' do
+        @basic.match(IMAGE_RE)[2].should match "Tony Tribe , Red Red Wine"
+      end
+      it 'should have a link pointing to the youtube video' do
+        @basic.match(LINK_RE)[1].should match /http:\/\/www\.youtube\.com/
+      end
+    end
+    describe "#title" do
+      it "should render a title" do
+        @yt.title.should eq "Tony Tribe , Red Red Wine"
+      end
+    end
+    describe "#href" do
+      it 'should render a link' do
+        @yt.href.should eq "http://www.youtube.com/watch?v=#{@id}"
+      end
+    end
+    describe "#valid?" do
+      it 'should return true for a valid youtube-ID' do
+        @yt = YouTube.new("D80QdsFWdcQ")
+        @yt.should be_valid
+      end
+    end
+    it 'should get the large thumbnail' do
+      # re-stub to allow message-expectation
+      info = mock("video")
+      info.stub(:title)
+      info.should_receive(:thumbnail_large).and_return("http://i.ytimg.com/vi/D80QdsFWdcQ/hqdefault.jpg")
+      VideoInfo.stub(:get).and_return info
+      @yt.tags(@uri)
+    end
+  end #end valid-ID
+  describe "invalid-ID" do
+    before do
+      VideoInfo.stub(:get).and_return nil
+      @yt = YouTube.new("INVALID")
+    end
+    describe "#valid?" do
+      it 'should return false for an invalid youtube-ID' do
+        @yt = YouTube.new("INVALID")
+        @yt.should_not be_valid
+      end
+    end
+  end
+  describe "liberal IDs" do
+    before do
+      @id = "D80QdsFWdcQ"
+    end
+    it "should allow an ID" do
+      @yt = YouTube.new(@id)
+      @yt.id.should eq @id
+    end
+    it 'should allow an URL' do
+      @yt = YouTube.new("http://www.youtube.com/watch?v=#{@id}")
+      @yt.id.should eq @id
+    end
+    it 'should allow a shortened URL' do
+      @yt = YouTube.new("http://youtu.be/#{@id}")
+      @yt.id.should eq @id
+    end
+    it 'should allow an embed-code' do
+      @yt = YouTube.new("<iframe src=\"http://www.youtube.com/embed/D80QdsFWdcQ\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"></iframe>")
+      @yt.id.should eq @id
+    end
+  end
+end