media_embed 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 271bd0b19f56cf30b54ac2bef3507bb358caf4ad
-  data.tar.gz: a5a1ead1fe236e53e069f56a471848fb05d55beb
+  metadata.gz: a9096ec35334ef0c2f550288504a4a9dc29d5530
+  data.tar.gz: 2cf136dbe551deb08e635c0d7b6f71407e3d2f4c
 SHA512:
-  metadata.gz: 9d56273b015b3b3c35eafcb1b0d8b7226e7feca49f98b18ce230c4ded1e349515b835263b69772817e3acab487ff063d8a93c1d5e2eca18f294a03d80c691493
-  data.tar.gz: 8607ec0867624b583b30c32730a0951dae572184b6cd2ccbd556440a1c73026fb4c16ca87fc3ccb9271b143c6a545a82196de81b15c6de630e788708c9992cad
+  metadata.gz: bbf742c4d9efbbb0a291fb99b63589e18eae1bb13560c6f0b2c644c46501ddf15227e4829db30c536cb716e66a4f490c45e0da2d1e8511b4eb668b3dd70a0f42
+  data.tar.gz: 858b36547f11e620bc91f3afd6a274a9264519dd71ab92d76a56e95dc78211042c911ef678338c3cbf1c3bd455f9038008769fc3f8c2affec406680f8de6fd12

data/lib/media_embed.rb

@@ -1,6 +1,8 @@
 require "media_embed/version"
 require "media_embed/railtie" if defined? Rails
 
+require "media_embed/iframe_builder"
+require "media_embed/options_handler"
 require "media_embed/handler"
 require "media_embed/video"
 require "media_embed/podcast"

data/lib/media_embed/iframe_builder.rb

@@ -0,0 +1,53 @@
+module MediaEmbed
+  class IframeBuilder
+    IFRAME_ATTRS_WHITELIST = [ :align, :frameborder, :height,
+      :marginheight, :marginwidth, :name, :width, :allowfullscreen,
+      :webkitallowfullscreen, :mozallowfullscreen ]
+
+    NO_VALUE_OPTIONS = [
+      :allowfullscreen,
+      :webkitallowfullscreen,
+      :mozallowfullscreen
+    ]
+
+    attr_accessor :url_options, :iframe_options
+
+    def initialize(source, options = {}, url_params_whitelist = [])
+      @source = source
+      @options = Hash[options.map { |key, val| [key.to_sym, val] }]
+      @url_params_whitelist = url_params_whitelist
+
+      split_options
+    end
+
+    def build
+      %(<iframe src="#{@source}#{url_params_string}"#{iframe_options_string}></iframe>)
+    end
+
+    # private
+
+    def url_params_string
+      "?#{url_options.map { |name, value| "#{name}=#{value}" }.join('&')}" if url_options.any?
+    end
+
+    def iframe_options_string
+      return unless iframe_options.any?
+
+      key_value_options = iframe_options.reject { |opt_name, _| NO_VALUE_OPTIONS.include?(opt_name) }
+
+      options_string = " #{key_value_options.map { |name, value| "#{name}=\"#{value}\"" }.join(' ')}"
+
+      if NO_VALUE_OPTIONS.any? { |opt| iframe_options.keys.include? opt }
+        options_string = "#{options_string}#{NO_VALUE_OPTIONS.map { |opt| iframe_options[opt] ? opt.to_s : nil }.compact.join(' ')}"
+      end
+
+      options_string
+    end
+
+    def split_options
+      self.iframe_options = @options.select { |key, _| IFRAME_ATTRS_WHITELIST.include?(key) }
+      self.url_options = @options.select { |key, _| @url_params_whitelist.include?(key) }
+    end
+
+  end
+end

data/lib/media_embed/options_handler.rb

@@ -0,0 +1,43 @@
+module MediaEmbed
+  class OptionsHandler
+
+    attr_accessor :prioritized_options, :remaining_options
+
+    def initialize(prioritized_options_name, options_hash)
+      @prioritized_options_name = prioritized_options_name
+      @options_hash =  transform_synonymous_keys(options_hash)
+
+      split_options
+      override_duplicate_remaining_options
+    end
+
+    def consolidate_options
+      prioritized_options.merge(remaining_options)
+    end
+
+    private
+
+    def split_options
+      self.remaining_options = @options_hash.dup
+      self.prioritized_options = remaining_options.delete(@prioritized_options_name) || {}
+    end
+
+    def override_duplicate_remaining_options
+      remaining_options.reject! do |option_name, _|
+        prioritized_options.keys.include?(option_name)
+      end
+    end
+
+    def transform_synonymous_keys(options)
+      Hash[ options.map do |key, value|
+        [ keys_synonym(key), value.is_a?(Hash) ? transform_synonymous_keys(value) : value ]
+      end
+      ]
+    end
+
+    def keys_synonym(key)
+      key == :auto_play ? :autoplay : key
+    end
+
+  end
+end

data/lib/media_embed/podcast.rb

@@ -1,7 +1,32 @@
 module MediaEmbed
   class Podcast
+
+    SOUNDCLOUD_SRC_WHITELIST = [ :auto_play, :buying, :color, :default_height, :default_width,
+      :download, :enable_api, :font, :sharing, :show_artwork, :show_bpm, :show_comments,
+      :show_playcount, :show_user, :single_active, :start_track, :text_buy_set, :text_buy_track,
+      :text_download_track, :theme_color ]
+
     def self.soundcloud_template(code, options = {})
-      %Q(<iframe width="100%" height="450" scrolling="no" frameborder="no" src="https://w.soundcloud.com/player/?url=https%3A//soundcloud.com/#{code}&amp;auto_play=false&amp;hide_related=false&amp;show_comments=true&amp;show_user=true&amp;show_reposts=false&amp;visual=true"></iframe>)
+      source = "https://w.soundcloud.com/player?url=https%3A//soundcloud.com/#{code}"
+
+      builder = IframeBuilder.new(
+        source,
+        consolidated_options(:soundcloud, options),
+        SOUNDCLOUD_SRC_WHITELIST
+      )
+
+      builder.build
     end
+
+    def self.consolidated_options(service, options)
+      handler = OptionsHandler.new(service, options)
+
+      return transform_synonymous_keys(handler.consolidate_options)
+    end
+
+    def self.transform_synonymous_keys(options)
+      Hash[options.map { |k,v| [k == :autoplay ? :auto_play : k, v] }]
+    end
+
   end
 end

data/lib/media_embed/version.rb

@@ -1,3 +1,3 @@
 module MediaEmbed
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/lib/media_embed/video.rb

@@ -1,18 +1,42 @@
 module MediaEmbed
   class Video
+
+    YOUTUBE_SRC_WHITELIST = [ :autoplay, :cc_load_policy, :color,
+      :controls, :disablekb, :enablejsapi, :end, :fs, :h1, :iv_load_policy,
+      :list, :listType, :loop, :modestbranding, :origin, :playlist,
+      :playsinline, :rel, :showinfo, :start ]
+
+    VIMEO_SRC_WHITELIST = [ :autopause, :autoplay, :badge, :byline,
+      :color, :loop, :player_id, :portrait, :title ]
+
     def self.youtube_template(code, options = {})
-      iframe("//www.youtube.com/embed/#{code}/enablejsapi=1", options)
+      source = "//www.youtube.com/embed/#{code}"
+
+      builder = IframeBuilder.new(
+        source,
+        consolidated_options(:youtube, options),
+        YOUTUBE_SRC_WHITELIST
+      )
+
+      builder.build
     end
 
     def self.vimeo_template(code, options = {})
-      iframe("//player.vimeo.com/video/#{code}", options)
-    end
+      source = "//player.vimeo.com/video/#{code}"
+
+      builder = IframeBuilder.new(
+        source,
+        consolidated_options(:vimeo, options),
+        VIMEO_SRC_WHITELIST
+      )
 
-    private
+      builder.build
+    end
 
-    def self.iframe(source, options = {})
-      %(<iframe src='#{source}' #{options.map { |key, value| "#{key}='#{value}'" }.join(' ')}></iframe>)
+    def self.consolidated_options(service, options)
+      OptionsHandler.new(service, options).consolidate_options
     end
+
   end
 end
 

data/test/media_embed/handler_test.rb

@@ -2,6 +2,7 @@ require 'test_helper'
 require 'media_embed/handler'
 
 class HandlerTest < Minitest::Test
+
   CODE = MediaEmbed::Handler::CODE
 
   YOUTUBE_URLS = %w(youtube.com/watch?v=CODE
@@ -40,4 +41,5 @@ class HandlerTest < Minitest::Test
     match = @klass.soundcloud?("irrelevantinfo#{SOUNDCLOUD_URL}")[CODE]
     assert_equal match, 'username/code-for-podcast'
   end
+
 end

data/test/media_embed/iframe_builder_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+require 'media_embed/iframe_builder'
+
+class IframeBuilderTest < Minitest::Test
+
+  def setup
+    @source = '//youtube.com/embed/1234'
+  end
+
+  test 'it should return an iframe with the appropriate source, given no options' do
+    builder = MediaEmbed::IframeBuilder.new(@source)
+
+    iframe = %(<iframe src="#{@source}"></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+  test 'it should return an iframe with attributes, given valid iframe attributes' do
+    options = { :width => '500px' }
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options)
+
+    iframe = %(<iframe src="#{@source}" width="500px"></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+  test 'it should return an iframe with no attributes, given invalid iframe attributes' do
+    options = { :notanattr => 'fake' }
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options)
+
+    iframe = %(<iframe src="#{@source}"></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+  test 'it should return an iframe with a src that has parameters, given a parameters src_whitelist' do
+    options = { :autoplay => '0', :loop => 1 }
+    src_whitelist = [:autoplay, :loop]
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options, src_whitelist)
+
+    iframe = %(<iframe src="#{@source}?autoplay=0&loop=1"></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+  test 'it should return an iframe with a src with *only* src_whitelisted parameters' do
+    options = { :autoplay => '0', :loop => 1, :notanattr => 'fake' }
+    src_whitelist = [:autoplay, :loop]
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options, src_whitelist)
+
+    refute builder.build.match('notanattr=fake')
+  end
+
+  test 'it should combine iframe attrs and src parameters' do
+    options = { :autoplay => '0', :loop => 1, :notanattr => 'fake', :width => '500px' }
+    src_whitelist = [:autoplay, :loop]
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options, src_whitelist)
+
+    iframe = %(<iframe src="#{@source}?autoplay=0&loop=1" width="500px"></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+  test 'it should deal with the allowfullscreen options correctly' do
+    options = { allowfullscreen: true, webkitallowfullscreen: true, mozallowfullscreen: true }
+    src_whitelist = []
+
+    builder = MediaEmbed::IframeBuilder.new(@source, options, src_whitelist)
+
+    iframe = %(<iframe src="#{@source}" allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>)
+
+    assert_equal iframe, builder.build
+  end
+
+end

data/test/media_embed/options_handler_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+require 'media_embed/options_handler'
+
+class OptionsHandlerTest < Minitest::Test
+
+  test 'it should set the prioritized options' do
+    options = { youtube: { key: "value" }, not_youtube: "not youtube" }
+
+    handler = MediaEmbed::OptionsHandler.new(:youtube, options)
+
+    expected_options = { key: "value" }
+
+    assert_equal expected_options, handler.prioritized_options
+  end
+
+  test 'it should return remaining options that do not override prioritized options' do
+    options = { youtube: { autoplay: true }, autoplay: false, width: '500px' }
+
+    handler = MediaEmbed::OptionsHandler.new(:youtube, options)
+
+    expected_options = { width: '500px' }
+
+    assert_equal expected_options, handler.remaining_options
+  end
+
+  test 'it should return prioritized and remaining options, merged' do
+    options = { youtube: { autoplay: true }, autoplay: false, width: '500px' }
+
+    handler = MediaEmbed::OptionsHandler.new(:youtube, options)
+
+    expected_options = { autoplay: true, width: '500px' }
+
+    assert_equal expected_options, handler.consolidate_options
+  end
+
+  test 'it should return an empty hash for an empty hash' do
+    options = {}
+
+    handler = MediaEmbed::OptionsHandler.new(:youtube, options)
+
+    assert_equal options, handler.consolidate_options
+  end
+
+  test 'it should interpret :autoplay and :auto_play the same' do
+    options = { soundcloud: { auto_play: true }, autoplay: false }
+
+    handler = MediaEmbed::OptionsHandler.new(:soundcloud, options)
+
+    expected_options = { autoplay: true }
+
+    assert_equal expected_options, handler.consolidate_options
+  end
+
+end

data/test/media_embed/podcast_test.rb

@@ -3,12 +3,41 @@ require 'media_embed/podcast'
 
 class PodcastTest < Minitest::Test
 
-  test 'should wrap a given code in the soundcloud embed iframe' do
-    code = '1234'
+  # SOUNDCLOUD
 
-    iframe = %Q(<iframe width="100%" height="450" scrolling="no" frameborder="no" src="https://w.soundcloud.com/player/?url=https%3A//soundcloud.com/#{code}&amp;auto_play=false&amp;hide_related=false&amp;show_comments=true&amp;show_user=true&amp;show_reposts=false&amp;visual=true"></iframe>)
+  test 'it should call to the IframeBuilder with soundcloud source, consolidated options, and soundcloud src whitelist' do
+    source = 'https://w.soundcloud.com/player?url=https%3A//soundcloud.com/1234'
+    options = {}
+    consolidated_options = { consolidated: 'options' }
+    whitelist = MediaEmbed::Podcast::SOUNDCLOUD_SRC_WHITELIST
 
-    assert_equal iframe, MediaEmbed::Podcast.soundcloud_template(code)
+    builder = MediaEmbed::IframeBuilder.new(source, options, whitelist)
+
+    MediaEmbed::Podcast.expects(:consolidated_options).with(:soundcloud, {}).returns(consolidated_options)
+    MediaEmbed::IframeBuilder.expects(:new).with(source, consolidated_options, whitelist).returns(builder)
+
+    MediaEmbed::Podcast.soundcloud_template('1234')
+  end
+
+  test 'it should call to OptionsHandler with options' do
+    handler = MediaEmbed::OptionsHandler.new(:soundcloud, {})
+
+    MediaEmbed::OptionsHandler.expects(:new).with(:soundcloud, {}).returns(handler)
+    MediaEmbed::OptionsHandler.any_instance.expects(:consolidate_options).returns({})
+
+    MediaEmbed::Podcast.consolidated_options(:soundcloud, {})
+  end
+
+  test 'it should interpret :autoplay as :auto_play' do
+    handler = MediaEmbed::OptionsHandler.new(:soundcloud, {})
+    options = { autoplay: true }
+
+    MediaEmbed::OptionsHandler.expects(:new).with(:soundcloud, {}).returns(handler)
+    MediaEmbed::OptionsHandler.any_instance.expects(:consolidate_options).returns(options)
+
+    expected_options = { auto_play: true }
+
+    assert_equal expected_options, MediaEmbed::Podcast.consolidated_options(:soundcloud, {})
   end
 
 end

data/test/media_embed/video_test.rb

@@ -3,23 +3,54 @@ require 'media_embed/video'
 
 class VideoTest < Minitest::Test
 
-  test 'it should wrap a youtube code without options in an iframe tag' do
-    source = '//www.youtube.com/embed/1234/enablejsapi=1'
+  # YOUTUBE
 
-    assert_equal %(<iframe src='#{source}' ></iframe>), MediaEmbed::Video.youtube_template('1234')
+  test 'it should call to the IframeBuilder with youtube source and youtube src whitelist' do
+    source = '//www.youtube.com/embed/1234'
+    options = {}
+    consolidated_options = { consolidated: 'options' }
+    whitelist = MediaEmbed::Video::YOUTUBE_SRC_WHITELIST
+
+    builder = MediaEmbed::IframeBuilder.new(source, options, whitelist)
+
+    MediaEmbed::Video.expects(:consolidated_options).with(:youtube, {}).returns(consolidated_options)
+    MediaEmbed::IframeBuilder.expects(:new).with(source, consolidated_options, whitelist).returns(builder)
+
+    MediaEmbed::Video.youtube_template('1234')
   end
 
-  test 'it should wrap a vimeo code without options in an iframe tag' do
+  test 'it should call to OptionsHandler with Youtube Options' do
+    handler = MediaEmbed::OptionsHandler.new(:youtube, {})
+
+    MediaEmbed::OptionsHandler.expects(:new).with(:youtube, {}).returns(handler)
+    MediaEmbed::OptionsHandler.any_instance.expects(:consolidate_options).returns({})
+
+    MediaEmbed::Video.consolidated_options(:youtube, {})
+  end
+
+  # VIMEO
+
+  test 'it should call the IframeBuilder with vimeo source and vimeo src whitelist' do
     source = '//player.vimeo.com/video/1234'
+    options = {}
+    consolidated_options = { consolidated: 'options' }
+    whitelist = MediaEmbed::Video::VIMEO_SRC_WHITELIST
+
+    builder = MediaEmbed::IframeBuilder.new(source, options, whitelist)
 
-    assert_equal %(<iframe src='#{source}' ></iframe>), MediaEmbed::Video.vimeo_template('1234')
+    MediaEmbed::Video.expects(:consolidated_options).with(:vimeo, {}).returns(consolidated_options)
+    MediaEmbed::IframeBuilder.expects(:new).with(source, consolidated_options, whitelist).returns(builder)
+
+    MediaEmbed::Video.vimeo_template('1234')
   end
 
-  test 'it should wrap a source with options' do
-    source = '//www.youtube.com/embed/1234/enablejsapi=1'
-    iframe_with_options = %(<iframe src='#{source}' width='50px' height='50px'></iframe>)
+  test 'it should call to OptionsHandler with Vimeo Options' do
+    handler = MediaEmbed::OptionsHandler.new(:vimeo, {})
+
+    MediaEmbed::OptionsHandler.expects(:new).with(:vimeo, {}).returns(handler)
+    MediaEmbed::OptionsHandler.any_instance.expects(:consolidate_options).returns({})
 
-    assert_equal iframe_with_options, MediaEmbed::Video.youtube_template('1234', width: '50px', height: '50px')
+    MediaEmbed::Video.consolidated_options(:vimeo, {})
   end
 
 end

data/test/test_helper.rb

@@ -1,6 +1,9 @@
 require 'bundler'
 Bundler.require :default, :test
 require 'minitest/autorun'
+require 'minitest/unit'
+
+require 'mocha/mini_test'
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: media_embed
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - WendyBeth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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
@@ -64,12 +78,16 @@ files:
 - Rakefile
 - lib/media_embed.rb
 - lib/media_embed/handler.rb
+- lib/media_embed/iframe_builder.rb
+- lib/media_embed/options_handler.rb
 - lib/media_embed/podcast.rb
 - lib/media_embed/railtie.rb
 - lib/media_embed/version.rb
 - lib/media_embed/video.rb
 - lib/tasks/media_embed_tasks.rake
 - test/media_embed/handler_test.rb
+- test/media_embed/iframe_builder_test.rb
+- test/media_embed/options_handler_test.rb
 - test/media_embed/podcast_test.rb
 - test/media_embed/video_test.rb
 - test/test_helper.rb
@@ -99,6 +117,8 @@ specification_version: 4
 summary: Easy media embedding
 test_files:
 - test/media_embed/handler_test.rb
+- test/media_embed/iframe_builder_test.rb
+- test/media_embed/options_handler_test.rb
 - test/media_embed/podcast_test.rb
 - test/media_embed/video_test.rb
 - test/test_helper.rb