media_embedder 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,64 @@
+# MediaEmbedder
+`media_embedder` is a simple and easily extendible solution to parsing URLs in
+a string and replacing them with the proper media embed code. For example, a
+link to youtube would be converted to an HTML embed of that video.
+
+MediaEmbedder comes with the following out of the box:
+* Images (png, gif, jpg)
+* Youtube (both short and long formats)
+* Hyperlink (URLs that don't match any other processor are turned into HTML hyperlinks)
+
+## Installation
+```
+gem install media_embedder
+```
+
+or add the following line to your Gemfile
+```
+gem 'media_embedder'
+```
+
+## Usage To use MediaEmbedder 
+In your project simply create a new instance of
+`MediaEmbedder::Parser` and call the `parse_links` method on it.
+
+```ruby
+  text = 'Check out this awesome cat picture! http://image.com/cat.gif'
+  parser = MediaEmbedder::Parser.new(text)
+  parser.parse_links
+  #=> 'Check out this awesome cat picture! <img src="http://image.come/cat.gif" />'
+```
+
+## Extending with your own processors
+MediaEmbedder was designed to be exendable and it is really easy to add your
+own strategy for embedding a particular type of media. You need to create a
+class that does the following:
+* Registers itself with `MediaEmbedder::Parser` on load
+* Implements the `can_process_url?` method which returns true or false 
+* Implements the `to_html` method which will return the desired HTML code to embed the media
+
+Below is a very simple processor for images:
+```ruby
+module MediaEmbedder
+  module Resource
+    class Image
+      Parser.register(self)
+
+      def initialize(url)
+        @url = URI.parse url
+      end
+
+      def can_process_url?
+        @url.path.end_with? '.png', '.gif', '.jpg'
+      end
+
+      def to_html
+        "<img src=\"#{@url}\" />"
+      end
+    end
+  end
+end
+```
+
+## License
+This gem is distributed under the MIT license

data/lib/media_embedder/hyperlink_resource.rb

@@ -0,0 +1,16 @@
+module MediaEmbedder
+  class HyperlinkResource
+
+    def initialize(url)
+      @url = url
+    end
+
+    def can_process_url?
+      true
+    end
+
+    def to_html
+      "<a href=\"#{@url}\">#{@url}</a>"
+    end
+  end
+end

data/lib/media_embedder/parser.rb

@@ -0,0 +1,49 @@
+module MediaEmbedder
+  class Parser
+    @resources  = []
+
+    def self.register(resource)
+      @resources << resource
+    end
+
+    def self.resources
+      @resources.dup
+    end
+
+    def initialize(text)
+      @text = text.dup
+      @resources = self.class.resources << MediaEmbedder::HyperlinkResource
+    end
+
+    def parse_links
+      links.each do |link|
+        html_snippet = convert_to_media(link)
+        replace_url_with_html_embed link, html_snippet
+      end
+      @text
+    end
+
+    def convert_to_media(link)
+      resource_class = find_resource_for(link)
+      resource_class.new(link).to_html
+    end
+
+    private
+
+    def links
+      @links ||= URI.extract @text
+    end
+
+    def replace_url_with_html_embed(link, html_snippet)
+      @text.gsub!(link, html_snippet)
+    end
+
+    def find_resource_for(link)
+      @resources.find do |resource_class|
+        resource_class.new(link).can_process_url?
+      end
+    end
+
+    # Dir[File.expand_path("app/models/resources/*.rb")].each { |file| require file }
+  end
+end

data/lib/media_embedder/resource/image.rb

@@ -0,0 +1,19 @@
+module MediaEmbedder
+  module Resource
+    class Image
+      Parser.register(self)
+
+      def initialize(url)
+        @url = URI.parse url
+      end
+
+      def can_process_url?
+        @url.path.end_with? '.png', '.gif', '.jpg'
+      end
+
+      def to_html
+        "<img src=\"#{@url}\" />"
+      end
+    end
+  end
+end

data/lib/media_embedder/resource/youtube_regular.rb

@@ -0,0 +1,25 @@
+module MediaEmbedder
+  module Resource
+    class YoutubeRegular
+      Parser.register(self)
+
+      def initialize(url)
+        @url = URI.parse url
+      end
+
+      def to_html
+        "<iframe width=\"560\" height=\"315\" src=\"http://www.youtube.com/embed/#{video_id}\" frameborder=\"0\" allowfullscreen></iframe>"
+      end
+
+      def can_process_url?
+        @url.host.include?("youtube") && @url.query && @url.query.include?('v=')
+      end
+
+      private
+
+      def video_id
+        @url.query[2..-1]
+      end
+    end
+  end
+end

data/lib/media_embedder/resource/youtube_short.rb

@@ -0,0 +1,25 @@
+module MediaEmbedder
+  module Resource
+    class YoutubeShort
+      Parser.register(self)
+
+      def initialize(url)
+        @url = URI.parse url
+      end
+
+      def to_html
+        "<iframe width=\"560\" height=\"315\" src=\"http://www.youtube.com/embed/#{video_id}\" frameborder=\"0\" allowfullscreen></iframe>"
+      end
+
+      def can_process_url?
+        @url.host.include? "youtu.be"
+      end
+
+      private
+
+      def video_id
+        @url.path.gsub('/', '')
+      end
+    end
+  end
+end

data/lib/media_embedder/version.rb

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

data/lib/media_embedder.rb

@@ -0,0 +1,7 @@
+require 'uri'
+require 'media_embedder/parser'
+require 'media_embedder/hyperlink_resource'
+Dir[File.expand_path("lib/media_embedder/resource/*.rb")].each { |file| require file }
+
+module MediaEmbedder
+end

data/lib/tasks/media_embedder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :media_embedder do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: media_embedder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joël Quenneville
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies: []
+description: flexible, extendable library for parsing media links
+email:
+- joel.quen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/media_embedder/hyperlink_resource.rb
+- lib/media_embedder/parser.rb
+- lib/media_embedder/resource/image.rb
+- lib/media_embedder/resource/youtube_regular.rb
+- lib/media_embedder/resource/youtube_short.rb
+- lib/media_embedder/version.rb
+- lib/media_embedder.rb
+- lib/tasks/media_embedder_tasks.rake
+- MIT-LICENSE
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: flexible, extendable library for parsing media links
+test_files: []