glennr_opensrs 0.3.3

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

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "opensrs"
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Delsman", "Glenn Roberts"]
+  s.date = "2013-03-11"
+  s.description = "Provides support to utilize the OpenSRS API with Ruby/Rails."
+  s.email = "jdelsman@voxxit.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "lib/opensrs.rb",
+    "lib/opensrs/response.rb",
+    "lib/opensrs/server.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/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 = "http://github.com/voxxit/opensrs"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "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>, ["~> 2.1.2"])
+      s.add_development_dependency(%q<nokogiri>, ["~> 1.4.6"])
+      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<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<libxml-ruby>, ["~> 2.1.2"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.4.6"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<libxml-ruby>, ["~> 2.1.2"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.4.6"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 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,109 @@
+require 'spec_helper'
+
+describe OpenSRS::Server do
+  let(:server) { OpenSRS::Server.new }
+
+  describe '#new' do
+    it 'allows timeouts to be set' do
+      server = OpenSRS::Server.new({ :timeout => 90 })
+      server.timeout.should == 90
+      server.open_timeout.should be_nil
+    end
+
+    it 'allows open timeouts to be set' do
+      server = OpenSRS::Server.new({ :timeout => 90, :open_timeout => 10 })
+      server.timeout.should eq(90)
+      server.open_timeout.should eq(10)
+    end
+
+    it 'leaves it up to Net::HTTP if no timeouts given' do
+      server.timeout.should be_nil
+      server.open_timeout.should be_nil
+    end
+  end
+
+  describe ".call" do
+    let(:response) { double(:body => 'some response') }
+    let(:header) { {"some" => "header" } }
+    let(:xml) { '<some xml></some xml>' }
+    let(:response_xml) { xml }
+    let(:xml_processor) { double OpenSRS::XmlProcessor }
+    let(:http) { double(Net::HTTP, :use_ssl= => true, :verify_mode= => true)  }
+
+    before :each do
+      server.stub(:headers).and_return header
+      xml_processor.stub(:build).and_return xml
+      xml_processor.stub(:parse).and_return response_xml
+      server.stub(:xml_processor).and_return xml_processor
+      http.stub(:post).and_return response
+      Net::HTTP.stub(:new).and_return http
+    end
+
+    it "builds XML request" do
+      xml_processor.should_receive(:build).with(:protocol => "XCP", :some => 'option')
+      server.call(:some => 'option')
+    end
+
+    it "posts to given path" do
+      server.server = URI.parse 'http://with-path.com/endpoint'
+      http.should_receive(:post).with('/endpoint', xml, header).and_return double.as_null_object
+      server.call
+    end
+
+    it "parses the response" do
+      xml_processor.should_receive(:parse).with(response.body)
+      server.call(:some => 'option')
+    end
+
+    it "posts to root path" do
+      server.server = URI.parse 'http://root-path.com/'
+      http.should_receive(:post).with('/', xml, header).and_return double.as_null_object
+      server.call
+    end
+
+    it "defaults path to '/'" do
+      server.server = URI.parse 'http://no-path.com'
+      http.should_receive(:post).with('/', xml, header).and_return double.as_null_object
+      server.call
+    end
+
+    it 'allows overriding of default (Net:HTTP) timeouts' do
+      server.timeout = 90
+
+      http.should_receive(:open_timeout=).with(90)
+      http.should_receive(:read_timeout=).with(90)
+
+      server.call( { :some => 'data' } )
+    end
+
+    it 'allows overriding of default (Net:HTTP) timeouts' do
+      server.timeout = 180
+      server.open_timeout = 30
+
+      http.should_receive(:read_timeout=).with(180)
+      http.should_receive(:open_timeout=).with(180)
+      http.should_receive(:open_timeout=).with(30)
+
+      server.call( { :some => 'data' } )
+    end
+
+    it 're-raises Net:HTTP timeouts' do
+      http.should_receive(:post).and_raise err = Timeout::Error.new('test')
+      expect { server.call }.to raise_exception OpenSRS::TimeoutError
+    end
+  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.3")
+    end
+  end
+end

data/spec/opensrs/xml_processor/libxml_spec.rb

@@ -0,0 +1,254 @@
+require 'spec_helper'
+require 'date'
+
+describe OpenSRS::XmlProcessor::Libxml do
+  describe ".build" do    
+    it "should create XML for a nested hash" do
+      attributes = {:foo => {:bar => 'baz'}}
+      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::XmlProcessor::Libxml.encode_data([1,2,3])
+      end
+      
+      it "is a REXML::Element" do
+        @e.should be_an_instance_of(LibXML::XML::Node)
+      end
+
+      it "is a dt_array" do
+        @e.name.should == 'dt_array'
+      end
+
+      it "has 3 children all called <item>" do
+        @e.should have(3).children
+        @e.children[0].name.should == "item"
+        @e.children[1].name.should == "item"
+        @e.children[2].name.should == "item"
+      end
+
+      it "has children with keys 0, 1 and 2" do
+        @e.children[0].attributes["key"].should == "0"
+        @e.children[1].attributes["key"].should == "1"
+        @e.children[2].attributes["key"].should == "2"
+      end
+    end
+
+    context "on a hash" do
+      before(:each) do
+        @e = OpenSRS::XmlProcessor::Libxml.encode_data({:name => "kitteh"})
+      end
+
+      it "is a REXML::Element" do
+        @e.should be_an_instance_of(LibXML::XML::Node)
+      end
+
+      it "is a dt_assoc" do
+        @e.name.should == 'dt_assoc'
+      end
+
+      it "has an <item> child with the right key" do
+        @e.should have(1).children
+        @e.children[0].name.should == 'item'
+        @e.children[0].attributes["key"].should == 'name'
+      end
+    end
+    
+    context "on a nested hash" do
+      before(:each) do
+        @e = OpenSRS::XmlProcessor::Libxml.encode_data({:suggestion => {:maximum => "10"}})
+      end
+      
+      it "is a REXML::Element" do
+        @e.should be_an_instance_of(LibXML::XML::Node)
+      end
+
+      it "is a dt_assoc" do
+        @e.name.should == 'dt_assoc'
+      end
+      
+      it "has an <item> child with the correct children" do
+        @e.should have(1).children
+        suggestion = @e.children[0]
+        suggestion.name.should == 'item'
+        suggestion.attributes["key"].should == 'suggestion'
+        
+        suggestion.should have(1).children
+        dt_assoc = suggestion.children[0]
+        dt_assoc.name.should == 'dt_assoc'
+        
+        dt_assoc.should have(1).children
+        maximum = dt_assoc.children[0]
+        maximum.name.should == 'item'
+        maximum.attributes["key"].should == 'maximum'
+      end
+    end
+
+    context "produces a scalar" do
+      it "from a string" do
+        OpenSRS::XmlProcessor::Libxml.encode_data("cheezburger").to_s.should == "cheezburger"
+      end
+
+      it "from a string with XML characters" do
+        OpenSRS::XmlProcessor::Libxml.encode_data("<smile>").to_s.should == "<smile>"
+      end
+
+      it "from an integer" do
+        OpenSRS::XmlProcessor::Libxml.encode_data(12345).to_s.should == "12345"
+      end
+
+      it "from a date" do
+        date = Date.parse("2010/02/12")
+        OpenSRS::XmlProcessor::Libxml.encode_data(date).to_s.should == "2010-02-12"
+      end
+
+      it "from a symbol" do
+        OpenSRS::XmlProcessor::Libxml.encode_data(:name).to_s.should == "name"
+      end
+
+      it "from true or false" do
+        OpenSRS::XmlProcessor::Libxml.encode_data(true).to_s.should == "true"
+        OpenSRS::XmlProcessor::Libxml.encode_data(false).to_s.should == "false"
+      end
+    end
+  end
+
+  describe '.parse' do
+    it "should handle scalar values" 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>}
+        
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
+      resp.should == "Tom Jones"
+    end
+    
+    it "should handle associate arrays with arrays of values" 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>}
+        
+      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"
+      resp["domain_list"][2].should == "ns3.example.com"
+    end
+    
+    it "should handle associative arrays containing other associative arrays" 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>}
+      
+      resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
+      
+      resp["contact_set"]["owner"]["first_name"].should == "Tom"
+      resp["contact_set"]["owner"]["last_name"].should == "Jones"
+      resp["contact_set"]["tech"]["first_name"].should == "Anne"
+      resp["contact_set"]["tech"]["last_name"].should == "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>}
+        
+        @resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
+      end
+
+      it "produces a hash" do
+        @resp.should be_an_instance_of(Hash)
+      end
+
+      it "has top level keys" do
+        @resp["protocol"].should == "XCP"
+        @resp["action"].should == "REPLY"
+        @resp["object"].should == "BALANCE"
+      end
+
+      it "has second level keys" do
+        @resp["attributes"]["balance"].should == "8549.18"
+        @resp["attributes"]["hold_balance"].should == "1676.05"
+      end
+    end
+  end
+end