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.



883
884
885
886
887
888
889
890
 
# File 'lib/awsbase/right_awsbase.rb', line 883

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



964
965
966
967
968
969
970
971
 
# File 'lib/awsbase/right_awsbase.rb', line 964

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.



879
880
881
 
# File 'lib/awsbase/right_awsbase.rb', line 879

def result
  @result
end

#xml_lib ⇒ Object

Returns the value of attribute xml_lib.



881
882
883
 
# File 'lib/awsbase/right_awsbase.rb', line 881

def xml_lib
  @xml_lib
end

#xmlpath ⇒ Object (readonly)

Returns the value of attribute xmlpath.



880
881
882
 
# File 'lib/awsbase/right_awsbase.rb', line 880

def xmlpath
  @xmlpath
end

Class Method Details

.xml_lib ⇒ Object 



871
872
873
 
# File 'lib/awsbase/right_awsbase.rb', line 871

def self.xml_lib
    @@xml_lib
end

.xml_lib=(new_lib_name) ⇒ Object 



875
876
877
 
# File 'lib/awsbase/right_awsbase.rb', line 875

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'



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/awsbase/right_awsbase.rb', line 914

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.new
            xml.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)



974
975
 
# File 'lib/awsbase/right_awsbase.rb', line 974

def reset;
end

#tag_end(name) ⇒ Object 



898
899
900
901
902
903
 
# File 'lib/awsbase/right_awsbase.rb', line 898

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

#tag_start(name, attributes) ⇒ Object 



892
893
894
895
896
 
# File 'lib/awsbase/right_awsbase.rb', line 892

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

#tagend(name) ⇒ Object 



981
982
983
 
# File 'lib/awsbase/right_awsbase.rb', line 981

def tagend(name)
    ;
end

#tagstart(name, attributes) ⇒ Object 



977
978
979
 
# File 'lib/awsbase/right_awsbase.rb', line 977

def tagstart(name, attributes)
    ;
end

#tagtext(text) ⇒ Object 



985
986
987
 
# File 'lib/awsbase/right_awsbase.rb', line 985

def tagtext(text)
    ;
end

#text(text) ⇒ Object 



905
906
907
908
 
# File 'lib/awsbase/right_awsbase.rb', line 905

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