opensrs 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Josh Delsman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= OpenSRS
+
+Provides basic support to connect to, and utilise the OpenSRS API. More information on the API can be located here:
+
+http://opensrs.com/resources/documentation/subreseller_xmlapi.pdf
+
+== 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.
+* 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.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+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 = "jdelsman@voxxit.com"
+    gem.homepage = "http://github.com/voxxit/opensrs"
+    gem.authors = ["Josh Delsman"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+  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
+
+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
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "opensrs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/opensrs.rb

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

data/lib/opensrs/response.rb

@@ -0,0 +1,20 @@
+module OpenSRS
+  class Response
+    attr_accessor :response, :success
+    
+    def initialize(response)
+      @response = response
+      @success = success?
+    end
+  
+    # We need to return the error message unless the
+    # response is successful.
+    def errors
+      "#{response["response_text"]} (Code #{response["response_code"]})" unless success?
+    end
+  
+    def success?
+      response["is_success"].to_s == "1"
+    end
+  end
+end

data/lib/opensrs/server.rb

@@ -0,0 +1,57 @@
+require 'uri'
+require 'net/https'
+require 'digest/md5'
+require 'openssl'
+
+module OpenSRS
+  class Server
+    attr_accessor :server, :username, :password, :key
+
+    def initialize(options = {})
+      @server   = URI.parse(options[:server] || "https://rr-n1-tor.opensrs.net:55443/")
+      @username = options[:username]
+      @password = options[:password]
+      @key      = options[:key]
+    end
+
+    def call(options = {})
+      xml = OpenSRS::XML.build({
+        :protocol   => "XCP",
+        :action     => options[:action],
+        :object     => options[:object],
+        :attributes => options[:attributes]
+      })
+      
+      response = http.post(server.path, xml, headers(xml))
+      parsed_response = OpenSRS::XML.parse(response.body)
+      
+      return OpenSRS::Response.new(parsed_response)
+    end
+    
+    private
+    
+    def headers(request)
+      headers = {
+        "Content-Length"  => request.length.to_s,
+        "Content-Type"    => "text/xml",
+        "X-Username"      => username,
+        "X-Signature"     => signature(request)
+      }
+      
+      return headers
+    end
+    
+    def signature(request)
+      signature = Digest::MD5.hexdigest(request + key)
+      signature = Digest::MD5.hexdigest(signature + key)
+      signature
+    end
+    
+    def http
+      http = Net::HTTP.new(server.host, server.port)
+      http.use_ssl = (server.scheme == 'https')
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
+  end
+end

data/lib/opensrs/xml.rb

@@ -0,0 +1,138 @@
+require 'rexml/document'
+
+module OpenSRS
+  class XML
+    include REXML
+    
+    # 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)
+
+      doc = Document.new
+      doc << XMLDecl.new("1.0", "UTF-8", "no")
+      doc << DocType.new("OPS_envelope", "SYSTEM 'ops.dtd'")
+
+      root = Element.new("OPS_envelope", doc)
+
+      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
+    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)
+
+      data_block_children = XPath.first(response, "//OPS_envelope/body/data_block/*")
+
+      raise ArgumentError.new("No OPS_envelope found in document") unless data_block_children
+
+      return decode(data_block_children)
+    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) }
+        end
+      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 = []
+
+        data.elements.each("item") do |item| 
+          array[item.attributes["key"].to_i] = trim_and_decode(item.children)
+        end
+
+        return array
+      when "dt_assoc"
+        hash = {}
+
+        data.elements.each("item") do |item|
+          hash[item.attributes["key"]] = trim_and_decode(item.children)
+        end
+
+        return hash
+      when /^dt_scalar(ref)?/ then return guess_scalar(data.value)
+      end
+    end
+
+    protected
+
+    # 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
+      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])
+    end
+  end
+end

data/test/opensrs_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class OpenSRSTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'opensrs'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: opensrs
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josh Delsman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-01 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides support to utilise the OpenSRS API with Ruby/Rails.
+email: jdelsman@voxxit.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/opensrs.rb
+- lib/opensrs/response.rb
+- lib/opensrs/server.rb
+- lib/opensrs/xml.rb
+- test/opensrs_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/voxxit/opensrs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides support to utilise the OpenSRS API with Ruby/Rails.
+test_files: 
+- test/opensrs_test.rb
+- test/test_helper.rb