s-savon 0.8.6

data/lib/savon/version.rb

@@ -0,0 +1,5 @@
+module Savon
+
+  Version = "0.8.6"
+
+end

data/lib/savon/wsdl/document.rb

@@ -0,0 +1,112 @@
+require "rexml/document"
+
+require "savon/wsdl/request"
+require "savon/wsdl/parser"
+
+module Savon
+  module WSDL
+
+    # = Savon::WSDL::Document
+    #
+    # Represents the WSDL of your service, including information like the namespace URI,
+    # the SOAP endpoint and available SOAP actions.
+    class Document
+
+      # Accepts an <tt>HTTPI::Request</tt> and a +document+.
+      def initialize(request = nil, document = nil)
+        self.request = request
+        self.document = document
+      end
+
+      # Accessor for the <tt>HTTPI::Request</tt> to use.
+      attr_accessor :request
+
+      def present?
+        !!@document
+      end
+
+      # Returns the namespace URI of the WSDL.
+      def namespace
+        @namespace ||= parser.namespace
+      end
+
+      # Sets the SOAP namespace.
+      attr_writer :namespace
+
+      # Returns the SOAP endpoint.
+      def endpoint
+        @endpoint ||= parser.endpoint
+      end
+
+      # Sets the SOAP endpoint.
+      attr_writer :endpoint
+
+      # Returns an Array of available SOAP actions.
+      def soap_actions
+        @soap_actions ||= parser.operations.keys
+      end
+
+      # Returns the SOAP action for a given +key+.
+      def soap_action(key)
+        operations[key][:action] if present? && operations[key]
+      end
+
+      # Returns the SOAP input for a given +key+.
+      def soap_input(key)
+        operations[key][:input].to_sym if present? && operations[key]
+      end
+
+      # Returns a Hash of SOAP operations.
+      def operations
+        @operations ||= parser.operations
+      end
+
+      # Returns the elementFormDefault value.
+      def element_form_default
+        @element_form_default ||= parser.element_form_default
+      end
+
+      # Sets the location of the WSDL document to use. This can either be a URL
+      # or a path to a local file.
+      attr_writer :document
+
+      # Returns the raw WSDL document.
+      def document
+        @wsdl_document ||= begin
+          raise ArgumentError, "No WSDL document given" if @document.blank?
+          remote? ? http_request : read_file
+        end
+      end
+
+      alias :to_xml :document
+
+    private
+
+      # Returns whether the WSDL document is located on the Web.
+      def remote?
+        @document =~ /^http/
+      end
+
+      # Executes an HTTP GET request to retrieve a remote WSDL document.
+      def http_request
+        request.url = @document
+        Request.new(request).response.body
+      end
+
+      # Reads the WSDL document from a local file.
+      def read_file
+        File.read @document
+      end
+
+      # Parses the WSDL document and returns the <tt>Savon::WSDL::Parser</tt>.
+      def parser
+        @parser ||= begin
+          parser = Parser.new
+          REXML::Document.parse_stream document, parser
+          parser
+        end
+      end
+
+    end
+  end
+end

data/lib/savon/wsdl/parser.rb

@@ -0,0 +1,102 @@
+require "savon/core_ext/object"
+require "savon/core_ext/string"
+
+module Savon
+  module WSDL
+
+    # = Savon::WSDL::Parser
+    #
+    # Serves as a stream listener for parsing WSDL documents.
+    class Parser
+
+      # The main sections of a WSDL document.
+      Sections = %w(definitions types message portType binding service)
+
+      def initialize
+        @path = []
+        @operations = {}
+        @namespaces = {}
+        @element_form_default = :unqualified
+      end
+
+      # Returns the namespace URI.
+      attr_reader :namespace
+
+      # Returns the SOAP operations.
+      attr_reader :operations
+
+      # Returns the SOAP endpoint.
+      attr_reader :endpoint
+
+      # Returns the elementFormDefault value.
+      attr_reader :element_form_default
+
+      # Hook method called when the stream parser encounters a starting tag.
+      def tag_start(tag, attrs)
+        # read xml namespaces if root element
+        read_namespaces(attrs) if @path.empty?
+
+        tag, namespace = tag.split(":").reverse
+        @path << tag
+
+        if @section == :types && tag == "schema"
+          @element_form_default = attrs["elementFormDefault"].to_sym if attrs["elementFormDefault"]
+        end
+
+        if @section == :binding && tag == "binding"
+          # ensure that we are in an wsdl/soap namespace
+          @section = nil unless @namespaces[namespace].starts_with? "http://schemas.xmlsoap.org/wsdl/soap"
+        end
+
+        @section = tag.to_sym if Sections.include?(tag) && depth <= 2
+
+        @namespace ||= attrs["targetNamespace"] if @section == :definitions
+        @endpoint ||= URI(URI.escape(attrs["location"])) if @section == :service && tag == "address"
+
+        operation_from tag, attrs if @section == :binding && tag == "operation"
+      end
+
+      # Returns our current depth in the WSDL document.
+      def depth
+        @path.size
+      end
+
+      # Reads namespace definitions from a given +attrs+ Hash.
+      def read_namespaces(attrs)
+        attrs.each do |key, value|
+          @namespaces[key.strip_namespace] = value if key.starts_with? "xmlns:"
+        end
+      end
+
+      # Hook method called when the stream parser encounters a closing tag.
+      def tag_end(tag)
+        @path.pop
+
+        if @section == :binding && @input && tag.strip_namespace == "operation"
+          # no soapAction attribute found till now
+          operation_from tag, "soapAction" => @input
+        end
+
+        @section = :definitions if Sections.include?(tag) && depth <= 1
+      end
+
+      # Stores available operations from a given tag +name+ and +attrs+.
+      def operation_from(tag, attrs)
+        @input = attrs["name"] if attrs["name"]
+
+        if attrs["soapAction"]
+          @action = !attrs["soapAction"].blank? ? attrs["soapAction"] : @input
+          @input = @action.split("/").last if !@input || @input.empty?
+
+          @operations[@input.snakecase.to_sym] = { :action => @action, :input => @input }
+          @input, @action = nil, nil
+        end
+      end
+
+      # Catches calls to unimplemented hook methods.
+      def method_missing(method, *args)
+      end
+
+    end
+  end
+end

data/lib/savon/wsdl/request.rb

@@ -0,0 +1,35 @@
+require "httpi"
+
+module Savon
+  module WSDL
+
+    # = Savon::WSDL::Request
+    #
+    # Executes WSDL requests.
+    class Request
+
+      # Expects an <tt>HTTPI::Request</tt>.
+      def initialize(request)
+        self.request = request
+      end
+
+      # Accessor for the <tt>HTTPI::Request</tt>.
+      attr_accessor :request
+
+      # Executes the request and returns the response.
+      def response
+        @response ||= with_logging { HTTPI.get request }
+      end
+
+    private
+
+      # Logs the HTTP request and yields to a given +block+.
+      def with_logging
+        Savon.log "Retrieving WSDL from: #{request.url}"
+        Savon.log "Using :#{request.auth.type} authentication" if request.auth?
+        yield
+      end
+
+    end
+  end
+end

data/lib/savon/wsse.rb

@@ -0,0 +1,150 @@
+require "base64"
+require "digest/sha1"
+
+require "savon/core_ext/string"
+require "savon/core_ext/hash"
+require "savon/core_ext/time"
+
+module Savon
+
+  # = Savon::WSSE
+  #
+  # Provides WSSE authentication.
+  class WSSE
+
+    # Namespace for WS Security Secext.
+    WSENamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+
+    # Namespace for WS Security Utility.
+    WSUNamespace = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
+
+    # URI for "wsse:Password/@Type" #PasswordText.
+    PasswordTextURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText"
+
+    # URI for "wsse:Password/@Type" #PasswordDigest.
+    PasswordDigestURI = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"
+
+    # Returns a value from the WSSE Hash.
+    def [](key)
+      hash[key]
+    end
+
+    # Sets a value on the WSSE Hash.
+    def []=(key, value)
+      hash[key] = value
+    end
+
+    # Sets authentication credentials for a wsse:UsernameToken header.
+    # Also accepts whether to use WSSE digest authentication.
+    def credentials(username, password, digest = false)
+      self.username = username
+      self.password = password
+      self.digest = digest
+    end
+
+    attr_accessor :username, :password, :created_at, :expires_at
+
+    # Returns whether to use WSSE digest. Defaults to +false+.
+    def digest?
+      !!@digest
+    end
+
+    attr_writer :digest
+
+    # Returns whether to generate a wsse:UsernameToken header.
+    def username_token?
+      username && password
+    end
+
+    # Returns whether to generate a wsse:Timestamp header.
+    def timestamp?
+      created_at || expires_at || @wsse_timestamp
+    end
+
+    # Sets whether to generate a wsse:Timestamp header.
+    def timestamp=(timestamp)
+      @wsse_timestamp = timestamp
+    end
+
+    # Returns the XML for a WSSE header.
+    def to_xml
+      if username_token?
+        Gyoku.xml wsse_username_token.merge!(hash)
+      elsif timestamp?
+        Gyoku.xml wsse_timestamp.merge!(hash)
+      else
+        ""
+      end
+    end
+
+  private
+
+    # Returns a Hash containing wsse:UsernameToken details.
+    def wsse_username_token
+      if digest?
+        wsse_security "UsernameToken",
+          "wsse:Username" => username,
+          "wsse:Nonce" => nonce,
+          "wsu:Created" => timestamp,
+          "wsse:Password" => digest_password,
+          :attributes! => { "wsse:Password" => { "Type" => PasswordDigestURI } }
+      else
+        wsse_security "UsernameToken",
+          "wsse:Username" => username,
+          "wsse:Password" => password,
+          :attributes! => { "wsse:Password" => { "Type" => PasswordTextURI } }
+      end
+    end
+
+    # Returns a Hash containing wsse:Timestamp details.
+    def wsse_timestamp
+      wsse_security "Timestamp",
+        "wsu:Created" => (created_at || Time.now).xs_datetime,
+        "wsu:Expires" => (expires_at || (created_at || Time.now) + 60).xs_datetime
+    end
+
+    # Returns a Hash containing wsse:Security details for a given +tag+ and +hash+.
+    def wsse_security(tag, hash)
+      {
+        "wsse:Security" => {
+          "wsse:#{tag}" => hash,
+          :attributes! => { "wsse:#{tag}" => { "wsu:Id" => "#{tag}-#{count}", "xmlns:wsu" => WSUNamespace } }
+        },
+        :attributes! => { "wsse:Security" => { "xmlns:wsse" => WSENamespace } }
+      }
+    end
+
+    # Returns the WSSE password, encrypted for digest authentication.
+    def digest_password
+      token = nonce + timestamp + password
+      Base64.encode64(Digest::SHA1.hexdigest(token)).chomp!
+    end
+
+    # Returns a WSSE nonce.
+    def nonce
+      @nonce ||= Digest::SHA1.hexdigest random_string + timestamp
+    end
+
+    # Returns a random String of 100 characters.
+    def random_string
+      (0...100).map { ("a".."z").to_a[rand(26)] }.join
+    end
+
+    # Returns a WSSE timestamp.
+    def timestamp
+      @timestamp ||= Time.now.xs_datetime
+    end
+
+    # Returns a new number with every call.
+    def count
+      @count ||= 0
+      @count += 1
+    end
+
+    # Returns a memoized and autovivificating Hash.
+    def hash
+      @hash ||= Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
+    end
+
+  end
+end

data/savon.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift lib unless $:.include? lib
+
+require "savon/version"
+
+Gem::Specification.new do |s|
+  s.name = "s-savon"
+  s.version = Savon::Version
+  s.authors = "Daniel Harrington"
+  s.email = "me@rubiii.com"
+  s.homepage = "http://github.com/rubiii/#{s.name}"
+  s.summary = "Heavy metal Ruby SOAP client"
+  s.description = "Savon is the heavy metal Ruby SOAP client."
+
+  s.rubyforge_project = s.name
+
+  s.add_dependency "builder", ">= 2.1.2"
+  s.add_dependency "crack", "~> 0.1.8"
+  s.add_dependency "httpi", ">= 0.7.8"
+  s.add_dependency "gyoku", ">= 0.3.0"
+
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "mocha", "~> 0.9.8"
+  s.add_development_dependency "timecop", "~> 0.3.5"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = "lib"
+end

data/spec/fixtures/response/another_soap_fault.xml

@@ -0,0 +1,14 @@
+<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <SOAP-ENV:Body>
+    <SOAP-ENV:Fault>
+      <faultcode>ERR_NO_SESSION</faultcode>
+      <faultfactor>doGetItemsInfo - Wrong session</faultfactor>
+      <faultstring>Wrong session message</faultstring>
+      <detail><soapVal><ERRNO xsi:type="xsd:string">80:1289245853:55</ERRNO></soapVal></detail>
+    </SOAP-ENV:Fault>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>