lib/google/api_client/discovery/resource.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 'addressable/uri'
  17
  18 require 'google/inflection'
  19 require 'google/api_client/discovery/method'
  20
  21
  22 module Google
  23   class APIClient
  24     ##
  25     # A resource that has been described by a discovery document.
  26     class Resource
  27
  28       ##
  29       # Creates a description of a particular version of a resource.
  30       #
  31       # @param [Google::APIClient::API] api
  32       #   The API this resource belongs to.
  33       # @param [Addressable::URI] method_base
  34       #   The base URI for the service.
  35       # @param [String] resource_name
  36       #   The identifier for the resource.
  37       # @param [Hash] discovery_document
  38       #   The section of the discovery document that applies to this resource.
  39       #
  40       # @return [Google::APIClient::Resource] The constructed resource object.
  41       def initialize(api, method_base, resource_name, discovery_document)
  42         @api = api
  43         @method_base = method_base
  44         @name = resource_name
  45         @discovery_document = discovery_document
  46         metaclass = (class <<self; self; end)
  47         self.discovered_resources.each do |resource|
  48           method_name = Google::INFLECTOR.underscore(resource.name).to_sym
  49           if !self.respond_to?(method_name)
  50             metaclass.send(:define_method, method_name) { resource }
  51           end
  52         end
  53         self.discovered_methods.each do |method|
  54           method_name = Google::INFLECTOR.underscore(method.name).to_sym
  55           if !self.respond_to?(method_name)
  56             metaclass.send(:define_method, method_name) { method }
  57           end
  58         end
  59       end
  60
  61       ##
  62       # Returns the identifier for the resource.
  63       #
  64       # @return [String] The resource identifier.
  65       attr_reader :name
  66
  67       ##
  68       # Returns the parsed section of the discovery document that applies to
  69       # this resource.
  70       #
  71       # @return [Hash] The resource description.
  72       attr_reader :description
  73
  74       ##
  75       # Returns the base URI for this resource.
  76       #
  77       # @return [Addressable::URI] The base URI that methods are joined to.
  78       attr_reader :method_base
  79
  80       ##
  81       # Updates the hierarchy of resources and methods with the new base.
  82       #
  83       # @param [Addressable::URI, #to_str, String] new_method_base
  84       #   The new base URI to use for the resource.
  85       def method_base=(new_method_base)
  86         @method_base = Addressable::URI.parse(new_method_base)
  87         self.discovered_resources.each do |resource|
  88           resource.method_base = @method_base
  89         end
  90         self.discovered_methods.each do |method|
  91           method.method_base = @method_base
  92         end
  93       end
  94
  95       ##
  96       # A list of sub-resources available on this resource.
  97       #
  98       # @return [Array] A list of {Google::APIClient::Resource} objects.
  99       def discovered_resources
 100         return @discovered_resources ||= (
 101           (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
 102             accu << Google::APIClient::Resource.new(
 103               @api, self.method_base, k, v
 104             )
 105             accu
 106           end
 107         )
 108       end
 109
 110       ##
 111       # A list of methods available on this resource.
 112       #
 113       # @return [Array] A list of {Google::APIClient::Method} objects.
 114       def discovered_methods
 115         return @discovered_methods ||= (
 116           (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
 117             accu << Google::APIClient::Method.new(@api, self.method_base, k, v)
 118             accu
 119           end
 120         )
 121       end
 122
 123       ##
 124       # Converts the resource to a flat mapping of RPC names and method
 125       # objects.
 126       #
 127       # @return [Hash] All methods available on the resource.
 128       def to_h
 129         return @hash ||= (begin
 130           methods_hash = {}
 131           self.discovered_methods.each do |method|
 132             methods_hash[method.id] = method
 133           end
 134           self.discovered_resources.each do |resource|
 135             methods_hash.merge!(resource.to_h)
 136           end
 137           methods_hash
 138         end)
 139       end
 140
 141       ##
 142       # Returns a <code>String</code> representation of the resource's state.
 143       #
 144       # @return [String] The resource's state, as a <code>String</code>.
 145       def inspect
 146         sprintf(
 147           "#<%s:%#0x NAME:%s>", self.class.to_s, self.object_id, self.name
 148         )
 149       end
 150     end
 151   end
 152 end