nominet-epp 0.0.2 → 0.0.3

data/History.md

@@ -0,0 +1,37 @@
+0.0.3 / 2011-01-17 
+==================
+
+  * Tweak how #poll method works w.r.t blocks
+
+0.0.2 / 2011-01-07
+==================
+
+  * Add Documentation
+  * Support the 'abuse-limit' on Nominet check operation
+  * Fix issue with info operation XML response parsing
+
+0.0.1 / 2010-05-26
+==================
+
+  * Add support for 'none' and 'all' options on list operation
+  * Fix bugs in info operation for account objects
+  * Improve handling of XML namespaces and schema locations
+
+0.0.0 / 2010-05-25
+==================
+
+  * Initial release
+  * Supports the following operations
+    * Create
+    * Delete
+    * Fork
+    * Hello
+    * Info
+    * List
+    * Lock
+    * Merge
+    * Poll
+    * Transfer
+    * Unlock
+    * Unrenew
+    * Update

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/nominet-epp/operations/poll.rb

@@ -2,23 +2,41 @@ module NominetEPP
   module Operations
     # EPP Poll Operation
     module Poll
-      # Poll the EPP server for events
+      class AckError < RuntimeError; end
+
+      # Poll the EPP server for events.
+      #
+      # If a block is given then it will be invoked once for
+      # each pending event. If no block is given the only the
+      # first received event will be returned along with the
+      # message ID of the event to allow the message to be
+      # ack'd. nil is returned if there is an error in the
+      # response or if there are not further messages to process.
+      #
+      # @example Without a block
+      #   msgID, xml = client.poll
+      #   ... process xml ...
+      #   client.ack(msgID)
+      #
+      # @example With a block
+      #   client.poll do |xml|
+      #     ... process xml ...
+      #   end
       #
       # @yield [data] process data if messages to poll
       # @yieldparam [XML::Node] data Response data
       # @return [nil] no messages to handle
-      # @return [Boolean] ack successful
+      # @return [Array<String,XML::Node>] message ID and response xml data
+      # @raise [AckError] ack of event notification failed
       # @see ack
       def poll
-        resp = @client.poll do |poll|
-          poll['op'] = 'req'
-        end
-
-        return if resp.code != 1301 || resp.msgQ['count'] == '0'
-
-        yield resp.data
+        while resp = poll_req
+          return if resp.code != 1301 || resp.msgQ['count'] == '0'
+          return [resp.msgQ['id'], resp.data] unless block_given?
 
-        ack(resp.msgQ['id'])
+          yield resp.data
+          raise AckError, "failed to acknowledge message #{resp.msgQ['id']}" unless ack(resp.msgQ['id'])
+        end
       end
 
       # Acknowledges a polled message ID
@@ -33,6 +51,13 @@ module NominetEPP
 
         return resp.success?
       end
+
+      protected
+        def poll_req
+          @client.poll do |poll|
+            poll['op'] = 'req'
+          end
+        end
     end
   end
 end

data/nominet-epp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{nominet-epp}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Geoff Garside"]
-  s.date = %q{2011-01-07}
+  s.date = %q{2011-01-17}
   s.description = %q{Client for communicating with the Nominet EPP}
   s.email = %q{geoff@geoffgarside.co.uk}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "History.md",
     "LICENSE",
     "README.rdoc",
     "Rakefile",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nominet-epp
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Geoff Garside
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-07 00:00:00 +00:00
+date: 2011-01-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- History.md
 - LICENSE
 - README.rdoc
 - Rakefile