File: xml_serializer.rb

package info (click to toggle)
ruby-aws-sdk 1.67.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,840 kB
  • sloc: ruby: 28,436; makefile: 7
file content (118 lines) | stat: -rw-r--r-- 3,687 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# 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 Options

      # Given a hash of serialization rules, an XMLSerializer can convert
      # a hash of request options into XML.  The request options are
      # validated before returning XML.
      class XMLSerializer

        # @param [String] namespace
        # @param [String] operation_name
        # @param [Hash] operation
        def initialize namespace, operation_name, operation
          @namespace = namespace
          @operation_name = operation_name
          @rules = operation[:inputs]
          @http = operation[:http]
          @validator = Validator.new(rules)
        end

        # @return [String] Returns the name of the API operation.
        attr_reader :operation_name

        # @return [String]
        attr_reader :namespace

        # @return [Hash]
        attr_reader :rules

        # @return [Hash,nil]
        attr_reader :http

        # @return [Validator]
        attr_reader :validator

        # @overload serialize!(request_options)
        #   @param [Hash] request_options A hash of already validated
        #     request options with normalized values.
        #   @return [String] Returns an string of the request parameters
        #     serialized into XML.
        def serialize request_options
          if http && http[:request_payload]
            payload = http[:request_payload]
            root_node_name = rules[payload][:name]
            params = request_options[payload]
            rules = self.rules[payload][:members]
          else
            root_node_name = "#{operation_name}Request"
            params = request_options
            rules = self.rules
          end
          xml = Nokogiri::XML::Builder.new
          xml.send(root_node_name, :xmlns => namespace) do |xml|
            hash_members_xml(params, rules, xml)
          end
          xml.doc.root.to_xml
        end

        protected

        def to_xml builder, opt_name, rules, value

          xml_name = rules[:name]
          xml_name ||= opt_name.is_a?(String) ?
            opt_name : Inflection.class_name(opt_name.to_s)

          case value
          when Hash

            builder.send(xml_name) do |builder|
              hash_members_xml(value, rules[:members], builder)
            end

          when Array
            builder.send(xml_name) do
              value.each do |member_value|
                to_xml(builder, 'member', rules[:members], member_value)
              end
            end
          else builder.send(xml_name, value)
          end

        end

        def hash_members_xml hash, rules, builder
          xml_ordered_members(rules).each do |member_name|
            if hash.key?(member_name)
              value = hash[member_name]
              to_xml(builder, member_name, rules[member_name], value)
            end
          end
        end

        def xml_ordered_members members
          members.inject([]) do |list,(member_name, member)|
            list << [member[:position] || 0, member_name]
          end.sort_by(&:first).map(&:last)
        end

      end
    end
  end
end