Class: Genio::Parser::Format::Wadl

Inherits:
Base
  • Object
show all
Defined in:
lib/genio/parser/format/wadl.rb

Direct Known Subclasses

Wsdl

Instance Attribute Summary collapse

Attributes inherited from Base

#data_types, #endpoint, #enum_types, #files, #options, #services

Instance Method Summary collapse

Methods inherited from Base

#expand_path, #initialize, #load_files, #open, #read_file, #to_iodocs

Methods included from Logging

#logger

Constructor Details

This class inherits a constructor from Genio::Parser::Format::Base

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



24
25
26
 
# File 'lib/genio/parser/format/wadl.rb', line 24

def attributes
  @attributes
end

#current_schema ⇒ Object

Returns the value of attribute current_schema.



24
25
26
 
# File 'lib/genio/parser/format/wadl.rb', line 24

def current_schema
  @current_schema
end

#element_form_defaults ⇒ Object

Returns the value of attribute element_form_defaults.



24
25
26
 
# File 'lib/genio/parser/format/wadl.rb', line 24

def element_form_defaults
  @element_form_defaults
end

#namespaces ⇒ Object

Returns the value of attribute namespaces.



24
25
26
 
# File 'lib/genio/parser/format/wadl.rb', line 24

def namespaces
  @namespaces
end

Instance Method Details

#add_operation(operation) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/genio/parser/format/wadl.rb', line 238

def add_operation(operation)
  path = operation.path.split("/")
  type =
    if path[-1] =~ /^{/ and path[-2].present? and self.data_types[valid_class(path[-2])]
      valid_class(path[-2])
    elsif path[-2] =~ /^{/ and path[-3].present? and self.data_types[valid_class(path[-3])]
      valid_class(path[-3])
    elsif path[-1].present? and path[-1] !~ /^{/ and self.data_types[valid_class(path[-1])]
      valid_class(path[-1])
    elsif operation.response and self.data_types[operation.response]
      operation.response
    elsif operation.request and self.data_types[operation.request]
      operation.request
    else
      "Service"
    end
  if type
    self.data_types[type] ||= Types::DataType.new( :properties => {} )
    self.services[type] ||= Types::Service.new( :operations => {} )
    name = operation_name(operation)
    self.services[type].operations[name] = operation
  end
end

#get_element(name, level = 0) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/genio/parser/format/wadl.rb', line 137

def get_element(name, level = 0)
  if name.present?
     element = self.current_schema.css("elements element[name=#{name}]").first
     if element and element.attr("name") != element.attr("type") and level > 0
       get_element(element.attr("type"), level - 1 ) || element
     else
       element
     end
  end
end

#load(file) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/genio/parser/format/wadl.rb', line 26

def load(file)
  return if self.files[file]
  self.files[file] = file

  doc = load_doc(file)
  schema = xslt.transform(doc)
  schema.remove_namespaces!

  parse_schema(schema)
end

#load_doc(file) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/genio/parser/format/wadl.rb', line 37

def load_doc(file)
  logger.info "GET #{file}"
  document = Nokogiri::XML(open(file).read)

  import_document = document.dup
  import_document.remove_namespaces!

  import_document.css("schema import").each do |import|
    if import.attr("schemaLocation")
      import_file = File.join(File.dirname(file), import.attr("schemaLocation"))
      logger.info "GET #{import_file}"
      parent = document.css("definitions types").first
      if parent and parent.children.first
        xml = Nokogiri::XML(open(import_file).read)
        xml.children.each{|element| parent.children.first.before(element) }
      end
    end
  end

  document
end

#operation_property(type) ⇒ Object 



230
231
232
233
234
235
236
 
# File 'lib/genio/parser/format/wadl.rb', line 230

def operation_property(type)
  property = Types::Property.new(type.attributes.map{|k,v| [k, v.value] })
  property.type = valid_type(property.element) || "string"
  element = get_element(property.type)
  property.type = valid_type(element.attr(:type)) if element and element.attr(:type).present?
  property
end

#parse_data_type(kls, default_package = nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/genio/parser/format/wadl.rb', line 113

def parse_data_type(kls, default_package = nil)
  attrs = Hash[kls.attributes.map{|key, value| [ key, value.value ] }]
  data_type = Types::DataType.new(attrs)

  if data_type.package.blank?
    element = self.current_schema.css("elements element[name=#{data_type.name}]")[0]
    data_type.package = element.attr("package") if element
  end

  if kls.css("extends").any?
    data_type.extends = kls.css("extends").first.attr("name")
  end

  data_type.properties = {}
  kls.css("properties property").each do |property|
    name  = property.attr("name")
    value = Hash[property.attributes.map{|key, value| [ key, value.value ] }]
    value["package"] = default_package if default_package and name != "value"
    data_type.properties[name] = parse_property(value)
  end

  data_type
end

#parse_property(property) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/genio/parser/format/wadl.rb', line 148

def parse_property(property)
  property = Types::Property.new(property)

  # Check for complex type
  if property.ref
    property.type = valid_type(property.ref)
  end

  unless property.type
    element = get_element(property.name)
    if element
      property.type = element.attr("type")
      element_package = self.namespaces[element.attr("package")]
      property.package = element_package if element_package
    end
  end

  if property.type.present? and !current_schema.css("classes class[name=#{property.type}]").first
    element = get_element(property.type)
    property.type = element.attr("type") if element and element.attr("type").present?
  end

  # Array type
  if property.max == "unbounded" or property.max.to_i > 1
    property.array = true
  end

  # Required
  if property.min and property.min.to_i > 0
    property.required = true
  end

  # Description
  if property.documentation
    property.description = property.documentation.gsub(/\s+/, " ").strip
  end

  # Enum
  if enum_types[property.type]
    property.enum = enum_types[property.type].values
  end

  property.attribute = true if property.attrib

  property
end

#parse_resource(resource) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/genio/parser/format/wadl.rb', line 195

def parse_resource(resource)
  resource.css("method").each do |method_object|
    operation = Types::Operation.new(
                  :id => method_object.attr("id"),
                  :type => method_object.attr("name"),
                  :parameters => {},
                  :path => resource.attr("path") )

    resource.css("> param").each do |param|
      operation.parameters[param.attr("name")] =
        Types::Property.new( :type => valid_type(param.attr("type")), :location => "path" )
    end

    method_object.css("param").each do |param|
      operation.parameters[param.attr("name")] =
        Types::Property.new( :type => valid_type(param.attr("type")) )
    end

    request = method_object.css("request representation").first
    if request
      operation.request_property = operation_property(request)
      operation.request = operation.request_property.type
    end

    response = method_object.css("response representation").first
    if response
      operation.response_property = operation_property(response)
      operation.response = operation.response_property.type
    end

    add_operation(operation)
    operation
  end
end

#parse_schema(schema) ⇒ Object 



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
 
# File 'lib/genio/parser/format/wadl.rb', line 63

def parse_schema(schema)

  self.current_schema = schema

  self.namespaces ||= Types::Base.new
  schema.css("properties namespace").map{|namespace|
    self.namespaces[namespace.text] = namespace.attr("name")
  }

  self.attributes ||= Types::Base.new
  schema.css("properties attribute").map{|attribute|
    self.attributes[attribute.attr("name")] = attribute.text
  }

  self.element_form_defaults ||= Types::Base.new
  schema.css("properties elementFormDefault").map{|element|
    self.element_form_defaults[element.attr("namespace")] = element.text
  }

  schema.css("elements enum").each do |enum|
    name = valid_class(enum.attr("name"))
    type = Types::EnumType.new(enum.attributes.map{|k,v| [k, v.value] })
    type.values = enum.css("value").map{|element| element.text }
    self.enum_types[name] = type
  end

  # Load data_types
  schema.css("classes class").each do |kls|
    name  = valid_class(kls.attr("name"))
    value = parse_data_type(kls, self.namespaces[kls.attr("package")])
    self.data_types[name] = value
  end

  # Validate property.type in each data_type
  self.data_types.values.each do |data_type|
    data_type.properties.values.each do |property|
      property.type = valid_type(property.type)
    end
  end

  # Set endpoint
  resources = schema.css("resources").first
  self.endpoint ||= resources.attr("base") if resources

  # Load service and operations
  schema.css("resources resource").each do |resource|
    parse_resource(resource)
  end
end

#xslt ⇒ Object 



59
60
61
 
# File 'lib/genio/parser/format/wadl.rb', line 59

def xslt
  @xslt ||= Nokogiri::XSLT(File.read(File.expand_path("../../../../../data/wadl2meta.xsl", __FILE__)))
end