netshade-oembed_links 0.0.5 → 0.0.6

data/README

@@ -4,6 +4,11 @@ inside the text. A sample configuration file for configuring the
 library has been included (oembed_links_example.yml), though you
 may also configure the library programmatically (see rdocs).
 
+You must have the JSON gem installed to use oembed_links.
+If you have the libxml-ruby gem installed, oembed_links will use that;
+it will fall back to hpricot if that is installed, and finally REXML
+if you have nothing else.  
+
 
 
 To get started quickly (in irb):
@@ -53,7 +58,20 @@ To get started quickly in Rails:
 
 Copy the included oembed_links_example.yml file to RAILS_ROOT/config/oembed_links.yml,
 add a dependency to the gem in your environment.rb ( config.gem "oembed_links" )
-and start your server.  That's it.
+and start your server.  That's it.  If you'd like to transform the oembedded content via
+templates, you can do so using the following syntax:
+
+OEmbed.transform(text_to_transform) do |res, url|
+  res.video?(:template => "oembed/video")
+  res.from?(:a_provider, :template => "a_provider/oembed")
+  res.matches?(/some_regex/, :template => "shared/oembed_link")
+  res.any?(:template => "shared/oembed_link")
+end
+
+This presumes you have a directory in your Rails views directory called "oembed", and a file
+of the form "video.html.erb" or "video.rhtml".  Haml templates are also supported (Erubis too).  If you are
+not using Rails, you may still use the template functionality, but you must specify the full path
+to the template.  See the RDocs for OEmbed::TemplateResolver for more information.
 
 
 

data/lib/oembed_links.rb

@@ -149,15 +149,22 @@ class OEmbed
   end
 
   # Clear all registration information; really only valuable in testing
-  def self.clear_registrations
+  def self.clear_registrations()
     @schemes = []
     @urls = { }
     @formats = { }
     @formatters = { }
     @fetchers = { }
-    self.register_formatter(OEmbed::Formatters::LibXML)
+  end
+
+  # Load the default JSON and XML formatters, autodetecting
+  # formatters when possible; load the default fetcher as well
+  def self.load_default_libs(*ignore_formats)
+    self.autodetect_xml_formatters(*ignore_formats)
+    require 'oembed_links/formatters/json'
     self.register_formatter(OEmbed::Formatters::JSON)
-    self.register_fetcher(OEmbed::Fetchers::NetHTTP)    
+    require 'oembed_links/fetchers/net_http'
+    self.register_fetcher(OEmbed::Fetchers::NetHTTP)        
   end
 
   # Register a new formatter.  klass is the class object of the desired formatter.
@@ -286,6 +293,38 @@ class OEmbed
     return ret
   end
 
+  # Determine the XML formatter that can be loaded for
+  # this system based on what libraries are present
+  def self.autodetect_xml_formatters(*ignore)
+    loaded_lib = false
+    unless ignore.include? "libxml"
+      begin
+        require 'libxml'
+        require 'oembed_links/formatters/lib_xml'
+        self.register_formatter(OEmbed::Formatters::LibXML)
+        loaded_lib = true
+      rescue LoadError
+        puts "Error loading LibXML XML formatter"
+      end
+    end
+    unless loaded_lib || ignore.include?("hpricot")
+      begin
+        require 'hpricot'
+        require 'oembed_links/formatters/hpricot_xml'
+        self.register_formatter(OEmbed::Formatters::HpricotXML)        
+        loaded_lib = true
+      rescue LoadError
+        puts "Error loading Hpricot XML formatter"
+      end      
+    end
+    unless loaded_lib || ignore.include?("rexml")
+      require 'oembed_links/formatters/ruby_xml'
+      self.register_formatter(OEmbed::Formatters::RubyXML) 
+      loaded_lib = true
+    end
+    raise StandardError.new("No XML formatter could be autodetected") unless loaded_lib
+  end
+
   private
 
   # stupid simple copy of URI.extract to allow for looser URI detection
@@ -316,9 +355,8 @@ class OEmbed
       end
     end    
   end
-  
-  
 end
-require 'oembed_links/formatters/json'
-require 'oembed_links/formatters/xml'
-require 'oembed_links/fetchers/net_http'    
+
+
+OEmbed.load_default_libs
+

data/oembed_links.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name       = "oembed_links"
-    s.version    = "0.0.5"
+    s.version    = "0.0.6"
     s.author     = "Indianapolis Star"
     s.email      = "bugs at indystar dot com"
     s.homepage   = "http://www.indystar.com"
@@ -11,5 +11,4 @@ Gem::Specification.new do |s|
     s.has_rdoc          = true
     s.extra_rdoc_files  = ['README']
     s.add_dependency(%q<json>)
-    s.add_dependency(%q<libxml-ruby>)
 end

data/spec/oembed_links_spec.rb

@@ -5,6 +5,7 @@ describe OEmbed, "registration tasks" do
   
   before(:each) do
     OEmbed.clear_registrations
+    OEmbed.load_default_libs
     clear_urls
   end
 
@@ -62,12 +63,53 @@ describe OEmbed, "registration tasks" do
     OEmbed.transform("http://fake/bar/baz").should == "http://fakesville"
   end
 
+  it "should allow selective loading of formatters through the load_default_libs function" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::LibXML
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml")
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::HpricotXML
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml", "hpricot")
+    OEmbed.instance_variable_get("@formatters")["xml"].class.should == OEmbed::Formatters::RubyXML    
+  end
+
+  it "should support the hpricot formatter" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml")
+    url_provides(<<-EOXML)
+<?xml version="1.0"?>
+<oembed>
+  <html>bar</html>
+</oembed>
+    EOXML
+    OEmbed.register_provider(:test, "http://test4/oembed.{format}", "xml", "http://test.*/*")
+    OEmbed.transform("http://test.com/bar/baz").should == "bar"
+  end
+
+  it "should support the rexml formatter" do
+    OEmbed.clear_registrations
+    OEmbed.load_default_libs("libxml", "hpricot")
+    url_provides(<<-EOXML)
+<?xml version="1.0"?>
+<oembed>
+  <html>barxml</html>
+</oembed>
+    EOXML
+    OEmbed.register_provider(:test, "http://test4/oembed.{format}", "xml", "http://test.*/*")
+    OEmbed.transform("http://test.com/bar/baz").should == "barxml"
+  end  
+
+  
+
 end
 
 describe OEmbed, "transforming functions" do
   include SpecHelper
   before(:each) do
     OEmbed.clear_registrations
+    OEmbed.load_default_libs
     clear_urls
     url_provides({
      "html" => "foo",
@@ -181,6 +223,7 @@ describe OEmbed, "Rails template resolving functions" do
   include SpecHelper
   before(:each) do
     OEmbed.clear_registrations
+    OEmbed.load_default_libs    
     clear_urls
     url_provides({
      "html" => "foo",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netshade-oembed_links
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Indianapolis Star
@@ -21,15 +21,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: libxml-ruby
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 description: 
 email: bugs at indystar dot com
 executables: []

data/lib/oembed_links/formatters/xml.rb

@@ -1,36 +0,0 @@
-require 'libxml'
-
-class OEmbed
-  module Formatters
-    class LibXML
-      
-      def name
-        "xml"
-      end
-
-      # This is an extremely naive XML doc to hash
-      # formatter.  Cases like arrays represented in
-      # XML will not work; only strings, ints and
-      # floats will be converted.
-      def format(txt)
-        parser = ::LibXML::XML::Parser.string(txt)
-        doc = parser.parse
-        h = { }
-        doc.root.children.each do |node|
-          unless node.name.strip.empty?
-            c = node.content
-            if c =~ /^[0-9]+$/
-              c = c.to_i
-            elsif c=~ /^[0-9]+\.[0-9]+$/
-              c = c.to_f
-            end
-            h[node.name.strip] = c
-          end
-        end
-        return h
-      end
-      
-    end
-  end
-end
-OEmbed.register_formatter(OEmbed::Formatters::LibXML)