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 'base64'
  19 require 'autoparse'
  20 require 'addressable/uri'
  21 require 'addressable/template'
  22
  23 require 'google/inflection'
  24 require 'google/api_client/errors'
  25
  26
  27 module Google
  28   class APIClient
  29     module Schema
  30       def self.parse(api, schema_data)
  31         # This method is super-long, but hard to break up due to the
  32         # unavoidable dependence on closures and execution context.
  33         schema_name = schema_data['id']
  34
  35         # Due to an oversight, schema IDs may not be URI references.
  36         # TODO(bobaman): Remove this code once this has been resolved.
  37         schema_uri = (
  38           api.document_base +
  39           (schema_name[0..0] != '#' ? '#' + schema_name : schema_name)
  40         )
  41         # puts schema_uri
  42
  43         # Due to an oversight, schema IDs may not be URI references.
  44         # TODO(bobaman): Remove this whole lambda once this has been resolved.
  45         reformat_references = lambda do |data|
  46           # This code is not particularly efficient due to recursive traversal
  47           # and excess object creation, but this hopefully shouldn't be an
  48           # issue since it should only be called only once per schema per
  49           # process.
  50           if data.kind_of?(Hash) && data['$ref']
  51             reference = data['$ref']
  52             reference = '#' + reference if reference[0..0] != '#'
  53             data.merge({
  54               '$ref' => reference
  55             })
  56           elsif data.kind_of?(Hash)
  57             data.inject({}) do |accu, (key, value)|
  58               if value.kind_of?(Hash)
  59                 accu[key] = reformat_references.call(value)
  60               else
  61                 accu[key] = value
  62               end
  63               accu
  64             end
  65           else
  66             data
  67           end
  68         end
  69         schema_data = reformat_references.call(schema_data)
  70         # puts schema_data.inspect
  71
  72         if schema_name
  73           api_name_string =
  74             Google::INFLECTOR.camelize(api.name)
  75           api_version_string =
  76             Google::INFLECTOR.camelize(api.version).gsub('.', '_')
  77           # This is for compatibility with Ruby 1.8.7.
  78           # TODO(bobaman) Remove this when we eventually stop supporting 1.8.7.
  79           args = []
  80           args << false if Class.method(:const_defined?).arity != 1
  81           if Google::APIClient::Schema.const_defined?(api_name_string, *args)
  82             api_name = Google::APIClient::Schema.const_get(
  83               api_name_string, *args
  84             )
  85           else
  86             api_name = Google::APIClient::Schema.const_set(
  87               api_name_string, Module.new
  88             )
  89           end
  90           if api_name.const_defined?(api_version_string, *args)
  91             api_version = api_name.const_get(api_version_string, *args)
  92           else
  93             api_version = api_name.const_set(api_version_string, Module.new)
  94           end
  95           if api_version.const_defined?(schema_name, *args)
  96             schema_class = api_version.const_get(schema_name, *args)
  97           end
  98         end
  99
 100         # It's possible the schema has already been defined. If so, don't
 101         # redefine it. This means that reloading a schema which has already
 102         # been loaded into memory is not possible.
 103         unless schema_class
 104           schema_class = AutoParse.generate(schema_data, :uri => schema_uri)
 105           if schema_name
 106             api_version.const_set(schema_name, schema_class)
 107           end
 108         end
 109         return schema_class
 110       end
 111     end
 112   end
 113 end