opensrs 0.1.1 → 0.2.0

data/README.rdoc

@@ -15,9 +15,13 @@ You can then include it in a Ruby project, like so:
 
     require 'opensrs'
     
-Alternatively, you can include it in a Rails project in the <tt>environment.rb</tt> file, like so:
+Alternatively, you can include it in a Rails 2.x project in the <tt>environment.rb</tt> file, like so:
 
     config.gem "opensrs"
+    
+For Rails 3.x, use the <tt>Gemfile</tt>:
+
+    gem "opensrs"
 
 == Usage
 
@@ -31,14 +35,14 @@ This library provides basic functionality for interacting with the OpenSRS XML A
 To connect, instantiate a new OpenSRS::Server object:
 
     server = OpenSRS::Server.new(
-      :server => "https://rr-n1-tor.opensrs.net:55443/",
+      :server   => "https://rr-n1-tor.opensrs.net:55443/",
       :username => "testing",
       :password => "53cr3t",
-      :key => "c633be3170c7fb3fb29e2f99b84be24107b37e206663967f8cdfarandomc17d411fc28b3dbff47d03c51c61279bd6f3c545a3210777ab93b44e6aef5e23d82"
+      :key      => "c633be3170c7fb3fb29e2f99b84be2410..."
     )
     
-Once you have this, you can build from this to create the methods that you need. For instance, let's say we want to grab our balance. The
-OpenSRS XML API takes a couple of attributes for all commands. You can include those here:
+Once you have this, you can build from this to create the methods that you need. For instance, let's say we want to grab 
+our account balance. The OpenSRS XML API takes a couple of attributes for all commands. You can include those here:
 
     def get_balance
       server.call(

data/Rakefile

@@ -7,10 +7,12 @@ begin
     gem.name = "opensrs"
     gem.summary = %Q{Provides support to utilise the OpenSRS API with Ruby/Rails.}
     gem.description = %Q{Provides support to utilise the OpenSRS API with Ruby/Rails.}
-    gem.email = "jdelsman@voxxit.com"
+    gem.email = "josh@voxx.it"
     gem.homepage = "http://github.com/voxxit/opensrs"
     gem.authors = ["Josh Delsman"]
+    gem.add_dependency "libxml-ruby"
     gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "rspec"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
@@ -52,4 +54,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "opensrs #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/opensrs/response.rb

@@ -13,11 +13,17 @@ module OpenSRS
     # We need to return the error message unless the
     # response is successful.
     def errors
-      "#{response["response_text"]} (Code #{response["response_code"]})" unless success?
+      if !success?
+        if response["response_text"] and response["response_code"]
+          "#{response["response_text"]} (Code #{response["response_code"]})"
+        else
+          "Unknown error"
+        end
+      end
     end
   
     def success?
-      response["is_success"].to_s == "1"
+      response["is_success"] ? response["is_success"].to_s == "1" : true
     end
   end
 end

data/lib/opensrs/server.rb

@@ -1,7 +1,7 @@
-require 'uri'
-require 'net/https'
-require 'digest/md5'
-require 'openssl'
+require "uri"
+require "net/https"
+require "digest/md5"
+require "openssl"
 
 module OpenSRS
   class Server
@@ -48,7 +48,7 @@ module OpenSRS
     
     def http
       http = Net::HTTP.new(server.host, server.port)
-      http.use_ssl = (server.scheme == 'https')
+      http.use_ssl = (server.scheme == "https")
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       http
     end

data/lib/opensrs/xml.rb

@@ -1,138 +1,117 @@
-require 'rexml/document'
+require "libxml"
 
 module OpenSRS
   class XML
-    include REXML
+    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.
     def self.build(data)
-      data = encode(data) unless data.kind_of?(REXML::Element)
+      xml = Document.new
+      xml.root = envelope = Node.new("OPS_envelope")
 
-      doc = Document.new
-      doc << XMLDecl.new("1.0", "UTF-8", "no")
-      doc << DocType.new("OPS_envelope", "SYSTEM 'ops.dtd'")
+      envelope << header = Node.new("header")
+      envelope << body = Node.new("body")
+      header   << Node.new("version", "0.9")
+      body     << data_block = Node.new("data_block")
 
-      root = Element.new("OPS_envelope", doc)
+      encode_data(data, data_block)
 
-      Element.new("version", Element.new("header", root)).add_text("0.9")
-      Element.new("data_block", Element.new("body", root)).add(data)
-
-      return doc.to_s
-    end
-
-    # Encodes individual elements, and their child elements, for the root 
-    # XML document.
-    def self.encode(data)
-      case data
-      when Array
-        element = Element.new("dt_array")
-
-        data.each_with_index do |v, j|
-          item = Element.new("item")
-          item.add_attribute("key", j.to_s)
-          item.add_element(encode(v)) 
-
-          element.add_element(item)
-        end
-
-        return element
-      when Hash
-        element = Element.new("dt_assoc")
-
-        data.each do |k, v|
-          item = Element.new("item")
-          item.add_attribute("key", k.to_s)
-          item.add_element(encode(v))
-          
-          element.add_element(item)
-        end
-
-        return element
-      when String, Numeric, Date, Time, Symbol, NilClass
-        element = Element.new("dt_scalar")
-        element.text = data.to_s
-
-        return element
-      else
-        # Give up, probably wrong!
-        return encode(data.inspect)
-      end
+      return xml.to_s
     end
 
     # Parses the main data block from OpenSRS and discards
     # the rest of the response.
     def self.parse(response)
-      response.gsub!(/<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">/, "")
-      response = Document.new(response) unless response.is_a?(REXML::Document)
+      doc = Parser.string(response).parse
+      data_block = doc.find("//OPS_envelope/body/data_block/*")
 
-      data_block_children = XPath.first(response, "//OPS_envelope/body/data_block/*")
+      raise ArgumentError.new("No data found in document") if !data_block
 
-      raise ArgumentError.new("No OPS_envelope found in document") unless data_block_children
-
-      return decode(data_block_children)
+      return decode_data(data_block)
     end
 
-    # Decodes individual data elements from OpenSRS response.
-    def self.decode(data)
-      if data.is_a?(String)
-        doc = Document.new(data)
-
-        if doc.children.length == 1
-          return decode(doc.children[0])
-        else
-          doc.children.map { |i| return decode(i) }
+    protected
+    
+    # Recursively decodes individual data elements from OpenSRS 
+    # server response.
+    def self.decode_data(data)
+      data.each do |element|
+        case element.name
+        when "dt_array"
+          arr = []
+
+          element.children.each do |item| 
+            next if item.empty?        
+            arr[item.attributes["key"].to_i] = decode_data(item)
+          end
+
+          return arr
+        when "dt_assoc"      
+          hash = {}
+
+          element.children.each do |item|
+            next if item.empty?        
+            hash[item.attributes["key"]] = decode_data(item)
+          end
+
+          return hash
+        when "text", "item", "dt_scalar"
+          next if element.empty?
+          return element.content.strip
         end
       end
+    end
+    
+    # Encodes individual elements, and their child elements, for the root 
+    # XML document.
+    def self.encode_data(data, container = nil)
+      case data.class.to_s
+      when "Array" then return encode_dt_array(data, container)
+      when "Hash"  then return encode_dt_assoc(data, container)
+      when "String", "Numeric", "Date", "Time", "Symbol", "NilClass"
+        return data.to_s
+      else
+        return data.inspect
+      end
 
-      # The OpenSRS server's response (and the client docs) don't always
-      # encapsulate scalars in <dt_scalar> as you'd expect - so we have to
-      # infer that unexpected raw text is always a scalar.
-      return guess_scalar(data.value) if data.is_a?(REXML::Text)
-
-      case data.name
-      when "dt_array"
-        array = []
+      return nil
+    end
 
-        data.elements.each("item") do |item| 
-          array[item.attributes["key"].to_i] = trim_and_decode(item.children)
-        end
+    def self.encode_dt_array(data, container)
+      dt_array = Node.new("dt_array")
 
-        return array
-      when "dt_assoc"
-        hash = {}
+      data.each_with_index do |item, index|
+        item_node = Node.new("item")
+        item_node["key"] = index.to_s
+        item_node << encode_data(item, item_node)
 
-        data.elements.each("item") do |item|
-          hash[item.attributes["key"]] = trim_and_decode(item.children)
-        end
+        dt_array << item_node
+      end
 
-        return hash
-      when /^dt_scalar(ref)?/ then return guess_scalar(data.value)
+      if container
+        container << dt_array
+      else
+        return dt_array
       end
     end
 
-    protected
+    def self.encode_dt_assoc(data, container)  
+      dt_assoc = Node.new("dt_assoc")
 
-    # Tries to correctly parse individual text into Date, Time, or Integers.
-    # If it fails, just displays the returned text.
-    def self.guess_scalar(text)
-      case text
-      when /^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/ then Time.parse(text)
-      when /^\d\d\d\d-\d\d-\d\d$/ then Date.parse(text)
-      else
-        text
+      data.each do |key, value|
+        item_node = Node.new("item")
+        item_node["key"] = key.to_s
+        item_node << encode_data(value, item_node)
+
+        dt_assoc << item_node
       end
-    end
 
-    # Decodes lists, such as contact lists.
-    def self.trim_and_decode(list)
-      return "" if list.length.zero?
-      return decode(list[0]) if list.length == 1
-      
-      first_non_text = list.select { |e| !e.kind_of?(REXML::Text) }[0]
-      
-      return decode(first_non_text) unless first_non_text.nil?
-      return decode(list[0])
+      if container
+        container << dt_assoc 
+      else
+        return dt_assoc
+      end
     end
   end
 end

data/spec/opensrs/xml_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+require 'date'
+
+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])
+      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::XML.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 "produces a scalar" do
+      it "from a string" do
+        OpenSRS::XML.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>"
+      end
+
+      it "from an integer" do
+        OpenSRS::XML.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"
+      end
+
+      it "from a symbol" do
+        OpenSRS::XML.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"
+      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::XML.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::XML.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::XML.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::XML.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

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'opensrs/xml.rb'

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: opensrs
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Delsman
@@ -9,21 +14,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-06 00:00:00 +00:00
+date: 2011-01-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: Provides support to utilise the OpenSRS API with Ruby/Rails.
-email: jdelsman@voxxit.com
+email: josh@voxx.it
 executables: []
 
 extensions: []
@@ -42,6 +76,8 @@ files:
 - lib/opensrs/response.rb
 - lib/opensrs/server.rb
 - lib/opensrs/xml.rb
+- spec/opensrs/xml_spec.rb
+- spec/spec_helper.rb
 - test/opensrs_test.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -54,24 +90,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides support to utilise the OpenSRS API with Ruby/Rails.
 test_files: 
+- spec/opensrs/xml_spec.rb
+- spec/spec_helper.rb
 - test/opensrs_test.rb
 - test/test_helper.rb