epp-client-base 0.14.0 → 0.15.0

data/lib/epp-client/exceptions.rb

@@ -1,4 +1,5 @@
 module EPPClient
+  # This "strange" exception allows having more informative error messages.
   class EPPErrorResponse < StandardError
     attr_accessor :response_xml, :response_code, :message
 

data/lib/epp-client/poll.rb

@@ -1,8 +1,9 @@
 module EPPClient
+  # This implements the poll EPP commands.
   module Poll
     def poll_req_xml #:nodoc:
       command do |xml|
-	xml.poll(:op => :req)
+        xml.poll(:op => :req)
       end
     end
 
@@ -28,33 +29,32 @@ module EPPClient
 
     def poll_req_process(xml) #:nodoc:
       ret = {}
-      if (date = xml.xpath("epp:msgQ/epp:qDate", EPPClient::SCHEMAS_URL)).size > 0
-	ret[:qDate] = DateTime.parse(date.text)
+      if (date = xml.xpath('epp:msgQ/epp:qDate', EPPClient::SCHEMAS_URL)).size > 0
+        ret[:qDate] = DateTime.parse(date.text)
       end
-      if (msg = xml.xpath("epp:msgQ/epp:msg", EPPClient::SCHEMAS_URL)).size > 0
-	ret[:msg] = msg.text
-	ret[:msg_xml] = msg.to_s
+      if (msg = xml.xpath('epp:msgQ/epp:msg', EPPClient::SCHEMAS_URL)).size > 0
+        ret[:msg] = msg.text
+        ret[:msg_xml] = msg.to_s
       end
       if (obj = xml.xpath('epp:resData', EPPClient::SCHEMAS_URL)).size > 0 ||
-	(obj = xml.xpath('epp:extension', EPPClient::SCHEMAS_URL)).size > 0
-	ret[:obj_xml] = obj.to_s
-	PARSERS.each do |xpath,parser|
-	  if obj.xpath(xpath, EPPClient::SCHEMAS_URL).size > 0
-	    ret[:obj] = case parser
-			when Symbol
-			  send(parser, xml)
-			else
-			  raise NotImplementedError
-			end
-	  end
-	end
+         (obj = xml.xpath('epp:extension', EPPClient::SCHEMAS_URL)).size > 0
+        ret[:obj_xml] = obj.to_s
+        PARSERS.each do |xpath, parser|
+          next unless obj.xpath(xpath, EPPClient::SCHEMAS_URL).size > 0
+          ret[:obj] = case parser
+                      when Symbol
+                        send(parser, xml)
+                      else
+                        fail NotImplementedError
+                      end
+        end
       end
       ret
     end
 
     def poll_ack_xml(mid) #:nodoc:
       command do |xml|
-	xml.poll(:op => :ack, :msgID => mid)
+        xml.poll(:op => :ack, :msgID => mid)
       end
     end
 

data/lib/epp-client/session.rb

@@ -1,36 +1,34 @@
 module EPPClient
+  # This handles the basic session, login, logout, and hello.
   module Session
-
     # Sends an hello epp command.
     def hello
-      send_request(command do |xml|
-	xml.hello
-      end)
+      send_request(command(&:hello))
     end
 
     def login_xml(new_pw = nil) #:nodoc:
       command do |xml|
-	xml.login do
-	  xml.clID(@client_id)
-	  xml.pw(@password)
-	  xml.newPW(new_pw) unless new_pw.nil?
-	  xml.options do
-	    xml.version(@version)
-	    xml.lang(@lang)
-	  end
-	  xml.svcs do
-	    services.each do |s|
-	      xml.objURI(s)
-	    end
-	    unless extensions.empty?
-	      xml.svcExtension do
-		extensions.each do |e|
-		  xml.extURI(e)
-		end
-	      end
-	    end
-	  end
-	end
+        xml.login do
+          xml.clID(@client_id)
+          xml.pw(@password)
+          xml.newPW(new_pw) unless new_pw.nil?
+          xml.options do
+            xml.version(@version)
+            xml.lang(@lang)
+          end
+          xml.svcs do
+            services.each do |s|
+              xml.objURI(s)
+            end
+            unless extensions.empty?
+              xml.svcExtension do
+                extensions.each do |e|
+                  xml.extURI(e)
+                end
+              end
+            end
+          end
+        end
       end
     end
     private :login_xml
@@ -46,9 +44,7 @@ module EPPClient
     # Performs the logout command, after it, the server terminates the
     # connection.
     def logout
-      response = send_request(command do |xml|
-	xml.logout
-      end)
+      response = send_request(command(&:logout))
 
       get_result(response)
     end

data/lib/epp-client/ssl.rb

@@ -1,32 +1,29 @@
 module EPPClient
+  # This module handles the SSL strangeness that happens with EPP.
   module SSL
     attr_reader :ssl_cert, :ssl_key
 
     def ssl_key=(key) #:nodoc:
       case key
       when OpenSSL::PKey::RSA
-	@ssl_key = key
+        @ssl_key = key
       when String
-	unless key =~ /-----BEGIN RSA PRIVATE KEY-----/
-	  key = File.read(key)
-	end
-	@ssl_key = OpenSSL::PKey::RSA.new(key)
+        key = File.read(key) unless key =~ /-----BEGIN RSA PRIVATE KEY-----/
+        @ssl_key = OpenSSL::PKey::RSA.new(key)
       else
-	raise ArgumentError, "Must either be an OpenSSL::PKey::RSA object, a filename or a key"
+        fail ArgumentError, 'Must either be an OpenSSL::PKey::RSA object, a filename or a key'
       end
     end
 
     def ssl_cert=(cert) #:nodoc:
       case cert
       when OpenSSL::X509::Certificate
-	@ssl_cert = cert
+        @ssl_cert = cert
       when String
-	unless cert =~ /-----BEGIN CERTIFICATE-----/
-	  cert = File.read(cert)
-	end
-	@ssl_cert = OpenSSL::X509::Certificate.new(cert)
+        cert = File.read(cert) unless cert =~ /-----BEGIN CERTIFICATE-----/
+        @ssl_cert = OpenSSL::X509::Certificate.new(cert)
       else
-	raise ArgumentError, "Must either be an OpenSSL::X509::Certificate object, a filename or a certificate"
+        fail ArgumentError, 'Must either be an OpenSSL::X509::Certificate object, a filename or a certificate'
       end
     end
 

data/lib/epp-client/version.rb

@@ -1,3 +1,3 @@
 module EPPClient
-  VERSION = "0.14.0"
+  VERSION = '0.15.0'.freeze
 end

data/lib/epp-client/xml.rb

@@ -1,13 +1,13 @@
 module EPPClient
+  # This handles all the XML I/O
   module XML
-
     attr_reader :sent_xml, :recv_xml, :msgQ_count, :msgQ_id, :trID
 
     # Parses a frame and returns a Nokogiri::XML::Document.
     def parse_xml(string) #:doc:
       Nokogiri::XML::Document.parse(string) do |opts|
-	opts.options = 0
-	opts.noblanks
+        opts.options = 0
+        opts.noblanks
       end
     end
     private :parse_xml
@@ -15,13 +15,13 @@ module EPPClient
     def recv_frame_to_xml #:nodoc:
       @recv_xml = parse_xml(@recv_frame)
       puts @recv_xml.to_s.gsub(/^/, '<< ') if debug
-      return @recv_xml
+      @recv_xml
     end
 
     def sent_frame_to_xml #:nodoc:
       @send_xml = parse_xml(@sent_frame)
       puts @send_xml.to_s.gsub(/^/, '>> ') if debug
-      return @send_xml
+      @send_xml
     end
 
     def raw_builder(opts = {}) #:nodoc:
@@ -32,10 +32,10 @@ module EPPClient
     # creates a Builder::XmlMarkup object, mostly only used by +command+
     def builder(opts = {})
       raw_builder(opts) do |xml|
-	xml.instruct! :xml, :version =>"1.0", :encoding => "UTF-8"
-	xml.epp('xmlns' => EPPClient::SCHEMAS_URL['epp'], 'xmlns:epp' => EPPClient::SCHEMAS_URL['epp']) do
-	  yield xml
-	end
+        xml.instruct! :xml, :version => '1.0', :encoding => 'UTF-8'
+        xml.epp('xmlns' => EPPClient::SCHEMAS_URL['epp'], 'xmlns:epp' => EPPClient::SCHEMAS_URL['epp']) do
+          yield xml
+        end
       end
     end
 
@@ -49,51 +49,48 @@ module EPPClient
     # In case there was a problem, an EPPErrorResponse exception is raised.
     def get_result(args)
       xml = case args
-	    when Hash
-	      args.delete(:xml)
-	    else
-	      xml = args
-	      args = {}
-	      xml
-	    end
+            when Hash
+              args.delete(:xml)
+            else
+              xml = args
+              args = {}
+              xml
+            end
 
       args[:range] ||= 1000..1999
 
       if (mq = xml.xpath('epp:epp/epp:response/epp:msgQ', EPPClient::SCHEMAS_URL)).size > 0
-	@msgQ_count = mq.attribute('count').value.to_i
-	@msgQ_id = mq.attribute('id').value
-	puts "DEBUG: MSGQ : count=#{@msgQ_count}, id=#{@msgQ_id}\n" if debug
+        @msgQ_count = mq.attribute('count').value.to_i
+        @msgQ_id = mq.attribute('id').value
+        puts "DEBUG: MSGQ : count=#{@msgQ_count}, id=#{@msgQ_id}\n" if debug
       else
-	@msgQ_count = 0
-	@msgQ_id = nil
+        @msgQ_count = 0
+        @msgQ_id = nil
       end
 
       if (trID = xml.xpath('epp:epp/epp:response/epp:trID', EPPClient::SCHEMAS_URL)).size > 0
-	@trID = get_trid(trID)
+        @trID = get_trid(trID)
       end
 
       res = xml.xpath('epp:epp/epp:response/epp:result', EPPClient::SCHEMAS_URL)
       code = res.attribute('code').value.to_i
-      if args[:range].include?(code)
-	if args.key?(:callback)
-	  case cb = args[:callback]
-	  when Symbol
-	    return send(cb, xml.xpath('epp:epp/epp:response', EPPClient::SCHEMAS_URL))
-	  else
-	    raise ArgumentError, "Invalid callback type"
-	  end
-	else
-	  return true
-	end
+
+      fail EPPClient::EPPErrorResponse.new(:xml => xml, :code => code, :message => res.xpath('epp:msg', EPPClient::SCHEMAS_URL).text) unless args[:range].include?(code)
+
+      return true unless args.key?(:callback)
+
+      case cb = args[:callback]
+      when Symbol
+        return send(cb, xml.xpath('epp:epp/epp:response', EPPClient::SCHEMAS_URL))
       else
-	raise EPPClient::EPPErrorResponse.new(:xml => xml, :code => code, :message => res.xpath('epp:msg', EPPClient::SCHEMAS_URL).text)
+        fail ArgumentError, 'Invalid callback type'
       end
     end
 
     def get_trid(xml)
       {
-	:clTRID => xml.xpath('epp:clTRID', EPPClient::SCHEMAS_URL).text,
-	:svTRID => xml.xpath('epp:svTRID', EPPClient::SCHEMAS_URL).text,
+        :clTRID => xml.xpath('epp:clTRID', EPPClient::SCHEMAS_URL).text,
+        :svTRID => xml.xpath('epp:svTRID', EPPClient::SCHEMAS_URL).text,
       }
     end
 
@@ -114,31 +111,31 @@ module EPPClient
     #     end, lambda do |xml|
     #       xml.extension
     #     end)
-    def command(*args, &block)
+    def command(*args, &_block)
       builder do |xml|
-	xml.command do
-	  if block_given?
-	    yield xml
-	  else
-	    command = args.shift
-	    command.call(xml)
-	    args.each do |ext|
-	      xml.extension do
-		ext.call(xml)
-	      end
-	    end
-	  end
-	  xml.clTRID(clTRID)
-	end
+        xml.command do
+          if block_given?
+            yield xml
+          else
+            command = args.shift
+            command.call(xml)
+            args.each do |ext|
+              xml.extension do
+                ext.call(xml)
+              end
+            end
+          end
+          xml.clTRID(clTRID)
+        end
       end
     end
 
     # Wraps the content in an epp:extension.
     def extension
       raw_builder do |xml|
-	xml.extension do
-	  yield(xml)
-	end
+        xml.extension do
+          yield(xml)
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: epp-client-base
 version: !ruby/object:Gem::Version 
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors: 
 - Mathieu Arnold
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-02-10 00:00:00 Z
+date: 2016-02-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler