aws-sdk-euca 1.8.5

data/lib/aws/core/xml/parser.rb

@@ -0,0 +1,70 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+    module XML
+      class Parser
+
+        # @param [Hash] rules A has of xml parsing rules.  Generally
+        #   rules will come from an xml grammar.
+        def initialize rules = {}
+          @rules = rules
+        end
+
+        # @return [Hash] Returns the rules for this xml parser that define
+        #   how it should transform the XMl into Ruby.
+        attr_reader :rules
+
+        # @param [String] xml An XML document string to parse.
+        # @return [Hash] Returns a hash of parsed xml data.
+        def parse xml
+          xml = '<xml/>' if xml.nil? or xml.empty?
+          sax_handler.parse(xml)
+        end
+
+        # @return [Hash] Returns a hash of mostly empty placeholder data.
+        def simulate
+          XML::Stub.simulate(rules)
+        end
+
+        # @param [String] xml An XML document string to parse.
+        # @param [Hash] rules A has of xml parsing rules.  Generally
+        #   rules will come from an xml grammar.
+        # @return [Hash] Returns a hash of parsed xml data.
+        def self.parse xml, rules = {}
+          self.new(rules).parse(xml)
+        end
+
+        protected
+
+        # There are three handlers, nokogiri is the fastest, followed
+        # by libxml-ruby.  Lastly (by a long shot) is REXML.  REXML
+        # is the only library that does not  rely on a native
+        # extension.
+        #
+        # Currently you can not choose your xml sax handler, and the only
+        # we express a gem dependency on is nokogiri.
+        #
+        def sax_handler
+          begin
+            SaxHandlers::Nokogiri.new(rules)
+          rescue NameError, LoadError
+            SaxHandlers::REXML.new(rules)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws/core/xml/root_frame.rb

@@ -0,0 +1,65 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+    module XML
+
+      class RootFrame < Frame
+
+        def initialize rules
+          @inflected = {}
+          @indexes = {}
+          setup_indexes(rules)
+          super(self, nil, 'XML', rules)
+        end
+
+        def build_child_frame element_name
+          Frame.new(self, self, element_name, rules)
+        end
+
+        def value
+          value = @data.values.find{|v| v.is_a?(Hash) }
+          value ||= {}
+          value.merge(@indexes)
+        end
+
+        def add_to_index index_name, key, value
+          @indexes[index_name] ||= {}
+          @indexes[index_name][key] = value
+        end
+
+        # The root frame maintains a cache of inflected element names.
+        def inflect element_name
+          @inflected[element_name] ||= Inflection.ruby_name(element_name).to_sym
+        end
+
+        protected
+
+        # recursively crawls the parser rules and looks for elements
+        # that index values.  Adds an empty index for each of these.
+        def setup_indexes rules
+          if rules[:children]
+            rules[:children].each_pair do |child_name,child_rules|
+              if index = child_rules[:index]
+                @indexes[index[:name]] = {}
+              end
+              setup_indexes(child_rules)
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws/core/xml/sax_handlers/libxml.rb

@@ -0,0 +1,47 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'libxml'
+
+module AWS
+  module Core
+    module XML
+      module SaxHandlers
+        class LibXML
+          
+          include FrameStack
+          include ::LibXML::XML::SaxParser::Callbacks
+
+          def sax_parse xml
+            sax_parser = ::LibXML::XML::SaxParser.string(xml)
+            sax_parser.callbacks = self
+            sax_parser.parse
+          end
+
+          def on_start_element_ns element_name, attributes, *ignore
+            start_element(element_name, attributes) 
+          end
+
+          def on_end_element_ns *ignore
+            end_element
+          end
+
+          def on_characters chars
+            text(chars)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws/core/xml/sax_handlers/nokogiri.rb

@@ -0,0 +1,55 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'nokogiri'
+
+module AWS
+  module Core
+    module XML
+      module SaxHandlers
+        class Nokogiri
+          
+          include FrameStack
+
+          def sax_parse xml
+            ::Nokogiri::XML::SAX::Parser.new(self).parse(xml)
+          end
+
+          def xmldecl(*args); end
+          def start_document; end
+          def end_document; end
+          def error(*args); end
+
+          def start_element_namespace element_name, attributes = [], *ignore
+
+            attributes = attributes.map.inject({}) do |hash,attr| 
+              hash.merge(attr.localname => attr.value)
+            end
+
+            start_element(element_name, attributes) 
+
+          end
+
+          def end_element_namespace *ignore
+            end_element
+          end
+
+          def characters chars
+            text(chars)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws/core/xml/sax_handlers/ox.rb

@@ -0,0 +1,41 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'stringio'
+require 'ox'
+
+module AWS
+  module Core
+    module XML
+      module SaxHandlers
+        class Ox
+
+          include FrameStack
+
+          def sax_parse xml
+            ::Ox.sax_parse(self, StringIO.new(xml))
+          end
+
+          def start_element name
+            super(name.to_s)
+          end
+
+          def attr name, value
+            attributes(name.to_s => value)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/aws/core/xml/sax_handlers/rexml.rb

@@ -0,0 +1,43 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'rexml/document'
+require 'rexml/streamlistener'
+
+module AWS
+  module Core
+    module XML
+      module SaxHandlers
+        class REXML
+  
+          include FrameStack
+          include ::REXML::StreamListener
+  
+          def sax_parse xml
+            source = ::REXML::Source.new(xml)
+            ::REXML::Parsers::StreamParser.new(source, self).parse
+          end
+  
+          def tag_start name, attrs
+            start_element(name, attrs)
+          end
+    
+          def tag_end name
+            end_element
+          end
+  
+        end
+      end
+    end
+  end
+end

data/lib/aws/core/xml/stub.rb

@@ -0,0 +1,123 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+    module XML
+
+      # This class takes the rules from an XML parser and then
+      # returns a stubbed reponse.  This response has placeholder
+      # values based on the grammar, e.g.
+      #
+      # * Lists are stubbed with empty arrays
+      # * Indexes become empty hashes
+      # * Numeric types are returned as 0
+      # * etc
+      #
+      # This is used primarily to help with the AWS.stub! utility.
+      #
+      class Stub
+
+        # @param [Hash] rules
+        def initialize rules
+          @rules = rules
+        end
+
+        # @return [Hash]
+        attr_reader :rules
+
+        # Returns a hash with stubbed values as if it had parsed
+        # an empty xml document.  
+        # @return [Hash] 
+        def simulate 
+          if rules[:children]
+            data = stub_data_for(rules)
+            apply_empty_indexes(rules, data)
+            data
+          else
+            {}
+          end
+        end
+
+        # Returns a hash with stubbed values as if it had parsed
+        # an empty xml document.  
+        # @param [Hash] rules An XML::Parser rule set.
+        # @return [Hash] 
+        def self.simulate rules
+          stub = Stub.new(rules)
+          stub.simulate
+        end
+
+        protected
+        def stub_data_for rules, data = {}
+          rules[:children].each_pair do |name,child_rules|
+
+            # skip ignored elements
+            if child_rules[:ignore]
+              stub_data_for(child_rules, data) if child_rules[:children]
+              next
+            end
+
+            orig_data = data
+            if wrapper = child_rules[:wrap]
+              data[wrapper] ||= {}
+              data = data[wrapper]
+            end
+
+            ruby_name = child_rules[:rename] || 
+              Inflection.ruby_name(name.to_s).to_sym
+
+            if child_rules[:list]
+              data[ruby_name] = []
+            elsif child_rules[:map]
+              data[ruby_name] = {}
+            elsif child_rules[:children] and !child_rules[:children].empty?
+              data[ruby_name] = stub_data_for(child_rules)
+            else
+              data[ruby_name] = case child_rules[:type]
+                when :integer  then 0 
+                when :float    then 0.0
+                when :time     then Time.now
+                when :datetime then Date.parse(Time.now.to_s)
+                when :boolean  then false
+                else nil
+              end
+            end
+
+            # restore data incase it was redirected for wrapping
+            data = orig_data
+
+          end
+
+          data
+
+        end
+
+        protected
+        def apply_empty_indexes rules, data
+          
+          return unless rules[:children]
+          
+          rules[:children].each_pair do |name,child_rules|
+            if index = child_rules[:index]
+              data[index[:name]] = {}
+            end
+            apply_empty_indexes(child_rules, data)
+          end
+
+        end
+
+      end
+    end
+  end
+end