soap-object 0.1 → 0.2

data/ChangeLog

@@ -1,2 +1,10 @@
+=== Version 0.2 / 2013-3-11
+* Enhancements
+  * Added ability to add XML to the soap header
+  * Added ability to set the encoding for the messages
+  * Added ability to use basic authentication
+  * Added ability to use digest authentication
+  * Added ability to set the log level
+
 === Version 0.1 / 2013-3-4
 Initial release

data/README.md

@@ -1,6 +1,22 @@
 # Soap::Object
 
-TODO: Write a gem description
+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.
+
+````ruby
+class AirportService
+  include SoapObject
+
+  wsdl 'http://www.webservicex.net/airport.asmx?WSDL'
+
+  def get_airport_name_for(airport_code)
+    response = get_airport_information_by_airport_code airport_code: airport_code
+    doc = Nokogiri::XML(response)
+    doc.xpath('//Table/CityOrAirportName').first.content
+  end
+end
+````
 
 ## Installation
 
@@ -16,9 +32,6 @@ Or install it yourself as:
 
     $ gem install soap-object
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 

data/features/step_definitions/basic_functionality_steps.rb

@@ -2,6 +2,13 @@ class TestServiceWithWsdl
   include SoapObject
 
   wsdl 'http://www.webservicex.net/airport.asmx?WSDL'
+  log_level :error
+
+  def get_airport_name_for(airport_code)
+    response = get_airport_information_by_airport_code airport_code: airport_code
+    doc = Nokogiri::XML(response)
+    doc.xpath('//Table/CityOrAirportName').first.content
+  end
 end
 
 class TestServiceWithLocalWsdl
@@ -33,7 +40,5 @@ Then /^I should be able to determine the operations$/ do
 end
 
 Then /^I should be able to make a call and receive the correct results$/ do
-  response = @so.get_airport_information_by_airport_code airport_code: 'SFO'
-  doc = Nokogiri::XML(response)
-  doc.xpath('//Table/AirportCode').first.content.should == 'SFO'
+  @so.get_airport_name_for('SFO').should == 'SAN FRANCISCO INTL'
 end

data/lib/soap-object.rb

@@ -3,8 +3,26 @@ require 'soap-object/version'
 require 'soap-object/class_methods'
 
 #
-# module to make it simpler to tests SOAP web services.  You define
-# the behavior by calling class methods to set the configuration.
+# 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 AirportService
+#   include SoapObject
+#
+#   wsdl 'http://www.webservicex.net/airport.asmx?WSDL'
+#
+#   def get_airport_name_for(airport_code)
+#     response = get_airport_information_by_airport_code airport_code: airport_code
+#     doc = Nokogiri::XML(response)
+#     doc.xpath('//Table/CityOrAirportName').first.content
+#   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
@@ -17,14 +35,24 @@ module SoapObject
     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
 
+  private
+
   def method_missing(*args)
     method = args.shift
     @response = @client.call(method, {message: args.first})
@@ -37,18 +65,16 @@ module SoapObject
      :with_proxy,
      :with_open_timeout,
      :with_read_timeout,
-     :no_log].each do |sym|
+     :with_soap_header,
+     :with_encoding,
+     :with_basic_auth,
+     :with_digest_auth,
+     :with_log_level].each do |sym|
       properties = properties.merge(self.send sym) if self.respond_to? sym
     end
     properties
   end
 
-  def no_log
-    {log: false}
-  end
-
-  private
-
   def body_for(method)
     @response.body["#{method.to_s}_response".to_sym]["#{method.to_s}_result".to_sym]
   end

data/lib/soap-object/class_methods.rb

@@ -2,6 +2,13 @@
 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 [Stroing] 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
@@ -9,24 +16,95 @@ module SoapObject
       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
-        {proxy: @proxy}
+        {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
-        {open_timeout: @open_timeout}
+        {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
-        {read_timeout: @read_timeout}
+        {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_level: level}
       end
     end
   end

data/lib/soap-object/version.rb

@@ -1,5 +1,5 @@
 module Soap
   module Object
-    VERSION = "0.1"
+    VERSION = "0.2"
   end
 end

data/spec/lib/soap_object_spec.rb

@@ -7,6 +7,11 @@ class TestServiceWithWsdl
   proxy 'http://proxy.com:8080'
   open_timeout 10
   read_timeout 20
+  soap_header 'Token' => 'secret'
+  encoding 'UTF-16'
+  basic_auth 'steve', 'secret'
+  digest_auth 'digest', 'auth'
+  log_level :error
 end
 
 
@@ -21,7 +26,7 @@ describe SoapObject do
     end
   
     it "should initialize the client using the wsdl" do
-      subject.client_properties[:wsdl].should == 'http://blah.com'
+      subject.send(:client_properties)[:wsdl].should == 'http://blah.com'
     end
 
     it "should know when it is connected to service" do
@@ -29,15 +34,35 @@ describe SoapObject do
     end
 
     it "should allow one to setup a proxy" do
-      subject.client_properties[:proxy].should == 'http://proxy.com:8080'
+      subject.send(:client_properties)[:proxy].should == 'http://proxy.com:8080'
     end
 
     it "should allow one to set an open timeout" do
-      subject.client_properties[:open_timeout].should == 10
+      subject.send(:client_properties)[:open_timeout].should == 10
     end
 
     it "should allow one to set a read timeout" do
-      subject.client_properties[:read_timeout].should == 20
+      subject.send(:client_properties)[:read_timeout].should == 20
+    end
+
+    it "should allow one to set a soap header" do
+      subject.send(:client_properties)[:soap_header].should == {'Token' => 'secret'}
+    end
+
+    it "should allow one to set the encoding" do
+      subject.send(:client_properties)[:encoding].should == 'UTF-16'
+    end
+
+    it "should allow one to use basic authentication" do
+      subject.send(:client_properties)[:basic_auth].should == ['steve', 'secret']
+    end
+
+    it "should allow one to use digest authentication" do
+      subject.send(:client_properties)[:digest_auth].should == ['digest', 'auth']
+    end
+
+    it "should allow one to set the log level" do
+      subject.send(:client_properties)[:log_level].should == :error
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soap-object
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -280735046766684970
+      hash: -4037676578174017832
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -280735046766684970
+      hash: -4037676578174017832
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25