opensrs 0.2.1 → 0.3.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "libxml-ruby", "~> 1.0.0"
+
+group :development do
+  gem "nokogiri"
+  gem "jeweler"
+  gem "git"
+  gem "rake"
+  gem "bundler"
+  gem "yard"
+  gem "shoulda"
+  gem "rspec", "~> 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    libxml-ruby (1.0.0)
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    shoulda (2.11.3)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  git
+  jeweler
+  libxml-ruby (~> 1.0.0)
+  nokogiri
+  rake
+  rspec (~> 2.0)
+  shoulda
+  yard

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Josh Delsman
+Copyright (c) 2010-2011 Josh Delsman
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,7 +1,7 @@
 = OpenSRS
 
-Provides basic support to connect to, and utilise the OpenSRS API. This library has been well-tested in a high performance production
-environment. More information on the API can be located here:
+This (unofficial) OpenSRS gem provides basic support to connect to, and utilize the OpenSRS API. This library has been well-tested in high-performance production
+environments. More information on the API can be located here:
 
 http://opensrs.com/resources/documentation/opensrs_xmlapi.pdf
 
@@ -9,19 +9,19 @@ http://opensrs.com/resources/documentation/opensrs_xmlapi.pdf
 
 You can install this gem by doing the following:
 
-    $ gem install opensrs
+  $ gem install opensrs
     
 You can then include it in a Ruby project, like so:
 
-    require 'opensrs'
+  require 'opensrs'
     
 Alternatively, you can include it in a Rails 2.x project in the <tt>environment.rb</tt> file, like so:
 
-    config.gem "opensrs"
+  config.gem "opensrs"
     
 For Rails 3.x, use the <tt>Gemfile</tt>:
 
-    gem "opensrs"
+  gem "opensrs"
 
 == Usage
 
@@ -32,38 +32,43 @@ This library provides basic functionality for interacting with the OpenSRS XML A
 * XML encoding
 * XML decoding
 
-To connect, instantiate a new OpenSRS::Server object:
+Currently, the library supports LibXML and Nokogiri as XML parsers. By default, it uses LibXML to parse and generate XML. If you'd like to use Nokogiri for parsing XML, then in one of your app initializers add the following line:
 
-    server = OpenSRS::Server.new(
-      :server   => "https://rr-n1-tor.opensrs.net:55443/",
-      :username => "testing",
-      :password => "53cr3t",
-      :key      => "c633be3170c7fb3fb29e2f99b84be2410..."
+  OpenSRS::Server.xml_processor = :nokogiri
+
+To connect, instantiate a new <tt>OpenSRS::Server</tt> object:
+
+  server = OpenSRS::Server.new(
+    :server   => "https://rr-n1-tor.opensrs.net:55443/",
+    :username => "testing",
+    :password => "53cr3t",
+    :key      => "c633be3170c7fb3fb29e2f99b84be2410..."
+  )
+
+NOTE: Connecting to OpenSRS requires that you add the IP(s) you're connecting from to their whitelist. Login to the testing or production servers, and add your IP(s) under Profile Management > Add IPs for Script/API Access. IP changes take about one hour to take effect.
+
+Once you have a server connection class, 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(
+      :action => "GET_BALANCE",
+      :object => "BALANCE"
     )
-    
-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(
-        :action => "GET_BALANCE",
-        :object => "BALANCE"
-      )
-    end
+  end
     
 Sometimes you might need to include attributes for the command, such as a cookie, or the data attributes themselves. You can do this, too:
 
-    def create_nameserver(nameserver)
-      server.call(
-        :action => "CREATE",
-        :object => "NAMESERVER",
-        :cookie => "366828736:3210384",
-        :attributes => {
-          :name => nameserver.hostname,
-          :ipaddress => "212.112.123.11"
-        }
-      )
-    end
+  def create_nameserver(nameserver)
+    server.call(
+      :action => "CREATE",
+      :object => "NAMESERVER",
+      :cookie => "366828736:3210384",
+      :attributes => {
+        :name => nameserver.hostname,
+        :ipaddress => "212.112.123.11"
+      }
+    )
+  end
     
 Responses from OpenSRS are returned in an OpenSRS::Response object, which gives you access to a multitude of things.
 
@@ -80,14 +85,13 @@ If you have any bugs or feature requests for this gem, feel free to add them in
 http://github.com/voxxit/opensrs/issues
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
 * Commit, do not mess with rakefile, version, or history. If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2010 Josh Delsman. See LICENSE for details.
+Copyright (c) 2010-2011 Josh Delsman. Distributed under the MIT license. See LICENSE for details.

data/Rakefile

@@ -1,56 +1,46 @@
 require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift("lib")
+
 require 'rake'
+require 'opensrs'
 
 begin
   require 'jeweler'
+  
   Jeweler::Tasks.new do |gem|
-    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 = "josh@voxx.it"
-    gem.homepage = "http://github.com/voxxit/opensrs"
-    gem.authors = ["Josh Delsman"]
-    gem.add_dependency "libxml-ruby"
-    gem.add_development_dependency "rspec", "~> 2.0"
+    gem.name        = "opensrs"
+    gem.version     = OpenSRS::Version::VERSION
+    gem.summary     = "Provides support to utilize the OpenSRS API with Ruby/Rails."
+    gem.description = "Provides support to utilize the OpenSRS API with Ruby/Rails."
+    gem.email       = "josh@voxxit.com"
+    gem.homepage    = "http://github.com/voxxit/opensrs"
+    gem.license     = "MIT"
+    gem.authors     = ["Josh Delsman"]
+    
+    # Requirements are in Gemfile
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+require 'rspec/core/rake_task'
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+require 'yard'
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "opensrs #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+YARD::Rake::YardocTask.new do |t|
+  t.files = FileList['lib/**/*.rb']
 end

data/lib/opensrs.rb

@@ -1,6 +1,8 @@
+require File.dirname(__FILE__) + '/opensrs/xml_processor'
+require File.dirname(__FILE__) + '/opensrs/xml_processor/libxml.rb'
 require File.dirname(__FILE__) + '/opensrs/server.rb'
 require File.dirname(__FILE__) + '/opensrs/response.rb'
-require File.dirname(__FILE__) + '/opensrs/xml.rb'
+require File.dirname(__FILE__) + '/opensrs/version.rb'
 
 module OpenSRS
 end

data/lib/opensrs/server.rb

@@ -4,6 +4,8 @@ require "digest/md5"
 require "openssl"
 
 module OpenSRS
+  class BadResponse < StandardError; end
+  
   class Server
     attr_accessor :server, :username, :password, :key
 
@@ -19,13 +21,26 @@ module OpenSRS
         :protocol => "XCP"
       }
       
-      xml = OpenSRS::XML.build(attributes.merge!(options))
-      
-      response = http.post(server.path, xml, headers(xml))
-      parsed_response = OpenSRS::XML.parse(response.body)
+      xml = xml_processor.build(attributes.merge!(options))
+
+      response        = http.post(server.path, xml, headers(xml))
+      parsed_response = xml_processor.parse(response.body)
       
       return OpenSRS::Response.new(parsed_response, xml, response.body)
+    rescue Net::HTTPBadResponse
+      raise OpenSRS::BadResponse, "Received a bad response from OpenSRS. Please check that your IP address is added to the whitelist, and try again."
+    end
+
+    def xml_processor
+      @@xml_processor
     end
+
+    def self.xml_processor=(name)
+      require File.dirname(__FILE__) + "/xml_processor/#{name.to_s.downcase}"
+      @@xml_processor = OpenSRS::XmlProcessor.const_get("#{name.to_s.capitalize}")
+    end
+
+    OpenSRS::Server.xml_processor = :libxml
     
     private
     
@@ -53,4 +68,4 @@ module OpenSRS
       http
     end
   end
-end
+end

data/lib/opensrs/version.rb

@@ -0,0 +1,5 @@
+module OpenSRS
+  class Version
+    VERSION = "0.3.0"
+  end
+end

data/lib/opensrs/xml_processor.rb

@@ -0,0 +1,77 @@
+module OpenSRS
+
+  class XmlProcessor
+
+    # Parses the main data block from OpenSRS and discards
+    # the rest of the response.
+    def self.parse(response)
+      data_block = data_block_element(response)
+
+      raise ArgumentError.new("No data found in document") if !data_block
+
+      return decode_data(data_block)
+    end
+
+    protected
+
+    # 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
+
+      return nil
+    end
+
+    def self.encode_dt_array(data, container)
+      dt_array = new_element(:dt_array, container)
+
+      data.each_with_index do |item, index|
+        item_node = new_element(:item, container)
+        item_node["key"] = index.to_s
+        item_node << encode_data(item, item_node)
+
+        dt_array << item_node
+      end
+
+      return dt_array
+    end
+
+    def self.encode_dt_assoc(data, container)
+      dt_assoc = new_element(:dt_assoc, container)
+
+      data.each do |key, value|
+        item_node = new_element(:item, container)
+        item_node["key"] = key.to_s
+        item_node << encode_data(value, item_node)
+
+        dt_assoc << item_node
+      end
+
+      return dt_assoc
+    end
+
+    # Recursively decodes individual data elements from OpenSRS
+    # server response.
+    def self.decode_data(data)
+      data.each do |element|
+        case element.name
+        when "dt_array"
+          return decode_dt_array_data(element)
+        when "dt_assoc"
+          return decode_dt_assoc_data(element)
+        when "text", "item", "dt_scalar"
+          next if element.content.strip.empty?
+          return element.content.strip
+        end
+      end
+    end
+
+  end
+
+end

data/lib/opensrs/xml_processor/libxml.rb

@@ -0,0 +1,60 @@
+require "libxml"
+
+module OpenSRS
+  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.
+    def self.build(data)
+      xml = Document.new
+      xml.root = envelope = Node.new("OPS_envelope")
+
+      envelope << header = Node.new("header")
+      envelope << body = Node.new("body")
+      header   << Node.new("version", "0.9")
+      body     << data_block = Node.new("data_block")
+
+      data_block << encode_data(data, data_block)
+
+      return xml.to_s
+    end
+
+    protected
+
+    def self.data_block_element(response)
+      doc = Parser.string(response).parse
+      return doc.find("//OPS_envelope/body/data_block/*")
+    end
+
+    def self.decode_dt_array_data(element)
+      dt_array = []
+
+      element.children.each do |item|
+        next if item.empty?
+        dt_array[item.attributes["key"].to_i] = decode_data(item)
+      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"]] = decode_data(item)
+      end
+
+      return dt_assoc
+    end
+
+    # Accepts two parameters but uses only one; to keep the interface same as other xml parser classes
+    # Is that a side effect of Template pattern?
+    #
+    def self.new_element(element_name, container)
+      return Node.new(element_name.to_s)
+    end
+
+  end
+end