opensrs 0.2.1 → 0.3.0

data/lib/opensrs/xml_processor/nokogiri.rb

@@ -0,0 +1,59 @@
+begin
+  require 'nokogiri'
+rescue LoadError => e
+  $stderr.puts "Cannot find Nokogiri gem. Please install Nokogiri before using it as the xml processor\n\n"
+  raise e
+end
+
+module OpenSRS
+  class XmlProcessor::Nokogiri < OpenSRS::XmlProcessor
+
+    def self.build(data)
+      builder = ::Nokogiri::XML::Builder.new
+
+      envelope   = ::Nokogiri::XML::Node.new("OPS_envelope", builder.doc)
+      header     = ::Nokogiri::XML::Node.new("header", builder.doc)
+      version    = ::Nokogiri::XML::Node.new("version", builder.doc)
+      body       = ::Nokogiri::XML::Node.new("body", builder.doc)
+      data_block = ::Nokogiri::XML::Node.new("data_block", builder.doc)
+      other_data = encode_data(data, builder.doc)
+      builder.doc << envelope << header << version << '0.9'
+      envelope << body << data_block << other_data
+      return builder.to_xml
+    end
+
+    protected
+
+    def self.data_block_element(response)
+      doc = ::Nokogiri::XML(response)
+      return doc.xpath('//OPS_envelope/body/data_block/*')
+    end
+
+    def self.decode_dt_array_data(element)
+      dt_array = []
+
+      element.children.each do |item|
+        next if item.content.strip.empty?
+        dt_array[item.attributes["key"].value.to_i] = decode_data(item.children)
+      end
+
+      return dt_array
+    end
+
+    def self.decode_dt_assoc_data(element)
+      dt_assoc = {}
+
+      element.children.each do |item|
+        next if item.content.strip.empty?
+        dt_assoc[item.attributes["key"].value] = decode_data(item.children)
+      end
+
+      return dt_assoc
+    end
+
+    def self.new_element(element_name, container)
+      return ::Nokogiri::XML::Node.new(element_name.to_s, container)
+    end
+
+  end
+end

data/opensrs.gemspec

@@ -5,56 +5,77 @@
 
 Gem::Specification.new do |s|
   s.name = %q{opensrs}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Delsman"]
-  s.date = %q{2011-01-31}
-  s.description = %q{Provides support to utilise the OpenSRS API with Ruby/Rails.}
-  s.email = %q{josh@voxx.it}
+  s.date = %q{2011-05-09}
+  s.description = %q{Provides support to utilize the OpenSRS API with Ruby/Rails.}
+  s.email = %q{josh@voxxit.com}
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
-    "VERSION",
     "lib/opensrs.rb",
     "lib/opensrs/response.rb",
     "lib/opensrs/server.rb",
-    "lib/opensrs/xml.rb",
+    "lib/opensrs/version.rb",
+    "lib/opensrs/xml_processor.rb",
+    "lib/opensrs/xml_processor/libxml.rb",
+    "lib/opensrs/xml_processor/nokogiri.rb",
     "opensrs.gemspec",
-    "spec/opensrs/xml_spec.rb",
-    "spec/spec_helper.rb",
-    "test/opensrs_test.rb",
-    "test/test_helper.rb"
+    "spec/opensrs/server_spec.rb",
+    "spec/opensrs/version_spec.rb",
+    "spec/opensrs/xml_processor/libxml_spec.rb",
+    "spec/opensrs/xml_processor/nokogiri_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/voxxit/opensrs}
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{Provides support to utilise the OpenSRS API with Ruby/Rails.}
-  s.test_files = [
-    "spec/opensrs/xml_spec.rb",
-    "spec/spec_helper.rb",
-    "test/opensrs_test.rb",
-    "test/test_helper.rb"
-  ]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Provides support to utilize the OpenSRS API with Ruby/Rails.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<libxml-ruby>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<git>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.0"])
     else
-      s.add_dependency(%q<libxml-ruby>, [">= 0"])
+      s.add_dependency(%q<libxml-ruby>, ["~> 1.0.0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.0"])
     end
   else
-    s.add_dependency(%q<libxml-ruby>, [">= 0"])
+    s.add_dependency(%q<libxml-ruby>, ["~> 1.0.0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.0"])
   end
 end

data/spec/opensrs/server_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OpenSRS::Server do
+  before(:each) do
+    @server = OpenSRS::Server.new
+  end
+
+  describe "#test xml processor" do
+    context "on class initialization" do
+      it { @server.xml_processor.should eql(OpenSRS::XmlProcessor::Libxml) }
+    end
+
+    context "on changing xml processor" do
+      before(:each) do
+        OpenSRS::Server.xml_processor = :nokogiri
+      end
+
+      it { @server.xml_processor.should eql(OpenSRS::XmlProcessor::Nokogiri) }
+    end
+  end
+end

data/spec/opensrs/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe OpenSRS::Version do
+  describe "VERSION" do
+    it "should return version string" do
+      OpenSRS::Version::VERSION.should eql("0.3.0")
+    end
+  end
+end

data/spec/opensrs/{xml_spec.rb → xml_processor/libxml_spec.rb}

@@ -1,11 +1,11 @@
 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
@@ -13,7 +13,7 @@ describe OpenSRS::XML do
   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 @@ describe OpenSRS::XML do
 
     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 @@ describe OpenSRS::XML do
     
     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 @@ describe OpenSRS::XML do
 
     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 @@ describe OpenSRS::XML do
           </body>
         </OPS_envelope>}
         
-      resp = OpenSRS::XML.parse(xml)
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       resp.should == "Tom Jones"
     end
     
@@ -158,7 +158,7 @@ describe OpenSRS::XML do
         </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 @@ describe OpenSRS::XML do
         </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 @@ describe OpenSRS::XML do
             </body>
           </OPS_envelope>}
         
-        @resp = OpenSRS::XML.parse(xml)
+        @resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       end
 
       it "produces a hash" do

data/spec/opensrs/xml_processor/nokogiri_spec.rb

@@ -0,0 +1,228 @@
+require 'spec_helper'
+require 'date'
+
+describe OpenSRS::XmlProcessor::Nokogiri do
+  describe ".build" do
+    it "should create XML for a nested hash" do
+      attributes = {:foo => {:bar => 'baz'}}
+      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
+
+  describe '.encode_data' do
+    
+    before(:each) do
+      @builder = ::Nokogiri::XML::Builder.new
+      @doc     = @builder.doc
+    end
+
+    context "on a 3 element array" do
+      before(:each) do
+        @e = OpenSRS::XmlProcessor::Nokogiri.encode_data([1,2,3], @doc)
+      end
+
+      it { @e.should be_an_instance_of(::Nokogiri::XML::Element) }
+      it { @e.name.should eql('dt_array') }
+
+      it { @e.should have(3).children }
+      it { @e.children[0].name.should eql("item") }
+      it { @e.children[1].name.should eql("item") }
+      it { @e.children[2].name.should eql("item") }
+
+      it { @e.children[0].attributes["key"].value.should eql("0") }
+      it { @e.children[1].attributes["key"].value.should eql("1") }
+      it { @e.children[2].attributes["key"].value.should eql("2") }
+    end
+
+    context "on a hash" do
+      before(:each) do
+        @e = OpenSRS::XmlProcessor::Nokogiri.encode_data({:name => "kitteh"}, @doc)
+      end
+
+      it { @e.should be_an_instance_of(::Nokogiri::XML::Element) }
+      it { @e.name.should eql('dt_assoc') }
+
+      it { @e.should have(1).children }
+      it { @e.children[0].name.should eql('item') }
+      it { @e.children[0].attributes["key"].value.should eql('name') }
+    end
+
+    context "on a nested hash" do
+      before(:each) do
+        @e          = OpenSRS::XmlProcessor::Nokogiri.encode_data({:suggestion => {:maximum => "10"}}, @doc)
+        @suggestion = @e.children[0]
+        @dt_assoc   = @suggestion.children[0]
+      end
+
+      it { @e.should be_an_instance_of(::Nokogiri::XML::Element) }
+      it { @e.name.should == 'dt_assoc' }
+
+      context "<item> child" do
+        it { @e.should have(1).children }
+        it { @suggestion.name.should eql('item') }
+        it { @suggestion.attributes["key"].value.should eql('suggestion') }
+      end
+
+      context "suggesion children" do
+        it { @suggestion.should have(1).children }
+        it { @dt_assoc.name.should eql('dt_assoc') }
+      end
+
+      context "dt_assoc children" do
+        before(:each) do
+          @maximum = @dt_assoc.children[0]
+        end
+        it { @dt_assoc.should have(1).children }
+        it { @maximum.name.should eql('item') }
+        it { @maximum.attributes["key"].value.should eql('maximum') }
+      end
+    end
+
+    context "produces a scalar" do
+      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
+
+  describe '.parse' do
+    
+    context "when scaler values" do
+      before(:each) do
+        xml = %{<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
+          <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
+          <OPS_envelope>
+            <header>
+              <version>1.0</version>
+            </header>
+            <body>
+              <data_block>
+                <dt_scalar>Tom Jones</dt_scalar>
+              </data_block>
+            </body>
+          </OPS_envelope>}
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
+      end
+
+      it { @response.should eql("Tom Jones") }
+    end
+
+    context "when associative arrays with arrays of values" do
+      before(:each) do
+        xml = %{<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
+        <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
+        <OPS_envelope>
+          <header>
+            <version>1.0</version>
+          </header>
+          <body>
+            <data_block>
+              <dt_assoc>
+                <item key='domain_list'>
+                  <dt_array>
+                    <item key='0'>ns1.example.com</item>
+                    <item key='1'>ns2.example.com</item>
+                    <item key='2'>ns3.example.com</item>
+                  </dt_array>
+                </item>
+              </dt_assoc>
+            </data_block>
+          </body>
+        </OPS_envelope>}
+
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
+      end
+
+      it { @response["domain_list"].class.should eql(Array) }
+      it { @response["domain_list"][0].should eql("ns1.example.com") }
+      it { @response["domain_list"][1].should eql("ns2.example.com") }
+      it { @response["domain_list"][2].should eql("ns3.example.com") }
+    end
+
+    context "when associative arrays containing other associative arrays" do
+      before(:each) do
+        xml = %{<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
+        <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
+        <OPS_envelope>
+          <header>
+            <version>1.0</version>
+          </header>
+          <body>
+            <data_block>
+              <dt_assoc>
+                <item key="contact_set">
+                  <dt_assoc>
+                    <item key='owner'>
+                      <dt_assoc>
+                        <item key='first_name'>Tom</item>
+                        <item key='last_name'>Jones</item>
+                      </dt_assoc>
+                    </item>
+                    <item key='tech'>
+                      <dt_assoc>
+                        <item key='first_name'>Anne</item>
+                        <item key='last_name'>Smith</item>
+                      </dt_assoc>
+                    </item>
+                  </dt_assoc>
+                </item>
+              </dt_assoc>
+            </data_block>
+          </body>
+        </OPS_envelope>}
+
+        @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") }
+      it { @response["contact_set"]["tech"]["first_name"].should eql("Anne") }
+      it { @response["contact_set"]["tech"]["last_name"].should eql("Smith") }
+    end
+
+    context "with a balance enquiry example response" do
+      before(:each) do
+        xml = %{<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
+          <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
+          <OPS_envelope>
+            <header>
+              <version>0.9</version>
+            </header>
+            <body>
+              <data_block>
+                <dt_assoc>
+                  <item key="protocol">XCP</item>
+                  <item key="action">REPLY</item>
+                  <item key="object">BALANCE</item>
+                  <item key="is_success">1</item>
+                  <item key="response_code">200</item>
+                  <item key="response_text">Command successful</item>
+                  <item key="attributes">
+                    <dt_assoc>
+                      <item key="balance">8549.18</item>
+                      <item key="hold_balance">1676.05</item>
+                    </dt_assoc>
+                  </item>
+                </dt_assoc>
+              </data_block>
+            </body>
+          </OPS_envelope>}
+
+        @response = OpenSRS::XmlProcessor::Nokogiri.parse(xml)
+      end
+
+      it { @response.should be_an_instance_of(Hash) }
+      it { @response["protocol"].should eql("XCP") }
+      it { @response["action"].should eql("REPLY") }
+      it { @response["object"].should eql("BALANCE") }
+      it { @response["attributes"]["balance"].should eql("8549.18") }
+      it { @response["attributes"]["hold_balance"].should eql("1676.05") }
+
+    end
+  end
+end