isbm_adaptor 1.0.rc8.6 → 1.0.rc8.7

data/lib/isbm_adaptor/consumer_publication.rb

@@ -1,71 +1,71 @@
-require 'isbm_adaptor/client'
-
-module IsbmAdaptor
-  class ConsumerPublication < IsbmAdaptor::Client
-
-    # Creates a new ISBM ConsumerPublication client.
-    #
-    # @param endpoint [String] the SOAP endpoint URI
-    # @option options [Object] :logger (Rails.logger or $stdout) location where log should be output
-    # @option options [Boolean] :log (true) specify whether requests are logged
-    # @option options [Boolean] :pretty_print_xml (false) specify whether request and response XML are formatted
-    def initialize(endpoint, options = {})
-      super('ISBMConsumerPublicationService.wsdl', endpoint, options)
-    end
-
-    # Opens a subscription session for a channel.
-    #
-    # @param uri [String] the channel URI
-    # @param topics [Array<String>] an array of topics
-    # @param listener_uri [String] the URI for notification callbacks
-    # @return [String] the session id
-    # @raise [ArgumentError] if uri or topics are nil/empty
-    def open_session(uri, topics, listener_uri = nil)
-      validate_presence_of uri, 'Channel URI'
-      validate_presence_of topics, 'Topics'
-
-      # Use Builder to generate XML body as we may have multiple Topic elements
-      xml = Builder::XmlMarkup.new
-      xml.isbm :ChannelURI, uri
-      topics.each do |topic|
-        xml.isbm :Topic, topic
-      end
-      xml.isbm :ListenerURI, listener_uri unless listener_uri.nil?
-
-      response = @client.call(:open_subscription_session, message: xml.target!)
-
-      response.to_hash[:open_subscription_session_response][:session_id].to_s
-    end
-
-    # Reads the first message after the specified last message in the message
-    # queue.
-    #
-    # @param session_id [String] the session id
-    # @param last_message_id [String] the id of the last message. When set to
-    #   nil, returns the first publication in the message queue
-    # @return [Message] first message after specified last message. nil if no message.
-    # @raise [ArgumentError] if session_id is nil/empty
-    def read_publication(session_id, last_message_id)
-      validate_presence_of session_id, 'Session Id'
-
-      message = { 'SessionID' => session_id }
-      message['LastMessageID'] = last_message_id unless last_message_id.nil?
-      response = @client.call(:read_publication, message: message)
-
-      extract_message(response)
-    end
-
-    # Closes a subscription session.
-    #
-    # @param session_id [String] the session id
-    # @return [void]
-    # @raise [ArgumentError] if session_id is nil/empty
-    def close_session(session_id)
-      validate_presence_of session_id, 'Session Id'
-
-      @client.call(:close_subscription_session, message: { 'SessionID' => session_id })
-
-      return true
-    end
-  end
-end
+require 'isbm_adaptor/client'
+
+module IsbmAdaptor
+  class ConsumerPublication < IsbmAdaptor::Client
+
+    # Creates a new ISBM ConsumerPublication client.
+    #
+    # @param endpoint [String] the SOAP endpoint URI
+    # @option options [Object] :logger (Rails.logger or $stdout) location where log should be output
+    # @option options [Boolean] :log (true) specify whether requests are logged
+    # @option options [Boolean] :pretty_print_xml (false) specify whether request and response XML are formatted
+    def initialize(endpoint, options = {})
+      super('ISBMConsumerPublicationService.wsdl', endpoint, options)
+    end
+
+    # Opens a subscription session for a channel.
+    #
+    # @param uri [String] the channel URI
+    # @param topics [Array<String>] an array of topics
+    # @param listener_uri [String] the URI for notification callbacks
+    # @return [String] the session id
+    # @raise [ArgumentError] if uri or topics are blank
+    def open_session(uri, topics, listener_uri = nil)
+      validate_presence_of uri, 'Channel URI'
+      validate_presence_of topics, 'Topics'
+
+      # Use Builder to generate XML body as we may have multiple Topic elements
+      xml = Builder::XmlMarkup.new
+      xml.isbm :ChannelURI, uri
+      topics.each do |topic|
+        xml.isbm :Topic, topic
+      end
+      xml.isbm :ListenerURI, listener_uri unless listener_uri.nil?
+
+      response = @client.call(:open_subscription_session, message: xml.target!)
+
+      response.to_hash[:open_subscription_session_response][:session_id].to_s
+    end
+
+    # Reads the first message after the specified last message in the message
+    # queue.
+    #
+    # @param session_id [String] the session id
+    # @param last_message_id [String] the id of the last message. When set to
+    #   nil, returns the first publication in the message queue
+    # @return [Message] first message after specified last message. nil if no message.
+    # @raise [ArgumentError] if session_id is blank
+    def read_publication(session_id, last_message_id)
+      validate_presence_of session_id, 'Session Id'
+
+      message = { 'SessionID' => session_id }
+      message['LastMessageID'] = last_message_id unless last_message_id.nil?
+      response = @client.call(:read_publication, message: message)
+
+      extract_message(response)
+    end
+
+    # Closes a subscription session.
+    #
+    # @param session_id [String] the session id
+    # @return [void]
+    # @raise [ArgumentError] if session_id is blank
+    def close_session(session_id)
+      validate_presence_of session_id, 'Session Id'
+
+      @client.call(:close_subscription_session, message: { 'SessionID' => session_id })
+
+      return true
+    end
+  end
+end

data/lib/isbm_adaptor/consumer_request.rb

@@ -1,109 +1,109 @@
-require 'isbm_adaptor/client'
-
-module IsbmAdaptor
-  class ConsumerRequest < IsbmAdaptor::Client
-
-    # Creates a new ISBM ConsumerRequest client.
-    #
-    # @param endpoint [String] the SOAP endpoint URI
-    # @option options [Object] :logger (Rails.logger or $stdout) location where log should be output
-    # @option options [Boolean] :log (true) specify whether requests are logged
-    # @option options [Boolean] :pretty_print_xml (false) specify whether request and response XML are formatted
-    def initialize(endpoint, options = {})
-      super('ISBMConsumerRequestService.wsdl', endpoint, options)
-    end
-
-    # Opens a consumer request session for a channel for posting requests and
-    # reading responses.
-    #
-    # @param uri [String] the channel URI
-    # @param listener_uri [String] the URI for notification callbacks
-    # @return [String] the session id
-    # @raise [ArgumentError] if uri is nil/empty
-    def open_session(uri, listener_uri = nil)
-      validate_presence_of uri, 'Channel URI'
-
-      message = { 'ChannelURI' => uri }
-      message['ListenerURI'] = listener_uri if listener_uri
-
-      response = @client.call(:open_consumer_request_session, message: message)
-
-      response.to_hash[:open_consumer_request_session_response][:session_id].to_s
-    end
-
-    # Posts a request message on a channel.
-    #
-    # @param session_id [String] the session id
-    # @param content [String] a valid XML string as message contents
-    # @param topic [String] the topic
-    # @return [String] the request message id
-    # @raise [ArgumentError] if session_id, content or topics are nil/empty, or
-    #   content is not valid XML
-    def post_request(session_id, content, topic)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of content, 'Content'
-      validate_presence_of topic, 'Topic'
-      validate_xml content
-
-      # Use Builder to generate XML body as we need to concatenate XML message content
-      xml = Builder::XmlMarkup.new
-      xml.isbm :SessionID, session_id
-      xml.isbm :MessageContent do
-        xml << content
-      end
-      xml.isbm :Topic, topic
-
-      response = @client.call(:post_request, message: xml.target!)
-
-      response.to_hash[:post_request_response][:message_id].to_s
-    end
-
-    # Returns the first response message, if any, in the message queue
-    # associated with the request.
-    #
-    # @param session_id [String] the session id
-    # @param request_message_id [String] the id of the original request message
-    # @return [Message] the first message in the queue for the session.
-    #   nil if no message.
-    # @raise [ArgumentError] if session_id or request_message_id are nil/empty
-    def read_response(session_id, request_message_id)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of request_message_id, 'Request Message Id'
-
-      message = { 'SessionID' => session_id, 'RequestMessageID' => request_message_id }
-      response = @client.call(:read_response, message: message)
-
-      extract_message(response)
-    end
-
-    # Deletes the first response message, if any, in the message queue
-    # associated with the request.
-    #
-    # @param session_id [String] the session id
-    # @param request_message_id [String] the id of the original request message
-    # @return [void]
-    # @raise [ArgumentError] if session_id is nil/empty
-    def remove_response(session_id, request_message_id)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of request_message_id, 'Request Message Id'
-
-      message = { 'SessionID' => session_id, 'RequestMessageID' => request_message_id }
-      @client.call(:remove_response, message: message)
-
-      return true
-    end
-
-    # Closes a consumer request session.
-    #
-    # @param session_id [String] the session id
-    # @return [void]
-    # @raise [ArgumentError] if session_id is nil/empty
-    def close_session(session_id)
-      validate_presence_of session_id, 'Session Id'
-
-      @client.call(:close_consumer_request_session, message: { 'SessionID' => session_id })
-
-      return true
-    end
-  end
-end
+require 'isbm_adaptor/client'
+
+module IsbmAdaptor
+  class ConsumerRequest < IsbmAdaptor::Client
+
+    # Creates a new ISBM ConsumerRequest client.
+    #
+    # @param endpoint [String] the SOAP endpoint URI
+    # @option options [Object] :logger (Rails.logger or $stdout) location where log should be output
+    # @option options [Boolean] :log (true) specify whether requests are logged
+    # @option options [Boolean] :pretty_print_xml (false) specify whether request and response XML are formatted
+    def initialize(endpoint, options = {})
+      super('ISBMConsumerRequestService.wsdl', endpoint, options)
+    end
+
+    # Opens a consumer request session for a channel for posting requests and
+    # reading responses.
+    #
+    # @param uri [String] the channel URI
+    # @param listener_uri [String] the URI for notification callbacks
+    # @return [String] the session id
+    # @raise [ArgumentError] if uri is blank
+    def open_session(uri, listener_uri = nil)
+      validate_presence_of uri, 'Channel URI'
+
+      message = { 'ChannelURI' => uri }
+      message['ListenerURI'] = listener_uri if listener_uri
+
+      response = @client.call(:open_consumer_request_session, message: message)
+
+      response.to_hash[:open_consumer_request_session_response][:session_id].to_s
+    end
+
+    # Posts a request message on a channel.
+    #
+    # @param session_id [String] the session id
+    # @param content [String] a valid XML string as message contents
+    # @param topic [String] the topic
+    # @return [String] the request message id
+    # @raise [ArgumentError] if session_id, content or topics are blank, or
+    #   content is not valid XML
+    def post_request(session_id, content, topic)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of content, 'Content'
+      validate_presence_of topic, 'Topic'
+      validate_xml content
+
+      # Use Builder to generate XML body as we need to concatenate XML message content
+      xml = Builder::XmlMarkup.new
+      xml.isbm :SessionID, session_id
+      xml.isbm :MessageContent do
+        xml << content
+      end
+      xml.isbm :Topic, topic
+
+      response = @client.call(:post_request, message: xml.target!)
+
+      response.to_hash[:post_request_response][:message_id].to_s
+    end
+
+    # Returns the first response message, if any, in the message queue
+    # associated with the request.
+    #
+    # @param session_id [String] the session id
+    # @param request_message_id [String] the id of the original request message
+    # @return [Message] the first message in the queue for the session.
+    #   nil if no message.
+    # @raise [ArgumentError] if session_id or request_message_id are blank
+    def read_response(session_id, request_message_id)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of request_message_id, 'Request Message Id'
+
+      message = { 'SessionID' => session_id, 'RequestMessageID' => request_message_id }
+      response = @client.call(:read_response, message: message)
+
+      extract_message(response)
+    end
+
+    # Deletes the first response message, if any, in the message queue
+    # associated with the request.
+    #
+    # @param session_id [String] the session id
+    # @param request_message_id [String] the id of the original request message
+    # @return [void]
+    # @raise [ArgumentError] if session_id is blank
+    def remove_response(session_id, request_message_id)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of request_message_id, 'Request Message Id'
+
+      message = { 'SessionID' => session_id, 'RequestMessageID' => request_message_id }
+      @client.call(:remove_response, message: message)
+
+      return true
+    end
+
+    # Closes a consumer request session.
+    #
+    # @param session_id [String] the session id
+    # @return [void]
+    # @raise [ArgumentError] if session_id is blank
+    def close_session(session_id)
+      validate_presence_of session_id, 'Session Id'
+
+      @client.call(:close_consumer_request_session, message: { 'SessionID' => session_id })
+
+      return true
+    end
+  end
+end

data/lib/isbm_adaptor/duration.rb

@@ -1,88 +1,88 @@
-module IsbmAdaptor
-  class Duration
-    # @return [Numeric] the years component of the duration
-    attr_accessor :years
-
-    # @return [Numeric] the months component of the duration
-    attr_accessor :months
-
-    # @return [Numeric] the days component of the duration
-    attr_accessor :days
-
-    # @return [Numeric] the hours component of the duration
-    attr_accessor :hours
-
-    # @return [Numeric] the minutes component of the duration
-    attr_accessor :minutes
-
-    # @return [Numeric] the seconds component of the duration
-    attr_accessor :seconds
-
-    # Creates a new Duration based on specified time components.
-    #
-    # @option duration [Numeric] :years duration in years
-    # @option duration [Numeric] :months duration in months
-    # @option duration [Numeric] :days duration in days
-    # @option duration [Numeric] :hours duration in hours
-    # @option duration [Numeric] :minutes duration in minutes
-    # @option duration [Numeric] :seconds duration in seconds
-    def initialize(duration)
-      duration.keys.each do |key|
-        raise ArgumentError.new "Invalid key: #{key}" unless VALID_SYMBOLS.include?(key)
-      end
-
-      duration.each do |key, value|
-        raise ArgumentError.new "Value for #{key} cannot be less than 0" if value < 0
-      end
-
-      @years = duration[:years]
-      @months = duration[:months]
-      @days = duration[:days]
-      @hours = duration[:hours]
-      @minutes = duration[:minutes]
-      @seconds = duration[:seconds]
-    end
-
-    # @return [String] ISO 8601 formatted duration
-    def to_s
-      date = []
-      date << "#{@years}Y" unless @years.nil?
-      date << "#{@months}M" unless @months.nil?
-      date << "#{@days}D" unless @days.nil?
-
-      time = []
-      time << "#{@hours}H" unless @hours.nil?
-      time << "#{@minutes}M" unless @minutes.nil?
-      time << "#{@seconds}S" unless @seconds.nil?
-
-      result = nil
-
-      if !date.empty? || !time.empty?
-        result = 'P'
-        result += date.join unless date.empty?
-        result += 'T' + time.join unless time.empty?
-      end
-
-      result
-    end
-
-    # Creates a hash of the time components. Any keys with nil values are
-    # excluded from the result.
-    #
-    # @return [Hash] all specified time components
-    def to_hash
-      hash = {}
-      hash[:years] = @years if @years
-      hash[:months] = @months if @months
-      hash[:days] = @days if @days
-      hash[:hours] = @hours if @hours
-      hash[:minutes] = @minutes if @minutes
-      hash[:seconds] = @seconds if @seconds
-      hash
-    end
-
-    private
-
-    VALID_SYMBOLS = [:years, :months, :days, :hours, :minutes, :seconds]
-  end
-end
+module IsbmAdaptor
+  class Duration
+    # @return [Numeric] the years component of the duration
+    attr_accessor :years
+
+    # @return [Numeric] the months component of the duration
+    attr_accessor :months
+
+    # @return [Numeric] the days component of the duration
+    attr_accessor :days
+
+    # @return [Numeric] the hours component of the duration
+    attr_accessor :hours
+
+    # @return [Numeric] the minutes component of the duration
+    attr_accessor :minutes
+
+    # @return [Numeric] the seconds component of the duration
+    attr_accessor :seconds
+
+    # Creates a new Duration based on specified time components.
+    #
+    # @option duration [Numeric] :years duration in years
+    # @option duration [Numeric] :months duration in months
+    # @option duration [Numeric] :days duration in days
+    # @option duration [Numeric] :hours duration in hours
+    # @option duration [Numeric] :minutes duration in minutes
+    # @option duration [Numeric] :seconds duration in seconds
+    def initialize(duration)
+      duration.keys.each do |key|
+        raise ArgumentError.new "Invalid key: #{key}" unless VALID_SYMBOLS.include?(key)
+      end
+
+      duration.each do |key, value|
+        raise ArgumentError.new "Value for #{key} cannot be less than 0" if value < 0
+      end
+
+      @years = duration[:years]
+      @months = duration[:months]
+      @days = duration[:days]
+      @hours = duration[:hours]
+      @minutes = duration[:minutes]
+      @seconds = duration[:seconds]
+    end
+
+    # @return [String] ISO 8601 formatted duration
+    def to_s
+      date = []
+      date << "#{@years}Y" unless @years.nil?
+      date << "#{@months}M" unless @months.nil?
+      date << "#{@days}D" unless @days.nil?
+
+      time = []
+      time << "#{@hours}H" unless @hours.nil?
+      time << "#{@minutes}M" unless @minutes.nil?
+      time << "#{@seconds}S" unless @seconds.nil?
+
+      result = nil
+
+      if !date.empty? || !time.empty?
+        result = 'P'
+        result += date.join unless date.empty?
+        result += 'T' + time.join unless time.empty?
+      end
+
+      result
+    end
+
+    # Creates a hash of the time components. Any keys with nil values are
+    # excluded from the result.
+    #
+    # @return [Hash] all specified time components
+    def to_hash
+      hash = {}
+      hash[:years] = @years if @years
+      hash[:months] = @months if @months
+      hash[:days] = @days if @days
+      hash[:hours] = @hours if @hours
+      hash[:minutes] = @minutes if @minutes
+      hash[:seconds] = @seconds if @seconds
+      hash
+    end
+
+    private
+    # Valid time components in a duration 
+    VALID_SYMBOLS = [:years, :months, :days, :hours, :minutes, :seconds]
+  end
+end

data/lib/isbm_adaptor/message.rb

@@ -1,23 +1,23 @@
-module IsbmAdaptor
-  class Message
-    # @return [String] the id of the message
-    attr_accessor :id
-
-    # @return [String] the XML content of the message
-    attr_accessor :content
-
-    # @return [Array<String>] topics associated with the message
-    attr_accessor :topics
-
-    # Creates a new ISBM Message container.
-    #
-    # @param id [String] message id
-    # @param content [String] XML content
-    # @param topics [Array<String>, String] collection of topics or single topic
-    def initialize(id, content, topics)
-      @id = id
-      @content = content
-      @topics = [topics].flatten
-    end
-  end
-end
+module IsbmAdaptor
+  class Message
+    # @return [String] the id of the message
+    attr_accessor :id
+
+    # @return [Nokogiri::XML::Document] the XML content of the message
+    attr_accessor :content
+
+    # @return [Array<String>] topics associated with the message
+    attr_accessor :topics
+
+    # Creates a new ISBM Message container.
+    #
+    # @param id [String] message id
+    # @param content [Nokogiri::XML::Document] XML content
+    # @param topics [Array<String>, String] collection of topics or single topic
+    def initialize(id, content, topics)
+      @id = id
+      @content = content
+      @topics = [topics].flatten
+    end
+  end
+end