soap-object 0.6.4 → 0.6.5

data/lib/soap-object.rb

@@ -1,132 +1,133 @@
-require 'savon'
-require 'cgi'
-require 'soap-object/version'
-require 'soap-object/class_methods'
-require 'soap-object/factory'
-
-#
-# module to make it simpler to tests SOAP web services.  The goal is
-# to abstract all information about how your call and parse results
-# from the web service within the soap objects.
-#
-# @example
-# class ZipCodeService
-#   include SoapObject
-#
-#   wsdl 'http://www.webservicex.net/uszip.asmx?WSDL'
-#
-#   def get_zipcode_info(zip_code)
-#     get_info_by_zip 'USZip' => zip_code
-#   end
-#
-#   def state
-#     message[:state]
-#   end
-#
-#   message
-#     response.body[:get_info_by_zip_response][:get_info_by_zip_result][:new_data_set][:table]
-#   end
-# end
-#
-# There are many additional properties that can be set to configure
-# the service calls.  See the comments for SoapObject::ClassMethods to
-# view all of the options.
-#
-module SoapObject
-  attr_reader :wsdl, :response
-
-  def initialize
-    @client = Savon.client(client_properties)
-  end
-
-  def self.included(cls)
-    cls.extend SoapObject::ClassMethods
-  end
-
-  #
-  # Returns true if the service has established communication with the
-  # remote server.
-  #
-  def connected?
-    not @client.nil?
-  end
-
-  #
-  # Returns an array of operations that can be called on the remote
-  # service.
-  #
-  def operations
-    @client.operations
-  end
-
-  #
-  # Return the xml response
-  #
-  def to_xml
-    response.to_xml
-  end
-
-  #
-  # Return value at xpath
-  #
-  def xpath(path)
-    response.xpath(path)
-  end
-
-  #
-  # Return the response as a Hash
-  #
-  def to_hash
-    response.hash
-  end
-
-  #
-  # Return the body of the message as a Hash
-  #
-  def body
-    response.body
-  end
-
-  #
-  # Return the response as a Nokogiri document
-  #
-  def doc
-    response.doc
-  end
-
-  private
-  DEFAULT_PROPERTIES = {log: false,
-                         ssl_verify_mode: :none,
-                         ssl_version: :SSLv3}
-
-  def method_missing(*args)
-    operation =args.shift
-    message = args.shift
-    type = message.is_a?(String) ? :xml : :message
-    call(operation, {type => message})
-  end
-
-  def call(operation, data)
-    @response = @client.call(operation, data)
-    response.to_xml
-  end
-
-  def client_properties
-    properties = DEFAULT_PROPERTIES
-     [:with_wsdl,
-     :with_proxy,
-     :with_open_timeout,
-     :with_read_timeout,
-     :with_soap_header,
-     :with_encoding,
-     :with_basic_auth,
-     :with_digest_auth,
-     :with_log_level,
-     :with_ssl_verification,
-     :with_ssl_version].each do |sym|
-       properties = properties.merge(self.send sym) if self.respond_to? sym
-    end
-     properties
-  end
-
-end
+require 'savon'
+require 'cgi'
+require 'soap-object/version'
+require 'soap-object/class_methods'
+require 'soap-object/factory'
+
+#
+# module to make it simpler to tests SOAP web services.  The goal is
+# to abstract all information about how your call and parse results
+# from the web service within the soap objects.
+#
+# @example
+# class ZipCodeService
+#   include SoapObject
+#
+#   wsdl 'http://www.webservicex.net/uszip.asmx?WSDL'
+#
+#   def get_zipcode_info(zip_code)
+#     get_info_by_zip 'USZip' => zip_code
+#   end
+#
+#   def state
+#     message[:state]
+#   end
+#
+#   message
+#     response.body[:get_info_by_zip_response][:get_info_by_zip_result][:new_data_set][:table]
+#   end
+# end
+#
+# There are many additional properties that can be set to configure
+# the service calls.  See the comments for SoapObject::ClassMethods to
+# view all of the options.
+#
+module SoapObject
+  attr_reader :wsdl, :response
+
+  def initialize
+    @client = Savon.client(client_properties)
+  end
+
+  def self.included(cls)
+    cls.extend SoapObject::ClassMethods
+  end
+
+  #
+  # Returns true if the service has established communication with the
+  # remote server.
+  #
+  def connected?
+    not @client.nil?
+  end
+
+  #
+  # Returns an array of operations that can be called on the remote
+  # service.
+  #
+  def operations
+    @client.operations
+  end
+
+  #
+  # Return the xml response
+  #
+  def to_xml
+    response.to_xml
+  end
+
+  #
+  # Return value at xpath
+  #
+  def xpath(path)
+    response.xpath(path)
+  end
+
+  #
+  # Return the response as a Hash
+  #
+  def to_hash
+    response.hash
+  end
+
+  #
+  # Return the body of the message as a Hash
+  #
+  def body
+    response.body
+  end
+
+  #
+  # Return the response as a Nokogiri document
+  #
+  def doc
+    response.doc
+  end
+
+  private
+  DEFAULT_PROPERTIES = {log: false,
+                         ssl_verify_mode: :none,
+                         ssl_version: :SSLv3}
+
+  def method_missing(*args)
+    operation =args.shift
+    message = args.shift
+    type = message.is_a?(String) ? :xml : :message
+    call(operation, {type => message})
+  end
+
+  def call(operation, data)
+    @response = @client.call(operation, data)
+    response.to_xml
+  end
+
+  def client_properties
+    properties = DEFAULT_PROPERTIES
+     [:with_wsdl,
+     :with_proxy,
+     :with_open_timeout,
+     :with_read_timeout,
+     :with_soap_header,
+     :with_encoding,
+     :with_basic_auth,
+     :with_digest_auth,
+     :with_log_level,
+     :with_soap_version,
+     :with_ssl_verification,
+     :with_ssl_version].each do |sym|
+       properties = properties.merge(self.send sym) if self.respond_to? sym
+    end
+     properties
+  end
+
+end

data/lib/soap-object/class_methods.rb

@@ -1,131 +1,138 @@
-
-module SoapObject
-  module ClassMethods
-
-    #
-    # Sets the url for the wsdl.  It can be a path to a local file or
-    # a url to a remote server containing the file.
-    #
-    # @param [String] either the local path to or the remote url to
-    # the wsdl to use for all requests.
-    #
-    def wsdl(url)
-      define_method(:with_wsdl) do 
-        @wsdl ||= url
-        {wsdl: @wsdl}
-      end
-    end
-
-    #
-    # Set a proxy server to be used.  This will be used for retrieving
-    # the wsdl as well as making the remote requests.
-    #
-    # @param [String] the url for the proxy server
-    #
-    def proxy(url)
-      define_method(:with_proxy) do
-        {proxy: url}
-      end
-    end
-
-    #
-    # Sets the open timeout for retrieving the wsdl and making remote
-    # requests.
-    #
-    # @param [Fixnum] the number of seconds for the timeout value
-    #
-    def open_timeout(timeout)
-      define_method(:with_open_timeout) do
-        {open_timeout: timeout}
-      end
-    end
-
-    #
-    # Sets the read timeout for retrieving the wsdl and reading the
-    # results of remote requests.
-    #
-    # @param [Fixnum] the number of seconds for the timeout value
-    #
-    def read_timeout(timeout)
-      define_method(:with_read_timeout) do
-        {read_timeout: timeout}
-      end
-    end
-
-    #
-    # Add custom XML to the soap header.
-    #
-    # @param [Hash] will be converted into xml and placed in the soap
-    # header
-    #
-    def soap_header(hsh)
-      define_method(:with_soap_header) do
-        {soap_header: hsh}
-      end
-    end
-
-    #
-    # Set the encoding for the message
-    #
-    # @param [String] the encoding to use
-    #
-    def encoding(enc)
-      define_method(:with_encoding) do
-        {encoding: enc}
-      end
-    end
-
-    #
-    # Use basic authentication for all requests
-    #
-    # @param [Array] username and password
-    #
-    def basic_auth(*name_password)
-      define_method(:with_basic_auth) do
-        {basic_auth: name_password}
-      end
-    end
-
-    #
-    # Use digest authentiation for all requests
-    #
-    # @param [Array] username and password
-    #
-    def digest_auth(*name_password)
-      define_method(:with_digest_auth) do
-        {digest_auth: name_password}
-      end
-    end
-
-    #
-    # Set the log level used for logging
-    #
-    # [Symbol] valid values are :info, :debug, :warn, :error, and :fatal
-    #
-    def log_level(level)
-      define_method(:with_log_level) do
-        {log: true, log_level: level, pretty_print_xml: true}
-      end
-    end
-
-    #
-    # Enable/Disable SSL verification when calling services over HTTPS (Default is true)
-    #
-    # @param [Boolean] valid values are true, false
-    #
-    def ssl_verification(enable)
-      if enable
-        define_method(:with_ssl_verification) do
-          {ssl_verify_mode: nil}
-        end
-      end
-    end
-
-    def ssl_version(version)
-      define_method(:with_ssl_version) do
-        {ssl_version: version}
-      end
-    end
-
-  end
-end
+
+module SoapObject
+  module ClassMethods
+
+    #
+    # Sets the url for the wsdl.  It can be a path to a local file or
+    # a url to a remote server containing the file.
+    #
+    # @param [String] either the local path to or the remote url to
+    # the wsdl to use for all requests.
+    #
+    def wsdl(url)
+      define_method(:with_wsdl) do 
+        @wsdl ||= url
+        {wsdl: @wsdl}
+      end
+    end
+
+    #
+    # Set a proxy server to be used.  This will be used for retrieving
+    # the wsdl as well as making the remote requests.
+    #
+    # @param [String] the url for the proxy server
+    #
+    def proxy(url)
+      define_method(:with_proxy) do
+        {proxy: url}
+      end
+    end
+
+    #
+    # Sets the open timeout for retrieving the wsdl and making remote
+    # requests.
+    #
+    # @param [Fixnum] the number of seconds for the timeout value
+    #
+    def open_timeout(timeout)
+      define_method(:with_open_timeout) do
+        {open_timeout: timeout}
+      end
+    end
+
+    #
+    # Sets the read timeout for retrieving the wsdl and reading the
+    # results of remote requests.
+    #
+    # @param [Fixnum] the number of seconds for the timeout value
+    #
+    def read_timeout(timeout)
+      define_method(:with_read_timeout) do
+        {read_timeout: timeout}
+      end
+    end
+
+    #
+    # Add custom XML to the soap header.
+    #
+    # @param [Hash] will be converted into xml and placed in the soap
+    # header
+    #
+    def soap_header(hsh)
+      define_method(:with_soap_header) do
+        {soap_header: hsh}
+      end
+    end
+
+    #
+    # Set the encoding for the message
+    #
+    # @param [String] the encoding to use
+    #
+    def encoding(enc)
+      define_method(:with_encoding) do
+        {encoding: enc}
+      end
+    end
+
+    #
+    # Use basic authentication for all requests
+    #
+    # @param [Array] username and password
+    #
+    def basic_auth(*name_password)
+      define_method(:with_basic_auth) do
+        {basic_auth: name_password}
+      end
+    end
+
+    #
+    # Use digest authentiation for all requests
+    #
+    # @param [Array] username and password
+    #
+    def digest_auth(*name_password)
+      define_method(:with_digest_auth) do
+        {digest_auth: name_password}
+      end
+    end
+
+    #
+    # Set the log level used for logging
+    #
+    # [Symbol] valid values are :info, :debug, :warn, :error, and :fatal
+    #
+    def log_level(level)
+      define_method(:with_log_level) do
+        {log: true, log_level: level, pretty_print_xml: true}
+      end
+    end
+
+    def soap_version(version)
+      define_method(:with_soap_version) do
+        {soap_version: version}
+      end
+    end
+
+
+    #
+    # Enable/Disable SSL verification when calling services over HTTPS (Default is true)
+    #
+    # @param [Boolean] valid values are true, false
+    #
+    def ssl_verification(enable)
+      if enable
+        define_method(:with_ssl_verification) do
+          {ssl_verify_mode: nil}
+        end
+      end
+    end
+
+    def ssl_version(version)
+      define_method(:with_ssl_version) do
+        {ssl_version: version}
+      end
+    end
+
+  end
+end