zemus 0.0.7 → 0.0.8

data/.gitignore

@@ -1,7 +1,9 @@
 *.gem
 *.rbc
+*.patch
 .bundle
 .config
+.DS_Store
 .yardoc
 Gemfile.lock
 InstalledFiles

data/README.md

@@ -2,7 +2,7 @@
 
 Zemus is a ruby gem that translates URLs into embedable code you can insert on a page.  It does its magic by simply inspecting and hacking up the URL itself, it makes no external requests to a webservice.
 
-It currently translates the follow URLs to embedabble HTML:
+It currently translates the following URLs to embedabble HTML in standard mode:
 
 * images
 * mp3s
@@ -12,6 +12,12 @@ It currently translates the follow URLs to embedabble HTML:
 * kickstarter
 * soundcloud
 
+For embeddable elements that require flash, we have implemented a "dirty mode" that will allow these objects for browsers that can display them, and show a message about the lack of compatibility on browsers that don't support flash, such as mobile devices. For flash embeds, there are two hidden div classes, .zemusflashembed and .zemusnoflash, and some lightweight javascript will detect flash capability and display the proper one.
+
+In dirty mode, embedding the following URLs is also supported:
+
+* twitch
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,6 +27,19 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
+	
+**If you only want to use standard mode and embed HTML5 widgets only, you're done. Skip to usage below.**
+
+To enable dirty mode, enter the following command:
+
+    $ rails g zemus:install
+	
+This will install the necessary javascript and css files to your project's app/assets directory. At runtime, Zemus will check for the existence of these files to determine whether to embed the supported flash or to fall back to normal mode and return a truncated link.
+
+Be sure to precompile your assets before going live to ensure the zemus.js and zemus.css files get included.
+
+    $ rake assets:precompile
+	
 
 ## Usage
 
@@ -38,7 +57,11 @@ And then execute:
 
     Zemus.embed("https://vine.co/v/bFPjjheVnau/embed/simple")
 
-    If Zemus can't automagically transfigure the URL it just returns it as a truncated link.
+If Zemus can't automagically transfigure the URL it just returns it as a truncated link.
+
+## Styling
+
+Zemus will output different embedded URLs with different classes, depending on the needs of the particular service. Check the generated HTML output in your project to find what to style.
 
 ## TODO / Contributions
 
@@ -50,6 +73,10 @@ If there is another URL you want to embed, submit the patch.  As long as you can
 
 Zemus was extracted from and is running in production at http://cheerfulghost.com by Jon Dodson and Mark Tabler.
 
+Contributions from:
+
+Travis Newman @travisnewman
+
 ## Even more
 
 Zemus was named after the antagonist of Final Fantasy IV.

data/app/assets/javascripts/zemus.js

@@ -0,0 +1,30 @@
+// Detect whether displaying *.swf is possible
+// https://stackoverflow.com/questions/998245
+
+var hasFlash = false;
+try {
+  var fo = new ActiveXObject('ShockwaveFlash.ShockwaveFlash');
+  if (fo) {
+    hasFlash = true;
+  }
+} catch (e) {
+  if (navigator.mimeTypes
+        && navigator.mimeTypes['application/x-shockwave-flash'] != undefined
+        && navigator.mimeTypes['application/x-shockwave-flash'].enabledPlugin) {
+    hasFlash = true;
+  }
+}
+
+
+// Show the proper div
+
+$(document).ready(function(){ 
+
+	if (hasFlash == true) {
+		$('.zemusflashembed').show();
+	} 
+	else {
+		$('.zemusnoflash').show();
+	}
+
+});

data/app/assets/stylesheets/zemus.css

@@ -0,0 +1,7 @@
+div .zemusflashembed {
+    display: none;
+}
+
+div .zemusnoflash {
+    display: none;
+}

data/lib/generators/zemus/install_generator.rb

@@ -0,0 +1,15 @@
+module Zemus
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      def install_assets
+        zemus_js_dir = 'app/assets/javascripts/zemus.js'
+        copy_file "zemus.js", zemus_js_dir
+
+        zemus_css_dir = 'app/assets/stylesheets/zemus.css'
+        copy_file "zemus.css", zemus_css_dir
+      end
+    end
+  end
+end
+

data/lib/generators/zemus/templates/zemus.css

@@ -0,0 +1,7 @@
+div .zemusflashembed {
+    display: none;
+}
+
+div .zemusnoflash {
+    display: none;
+}

data/lib/generators/zemus/templates/zemus.js

@@ -0,0 +1,30 @@
+// Detect whether displaying *.swf is possible
+// https://stackoverflow.com/questions/998245
+
+var hasFlash = false;
+try {
+  var fo = new ActiveXObject('ShockwaveFlash.ShockwaveFlash');
+  if (fo) {
+    hasFlash = true;
+  }
+} catch (e) {
+  if (navigator.mimeTypes
+        && navigator.mimeTypes['application/x-shockwave-flash'] != undefined
+        && navigator.mimeTypes['application/x-shockwave-flash'].enabledPlugin) {
+    hasFlash = true;
+  }
+}
+
+
+// Show the proper div
+
+$(document).ready(function(){ 
+
+	if (hasFlash == true) {
+		$('.zemusflashembed').show();
+	} 
+	else {
+		$('.zemusnoflash').show();
+	}
+
+});

data/lib/zemus/parser.rb

@@ -2,8 +2,14 @@ module Zemus
   class Parser
     
     def self.url_classes
-      [Image, Kickstarter, Sound, Soundcloud, Vimeo,
-      Vine, Youtube]
+      zemus_js_dir = 'app/assets/javascripts/zemus.js'
+      if File.exist?(zemus_js_dir)
+        [Image, Kickstarter, Sound, Soundcloud, Vimeo,
+         Vine, Youtube, Twitch]
+      else
+         [Image, Kickstarter, Sound, Soundcloud, Vimeo,
+          Vine, Youtube]
+      end
     end
 
     def self.build_embedder(url)
@@ -15,4 +21,4 @@ module Zemus
       Generic.new(url)
     end
   end
-end
+end

data/lib/zemus/twitch.rb

@@ -0,0 +1,31 @@
+module Zemus
+  class Twitch
+
+    def self.valid?(url)
+      url =~ /www.twitch.tv/
+    end
+
+    def initialize(url)
+      @url = url
+    end
+
+    def to_embed
+      id = @url.split('/').last
+      if @url.split('/')[4] == "b"
+        chan = @url.split('/')[3]
+        "<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=#{chan}&amp;auto_play=false&amp;start_volume=25&amp;archive_id=#{id}'></object></div>
+        <div class='zemusnoflash'><a href='#{@url}'>Your browser cannot display this embedded Twitch video</a></div>"
+        
+      elsif  @url.split('/')[4] == "c"
+        chan = @url.split('/')[3]
+        "<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=#{chan}&amp;auto_play=false&amp;start_volume=25&amp;chapter_id=#{id}'></object></div>
+        <div class='zemusnoflash'><a href='#{@url}'>Your browser cannot display this embedded Twitch video</a></div>"
+      else 
+        chan = @url.split('/')[3]
+        "<div class='zemusflashembed'><object type='application/x-shockwave-flash' height='378' id='live_embed_player_flash' data='http://www.twitch.tv/widgets/live_embed_player.swf?channel=#{chan}'><param name='allowFullScreen' value='true' /><param name='allowScriptAccess' value='always' /><param name='allowNetworking' value='all' /><param name='movie' value='http://www.twitch.tv/widgets/live_embed_player.swf' /><param name='flashvars' value='hostname=www.twitch.tv&channel=#{chan}&auto_play=true&start_volume=25' /></object></div><div class='zemusnoflash'><a href='#{@url}'>Your browser cannot display this embedded Twitch stream</a></div>"
+      end
+      
+    end
+
+  end
+end

data/lib/zemus/version.rb

@@ -1,3 +1,3 @@
 module Zemus
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/zemus.rb

@@ -2,7 +2,7 @@ path = File.expand_path('../zemus', __FILE__)
 Dir.glob(File.join(path, "/**/*.rb")).each { |f| require f }
 
 module Zemus
-  
+
   def self.embed(url)
     Zemus::Parser.build_embedder(url).to_embed
   end

data/spec/zemus/twitch_spec.rb

@@ -0,0 +1,20 @@
+require_relative('../spec_helper')
+ 
+describe Zemus::Twitch do
+  it "embeds twitch stream" do
+    Zemus::Twitch.new("http://www.twitch.tv/awesomeguy").to_embed.
+      should eq("<div class='zemusflashembed'><object type='application/x-shockwave-flash' height='378' id='live_embed_player_flash' data='http://www.twitch.tv/widgets/live_embed_player.swf?channel=awesomeguy'><param name='allowFullScreen' value='true' /><param name='allowScriptAccess' value='always' /><param name='allowNetworking' value='all' /><param name='movie' value='http://www.twitch.tv/widgets/live_embed_player.swf' /><param name='flashvars' value='hostname=www.twitch.tv&channel=awesomeguy&auto_play=true&start_volume=25' /></object></div><div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy'>Your browser cannot display this embedded Twitch stream</a></div>")
+  end
+  
+  it "embeds twitch /b/" do
+    Zemus::Twitch.new("http://www.twitch.tv/awesomeguy/b/123456789").to_embed.
+      should eq("<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=awesomeguy&amp;auto_play=false&amp;start_volume=25&amp;archive_id=123456789'></object></div>
+        <div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy/b/123456789'>Your browser cannot display this embedded Twitch video</a></div>")
+  end
+  
+  it "embeds twitch /c/" do
+    Zemus::Twitch.new("http://www.twitch.tv/awesomeguy/c/123456789").to_embed.
+      should eq("<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=awesomeguy&amp;auto_play=false&amp;start_volume=25&amp;chapter_id=123456789'></object></div>
+        <div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy/c/123456789'>Your browser cannot display this embedded Twitch video</a></div>")
+  end
+end

data/spec/zemus_spec.rb

@@ -57,6 +57,26 @@ describe Zemus do
 
     Zemus.embed(url).should eq("<iframe class='vine-embed' src='https://vine.co/v/bFPjjheVnau/embed/simple' width='100%' height='600px' frameborder='0'></iframe><script async src='//platform.vine.co/static/scripts/embed.js' charset='utf-8'></script>")
   end
+  
+  it "acceptance test for twitch stream" do
+    url = "http://www.twitch.tv/awesomeguy"
+
+    Zemus.embed(url).should eq("<div class='zemusflashembed'><object type='application/x-shockwave-flash' height='378' id='live_embed_player_flash' data='http://www.twitch.tv/widgets/live_embed_player.swf?channel=awesomeguy'><param name='allowFullScreen' value='true' /><param name='allowScriptAccess' value='always' /><param name='allowNetworking' value='all' /><param name='movie' value='http://www.twitch.tv/widgets/live_embed_player.swf' /><param name='flashvars' value='hostname=www.twitch.tv&channel=awesomeguy&auto_play=true&start_volume=25' /></object></div><div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy'>Your browser cannot display this embedded Twitch stream</a></div>")
+  end
+  
+  it "acceptance test for twitch /b/" do
+    url = "http://www.twitch.tv/awesomeguy/b/123456789"
+    
+    Zemus.embed(url).should eq("<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=awesomeguy&amp;auto_play=false&amp;start_volume=25&amp;archive_id=123456789'></object></div>
+        <div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy/b/123456789'>Your browser cannot display this embedded Twitch video</a></div>")
+  end
+
+  it "acceptance test for twitch /c/" do
+    url = "http://www.twitch.tv/awesomeguy/c/123456789"
+    
+    Zemus.embed(url).should eq("<div class='zemusflashembed'><object data='http://www.twitch.tv/widgets/archive_embed_player.swf' height='378' id='clip_embed_player_flash' type='application/x-shockwave-flash' ><param name='movie' value='http://www.twitch.tv/widgets/archive_embed_player.swf'><param name='allowScriptAccess' value='always'><param name='allowNetworking' value='all'><param name='allowFullScreen' value='true'><param name='flashvars' value='channel=awesomeguy&amp;auto_play=false&amp;start_volume=25&amp;chapter_id=123456789'></object></div>
+        <div class='zemusnoflash'><a href='http://www.twitch.tv/awesomeguy/c/123456789'>Your browser cannot display this embedded Twitch video</a></div>")
+  end
 
   it "acceptance test for the generic fallback" do
     url = "http://google.com/asdfhjklkjsdf/43123123/32124lkjklj123123/foo.html"

data/zemus.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "railties"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zemus
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +89,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/zemus.js
+- app/assets/stylesheets/zemus.css
+- lib/generators/zemus/install_generator.rb
+- lib/generators/zemus/templates/zemus.css
+- lib/generators/zemus/templates/zemus.js
 - lib/zemus.rb
 - lib/zemus/generic.rb
 - lib/zemus/image.rb
@@ -80,6 +101,7 @@ files:
 - lib/zemus/parser.rb
 - lib/zemus/sound.rb
 - lib/zemus/soundcloud.rb
+- lib/zemus/twitch.rb
 - lib/zemus/version.rb
 - lib/zemus/vimeo.rb
 - lib/zemus/vine.rb
@@ -89,6 +111,7 @@ files:
 - spec/zemus/kickstarter_spec.rb
 - spec/zemus/sound_spec.rb
 - spec/zemus/soundcloud_spec.rb
+- spec/zemus/twitch_spec.rb
 - spec/zemus/version_spec.rb
 - spec/zemus/vimeo_spec.rb
 - spec/zemus/vine_spec.rb
@@ -126,6 +149,7 @@ test_files:
 - spec/zemus/kickstarter_spec.rb
 - spec/zemus/sound_spec.rb
 - spec/zemus/soundcloud_spec.rb
+- spec/zemus/twitch_spec.rb
 - spec/zemus/version_spec.rb
 - spec/zemus/vimeo_spec.rb
 - spec/zemus/vine_spec.rb