Organize xml processor classes.

themgt · Apr 27, 2011 · 5028fc1 · 5028fc1
1 parent 614db50
commit 5028fc1
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 39 deletions.
diff --git a/lib/opensrs/xml_processor.rb b/lib/opensrs/xml_processor.rb
@@ -0,0 +1,7 @@
+module OpenSRS
+
+  class XmlProcessor
+
+  end
+
+end
diff --git a/lib/opensrs/xml.rb → lib/opensrs/xml_processor/libxml.rb b/lib/opensrs/xml.rb → lib/opensrs/xml_processor/libxml.rb
@@ -1,8 +1,8 @@
 require "libxml"
 
 module OpenSRS
-  class XML
-    include LibXML::XML
+  class XmlProcessor::Libxml < OpenSRS::XmlProcessor
+    include ::LibXML::XML
 
     # First, builds REXML elements for the inputted data. Then, it will
     # go ahead and build the entire XML document to send to OpenSRS.

diff --git a/lib/opensrs/nokogiri.rb → lib/opensrs/xml_processor/nokogiri.rb b/lib/opensrs/nokogiri.rb → lib/opensrs/xml_processor/nokogiri.rb
@@ -1,7 +1,12 @@
-require "nokogiri"
+begin
+  require 'nokogiri'
+rescue LoadError => e
+  $stderr.puts "You don't have nokogiri installed in your application. Please install the Nokogiri gem before using it as the xml processor"
+  raise e
+end
 
 module OpenSRS
-  class Nokogiri
+  class XmlProcessor::Nokogiri < OpenSRS::XmlProcessor
 
     def self.build(data)
       builder = ::Nokogiri::XML::Builder.new

diff --git a/spec/opensrs/xml_spec.rb → spec/opensrs/xml_processor/libxml_spec.rb b/spec/opensrs/xml_spec.rb → spec/opensrs/xml_processor/libxml_spec.rb
@@ -1,19 +1,19 @@
 require 'spec_helper'
 require 'date'
 
-describe OpenSRS::XML do
+describe OpenSRS::XmlProcessor::Libxml do
   describe ".build" do    
     it "should create XML for a nested hash" do
       attributes = {:foo => {:bar => 'baz'}}
-      xml = OpenSRS::XML.build(attributes)
+      xml = OpenSRS::XmlProcessor::Libxml.build(attributes)
       xml.should eq %{<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OPS_envelope>\n  <header>\n    <version>0.9</version>\n  </header>\n  <body>\n    <data_block>\n      <dt_assoc>\n        <item key=\"foo\">\n          <dt_assoc>\n            <item key=\"bar\">baz</item>\n          </dt_assoc>\n        </item>\n      </dt_assoc>\n    </data_block>\n  </body>\n</OPS_envelope>\n}
     end
   end
 
   describe '.encode_data' do
     context "on a 3 element array" do
       before(:each) do
-        @e = OpenSRS::XML.encode_data([1,2,3])
+        @e = OpenSRS::XmlProcessor::Libxml.encode_data([1,2,3])
       end
 
       it "is a REXML::Element" do
@@ -40,7 +40,7 @@
 
     context "on a hash" do
       before(:each) do
-        @e = OpenSRS::XML.encode_data({:name => "kitteh"})
+        @e = OpenSRS::XmlProcessor::Libxml.encode_data({:name => "kitteh"})
       end
 
       it "is a REXML::Element" do
@@ -60,7 +60,7 @@
 
     context "on a nested hash" do
       before(:each) do
-        @e = OpenSRS::XML.encode_data({:suggestion => {:maximum => "10"}})
+        @e = OpenSRS::XmlProcessor::Libxml.encode_data({:suggestion => {:maximum => "10"}})
       end
 
       it "is a REXML::Element" do
@@ -90,29 +90,29 @@
 
     context "produces a scalar" do
       it "from a string" do
-        OpenSRS::XML.encode_data("cheezburger").to_s.should == "cheezburger"
+        OpenSRS::XmlProcessor::Libxml.encode_data("cheezburger").to_s.should == "cheezburger"
       end
 
       it "from a string with XML characters" do
-        OpenSRS::XML.encode_data("<smile>").to_s.should == "<smile>"
+        OpenSRS::XmlProcessor::Libxml.encode_data("<smile>").to_s.should == "<smile>"
       end
 
       it "from an integer" do
-        OpenSRS::XML.encode_data(12345).to_s.should == "12345"
+        OpenSRS::XmlProcessor::Libxml.encode_data(12345).to_s.should == "12345"
       end
 
       it "from a date" do
         date = Date.parse("2010/02/12")
-        OpenSRS::XML.encode_data(date).to_s.should == "2010-02-12"
+        OpenSRS::XmlProcessor::Libxml.encode_data(date).to_s.should == "2010-02-12"
       end
 
       it "from a symbol" do
-        OpenSRS::XML.encode_data(:name).to_s.should == "name"
+        OpenSRS::XmlProcessor::Libxml.encode_data(:name).to_s.should == "name"
       end
 
       it "from true or false" do
-        OpenSRS::XML.encode_data(true).to_s.should == "true"
-        OpenSRS::XML.encode_data(false).to_s.should == "false"
+        OpenSRS::XmlProcessor::Libxml.encode_data(true).to_s.should == "true"
+        OpenSRS::XmlProcessor::Libxml.encode_data(false).to_s.should == "false"
       end
     end
   end
@@ -132,7 +132,7 @@
           </body>
         </OPS_envelope>}
 
-      resp = OpenSRS::XML.parse(xml)
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       resp.should == "Tom Jones"
     end
 
@@ -158,7 +158,7 @@
         </body>
       </OPS_envelope>}
 
-      resp = OpenSRS::XML.parse(xml)
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       resp["domain_list"].class.should == Array
       resp["domain_list"][0].should == "ns1.example.com"
       resp["domain_list"][1].should == "ns2.example.com"
@@ -196,7 +196,7 @@
         </body> 
       </OPS_envelope>}
 
-      resp = OpenSRS::XML.parse(xml)
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
 
       resp["contact_set"]["owner"]["first_name"].should == "Tom"
       resp["contact_set"]["owner"]["last_name"].should == "Jones"
@@ -232,7 +232,7 @@
             </body>
           </OPS_envelope>}
 
-        @resp = OpenSRS::XML.parse(xml)
+        @resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       end
 
       it "produces a hash" do

diff --git a/spec/opensrs/nokogiri_spec.rb → spec/opensrs/xml_processor/nokogiri_spec.rb b/spec/opensrs/nokogiri_spec.rb → spec/opensrs/xml_processor/nokogiri_spec.rb
@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'date'
 
-describe OpenSRS::Nokogiri do
+describe OpenSRS::XmlProcessor::Nokogiri do
   describe ".build" do
     it "should create XML for a nested hash" do
       attributes = {:foo => {:bar => 'baz'}}
-      xml = OpenSRS::Nokogiri.build(attributes)
+      xml = OpenSRS::XmlProcessor::Nokogiri.build(attributes)
       xml.should eq %{<?xml version=\"1.0\"?>\n<OPS_envelope>\n  <header>\n    <version>0.9</version>\n  </header>\n  <body>\n    <data_block>\n      <dt_assoc>\n        <item key=\"foo\">\n          <dt_assoc>\n            <item key=\"bar\">baz</item>\n          </dt_assoc>\n        </item>\n      </dt_assoc>\n    </data_block>\n  </body>\n</OPS_envelope>\n}
     end
   end
@@ -19,7 +19,7 @@
 
     context "on a 3 element array" do
       before(:each) do
-        @e = OpenSRS::Nokogiri.encode_data([1,2,3], @doc)
+        @e = OpenSRS::XmlProcessor::Nokogiri.encode_data([1,2,3], @doc)
       end
 
       it { @e.should be_an_instance_of(::Nokogiri::XML::Element) }
@@ -37,7 +37,7 @@
 
     context "on a hash" do
       before(:each) do
-        @e = OpenSRS::Nokogiri.encode_data({:name => "kitteh"}, @doc)
+        @e = OpenSRS::XmlProcessor::Nokogiri.encode_data({:name => "kitteh"}, @doc)
       end
 
       it{ @e.should be_an_instance_of(::Nokogiri::XML::Element) }
@@ -50,7 +50,7 @@
 
     context "on a nested hash" do
       before(:each) do
-        @e          = OpenSRS::Nokogiri.encode_data({:suggestion => {:maximum => "10"}}, @doc)
+        @e          = OpenSRS::XmlProcessor::Nokogiri.encode_data({:suggestion => {:maximum => "10"}}, @doc)
         @suggestion = @e.children[0]
         @dt_assoc   = @suggestion.children[0]
       end
@@ -80,14 +80,14 @@
     end
 
     context "produces a scalar" do
-      it { OpenSRS::Nokogiri.encode_data("cheezburger").to_s.should eql("cheezburger") }
-      it { OpenSRS::Nokogiri.encode_data("<smile>").to_s.should eql("<smile>") }
-
-      it { OpenSRS::Nokogiri.encode_data(12345).to_s.should eql("12345") }
-      it { OpenSRS::Nokogiri.encode_data(Date.parse("2010/02/12")).to_s.should eql("2010-02-12") }
-      it { OpenSRS::Nokogiri.encode_data(:name).to_s.should eql("name") }
-      it { OpenSRS::Nokogiri.encode_data(true).to_s.should eql("true") }
-      it { OpenSRS::Nokogiri.encode_data(false).to_s.should eql("false") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data("cheezburger").to_s.should eql("cheezburger") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data("<smile>").to_s.should eql("<smile>") }
+
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data(12345).to_s.should eql("12345") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data(Date.parse("2010/02/12")).to_s.should eql("2010-02-12") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data(:name).to_s.should eql("name") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data(true).to_s.should eql("true") }
+      it { OpenSRS::XmlProcessor::Nokogiri.encode_data(false).to_s.should eql("false") }
     end
   end
 
@@ -107,7 +107,7 @@
               </data_block>
             </body>
           </OPS_envelope>}
-        @response = OpenSRS::Nokogiri.parse(xml)
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
       end
 
       it { @response.should eql("Tom Jones") }
@@ -136,7 +136,7 @@
           </body>
         </OPS_envelope>}
 
-        @response = OpenSRS::Nokogiri.parse(xml)
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
       end
 
       it { @response["domain_list"].class.should eql(Array) }
@@ -177,7 +177,7 @@
           </body>
         </OPS_envelope>}
 
-        @response = OpenSRS::Nokogiri.parse(xml)
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
       end
       it { @response["contact_set"]["owner"]["first_name"].should eql("Tom") }
       it { @response["contact_set"]["owner"]["last_name"].should eql("Jones") }
@@ -213,7 +213,7 @@
             </body>
           </OPS_envelope>}
 
-        @response = OpenSRS::Nokogiri.parse(xml)
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
       end
 
       it { @response.should be_an_instance_of(Hash) }

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,2 +1,3 @@
-require 'opensrs/xml.rb'
-require 'opensrs/nokogiri.rb'
+require 'opensrs/xml_processor.rb'
+require 'opensrs/xml_processor/libxml.rb'
+require 'opensrs/xml_processor/nokogiri.rb'