opensrs 0.3.2 → 0.3.3

data/Gemfile.lock

@@ -1,24 +1,44 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    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)
-    jeweler (1.6.4)
+    i18n (0.6.1)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+      rdoc
+    json (1.7.7)
     libxml-ruby (2.1.2)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.1)
     nokogiri (1.4.7)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    shoulda (2.11.3)
+    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)
+      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)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -1,24 +1,27 @@
-= OpenSRS http://travis-ci.org/voxxit/opensrs.png
+= 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://opensrs.com/resources/documentation/opensrs_xmlapi.pdf
+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"
@@ -55,7 +58,7 @@ Once you have a server connection class, you can build from this to create the m
       :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)
@@ -69,7 +72,7 @@ Sometimes you might need to include attributes for the command, such as a cookie
       }
     )
   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.
@@ -92,6 +95,11 @@ http://github.com/voxxit/opensrs/issues
 * 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-2011 Josh Delsman. Distributed under the MIT license. See LICENSE for details.
+Copyright (c) 2010-2013 Josh Delsman. Distributed under the MIT license. See LICENSE for details.

data/lib/opensrs/server.rb

@@ -5,30 +5,33 @@ require "openssl"
 
 module OpenSRS
   class BadResponse < StandardError; end
-  
+  class TimeoutError < StandardError; end
+
   class Server
-    attr_accessor :server, :username, :password, :key
+    attr_accessor :server, :username, :password, :key, :timeout, :open_timeout
 
     def initialize(options = {})
       @server   = URI.parse(options[:server] || "https://rr-n1-tor.opensrs.net:55443/")
       @username = options[:username]
       @password = options[:password]
       @key      = options[:key]
+      @timeout  = options[:timeout]
+      @open_timeout  = options[:open_timeout]
     end
 
-    def call(options = {})
-      attributes = {
-        :protocol => "XCP"
-      }
-      
-      xml = xml_processor.build(attributes.merge!(options))
+    def call(data = {})
+      xml = xml_processor.build({ :protocol => "XCP" }.merge!(data))
+
+      begin
+        response = http.post(server_path, xml, headers(xml))
+      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
 
-      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."
+    rescue Timeout::Error => err
+      raise OpenSRS::TimeoutError, err
     end
 
     def xml_processor
@@ -41,31 +44,34 @@ module OpenSRS
     end
 
     OpenSRS::Server.xml_processor = :libxml
-    
+
     private
-    
+
     def headers(request)
-      headers = {
-        "Content-Length"  => request.length.to_s,
+      { "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.read_timeout = http.open_timeout = @timeout if @timeout
+      http.open_timeout = @open_timeout                if @open_timeout
       http
     end
+
+    def server_path
+      server.path.empty? ? '/' : server.path
+    end
   end
 end

data/lib/opensrs/version.rb

@@ -1,5 +1,5 @@
 module OpenSRS
   class Version
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/opensrs.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{opensrs}
-  s.version = "0.3.2"
+  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"]
-  s.date = %q{2011-08-08}
-  s.description = %q{Provides support to utilize the OpenSRS API with Ruby/Rails.}
-  s.email = %q{jdelsman@voxxit.com}
+  s.date = "2013-03-18"
+  s.description = "Provides support to utilize the OpenSRS API with Ruby/Rails."
+  s.email = "jdelsman@voxxit.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -37,18 +37,18 @@ Gem::Specification.new do |s|
     "spec/opensrs/xml_processor/nokogiri_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/voxxit/opensrs}
+  s.homepage = "http://github.com/voxxit/opensrs"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Provides support to utilize the OpenSRS API with Ruby/Rails.}
+  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>, [">= 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"])
@@ -56,7 +56,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, ["~> 2.0"])
     else
       s.add_dependency(%q<libxml-ruby>, ["~> 2.1.2"])
-      s.add_dependency(%q<nokogiri>, [">= 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"])
@@ -65,7 +65,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<libxml-ruby>, ["~> 2.1.2"])
-    s.add_dependency(%q<nokogiri>, [">= 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"])

data/spec/opensrs/server_spec.rb

@@ -1,13 +1,101 @@
 require 'spec_helper'
 
 describe OpenSRS::Server do
-  before(:each) do
-    @server = OpenSRS::Server.new
+  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) }
+      it { server.xml_processor.should eql(OpenSRS::XmlProcessor::Libxml) }
     end
 
     context "on changing xml processor" do
@@ -15,7 +103,7 @@ describe OpenSRS::Server do
         OpenSRS::Server.xml_processor = :nokogiri
       end
 
-      it { @server.xml_processor.should eql(OpenSRS::XmlProcessor::Nokogiri) }
+      it { server.xml_processor.should eql(OpenSRS::XmlProcessor::Nokogiri) }
     end
   end
-end
+end

data/spec/opensrs/version_spec.rb

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

data/spec/spec_helper.rb

@@ -2,4 +2,5 @@ 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/version.rb'
+require 'opensrs/response.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensrs
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-08 00:00:00.000000000 +08:00
-default_executable: 
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &70360313048380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +21,15 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70360313048380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70360313047860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +37,15 @@ dependencies:
         version: 1.4.6
   type: :development
   prerelease: false
-  version_requirements: *70360313047860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70360313047260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70360313047260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70360313046700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70360313046700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70360313046180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70360313046180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70360313045600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70360313045600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70360313021400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +117,12 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70360313021400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Provides support to utilize the OpenSRS API with Ruby/Rails.
 email: jdelsman@voxxit.com
 executables: []
@@ -116,7 +150,6 @@ files:
 - spec/opensrs/xml_processor/libxml_spec.rb
 - spec/opensrs/xml_processor/nokogiri_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/voxxit/opensrs
 licenses:
 - MIT
@@ -130,9 +163,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3837143162391248904
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -141,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Provides support to utilize the OpenSRS API with Ruby/Rails.