rubysl-soap 0.0.1 → 1.0.0

data/lib/soap/parser.rb

@@ -0,0 +1,251 @@
+# SOAP4R - SOAP XML Instance Parser library.
+# Copyright (C) 2001, 2003  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'xsd/ns'
+require 'xsd/xmlparser'
+require 'soap/soap'
+require 'soap/baseData'
+require 'soap/encodingstyle/handler'
+
+
+module SOAP
+
+
+class Parser
+  include SOAP
+
+  class ParseError < Error; end
+  class FormatDecodeError < ParseError; end
+  class UnexpectedElementError < ParseError; end
+
+private
+
+  class ParseFrame
+    attr_reader :node
+    attr_reader :name
+    attr_reader :ns, :encodingstyle
+
+    class NodeContainer
+      def initialize(node)
+	@node = node
+      end
+
+      def node
+	@node
+      end
+
+      def replace_node(node)
+	@node = node
+      end
+    end
+
+  public
+
+    def initialize(ns, name, node, encodingstyle)
+      @ns = ns
+      @name = name
+      self.node = node
+      @encodingstyle = encodingstyle
+    end
+
+    def node=(node)
+      @node = NodeContainer.new(node)
+    end
+  end
+
+public
+
+  attr_accessor :envelopenamespace
+  attr_accessor :default_encodingstyle
+  attr_accessor :decode_typemap
+  attr_accessor :allow_unqualified_element
+
+  def initialize(opt = {})
+    @opt = opt
+    @parser = XSD::XMLParser.create_parser(self, opt)
+    @parsestack = nil
+    @lastnode = nil
+    @handlers = {}
+    @envelopenamespace = opt[:envelopenamespace] || EnvelopeNamespace
+    @default_encodingstyle = opt[:default_encodingstyle] || EncodingNamespace
+    @decode_typemap = opt[:decode_typemap] || nil
+    @allow_unqualified_element = opt[:allow_unqualified_element] || false
+  end
+
+  def charset
+    @parser.charset
+  end
+
+  def parse(string_or_readable)
+    @parsestack = []
+    @lastnode = nil
+
+    @handlers.each do |uri, handler|
+      handler.decode_prologue
+    end
+
+    @parser.do_parse(string_or_readable)
+
+    unless @parsestack.empty?
+      raise FormatDecodeError.new("Unbalanced tag in XML.")
+    end
+
+    @handlers.each do |uri, handler|
+      handler.decode_epilogue
+    end
+
+    @lastnode
+  end
+
+  def start_element(name, attrs)
+    lastframe = @parsestack.last
+    ns = parent = parent_encodingstyle = nil
+    if lastframe
+      ns = lastframe.ns.clone_ns
+      parent = lastframe.node
+      parent_encodingstyle = lastframe.encodingstyle
+    else
+      ns = XSD::NS.new
+      parent = ParseFrame::NodeContainer.new(nil)
+      parent_encodingstyle = nil
+    end
+
+    attrs = XSD::XMLParser.filter_ns(ns, attrs)
+    encodingstyle = find_encodingstyle(ns, attrs)
+
+    # Children's encodingstyle is derived from its parent.
+    if encodingstyle.nil?
+      if parent.node.is_a?(SOAPHeader)
+        encodingstyle = LiteralNamespace
+      else
+        encodingstyle = parent_encodingstyle || @default_encodingstyle
+      end
+    end
+
+    node = decode_tag(ns, name, attrs, parent, encodingstyle)
+
+    @parsestack << ParseFrame.new(ns, name, node, encodingstyle)
+  end
+
+  def characters(text)
+    lastframe = @parsestack.last
+    if lastframe
+      # Need not to be cloned because character does not have attr.
+      decode_text(lastframe.ns, text, lastframe.encodingstyle)
+    else
+      # Ignore Text outside of SOAP Envelope.
+      p text if $DEBUG
+    end
+  end
+
+  def end_element(name)
+    lastframe = @parsestack.pop
+    unless name == lastframe.name
+      raise UnexpectedElementError.new("Closing element name '#{ name }' does not match with opening element '#{ lastframe.name }'.")
+    end
+    decode_tag_end(lastframe.ns, lastframe.node, lastframe.encodingstyle)
+    @lastnode = lastframe.node.node
+  end
+
+private
+
+  def find_encodingstyle(ns, attrs)
+    attrs.each do |key, value|
+      if (ns.compare(@envelopenamespace, AttrEncodingStyle, key))
+	return value
+      end
+    end
+    nil
+  end
+
+  def decode_tag(ns, name, attrs, parent, encodingstyle)
+    ele = ns.parse(name)
+
+    # Envelope based parsing.
+    if ((ele.namespace == @envelopenamespace) ||
+	(@allow_unqualified_element && ele.namespace.nil?))
+      o = decode_soap_envelope(ns, ele, attrs, parent)
+      return o if o
+    end
+
+    # Encoding based parsing.
+    handler = find_handler(encodingstyle)
+    if handler
+      return handler.decode_tag(ns, ele, attrs, parent)
+    else
+      raise FormatDecodeError.new("Unknown encodingStyle: #{ encodingstyle }.")
+    end
+  end
+
+  def decode_tag_end(ns, node, encodingstyle)
+    return unless encodingstyle
+
+    handler = find_handler(encodingstyle)
+    if handler
+      return handler.decode_tag_end(ns, node)
+    else
+      raise FormatDecodeError.new("Unknown encodingStyle: #{ encodingstyle }.")
+    end
+  end
+
+  def decode_text(ns, text, encodingstyle)
+    handler = find_handler(encodingstyle)
+
+    if handler
+      handler.decode_text(ns, text)
+    else
+      # How should I do?
+    end
+  end
+
+  def decode_soap_envelope(ns, ele, attrs, parent)
+    o = nil
+    if ele.name == EleEnvelope
+      o = SOAPEnvelope.new
+      if ext = @opt[:external_content]
+	ext.each do |k, v|
+	  o.external_content[k] = v
+	end
+      end
+    elsif ele.name == EleHeader
+      unless parent.node.is_a?(SOAPEnvelope)
+	raise FormatDecodeError.new("Header should be a child of Envelope.")
+      end
+      o = SOAPHeader.new
+      parent.node.header = o
+    elsif ele.name == EleBody
+      unless parent.node.is_a?(SOAPEnvelope)
+	raise FormatDecodeError.new("Body should be a child of Envelope.")
+      end
+      o = SOAPBody.new
+      parent.node.body = o
+    elsif ele.name == EleFault
+      unless parent.node.is_a?(SOAPBody)
+	raise FormatDecodeError.new("Fault should be a child of Body.")
+      end
+      o = SOAPFault.new
+      parent.node.fault = o
+    end
+    o
+  end
+
+  def find_handler(encodingstyle)
+    unless @handlers.key?(encodingstyle)
+      handler_factory = SOAP::EncodingStyle::Handler.handler(encodingstyle) ||
+	SOAP::EncodingStyle::Handler.handler(EncodingNamespace)
+      handler = handler_factory.new(@parser.charset)
+      handler.decode_typemap = @decode_typemap
+      handler.decode_prologue
+      @handlers[encodingstyle] = handler
+    end
+    @handlers[encodingstyle]
+  end
+end
+
+
+end

data/lib/soap/processor.rb

@@ -0,0 +1,66 @@
+# SOAP4R - marshal/unmarshal interface.
+# Copyright (C) 2000, 2001, 2003  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'xsd/datatypes'
+require 'soap/soap'
+require 'soap/element'
+require 'soap/parser'
+require 'soap/generator'
+require 'soap/encodingstyle/soapHandler'
+require 'soap/encodingstyle/literalHandler'
+require 'soap/encodingstyle/aspDotNetHandler'
+
+
+module SOAP
+
+
+module Processor
+  @@default_parser_option = {}
+
+  class << self
+  public
+
+    def marshal(env, opt = {}, io = nil)
+      generator = create_generator(opt)
+      marshalled_str = generator.generate(env, io)
+      unless env.external_content.empty?
+	opt[:external_content] = env.external_content
+      end
+      marshalled_str
+    end
+
+    def unmarshal(stream, opt = {})
+      parser = create_parser(opt)
+      parser.parse(stream)
+    end
+
+    def default_parser_option=(rhs)
+      @@default_parser_option = rhs
+    end
+
+    def default_parser_option
+      @@default_parser_option
+    end
+
+  private
+
+    def create_generator(opt)
+      SOAPGenerator.new(opt)
+    end
+
+    def create_parser(opt)
+      if opt.empty?
+	opt = @@default_parser_option
+      end
+      ::SOAP::Parser.new(opt)
+    end
+  end
+end
+
+
+end

data/lib/soap/property.rb

@@ -0,0 +1,333 @@
+# soap/property.rb: SOAP4R - Property implementation.
+# Copyright (C) 2003  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+module SOAP
+
+
+# Property stream format:
+#
+#   line separator is \r?\n.  1 line per a property.
+#   line which begins with '#' is a comment line.  empty line is ignored, too.
+#   key/value separator is ':' or '='.
+#   '\' as escape character.  but line separator cannot be escaped.
+#   \s at the head/tail of key/value are trimmed.
+#
+#   '[' + key + ']' indicates property section.  for example,
+#
+#     [aaa.bbb]
+#     ccc = ddd
+#     eee.fff = ggg
+#     []
+#     aaa.hhh = iii
+#
+#   is the same as;
+#
+#     aaa.bbb.ccc = ddd
+#     aaa.bbb.eee.fff = ggg
+#     aaa.hhh = iii
+#
+class Property
+  FrozenError = (RUBY_VERSION >= "1.9.0") ? RuntimeError : TypeError
+
+  include Enumerable
+
+  module Util
+    def const_from_name(fqname)
+      fqname.split("::").inject(Kernel) { |klass, name| klass.const_get(name) }
+    end
+    module_function :const_from_name
+
+    def require_from_name(fqname)
+      require File.join(fqname.split("::").collect { |ele| ele.downcase })
+    end
+    module_function :require_from_name
+  end
+
+  def self.load(stream)
+    new.load(stream)
+  end
+
+  def self.loadproperty(propname)
+    new.loadproperty(propname)
+  end
+
+  def initialize
+    @store = Hash.new
+    @hook = Hash.new
+    @self_hook = Array.new
+    @locked = false
+  end
+
+  KEY_REGSRC = '([^=:\\\\]*(?:\\\\.[^=:\\\\]*)*)'
+  DEF_REGSRC = '\\s*' + KEY_REGSRC + '\\s*[=:]\\s*(.*)'
+  COMMENT_REGEXP = Regexp.new('^(?:#.*|)$')
+  CATDEF_REGEXP = Regexp.new("^\\[\\s*#{KEY_REGSRC}\\s*\\]$")
+  LINE_REGEXP = Regexp.new("^#{DEF_REGSRC}$")
+  def load(stream)
+    key_prefix = ""
+    stream.each_with_index do |line, lineno|
+      line.sub!(/\r?\n\z/, '')
+      case line
+      when COMMENT_REGEXP
+	next
+      when CATDEF_REGEXP
+	key_prefix = $1.strip
+      when LINE_REGEXP
+	key, value = $1.strip, $2.strip
+	key = "#{key_prefix}.#{key}" unless key_prefix.empty?
+	key, value = loadstr(key), loadstr(value)
+	self[key] = value
+      else
+	raise TypeError.new(
+	  "property format error at line #{lineno + 1}: `#{line}'")
+      end
+    end
+    self
+  end
+
+  # find property from $:.
+  def loadproperty(propname)
+    return loadpropertyfile(propname) if File.file?(propname)
+    $:.each do |path|
+      if File.file?(file = File.join(path, propname))
+        return loadpropertyfile(file)
+      end
+    end
+    nil
+  end
+
+  # name: a Symbol, String or an Array
+  def [](name)
+    referent(name_to_a(name))
+  end
+
+  # name: a Symbol, String or an Array
+  # value: an Object
+  def []=(name, value)
+    name_pair = name_to_a(name).freeze
+    hooks = assign(name_pair, value)
+    hooks.each do |hook|
+      hook.call(name_pair, value)
+    end
+    value
+  end
+
+  # value: an Object
+  # key is generated by property
+  def <<(value)
+    self[generate_new_key] = value
+  end
+
+  # name: a Symbol, String or an Array; nil means hook to the root
+  # cascade: true/false; for cascading hook of sub key
+  # hook: block which will be called with 2 args, name and value
+  def add_hook(name = nil, cascade = false, &hook)
+    if name == nil or name == true or name == false
+      cascade = name
+      assign_self_hook(cascade, &hook)
+    else
+      assign_hook(name_to_a(name), cascade, &hook)
+    end
+  end
+
+  def each
+    @store.each do |key, value|
+      yield(key, value)
+    end
+  end
+
+  def empty?
+    @store.empty?
+  end
+
+  def keys
+    @store.keys
+  end
+
+  def values
+    @store.values
+  end
+
+  def lock(cascade = false)
+    if cascade
+      each_key do |key|
+	key.lock(cascade)
+      end
+    end
+    @locked = true
+    self
+  end
+
+  def unlock(cascade = false)
+    @locked = false
+    if cascade
+      each_key do |key|
+	key.unlock(cascade)
+      end
+    end
+    self
+  end
+
+  def locked?
+    @locked
+  end
+
+protected
+
+  def deref_key(key)
+    check_lock(key)
+    ref = @store[key] ||= self.class.new
+    unless propkey?(ref)
+      raise ArgumentError.new("key `#{key}' already defined as a value")
+    end
+    ref
+  end
+
+  def local_referent(key)
+    check_lock(key)
+    if propkey?(@store[key]) and @store[key].locked?
+      raise FrozenError.new("cannot split any key from locked property")
+    end
+    @store[key]
+  end
+
+  def local_assign(key, value)
+    check_lock(key)
+    if @locked
+      if propkey?(value)
+	raise FrozenError.new("cannot add any key to locked property")
+      elsif propkey?(@store[key])
+	raise FrozenError.new("cannot override any key in locked property")
+      end
+    end
+    @store[key] = value
+  end
+
+  def local_hook(key, direct)
+    hooks = []
+    (@self_hook + (@hook[key] || NO_HOOK)).each do |hook, cascade|
+      hooks << hook if direct or cascade
+    end
+    hooks
+  end
+
+  def local_assign_hook(key, cascade, &hook)
+    check_lock(key)
+    @store[key] ||= nil
+    (@hook[key] ||= []) << [hook, cascade]
+  end
+
+private
+
+  NO_HOOK = [].freeze
+
+  def referent(ary)
+    ary[0..-2].inject(self) { |ref, name|
+      ref.deref_key(to_key(name))
+    }.local_referent(to_key(ary.last))
+  end
+
+  def assign(ary, value)
+    ref = self
+    hook = NO_HOOK
+    ary[0..-2].each do |name|
+      key = to_key(name)
+      hook += ref.local_hook(key, false)
+      ref = ref.deref_key(key)
+    end
+    last_key = to_key(ary.last)
+    ref.local_assign(last_key, value)
+    hook + ref.local_hook(last_key, true)
+  end
+
+  def assign_hook(ary, cascade, &hook)
+    ary[0..-2].inject(self) { |ref, name|
+      ref.deref_key(to_key(name))
+    }.local_assign_hook(to_key(ary.last), cascade, &hook)
+  end
+
+  def assign_self_hook(cascade, &hook)
+    check_lock(nil)
+    @self_hook << [hook, cascade]
+  end
+
+  def each_key
+    self.each do |key, value|
+      if propkey?(value)
+	yield(value)
+      end
+    end
+  end
+
+  def check_lock(key)
+    if @locked and (key.nil? or !@store.key?(key))
+      raise FrozenError.new("cannot add any key to locked property")
+    end
+  end
+
+  def propkey?(value)
+    value.is_a?(::SOAP::Property)
+  end
+
+  def name_to_a(name)
+    case name
+    when Symbol
+      [name]
+    when String
+      name.scan(/[^.\\]+(?:\\.[^.\\])*/)	# split with unescaped '.'
+    when Array
+      name
+    else
+      raise ArgumentError.new("Unknown name #{name}(#{name.class})")
+    end
+  end
+
+  def to_key(name)
+    name.to_s.downcase
+  end
+
+  def generate_new_key
+    if @store.empty?
+      "0"
+    else
+      (key_max + 1).to_s
+    end
+  end
+
+  def key_max
+    (@store.keys.max { |l, r| l.to_s.to_i <=> r.to_s.to_i }).to_s.to_i
+  end
+
+  def loadpropertyfile(file)
+    puts "find property at #{file}" if $DEBUG
+    File.open(file) do |f|
+      load(f)
+    end
+  end
+
+  def loadstr(str)
+    str.gsub(/\\./) { |c| eval("\"#{c}\"") }
+  end
+end
+
+
+end
+
+
+# for ruby/1.6.
+unless Enumerable.instance_methods.include?('inject')
+  module Enumerable
+    def inject(init)
+      result = init
+      each do |item|
+	result = yield(result, item)
+      end
+      result
+    end
+  end
+end