Use ActiveSupport instead of extlib
[arvados.git] / lib / google / api_client / discovery / api.rb
index 57ca339bbea493b180f66eed216680253ecefcea..be83f6279fdb2765f774bff8e9f2a39c60d762d4 100644 (file)
 
 
 require 'addressable/uri'
-
-require 'google/inflection'
+require 'multi_json'
+require 'active_support/inflector'
 require 'google/api_client/discovery/resource'
 require 'google/api_client/discovery/method'
-
+require 'google/api_client/discovery/media'
 
 module Google
   class APIClient
@@ -29,13 +29,9 @@ module Google
       ##
       # Creates a description of a particular version of a service.
       #
-      # @param [String] api
-      #   The identifier for the service.  Note that while this frequently
-      #   matches the first segment of all of the service's RPC names, this
-      #   should not be assumed.  There is no requirement that these match.
-      # @param [String] version
-      #   The identifier for the service version.
-      # @param [Hash] api_description
+      # @param [String] document_base
+      #   Base URI for the service
+      # @param [Hash] discovery_document
       #   The section of the discovery document that applies to this service
       #   version.
       #
@@ -43,20 +39,23 @@ module Google
       def initialize(document_base, discovery_document)
         @document_base = Addressable::URI.parse(document_base)
         @discovery_document = discovery_document
-        metaclass = (class <<self; self; end)
-        self.resources.each do |resource|
-          method_name = Google::INFLECTOR.underscore(resource.name).to_sym
+        metaclass = (class << self; self; end)
+        self.discovered_resources.each do |resource|
+          method_name = ActiveSupport::Inflector.underscore(resource.name).to_sym
           if !self.respond_to?(method_name)
             metaclass.send(:define_method, method_name) { resource }
           end
         end
-        self.methods.each do |method|
-          method_name = Google::INFLECTOR.underscore(method.name).to_sym
+        self.discovered_methods.each do |method|
+          method_name = ActiveSupport::Inflector.underscore(method.name).to_sym
           if !self.respond_to?(method_name)
             metaclass.send(:define_method, method_name) { method }
           end
         end
       end
+      
+      # @return [String] unparsed discovery document for the API
+      attr_reader :discovery_document
 
       ##
       # Returns the id of the service.
@@ -149,8 +148,7 @@ module Google
       def method_base
         if @discovery_document['basePath']
           return @method_base ||= (
-            self.document_base +
-            Addressable::URI.parse(@discovery_document['basePath'])
+            self.document_base.join(Addressable::URI.parse(@discovery_document['basePath']))
           ).normalize
         else
           return nil
@@ -160,18 +158,33 @@ module Google
       ##
       # Updates the hierarchy of resources and methods with the new base.
       #
-      # @param [Addressable::URI, #to_str, String] new_base
+      # @param [Addressable::URI, #to_str, String] new_method_base
       #   The new base URI to use for the service.
       def method_base=(new_method_base)
         @method_base = Addressable::URI.parse(new_method_base)
-        self.resources.each do |resource|
+        self.discovered_resources.each do |resource|
           resource.method_base = @method_base
         end
-        self.methods.each do |method|
+        self.discovered_methods.each do |method|
           method.method_base = @method_base
         end
       end
 
+      ##
+      # Returns the base URI for batch calls to this service.
+      #
+      # @return [Addressable::URI] The base URI that methods are joined to.
+      def batch_path
+        if @discovery_document['batchPath']
+          return @batch_path ||= (
+            self.document_base.join(Addressable::URI.parse('/' +
+                @discovery_document['batchPath']))
+          ).normalize
+        else
+          return nil
+        end
+      end
+
       ##
       # A list of schemas available for this version of the API.
       #
@@ -207,8 +220,8 @@ module Google
       # API.
       #
       # @return [Array] A list of {Google::APIClient::Resource} objects.
-      def resources
-        return @resources ||= (
+      def discovered_resources
+        return @discovered_resources ||= (
           (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
             accu << Google::APIClient::Resource.new(
               self, self.method_base, k, v
@@ -223,8 +236,8 @@ module Google
       # API.
       #
       # @return [Array] A list of {Google::APIClient::Method} objects.
-      def methods
-        return @methods ||= (
+      def discovered_methods
+        return @discovered_methods ||= (
           (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
             accu << Google::APIClient::Method.new(self, self.method_base, k, v)
             accu
@@ -249,10 +262,10 @@ module Google
       def to_h
         return @hash ||= (begin
           methods_hash = {}
-          self.methods.each do |method|
+          self.discovered_methods.each do |method|
             methods_hash[method.id] = method
           end
-          self.resources.each do |resource|
+          self.discovered_resources.each do |resource|
             methods_hash.merge!(resource.to_h)
           end
           methods_hash
@@ -268,6 +281,20 @@ module Google
           "#<%s:%#0x ID:%s>", self.class.to_s, self.object_id, self.id
         )
       end
+      
+      ##
+      # Marshalling support - serialize the API to a string (doc base + original 
+      # discovery document).
+      def _dump(level)
+        MultiJson.dump([@document_base.to_s, @discovery_document])
+      end
+      
+      ##
+      # Marshalling support - Restore an API instance from serialized form
+      def self._load(obj)
+        new(*MultiJson.load(obj)) 
+      end
+
     end
   end
 end