Merge branch 'master' of https://github.com/google/google-api-ruby-client
[arvados.git] / lib / google / api_client / discovery / schema.rb
1 # Copyright 2010 Google Inc.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #      http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15
16 require 'time'
17 require 'multi_json'
18 require 'compat/multi_json'
19 require 'base64'
20 require 'autoparse'
21 require 'addressable/uri'
22 require 'addressable/template'
23
24 require 'active_support/inflector'
25 require 'google/api_client/errors'
26
27
28 module Google
29   class APIClient
30     ##
31     # @api private
32     module Schema
33       def self.parse(api, schema_data)
34         # This method is super-long, but hard to break up due to the
35         # unavoidable dependence on closures and execution context.
36         schema_name = schema_data['id']
37
38         # Due to an oversight, schema IDs may not be URI references.
39         # TODO(bobaman): Remove this code once this has been resolved.
40         schema_uri = (
41           api.document_base +
42           (schema_name[0..0] != '#' ? '#' + schema_name : schema_name)
43         )
44         # puts schema_uri
45
46         # Due to an oversight, schema IDs may not be URI references.
47         # TODO(bobaman): Remove this whole lambda once this has been resolved.
48         reformat_references = lambda do |data|
49           # This code is not particularly efficient due to recursive traversal
50           # and excess object creation, but this hopefully shouldn't be an
51           # issue since it should only be called only once per schema per
52           # process.
53           if data.kind_of?(Hash) &&
54               data['$ref'] && !data['$ref'].kind_of?(Hash)
55             if data['$ref'].respond_to?(:to_str)
56               reference = data['$ref'].to_str
57             else
58               raise TypeError, "Expected String, got #{data['$ref'].class}"
59             end
60             reference = '#' + reference if reference[0..0] != '#'
61             data.merge({
62               '$ref' => reference
63             })
64           elsif data.kind_of?(Hash)
65             data.inject({}) do |accu, (key, value)|
66               if value.kind_of?(Hash)
67                 accu[key] = reformat_references.call(value)
68               else
69                 accu[key] = value
70               end
71               accu
72             end
73           else
74             data
75           end
76         end
77         schema_data = reformat_references.call(schema_data)
78         # puts schema_data.inspect
79
80         if schema_name
81           api_name_string = ActiveSupport::Inflector.camelize(api.name)
82           api_version_string = ActiveSupport::Inflector.camelize(api.version).gsub('.', '_')
83           # This is for compatibility with Ruby 1.8.7.
84           # TODO(bobaman) Remove this when we eventually stop supporting 1.8.7.
85           args = []
86           args << false if Class.method(:const_defined?).arity != 1
87           if Google::APIClient::Schema.const_defined?(api_name_string, *args)
88             api_name = Google::APIClient::Schema.const_get(
89               api_name_string, *args
90             )
91           else
92             api_name = Google::APIClient::Schema.const_set(
93               api_name_string, Module.new
94             )
95           end
96           if api_name.const_defined?(api_version_string, *args)
97             api_version = api_name.const_get(api_version_string, *args)
98           else
99             api_version = api_name.const_set(api_version_string, Module.new)
100           end
101           if api_version.const_defined?(schema_name, *args)
102             schema_class = api_version.const_get(schema_name, *args)
103           end
104         end
105
106         # It's possible the schema has already been defined. If so, don't
107         # redefine it. This means that reloading a schema which has already
108         # been loaded into memory is not possible.
109         unless schema_class
110           schema_class = AutoParse.generate(schema_data, :uri => schema_uri)
111           if schema_name
112             api_version.const_set(schema_name, schema_class)
113           end
114         end
115         return schema_class
116       end
117     end
118   end
119 end