Class: Aws::AwsParser

Inherits:
Object show all
Defined in:
lib/awsbase/right_awsbase.rb

Overview

:nodoc:

Direct Known Subclasses

Aws::AcfInterface::AcfDistributionConfigParser, Aws::AcfInterface::AcfDistributionListParser, Aws::AcfInterface::AcfDistributionParser, Ec2::QEc2AllocateAddressParser, Ec2::QEc2AttachAndDetachVolumeParser, Ec2::QEc2BundleInstanceParser, Ec2::QEc2ConfirmProductInstanceParser, Ec2::QEc2CreateKeyPairParser, Ec2::QEc2CreateSnapshotParser, Ec2::QEc2CreateVolumeParser, Ec2::QEc2DescribeAddressesParser, Ec2::QEc2DescribeAvailabilityZonesParser, Ec2::QEc2DescribeBundleTasksParser, Ec2::QEc2DescribeImageAttributeParser, Ec2::QEc2DescribeImagesParser, Ec2::QEc2DescribeInstancesParser, Ec2::QEc2DescribeKeyPairParser, Ec2::QEc2DescribeRegionsParser, Ec2::QEc2DescribeSecurityGroupsParser, Ec2::QEc2DescribeSnapshotsParser, Ec2::QEc2DescribeVolumesParser, Ec2::QEc2GetConsoleOutputParser, Ec2::QEc2MonitorInstancesParser, Ec2::QEc2RegisterImageParser, Ec2::QEc2TerminateInstancesParser, Ec2::RightBoolResponseParser, Elb::QElbCreateParser, Elb::QElbDeleteParser, Elb::QElbDescribeInstancesHealthParser, Elb::QElbDescribeLoadBalancersParser, Elb::QElbRegisterInstancesParser, Mon::QMonGetMetricStatistics, Mon::QMonListMetrics, RightErrorResponseParser, RightHttp2xxParser, S3Interface::S3AclParser, S3Interface::S3BucketLocationParser, S3Interface::S3CopyParser, S3Interface::S3ImprovedListBucketParser, S3Interface::S3ListAllMyBucketsParser, S3Interface::S3ListBucketParser, S3Interface::S3LoggingParser, SdbInterface::QSdbDomainMetadataParser, SdbInterface::QSdbGetAttributesParser, SdbInterface::QSdbListDomainParser, SdbInterface::QSdbQueryParser, SdbInterface::QSdbQueryWithAttributesParser, SdbInterface::QSdbSelectParser, SdbInterface::QSdbSimpleParser, SqsInterface::SqsCreateQueueParser, SqsInterface::SqsGetQueueAttributesParser, SqsInterface::SqsListQueuesParser, SqsInterface::SqsReceiveMessageParser, SqsInterface::SqsSendMessagesParser, SqsInterface::SqsStatusParser

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ AwsParser

Returns a new instance of AwsParser.



1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/awsbase/right_awsbase.rb', line 1010

def initialize(params={})
    @xmlpath = ''
    @result = false
    @text = ''
    @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

#method_missing(method, *params) ⇒ Object

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



1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/awsbase/right_awsbase.rb', line 1090

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

#result ⇒ Object

Returns the value of attribute result.



1006
1007
1008
 
# File 'lib/awsbase/right_awsbase.rb', line 1006

def result
  @result
end

#xml_lib ⇒ Object

Returns the value of attribute xml_lib.



1008
1009
1010
 
# File 'lib/awsbase/right_awsbase.rb', line 1008

def xml_lib
  @xml_lib
end

#xmlpath ⇒ Object (readonly)

Returns the value of attribute xmlpath.



1007
1008
1009
 
# File 'lib/awsbase/right_awsbase.rb', line 1007

def xmlpath
  @xmlpath
end

Class Method Details

.xml_lib ⇒ Object 



998
999
1000
 
# File 'lib/awsbase/right_awsbase.rb', line 998

def self.xml_lib
    @@xml_lib
end

.xml_lib=(new_lib_name) ⇒ Object 



1002
1003
1004
 
# File 'lib/awsbase/right_awsbase.rb', line 1002

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

Instance Method Details

#parse(xml_text, params = {}) ⇒ Object

Parser method. Params:

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



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/awsbase/right_awsbase.rb', line 1041

def parse(xml_text, params={})
    # Get response body
    unless xml_text.is_a?(String)
        xml_text = xml_text.body.respond_to?(:force_encoding) ? xml_text.body.force_encoding("UTF-8") : xml_text.body
    end

    @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'
            # is it new ? - Setup SaxParserCallback
            if XML::Parser::VERSION >= '0.5.1.0'
                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'
            xml = XML::SaxParser.string(xml_text)
            # check libxml-ruby version
            if XML::Parser::VERSION >= '0.5.1.0'
                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

#reset ⇒ Object

the functions to be overriden by children (if nessesery)



1100
1101
 
# File 'lib/awsbase/right_awsbase.rb', line 1100

def reset;
end

#tag_end(name) ⇒ Object 



1025
1026
1027
1028
1029
1030
 
# File 'lib/awsbase/right_awsbase.rb', line 1025

def tag_end(name)
    if @xmlpath =~ /^(.*?)\/?#{name}$/
        @xmlpath = $1
    end
    tagend(name)
end

#tag_start(name, attributes) ⇒ Object 



1019
1020
1021
1022
1023
 
# File 'lib/awsbase/right_awsbase.rb', line 1019

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

#tagend(name) ⇒ Object 



1107
1108
1109
 
# File 'lib/awsbase/right_awsbase.rb', line 1107

def tagend(name)
    ;
end

#tagstart(name, attributes) ⇒ Object 



1103
1104
1105
 
# File 'lib/awsbase/right_awsbase.rb', line 1103

def tagstart(name, attributes)
    ;
end

#tagtext(text) ⇒ Object 



1111
1112
1113
 
# File 'lib/awsbase/right_awsbase.rb', line 1111

def tagtext(text)
    ;
end

#text(text) ⇒ Object 



1032
1033
1034
1035
 
# File 'lib/awsbase/right_awsbase.rb', line 1032

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