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

data/lib/isbm_adaptor/provider_publication.rb

@@ -1,92 +1,92 @@
-require 'isbm_adaptor/client'
-require 'isbm_adaptor/duration'
-
-module IsbmAdaptor
-  class ProviderPublication < IsbmAdaptor::Client
-
-    # Creates a new ISBM ProviderPublication 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('ISBMProviderPublicationService.wsdl', endpoint, options)
-    end
-
-    # Opens a publication session for a channel.
-    #
-    # @param uri [String] the channel URI
-    # @return [String] the session id
-    # @raise [ArgumentError] if uri is nil/empty
-    def open_session(uri)
-      validate_presence_of uri, 'Channel URI'
-
-      response = @client.call(:open_publication_session, message: { 'ChannelURI' => uri })
-
-      response.to_hash[:open_publication_session_response][:session_id].to_s
-    end
-
-    # Posts a publication message.
-    #
-    # @param session_id [String] the session id
-    # @param content [String] a valid XML string as message contents
-    # @param topics [Array<String>, String] a collection of topics or single topic
-    # @param expiry [Duration] when the message should expire
-    # @return [String] the message id
-    # @raise [ArgumentError] if session_id, content or topics are nil/empty, or
-    #   content is not valid XML
-    def post_publication(session_id, content, topics, expiry = nil)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of content, 'Content'
-      validate_presence_of topics, 'Topics'
-      validate_xml content
-
-      topics = [topics].flatten
-
-      # 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
-      topics.each do |topic|
-        xml.isbm :Topic, topic
-      end
-      duration = expiry.to_s
-      xml.isbm :Expiry, duration unless duration.nil?
-
-      response = @client.call(:post_publication, message: xml.target!)
-
-      response.to_hash[:post_publication_response][:message_id].to_s
-    end
-
-    # Expires a posted publication message.
-    #
-    # @param session_id [String] the session id used to post the publication
-    # @param message_id [String] the message id received after posting the publication
-    # @return [void]
-    # @raise [ArgumentError] if session_id or message_id are nil/empty
-    def expire_publication(session_id, message_id)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of message_id, 'Message Id'
-
-      @client.call(:expire_publication, message: { 'SessionID' => session_id, 'MessageID' => message_id })
-
-      return true
-    end
-
-    # Closes a publication 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_publication_session, message: { 'SessionID' => session_id })
-
-      return true
-    end
-  end
-end
+require 'isbm_adaptor/client'
+require 'isbm_adaptor/duration'
+
+module IsbmAdaptor
+  class ProviderPublication < IsbmAdaptor::Client
+
+    # Creates a new ISBM ProviderPublication 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('ISBMProviderPublicationService.wsdl', endpoint, options)
+    end
+
+    # Opens a publication session for a channel.
+    #
+    # @param uri [String] the channel URI
+    # @return [String] the session id
+    # @raise [ArgumentError] if uri is blank
+    def open_session(uri)
+      validate_presence_of uri, 'Channel URI'
+
+      response = @client.call(:open_publication_session, message: { 'ChannelURI' => uri })
+
+      response.to_hash[:open_publication_session_response][:session_id].to_s
+    end
+
+    # Posts a publication message.
+    #
+    # @param session_id [String] the session id
+    # @param content [String] a valid XML string as message contents
+    # @param topics [Array<String>, String] a collection of topics or single topic
+    # @param expiry [Duration] when the message should expire
+    # @return [String] the message id
+    # @raise [ArgumentError] if session_id, content or topics are blank, or
+    #   content is not valid XML
+    def post_publication(session_id, content, topics, expiry = nil)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of content, 'Content'
+      validate_presence_of topics, 'Topics'
+      validate_xml content
+
+      topics = [topics].flatten
+
+      # 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
+      topics.each do |topic|
+        xml.isbm :Topic, topic
+      end
+      duration = expiry.to_s
+      xml.isbm :Expiry, duration unless duration.nil?
+
+      response = @client.call(:post_publication, message: xml.target!)
+
+      response.to_hash[:post_publication_response][:message_id].to_s
+    end
+
+    # Expires a posted publication message.
+    #
+    # @param session_id [String] the session id used to post the publication
+    # @param message_id [String] the message id received after posting the publication
+    # @return [void]
+    # @raise [ArgumentError] if session_id or message_id are blank
+    def expire_publication(session_id, message_id)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of message_id, 'Message Id'
+
+      @client.call(:expire_publication, message: { 'SessionID' => session_id, 'MessageID' => message_id })
+
+      return true
+    end
+
+    # Closes a publication 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_publication_session, message: { 'SessionID' => session_id })
+
+      return true
+    end
+  end
+end

data/lib/isbm_adaptor/provider_request.rb

@@ -1,110 +1,110 @@
-require 'isbm_adaptor/client'
-
-module IsbmAdaptor
-  class ProviderRequest < IsbmAdaptor::Client
-
-    # Creates a new ISBM ProviderRequest 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('ISBMProviderRequestService.wsdl', endpoint, options)
-    end
-
-    # Opens a provider request session for a channel for reading requests and
-    # posting responses.
-    #
-    # @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_provider_request_session, message: xml.target!)
-
-      response.to_hash[:open_provider_request_session_response][:session_id].to_s
-    end
-
-    # Returns the first request message in the message queue for the session.
-    # Note: this service does not remove the message from the message queue.
-    #
-    # @param session_id [String] the session id
-    # @return [Message] the first message in the queue for the session.
-    #   nil if no message.
-    # @raise [ArgumentError] if session_id is nil/empty
-    def read_request(session_id)
-      validate_presence_of session_id, 'Session Id'
-
-      message = { 'SessionID' => session_id }
-      response = @client.call(:read_request, message: message)
-
-      extract_message(response)
-    end
-
-    # Deletes the first request message, if any, in the message queue for the session.
-    #
-    # @param session_id [String] the session id
-    # @return [void]
-    # @raise [ArgumentError] if session_id is nil/empty
-    def remove_request(session_id)
-      validate_presence_of session_id, 'Session Id'
-
-      @client.call(:remove_request, message: { 'SessionID' => session_id })
-
-      return true
-    end
-
-    # Posts a response message on a channel.
-    #
-    # @param session_id [String] the session id
-    # @param request_message_id [String] the id of the original request message
-    # @param content [String] a valid XML string as message contents
-    # @return [String] the response message id
-    # @raise [ArgumentError] if session_id, request_message_id or content are
-    #   nil/empty, or content is not valid XML
-    def post_response(session_id, request_message_id, content)
-      validate_presence_of session_id, 'Session Id'
-      validate_presence_of request_message_id, 'Request Message Id'
-      validate_presence_of content, 'Content'
-      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 :RequestMessageID, request_message_id
-      xml.isbm :MessageContent do
-        xml << content
-      end
-
-      response = @client.call(:post_response, message: xml.target!)
-
-      response.to_hash[:post_response_response][:message_id].to_s
-    end
-
-    # Closes a provider 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_provider_request_session, message: { 'SessionID' => session_id })
-
-      return true
-    end
-  end
-end
+require 'isbm_adaptor/client'
+
+module IsbmAdaptor
+  class ProviderRequest < IsbmAdaptor::Client
+
+    # Creates a new ISBM ProviderRequest 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('ISBMProviderRequestService.wsdl', endpoint, options)
+    end
+
+    # Opens a provider request session for a channel for reading requests and
+    # posting responses.
+    #
+    # @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_provider_request_session, message: xml.target!)
+
+      response.to_hash[:open_provider_request_session_response][:session_id].to_s
+    end
+
+    # Returns the first request message in the message queue for the session.
+    # Note: this service does not remove the message from the message queue.
+    #
+    # @param session_id [String] the session id
+    # @return [Message] the first message in the queue for the session.
+    #   nil if no message.
+    # @raise [ArgumentError] if session_id is blank
+    def read_request(session_id)
+      validate_presence_of session_id, 'Session Id'
+
+      message = { 'SessionID' => session_id }
+      response = @client.call(:read_request, message: message)
+
+      extract_message(response)
+    end
+
+    # Deletes the first request message, if any, in the message queue for the session.
+    #
+    # @param session_id [String] the session id
+    # @return [void]
+    # @raise [ArgumentError] if session_id is blank
+    def remove_request(session_id)
+      validate_presence_of session_id, 'Session Id'
+
+      @client.call(:remove_request, message: { 'SessionID' => session_id })
+
+      return true
+    end
+
+    # Posts a response message on a channel.
+    #
+    # @param session_id [String] the session id
+    # @param request_message_id [String] the id of the original request message
+    # @param content [String] a valid XML string as message contents
+    # @return [String] the response message id
+    # @raise [ArgumentError] if session_id, request_message_id or content are
+    #   blank, or content is not valid XML
+    def post_response(session_id, request_message_id, content)
+      validate_presence_of session_id, 'Session Id'
+      validate_presence_of request_message_id, 'Request Message Id'
+      validate_presence_of content, 'Content'
+      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 :RequestMessageID, request_message_id
+      xml.isbm :MessageContent do
+        xml << content
+      end
+
+      response = @client.call(:post_response, message: xml.target!)
+
+      response.to_hash[:post_response_response][:message_id].to_s
+    end
+
+    # Closes a provider 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_provider_request_session, message: { 'SessionID' => session_id })
+
+      return true
+    end
+  end
+end

data/lib/isbm_adaptor/version.rb

@@ -1,3 +1,4 @@
-module IsbmAdaptor
-  VERSION = '1.0.rc8.6'
-end
+module IsbmAdaptor
+  # Version should match the ISBM spec version, with a patch level
+  VERSION = '1.0.rc8.7'
+end

data/lib/isbm_adaptor.rb

@@ -1,12 +1,12 @@
-require 'active_support/core_ext/object/blank'
-require 'isbm_adaptor/version'
-require 'savon'
-
-module IsbmAdaptor
-  autoload :ChannelManagement, 'isbm_adaptor/channel_management'
-  autoload :ProviderPublication, 'isbm_adaptor/provider_publication'
-  autoload :ConsumerPublication, 'isbm_adaptor/consumer_publication'
-  autoload :ProviderRequest, 'isbm_adaptor/provider_request'
-  autoload :ConsumerRequest, 'isbm_adaptor/consumer_request'
-  autoload :Duration, 'isbm_adaptor/duration'
-end
+require 'active_support/core_ext/object/blank'
+require 'isbm_adaptor/version'
+require 'savon'
+
+module IsbmAdaptor
+  autoload :ChannelManagement, 'isbm_adaptor/channel_management'
+  autoload :ProviderPublication, 'isbm_adaptor/provider_publication'
+  autoload :ConsumerPublication, 'isbm_adaptor/consumer_publication'
+  autoload :ProviderRequest, 'isbm_adaptor/provider_request'
+  autoload :ConsumerRequest, 'isbm_adaptor/consumer_request'
+  autoload :Duration, 'isbm_adaptor/duration'
+end