Class: RightAws::RightAWSParser

Inherits:

Object

Object
RightAws::RightAWSParser

show all

Defined in:

lib/awsbase/right_awsbase.rb

Overview

:nodoc:

Direct Known Subclasses

Constant Summary

DEFAULT_XML_LIBRARY = default parsing library

'rexml'

@@supported_xml_libs = a list of supported parsers

[DEFAULT_XML_LIBRARY, 'libxml']

@@xml_lib = xml library name: 'rexml' | 'libxml'

DEFAULT_XML_LIBRARY

Instance Attribute Summary (collapse)

- (Object) full_tag_name readonly

Returns the value of attribute full_tag_name.
- (Object) result

Returns the value of attribute result.
- (Object) tag readonly

Returns the value of attribute tag.
- (Object) xml_lib

Returns the value of attribute xml_lib.
- (Object) xmlpath readonly

Returns the value of attribute xmlpath.

Class Method Summary (collapse)

Instance Method Summary (collapse)

- (RightAWSParser) initialize(params = {}) constructor

A new instance of RightAWSParser.
- (Object) method_missing(method, *params)

Parser must have a lots of methods (see /usr/lib/ruby/1.8/rexml/parsers/streamparser.rb) We dont need most of them in RightAWSParser and method_missing helps us to skip their definition.
- (Object) parse(xml_text, params = {})

Parser method.
- (Object) reset

the functions to be overriden by children (if nessesery).
- (Object) tag_end(name)
- (Object) tag_start(name, attributes)
- (Object) tagend(name)
- (Object) tagstart(name, attributes)
- (Object) tagtext(text)
- (Object) text(text)

Constructor Details

- (`RightAWSParser`) initialize(params = {})

A new instance of RightAWSParser

# File 'lib/awsbase/right_awsbase.rb', line 1202

def initialize(params={})
  @xmlpath = ''
  @full_tag_name = ''
  @result  = false
  @text    = ''
  @tag     = ''
  @xml_lib = params[:xml_lib] || @@xml_lib
  @logger  = params[:logger]
  reset
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (`Object`) method_missing(method, *params)

Parser must have a lots of methods (see /usr/lib/ruby/1.8/rexml/parsers/streamparser.rb) We dont need most of them in RightAWSParser and method_missing helps us to skip their definition

# File 'lib/awsbase/right_awsbase.rb', line 1286

def method_missing(method, *params)
    # if the method is one of known - just skip it ...
  return if [:comment, :attlistdecl, :notationdecl, :elementdecl, 
             :entitydecl, :cdata, :xmldecl, :attlistdecl, :instruction, 
             :doctype].include?(method)
    # ... else - call super to raise an exception
  super(method, params)
end

Instance Attribute Details

- (`Object`) full_tag_name (readonly)

Returns the value of attribute full_tag_name



1199
1200
1201

# File 'lib/awsbase/right_awsbase.rb', line 1199

def full_tag_name
  @full_tag_name
end

- (`Object`) result

Returns the value of attribute result



1196
1197
1198

# File 'lib/awsbase/right_awsbase.rb', line 1196

def result
  @result
end

- (`Object`) tag (readonly)

Returns the value of attribute tag



1200
1201
1202

# File 'lib/awsbase/right_awsbase.rb', line 1200

def tag
  @tag
end

- (`Object`) xml_lib

Returns the value of attribute xml_lib



1198
1199
1200

# File 'lib/awsbase/right_awsbase.rb', line 1198

def xml_lib
  @xml_lib
end

- (`Object`) xmlpath (readonly)

Returns the value of attribute xmlpath



1197
1198
1199

# File 'lib/awsbase/right_awsbase.rb', line 1197

def xmlpath
  @xmlpath
end

Class Method Details

+ (`Object`) xml_lib



1189
1190
1191

# File 'lib/awsbase/right_awsbase.rb', line 1189

def self.xml_lib
  @@xml_lib
end

+ (`Object`) xml_lib=(new_lib_name)



1192
1193
1194

# File 'lib/awsbase/right_awsbase.rb', line 1192

def self.xml_lib=(new_lib_name)
  @@xml_lib = new_lib_name
end

Instance Method Details

- (`Object`) parse(xml_text, params = {})

Parser method. Params:

xml_text         - xml message text(String) or Net:HTTPxxx instance (response)
params[:xml_lib] - library name: 'rexml' | 'libxml'

# File 'lib/awsbase/right_awsbase.rb', line 1232

def parse(xml_text, params={})
    # Get response body
  xml_text = xml_text.body unless xml_text.is_a?(String)
  @xml_lib = params[:xml_lib] || @xml_lib
    # check that we had no problems with this library otherwise use default 
  @xml_lib = DEFAULT_XML_LIBRARY unless @@supported_xml_libs.include?(@xml_lib)       
    # load xml library
  if @xml_lib=='libxml' && !defined?(XML::SaxParser)
    begin
      require 'xml/libxml'
      # Setup SaxParserCallback 
      if XML::Parser::VERSION >= '0.5.1' &&
         XML::Parser::VERSION  < '0.9.7'
        RightSaxParserCallback.include_callback
      end           
    rescue LoadError => e
      @@supported_xml_libs.delete(@xml_lib)
      @xml_lib = DEFAULT_XML_LIBRARY
      if @logger
        @logger.error e.inspect
        @logger.error e.backtrace
        @logger.info "Can not load 'libxml' library. '#{DEFAULT_XML_LIBRARY}' is used for parsing."
      end
    end
  end
    # Parse the xml text
  case @xml_lib
  when 'libxml'
    if XML::Parser::VERSION >= '0.9.9'
      # avoid warning on every usage
      xml        = XML::SaxParser.string(xml_text)
    else
      xml        = XML::SaxParser.new
      xml.string = xml_text 
    end
    # check libxml-ruby version 
    if    XML::Parser::VERSION >= '0.9.7'
      xml.callbacks = RightSaxParserCallbackNs.new(self)
    elsif XML::Parser::VERSION >= '0.5.1'
      xml.callbacks = RightSaxParserCallback.new(self) 
    else 
      xml.on_start_element{|name, attr_hash| self.tag_start(name, attr_hash)} 
      xml.on_characters{   |text|            self.text(text)}
      xml.on_end_element{  |name|            self.tag_end(name)} 
    end 
    xml.parse
  else
    REXML::Document.parse_stream(xml_text, self)
  end
end

- (`Object`) reset

the functions to be overriden by children (if nessesery)

1295	# File 'lib/awsbase/right_awsbase.rb', line 1295 def reset ; end

- (`Object`) tag_end(name)

# File 'lib/awsbase/right_awsbase.rb', line 1219

def tag_end(name)
  @xmlpath = @full_tag_name[/^(.*?)\/?#{name}$/] && $1
  tagend(name)
  @full_tag_name = @xmlpath
end

- (`Object`) tag_start(name, attributes)

# File 'lib/awsbase/right_awsbase.rb', line 1212

def tag_start(name, attributes)
  @text = ''
  @tag  = name
  @full_tag_name += @full_tag_name.empty? ? name : "/#{name}"
  tagstart(name, attributes)
  @xmlpath = @full_tag_name
end

- (`Object`) tagend(name)

1297	# File 'lib/awsbase/right_awsbase.rb', line 1297 def tagend(name) ; end

- (`Object`) tagstart(name, attributes)

1296	# File 'lib/awsbase/right_awsbase.rb', line 1296 def tagstart(name, attributes); end

- (`Object`) tagtext(text)

1298	# File 'lib/awsbase/right_awsbase.rb', line 1298 def tagtext(text) ; end

- (`Object`) text(text)

# File 'lib/awsbase/right_awsbase.rb', line 1224

def text(text)
  @text += text
  tagtext(text)
end

Class: RightAws::RightAWSParser

Overview

Direct Known Subclasses

Constant Summary

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (RightAWSParser) initialize(params = {})

Dynamic Method Handling

- (Object) method_missing(method, *params)

Instance Attribute Details

- (Object) full_tag_name (readonly)

- (Object) result

- (Object) tag (readonly)

- (Object) xml_lib

- (Object) xmlpath (readonly)

Class Method Details

+ (Object) xml_lib

+ (Object) xml_lib=(new_lib_name)

Instance Method Details

- (Object) parse(xml_text, params = {})

- (Object) reset

- (Object) tag_end(name)

- (Object) tag_start(name, attributes)

- (Object) tagend(name)

- (Object) tagstart(name, attributes)

- (Object) tagtext(text)

- (Object) text(text)