opensrs 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 127ecdac1c36fe084303d59efca748da537ce37a
-  data.tar.gz: f4018a9dd533a217dcc80f6692e642f28d38cd4d
+  metadata.gz: cef55dd62d0db183b1f6e3e85518268695882e8d
+  data.tar.gz: 1a195f62bdb2cd02ba0c9d6b4d90a7392ea4c386
 SHA512:
-  metadata.gz: 9268aa3a9cca1924ca1b8e40257caaeb630cb3133dd78562ef734ca1e291e0467d4b927ecfac4f0c3698667b7d2772854796ff89f8a8b0c868a80c93d3a4d278
-  data.tar.gz: e9b96abc301ff7a2f1101374847c44c3b1c5821351e5f7e7bd2fec9bfaaac2508fcb9177c6125b52ea8ca79261fca5ffc49341c483af38273346ad90b7fb872f
+  metadata.gz: 09f10fb90e00cc9b43e990a4fa2255b4cd3193533faa5d31064d3197f794f50cf20024f749dbb3a44d954df1d4066075a2e0af2718c4e35e32d2c08a29316d28
+  data.tar.gz: 90d8ba319a32a30764a8ccb1456a29286b5ae8ab2448a5f8e6f3c36635a8a79e6c628e3dbdd25dd2a77ac307428867d45893425b2e9926c82e49888652231abc

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--format doc
+--color
+--require spec_helper

data/Gemfile

@@ -1,12 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gem "libxml-ruby", "~> 2.6.0"
-
-group :development do
-  gem "nokogiri", "~> 1.4.6"
-  gem "jeweler"
-  gem "git"
-  gem "rake"
-  gem "shoulda"
-  gem "rspec", "~> 2.0"
-end
+gemspec

data/Gemfile.lock

@@ -1,53 +1,52 @@
+PATH
+  remote: .
+  specs:
+    opensrs (0.3.5)
+      libxml-ruby (~> 2)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
-    diff-lcs (1.2.1)
-    git (1.2.5)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.7)
-    libxml-ruby (2.6.0)
-    metaclass (0.0.1)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    multi_json (1.7.1)
-    nokogiri (1.4.7)
-    rake (10.0.3)
-    rdoc (4.0.0)
-      json (~> 1.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    libxml-ruby (2.8.0)
+    mini_portile (0.6.1)
+    minitest (5.5.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.2)
-    shoulda-matchers (1.4.2)
+    rspec-mocks (2.99.2)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
       activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  git
-  jeweler
-  libxml-ruby (~> 2.6.0)
-  nokogiri (~> 1.4.6)
+  bundler (~> 1.8)
+  nokogiri
+  opensrs!
   rake
   rspec (~> 2.0)
   shoulda

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2010-2011 Josh Delsman
+Copyright (c) 2014 Joshua Delsman
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# OpenSRS
+
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/voxxit/opensrs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Build Status](https://travis-ci.org/voxxit/opensrs.svg?branch=master)](https://travis-ci.org/voxxit/opensrs)
+[![Code Climate](https://codeclimate.com/github/voxxit/opensrs/badges/gpa.svg)](https://codeclimate.com/github/voxxit/opensrs)
+[![Coverage Status](https://img.shields.io/coveralls/voxxit/opensrs.svg)](https://coveralls.io/r/voxxit/opensrs)
+
+This (unofficial) OpenSRS gem provides basic support to connect to, and utilize the [OpenSRS API.](http://www.opensrs.com/site/resources/documentation/api) This library has been well-tested in high-performance production
+environments.
+
+### Requirements
+
+  * Ruby **>= 1.9.2** or **>= 2.0.0** or **>= 2.1.2**
+
+### Installation
+
+You can install this gem by doing the following:
+
+    $ gem install opensrs
+
+You can then include it in a Ruby project, like so:
+
+    require 'opensrs'
+
+For Rails 3.x and above, add it to the `Gemfile`:
+
+    gem "opensrs"
+
+### Usage
+
+This library provides basic functionality for interacting with the OpenSRS XML API.
+
+- Connection handling
+- Error reporting
+- XML encoding
+- XML decoding
+
+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 (1.4.7 and below) for parsing XML, then in one of your app initializers add the following line:
+
+    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. Log in 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.
+
+If you would like, you can provide OpenSRS::Server with a logger to write the contents of the requests and responses
+with OpenSRS. The assumption is you are using a Rails-like logger, but as long as your logger has an info method you
+are fine. You can simply assign the logger or pass it in as an initialization option:
+
+    server = OpenSRS::Server.new(
+      server:   "https://rr-n1-tor.opensrs.net:55443/",
+      username: "testing",
+      password: "53cr3t",
+      key:      "c633be3170c7fb3fb29e2f99b84be2410...",
+      logger:   Rails.logger
+    )
+
+or, if you can change it later:
+
+    server.logger = Rails.logger
+
+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"
+      )
+    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
+
+Responses from OpenSRS are returned in an OpenSRS::Response object, which gives you access to a multitude of things.
+
+  Method | Description
+  ---|---
+  `response.response` | This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
+  `response.response` | This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
+  `response.errors` | If there are errors which come back from OpenSRS, they are returned here. If not, it returns nil.
+  `response.success?` | Returns true if the response was labeled as successful. If not, it returns false.
+  `response.request_xml` | Returns raw request XML.
+  `response.response_xml` | Returns raw response XML.
+
+### Bugs/Feature Requests
+
+If you have any bugs or feature requests for this gem, feel free to [open an issue.](http://github.com/voxxit/opensrs/issues/new)
+
+### How To Contribute
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add specs for it.
+  * Commit, but **do not mess with Rakefile or version.**
+  * Send me a pull request. Bonus points for topic branches!
+
+### Contributors (in order of appearance)
+
+* [Joshua Delsman](http://github.com/voxxit)
+* Glenn Roberts
+
+### Copyright
+
+Copyright (c) 2010-2014 Joshua Delsman.
+
+Distributed under the MIT license. See `LICENSE` for details.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/voxxit/opensrs/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -1,40 +1 @@
-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.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       = "jdelsman@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 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"

data/lib/opensrs/server.rb

@@ -4,11 +4,14 @@ require "digest/md5"
 require "openssl"
 
 module OpenSRS
-  class BadResponse < StandardError; end
-  class TimeoutError < StandardError; end
+  class OpenSRSError < StandardError; end
+
+  class BadResponse < OpenSRSError; end
+  class ConnectionError < OpenSRSError; end
+  class TimeoutError < ConnectionError; end
 
   class Server
-    attr_accessor :server, :username, :password, :key, :timeout, :open_timeout
+    attr_accessor :server, :username, :password, :key, :timeout, :open_timeout, :logger
 
     def initialize(options = {})
       @server   = URI.parse(options[:server] || "https://rr-n1-tor.opensrs.net:55443/")
@@ -17,13 +20,16 @@ module OpenSRS
       @key      = options[:key]
       @timeout  = options[:timeout]
       @open_timeout  = options[:open_timeout]
+      @logger   = options[:logger]
     end
 
     def call(data = {})
       xml = xml_processor.build({ :protocol => "XCP" }.merge!(data))
+      log('Request', xml, data)
 
       begin
         response = http.post(server_path, xml, headers(xml))
+        log('Response', response.body, data)
       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
@@ -32,6 +38,8 @@ module OpenSRS
       return OpenSRS::Response.new(parsed_response, xml, response.body)
     rescue Timeout::Error => err
       raise OpenSRS::TimeoutError, err
+    rescue Errno::ECONNRESET, Errno::ECONNREFUSED => err
+      raise OpenSRS::ConnectionError, err
     end
 
     def xml_processor
@@ -70,6 +78,16 @@ module OpenSRS
       http
     end
 
+    def log(type, data, options = {})
+      return unless logger
+
+      message = "[OpenSRS] #{type} XML"
+      message = "#{message} for #{options[:object]} #{options[:action]}" if options[:object] && options[:action]
+
+      line = [message, data].join("\n")
+      logger.info(line)
+    end
+
     def server_path
       server.path.empty? ? '/' : server.path
     end

data/lib/opensrs/version.rb

@@ -1,5 +1,5 @@
 module OpenSRS
   class Version
-    VERSION = "0.3.4"
+    VERSION = "0.3.5"
   end
 end

data/lib/opensrs/xml_processor.rb

@@ -16,44 +16,42 @@ module OpenSRS
 
     # 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
+      case data
+      when Array
+        encode_dt_array(data, container)
+      when Hash
+        encode_dt_assoc(data, container)
+      when String, Numeric, Date, Time, Symbol, NilClass
+        data.to_s
       else
-        return data.inspect
+        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
+      build_element(:dt_array, data, container)
     end
 
     def self.encode_dt_assoc(data, container)
-      dt_assoc = new_element(:dt_assoc, container)
+      build_element(:dt_assoc, data, container)
+    end
+
+    def self.build_element(type, data, container)
+      element = new_element(type, container)
 
-      data.each do |key, value|
+      # if array, item = the item
+      # if hash, item will be array of the key & value
+      data.each_with_index do |item, index|
         item_node = new_element(:item, container)
-        item_node["key"] = key.to_s
-        item_node << encode_data(value, item_node)
+        item_node["key"] = item.is_a?(Array) ? item[0].to_s : index.to_s
+
+        value = item.is_a?(Array) ? item[1] : item
 
-        dt_assoc << item_node
+        item_node << encode_data(value, item_node)
+        element << item_node
       end
 
-      return dt_assoc
+      element
     end
 
     # Recursively decodes individual data elements from OpenSRS
@@ -74,4 +72,4 @@ module OpenSRS
 
   end
 
-end
+end

data/lib/opensrs/xml_processor/nokogiri.rb

@@ -17,8 +17,13 @@ module OpenSRS
       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
+      version << '0.9'
+      header << version
+      envelope << header
+      builder.doc << envelope
+      data_block << other_data
+      body << data_block
+      envelope << body
       return builder.to_xml
     end
 

data/opensrs.gemspec

@@ -1,76 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 
-Gem::Specification.new do |s|
-  s.name = "opensrs"
-  s.version = "0.3.4"
+lib = File.expand_path('../lib', __FILE__)
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Josh Delsman"]
-  s.date = "2013-04-04"
-  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."
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+require 'opensrs/version'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<libxml-ruby>, ["~> 2.6.0"])
-      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.6.0"])
-      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.6.0"])
-    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
+Gem::Specification.new do |spec|
+
+  spec.name          = "opensrs"
+  spec.version       = OpenSRS::Version::VERSION
+  spec.authors       = [ "Joshua Delsman" ]
+  spec.email         = [ "j@srv.im" ]
+  spec.summary       = "OpenSRS API for Ruby"
+  spec.description   = "Provides support to utilize the OpenSRS API with Ruby."
+  spec.homepage      = "https://github.com/voxxit/opensrs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = [ "lib" ]
 
+  spec.add_runtime_dependency "libxml-ruby", "~> 2"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "nokogiri"
+
+end

data/spec/opensrs/server_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe OpenSRS::Server do
   let(:server) { OpenSRS::Server.new }
 
@@ -20,6 +18,12 @@ describe OpenSRS::Server do
       server.timeout.should be_nil
       server.open_timeout.should be_nil
     end
+
+    it 'allows a logger to be set during initialization' do
+      logger = double(:info => '')
+      server = OpenSRS::Server.new({ :logger => logger })
+      server.logger.should eq(logger)
+    end
   end
 
   describe ".call" do
@@ -91,6 +95,32 @@ describe OpenSRS::Server do
       http.should_receive(:post).and_raise err = Timeout::Error.new('test')
       expect { server.call }.to raise_exception OpenSRS::TimeoutError
     end
+
+    it 'wraps connection errors' do
+      http.should_receive(:post).and_raise err = Errno::ECONNREFUSED
+      expect { server.call }.to raise_exception OpenSRS::ConnectionError
+
+      http.should_receive(:post).and_raise err = Errno::ECONNRESET
+      expect { server.call }.to raise_exception OpenSRS::ConnectionError
+    end
+
+    describe "logger is present" do
+      let(:logger) { OpenSRS::TestLogger.new }
+      before :each do
+        server.logger = logger
+      end
+
+      it "should log the request and the response" do
+        xml_processor.should_receive(:build).with(:protocol => "XCP", :some => 'option')
+        server.call(:some => 'option')
+        logger.messages.length.should eq(2)
+        logger.messages.first.should match(/\[OpenSRS\] Request XML/)
+        logger.messages.first.should match(/<some xml>/)
+        logger.messages.last.should match(/\[OpenSRS\] Response XML/)
+        logger.messages.last.should match(/some response/)
+      end
+
+    end
   end
 
   describe "#test xml processor" do

data/spec/opensrs/version_spec.rb

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

data/spec/opensrs/xml_processor/libxml_spec.rb

@@ -1,21 +1,20 @@
-require 'spec_helper'
 require 'date'
 
 describe OpenSRS::XmlProcessor::Libxml do
-  describe ".build" 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
@@ -57,12 +56,12 @@ describe OpenSRS::XmlProcessor::Libxml do
         @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
@@ -70,17 +69,17 @@ describe OpenSRS::XmlProcessor::Libxml do
       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'
@@ -131,11 +130,11 @@ describe OpenSRS::XmlProcessor::Libxml do
             </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'>
@@ -153,18 +152,18 @@ describe OpenSRS::XmlProcessor::Libxml do
                   <item key='2'>ns3.example.com</item>
                 </dt_array>
               </item>
-            </dt_assoc>    
+            </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'>
@@ -181,7 +180,7 @@ describe OpenSRS::XmlProcessor::Libxml do
                     <dt_assoc>
                       <item key='first_name'>Tom</item>
                       <item key='last_name'>Jones</item>
-                    </dt_assoc> 
+                    </dt_assoc>
                   </item>
                   <item key='tech'>
                     <dt_assoc>
@@ -193,17 +192,17 @@ describe OpenSRS::XmlProcessor::Libxml do
               </item>
             </dt_assoc>
           </data_block>
-        </body> 
+        </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' ?>
@@ -231,7 +230,7 @@ describe OpenSRS::XmlProcessor::Libxml do
               </data_block>
             </body>
           </OPS_envelope>}
-        
+
         @resp = OpenSRS::XmlProcessor::Libxml.parse(xml)
       end
 
@@ -251,4 +250,4 @@ describe OpenSRS::XmlProcessor::Libxml do
       end
     end
   end
-end
+end

data/spec/opensrs/xml_processor/nokogiri_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
 require 'date'
 
+class OrderedHash < Hash
+end
+
 describe OpenSRS::XmlProcessor::Nokogiri do
   describe ".build" do
     it "should create XML for a nested hash" do
@@ -11,7 +13,7 @@ describe OpenSRS::XmlProcessor::Nokogiri do
   end
 
   describe '.encode_data' do
-    
+
     before(:each) do
       @builder = ::Nokogiri::XML::Builder.new
       @doc     = @builder.doc
@@ -48,6 +50,22 @@ describe OpenSRS::XmlProcessor::Nokogiri do
       it { @e.children[0].attributes["key"].value.should eql('name') }
     end
 
+    context "on a hash subclass" do
+      before(:each) do
+        ohash = OrderedHash.new
+        ohash[:name] = 'kitten'
+        @e = OpenSRS::XmlProcessor::Nokogiri.encode_data(ohash, @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)
@@ -92,7 +110,7 @@ describe OpenSRS::XmlProcessor::Nokogiri do
   end
 
   describe '.parse' do
-    
+
     context "when scaler values" do
       before(:each) do
         xml = %{<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
@@ -225,4 +243,4 @@ describe OpenSRS::XmlProcessor::Nokogiri do
 
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,23 @@
-require 'opensrs/xml_processor.rb'
-require 'opensrs/xml_processor/libxml.rb'
-require 'opensrs/xml_processor/nokogiri.rb'
-require 'opensrs/server.rb'
-require 'opensrs/version.rb'
-require 'opensrs/response.rb'
+require 'bundler/setup'
+
+Bundler.setup
+
+require 'opensrs'
+
+RSpec.configure do |config|
+  # config for rspec!
+end
+
+class OpenSRS::TestLogger
+
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def info(message)
+    messages << message
+  end
+
+end

metadata

@@ -1,126 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: opensrs
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
-- Josh Delsman
+- Joshua Delsman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-description: Provides support to utilize the OpenSRS API with Ruby/Rails.
-email: jdelsman@voxxit.com
+description: Provides support to utilize the OpenSRS API with Ruby.
+email:
+- j@srv.im
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .document
+- ".document"
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
-- LICENSE
-- README.rdoc
+- LICENSE.txt
+- README.md
 - Rakefile
 - lib/opensrs.rb
 - lib/opensrs/response.rb
@@ -135,7 +122,7 @@ files:
 - spec/opensrs/xml_processor/libxml_spec.rb
 - spec/opensrs/xml_processor/nokogiri_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/voxxit/opensrs
+homepage: https://github.com/voxxit/opensrs
 licenses:
 - MIT
 metadata: {}
@@ -145,18 +132,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: Provides support to utilize the OpenSRS API with Ruby/Rails.
-test_files: []
+specification_version: 4
+summary: OpenSRS API for Ruby
+test_files:
+- 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

data/README.rdoc

@@ -1,105 +0,0 @@
-= OpenSRS
-
-{<img src="https://travis-ci.org/voxxit/opensrs.png" />}[https://travis-ci.org/voxxit/opensrs]
-{<img src="https://codeclimate.com/github/voxxit/opensrs.png" />}[https://codeclimate.com/github/voxxit/opensrs]
-
-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://www.opensrs.com/site/resources/documentation/api
-
-== Installation
-
-You can install this gem by doing the following:
-
-  $ gem install opensrs
-
-You can then include it in a Ruby project, like so:
-
-  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"
-
-For Rails 3.x, use the <tt>Gemfile</tt>:
-
-  gem "opensrs"
-
-== Usage
-
-This library provides basic functionality for interacting with the OpenSRS XML API.
-
-* Connection handling
-* Error reporting
-* XML encoding
-* XML decoding
-
-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 (1.4.7 and below) for parsing XML, then in one of your app initializers add the following line:
-
-  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"
-    )
-  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
-
-Responses from OpenSRS are returned in an OpenSRS::Response object, which gives you access to a multitude of things.
-
-* <tt>response.response</tt> - This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
-* <tt>response.errors</tt> - If there are errors which come back from OpenSRS, they are returned here. If not, it returns nil.
-* <tt>response.success?</tt> - Returns true if the response was labeled as successful. If not, it returns false.
-* <tt>response.request_xml</tt> - Returns raw request XML.
-* <tt>response.response_xml</tt> - Returns raw response XML.
-
-== Bugs/Feature Requests
-
-If you have any bugs or feature requests for this gem, feel free to add them in the Issues portion of the GitHub repository here:
-
-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.
-* 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.
-
-== Contributors (in order of appearance)
-
-* Josh Delsman
-* Glenn Roberts
-
-== Copyright
-
-Copyright (c) 2010-2013 Josh Delsman. Distributed under the MIT license. See LICENSE for details.