google-api-client 0.8.3 → 0.9

data/lib/google/apis/generator/helpers.rb

@@ -0,0 +1,74 @@
+module Google
+  module Apis
+    # @private
+    class Generator
+      # Methods for validating & normalizing symbols
+      module NameHelpers
+        KEYWORDS = %w(__ENCODING__ def in self __LINE__ defined? module super __FILE__ do next then BEGIN
+                      else nil true END elsif not undef alias end or unless and ensure redo until begin
+                      false rescue when break for retry while case if return yield class command)
+        PLURAL_METHODS = %w(list search)
+
+        # Check to see if the method name should be plauralized
+        # @return [Boolean]
+        def pluralize_method?(method_name)
+          PLURAL_METHODS.include?(method_name)
+        end
+
+        # Check to see if the method is either a keyword or built-in method on object
+        # @return [Boolean]
+        def reserved?(name)
+          keyword?(name) || object_method?(name)
+        end
+
+        # Check to see if the name is a ruby keyword
+        # @return [Boolean]
+        def keyword?(name)
+          KEYWORDS.include?(name)
+        end
+
+        # Check to see if the method already exists on ruby objects
+        # @return [Boolean]
+        def object_method?(name)
+          Object.new.respond_to?(name)
+        end
+
+        # Convert a parameter name to ruby conventions
+        # @param [String] name
+        # @return [String] updated param name
+        def normalize_param_name(name)
+          name = ActiveSupport::Inflector.underscore(name.gsub(/\W/, '_'))
+          if reserved?(name)
+            logger.warn { sprintf('Found reserved keyword \'%1$s\'', name) }
+            name += '_'
+            logger.warn { sprintf('Changed to \'%1$s\'', name) }
+          end
+          name
+        end
+
+        # Convert a property name to ruby conventions
+        # @param [String] name
+        # @return [String]
+        def normalize_property_name(name)
+          name = ActiveSupport::Inflector.underscore(name.gsub(/\W/, '_'))
+          if object_method?(name)
+            logger.warn { sprintf('Found reserved property \'%1$s\'', name) }
+            name += '_prop'
+            logger.warn { sprintf('Changed to \'%1$s\'', name) }
+          end
+          name
+        end
+
+        # Converts a scope string into a ruby constant
+        # @param [String] url
+        #   Url to convert
+        # @return [String]
+        def constantize_scope(url)
+          scope = Addressable::URI.parse(url).path[1..-1].upcase.gsub(/\W/, '_')
+          scope = 'AUTH_SCOPE' if scope.nil? || scope.empty?
+          scope
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/generator/model.rb

@@ -0,0 +1,143 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/inflector'
+require 'google/apis/discovery_v1'
+
+# Extend the discovery API classes with additional data needed to make
+# code generation produce better results
+module Google
+  module Apis
+    module DiscoveryV1
+      TYPE_MAP = {
+        'string' => 'String',
+        'boolean' => 'Boolean',
+        'number' => 'Float',
+        'integer' => 'Fixnum',
+        'any' => 'Object'
+      }
+
+      class JsonSchema
+        attr_accessor :name
+        attr_accessor :generated_name
+        attr_accessor :generated_class_name
+        attr_accessor :base_ref
+        attr_accessor :parent
+        attr_accessor :discriminant
+        attr_accessor :discriminant_value
+        attr_accessor :path
+
+        def properties
+          @properties ||= {}
+        end
+
+        def qualified_name
+          parent.qualified_name + '::' + generated_class_name
+        end
+
+        def generated_type
+          case type
+          when 'string', 'boolean', 'number', 'integer', 'any'
+            return 'DateTime' if format == 'date-time'
+            return 'Date' if format == 'date'
+            return TYPE_MAP[type]
+          when 'array'
+            return sprintf('Array<%s>', items.generated_type)
+          when 'hash'
+            return sprintf('Hash<String,%s>', additional_properties.generated_type)
+          when 'object'
+            return qualified_name
+          end
+        end
+      end
+
+      class RestMethod
+        attr_accessor :generated_name
+        attr_accessor :parent
+
+        def path_parameters
+          return [] if parameter_order.nil? || parameters.nil?
+          parameter_order.map { |name| parameters[name] }.select { |param| param.location == 'path' }
+        end
+
+        def query_parameters
+          return [] if parameters.nil?
+          parameters.values.select { |param| param.location == 'query' }
+        end
+        
+        def required_parameters
+          return [] if parameter_order.nil? || parameters.nil?
+          parameter_order.map { |name| parameters[name] }.select { |param| param.location == 'path' || param.required }
+        end
+        
+        def optional_query_parameters
+          query_parameters.select { |param| param.required != true }
+        end
+        
+      end
+
+      class RestResource
+        attr_accessor :parent
+
+        def all_methods
+          m = []
+          m << api_methods.values unless api_methods.nil?
+          m << resources.map { |_k, r| r.all_methods } unless resources.nil?
+          m.flatten
+        end
+      end
+
+      class RestDescription
+        attr_accessor :force_alt_json
+        alias_method :force_alt_json?, :force_alt_json
+
+        def version
+          ActiveSupport::Inflector.camelize(@version.gsub(/\W/, '-')).gsub(/-/, '_')
+        end
+
+        def name
+          ActiveSupport::Inflector.camelize(@name)
+        end
+
+        def module_name
+          name + version
+        end
+
+        def qualified_name
+          sprintf('Google::Apis::%s', module_name)
+        end
+
+        def service_name
+          class_name = (canonical_name || name).gsub(/\W/, '')
+          ActiveSupport::Inflector.camelize(sprintf('%sService', class_name))
+        end
+
+        def all_methods
+          m = []
+          m << api_methods.values unless api_methods.nil?
+          m << resources.map { |_k, r| r.all_methods } unless resources.nil?
+          m.flatten
+        end
+
+        class Auth
+          class Oauth2
+            class Scope
+              attr_accessor :constant
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/generator/template.rb

@@ -0,0 +1,124 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/inflector'
+require 'erb'
+require 'ostruct'
+
+module Google
+  module Apis
+    # @private
+    class Generator
+      # Directory containing ERB templates
+      TEMPLATE_DIR = File.expand_path('../templates', __FILE__)
+
+      # Helpers used in ERB templates
+      module TemplateHelpers
+        # Get the include path for a ruby module/class
+        #
+        # @param [String] module_name
+        #  Fully qualified module/class name
+        # @return [String]
+        #  Path to file
+        def to_path(module_name)
+          ActiveSupport::Inflector.underscore(module_name)
+        end
+
+        # Render a block comment
+        #
+        # @param [String] str
+        #  Comment string
+        # @param [Fixnum] spaces_before
+        #  Number of spaces to indent the comment hash
+        # @param [Fixnum] spaces_after
+        #  Number of spaces to indent after the comment hash for subsequent lines
+        # @return [String] formatted comment
+        def block_comment(str, spaces_before = 0, spaces_after = 0)
+          return '' if str.nil?
+          pre = ' ' * spaces_before
+          post = ' ' * spaces_after
+          lines = str.gsub(/([{}])/, '`').scan(/.{1,78}(?:\W|$)/).map(&:strip)
+          lines.join("\n" + pre + '#' + post)
+        end
+
+        # Indent a block of text
+        #
+        # @param [String] str
+        #  Content to indent
+        # @param [Fixnum] spaces
+        #  Number of spaces to indent
+        # @return [String] formatted content
+        def indent(str, spaces)
+          pre = ' ' * spaces
+          str = pre + str.split(/\n/).join("\n" + pre) + "\n"
+          return str unless str.strip.empty?
+          nil
+        end
+
+        # Include a partial inside a template.
+        #
+        # @private
+        # @param [String] partial
+        #  Name of the template
+        # @param [Hash] context
+        #  Context used to render
+        # @return [String] rendered content
+        def include(partial, context)
+          template = Template.new(sprintf('_%s.tmpl', partial))
+          template.render(context)
+        end
+      end
+
+      # Holds local vars/helpers for template rendering
+      class Context < OpenStruct
+        include TemplateHelpers
+
+        # Get the context for ERB evaluation
+        # @return [Binding]
+        def to_binding
+          binding
+        end
+      end
+
+      # ERB template for the code generator
+      class Template
+        # Loads a template from the template dir. Automatically
+        # appends the .tmpl suffix
+        #
+        # @param [String] template_name
+        #  Name of the template file
+        def self.load(template_name)
+          Template.new(sprintf('%s.tmpl', template_name))
+        end
+
+        # @param [String] template_name
+        #  Name of the template file
+        def initialize(template_name)
+          file = File.join(TEMPLATE_DIR, template_name)
+          @erb = ERB.new(File.read(file), nil, '-')
+        end
+
+        # Render the template
+        #
+        # @param [Hash] context
+        #  Variables to set when rendering the template
+        # @return [String] rendered template
+        def render(context)
+          ctx = Context.new(context)
+          @erb.result(ctx.to_binding)
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/generator/templates/_class.tmpl

@@ -0,0 +1,40 @@
+<% if cls.type == 'object' -%>
+
+# <%= block_comment(cls.description, 0, 1) %>
+class <%= cls.generated_class_name %><% if cls.base_ref %> < <%= cls.base_ref.generated_type %><% end %>
+  include Google::Apis::Core::Hashable
+<%   for property in cls.properties.values -%>
+
+  # <%= block_comment(property.description, 2, 1) %>
+  # Corresponds to the JSON property `<%= property.name %>`
+  # @return [<%= property.generated_type %>]
+  attr_accessor :<%= property.generated_name %>
+<%     if property.type == 'boolean' -%>
+  alias_method :<%= property.generated_name %>?, :<%= property.generated_name %>
+<%     end -%>
+<%   end -%>
+
+  def initialize(**args)
+<%   if cls.discriminant -%>
+    @<%= cls.properties[cls.discriminant].generated_name %> = '<%= cls.discriminant_value %>'
+<%   end -%>
+     update!(**args)
+  end
+
+  # Update properties of this object
+  def update!(**args)
+<%   for property in cls.properties.values -%>
+    @<%= property.generated_name %> = args[:<%= property.generated_name %>] unless args[:<%= property.generated_name %>].nil?
+<%   end -%>
+  end
+<%   for child_class in cls.properties.values -%>
+<%     if child_class._ref.nil? -%>
+<%= indent(include('class', :cls => child_class, :api => api), 2) -%>
+<%     end -%>
+<%   end -%>
+end
+<% elsif cls.items && cls.items._ref.nil? -%>
+<%= include('class', :cls => cls.items, :api => api) -%>
+<% elsif cls.additional_properties && cls.additional_properties._ref.nil? -%>
+<%= include('class', :cls => cls.additional_properties, :api => api) -%>
+<% end -%>

data/lib/google/apis/generator/templates/_method.tmpl

@@ -0,0 +1,92 @@
+
+# <%= block_comment(api_method.description, 0, 1) %>
+<% for param in api_method.required_parameters -%>
+# @param [<% if param.repeated? %>Array<<%= param.generated_type %>>, <% end %><%= param.generated_type %>] <%= param.generated_name %>
+<%   if param.description -%>
+#   <%=  block_comment(param.description, 0, 3) %>
+<%   end -%>
+<% end -%>
+<% if api_method.request -%>
+# @param [<%= api.schemas[api_method.request._ref].generated_type %>] <%= api.schemas[api_method.request._ref].generated_name %>_object
+<% end -%>
+<% for param in api_method.optional_query_parameters -%>
+# @param [<% if param.repeated? %>Array<<%= param.generated_type %>>, <% end %><%= param.generated_type %>] <%= param.generated_name %>
+<%   if param.description -%>
+#   <%=  block_comment(param.description, 0, 3) %>
+<%   end -%>
+<% end -%>
+<% for param in api.parameters.values.reject {|p| p.name == 'key'} -%>
+# @param [<% if param.repeated? %>Array<<%= param.generated_type %>>, <% end %><%= param.generated_type %>] <%= param.generated_name %>
+<%   if param.description -%>
+#   <%= block_comment(param.description, 0, 3) %>
+<%   end -%>
+<% end -%>
+<% if api_method.supports_media_upload? -%>
+# @param [IO, String] upload_source
+#   IO stream or filename containing content to upload
+# @param [String] content_type
+#   Content type of the uploaded content.
+<% elsif api_method.supports_media_download? -%>
+# @param [IO, String] download_dest
+#   IO stream or filename to receive content download
+<% end -%>
+# @param [Google::Apis::RequestOptions] options
+#   Request-specific options
+#
+# @yield [result, err] Result & error if block supplied
+<% if api_method.response -%>
+# @yieldparam result [<%= api.schemas[api_method.response._ref].generated_type %>] parsed result object
+# @yieldparam err [StandardError] error object if request failed
+#
+# @return [<%= api.schemas[api_method.response._ref].generated_type %>]
+<% else -%>
+# @yieldparam result [NilClass] No result returned for this method
+# @yieldparam err [StandardError] error object if request failed
+#
+# @return [void]
+<% end -%>
+#
+# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+# @raise [Google::Apis::AuthorizationError] Authorization is required
+def <%= api_method.generated_name %>(<% for param in api_method.required_parameters %><%= param.generated_name %>, <% end %><% if api_method.request %><%= api.schemas[api_method.request._ref].generated_name %>_object = nil, <% end %><% for param in api_method.optional_query_parameters %><%= param.generated_name %>: nil, <% end %><% for param in api.parameters.values.reject {|p| p.name == 'key'} %><%= param.generated_name %>: nil, <% end %><% if api_method.supports_media_upload? %>upload_source: nil, content_type: nil, <% elsif api_method.supports_media_download? %>download_dest: nil, <%  end  %>options: nil, &block)
+<% if api_method.supports_media_upload? -%>
+  if upload_source.nil?
+    command =  make_simple_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+  else
+    command = make_upload_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+    command.upload_source = upload_source
+    command.upload_content_type = content_type
+  end
+<% elsif api_method.supports_media_download? -%>
+  if download_dest.nil?
+    command =  make_simple_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+  else
+    command = make_download_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+    command.download_dest = download_dest
+  end
+<% else -%>
+  command =  make_simple_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+<% end -%>
+<% if api_method.request -%>
+  command.request_representation = <%= api.schemas[api_method.request._ref].generated_type %>::Representation
+  command.request_object = <%= api.schemas[api_method.request._ref].generated_name %>_object
+<% end -%>
+<% if api_method.response -%>
+<%   if api.force_alt_json? -%>
+  command.query['alt'] = 'json'
+<%   end -%>
+  command.response_representation = <%= api.schemas[api_method.response._ref].generated_type %>::Representation
+  command.response_class = <%= api.schemas[api_method.response._ref].generated_type %>
+<% end -%>
+<% for param in api_method.path_parameters -%>
+  command.params['<%= param.name %>'] = <%= param.generated_name %> unless <%= param.generated_name %>.nil?
+<% end -%>
+<% for param in api_method.query_parameters -%>
+  command.query['<%= param.name %>'] = <%= param.generated_name %> unless <%= param.generated_name %>.nil?
+<% end -%>
+<% for param in api.parameters.values.reject {|p| p.name == 'key'} -%>
+  command.query['<%= param.name %>'] = <%= param.generated_name %> unless <%= param.generated_name %>.nil?
+<% end -%>
+  execute_or_queue_command(command, &block)
+end

data/lib/google/apis/generator/templates/_representation.tmpl

@@ -0,0 +1,51 @@
+<% if cls.type == 'object' -%>
+
+class <%= cls.generated_class_name %>
+  # @private
+  class Representation < Google::Apis::Core::JsonRepresentation
+<%   if api.features && api.features.include?('dataWrapper') -%>
+    self.representation_wrap = lambda { |args| :data if args[:unwrap] == <%= cls.generated_type %> }
+<%   end -%>
+<%   if cls.variant -%>
+    def from_hash(hash, *args)
+      case hash['<%= cls.variant.discriminant %>']
+<%     for v in cls.variant.map -%>
+<%   ref = api.schemas[v._ref] %>
+      when '<%= v.type_value %>'
+        <%= ref.generated_type %>::Representation.new(<%= ref.generated_type %>.new).from_hash(hash, *args)
+<%     end -%>
+      end
+    end
+
+    def to_hash(*args)
+      case represented
+<%     for v in cls.variant.map -%>
+<%   ref = api.schemas[v._ref] %>
+      when <%= ref.generated_type %>
+        <%= ref.generated_type %>::Representation.new(represented).to_hash(*args)
+<%     end -%>
+      end
+    end
+<%   else -%>
+<%     for property in cls.properties.values -%>
+<%       if property.type == 'hash' -%>
+    hash :<%= property.generated_name %>, as: '<%= property.name %>'<%= include('representation_type', :lead => ', ', :type => property.additional_properties, :api => api) %>
+<%       elsif property.type == 'array' -%>
+    collection :<%= property.generated_name %>, as: '<%= property.name %>'<%= include('representation_type', :lead => ', ', :type => property.items, :api => api) %>
+<%       else -%>
+    property :<%= property.generated_name %>,<% if property.format == 'byte' %> :base64 => true,<%end%> as: '<%= property.name %>'<%= include('representation_type', :lead => ', ', :type => property, :api => api) %>
+<%       end -%>
+<%     end -%>
+<%   end -%>
+  end
+<%   for child_class in cls.properties.values -%>
+<%     if child_class._ref.nil? -%>
+<%= indent(include('representation', :cls => child_class, :api => api), 2) -%>
+<%     end -%>
+<%   end -%>
+end
+<% elsif cls.items && cls.items._ref.nil? -%>
+<%= include('representation', :cls => cls.items, :api => api) -%>
+<% elsif cls.additional_properties && cls.additional_properties._ref.nil? -%>
+<%= include('representation', :cls => cls.additional_properties, :api => api) -%>
+<% end -%>

data/lib/google/apis/generator/templates/_representation_stub.tmpl

@@ -0,0 +1,15 @@
+<% if cls.type == 'object' -%>
+
+class <%= cls.generated_class_name %>
+  class Representation < Google::Apis::Core::JsonRepresentation; end
+<%   for child_class in cls.properties.values -%>
+<%     if child_class._ref.nil? -%>
+<%= indent(include('representation_stub', :cls => child_class), 2) -%>
+<%     end -%>
+<%   end -%>
+end
+<% elsif cls.items && cls.items._ref.nil? -%>
+<%= include('representation_stub', :cls => cls.items, :api => api) -%>
+<% elsif cls.additional_properties && cls.additional_properties._ref.nil? -%>
+<%= include('representation_stub', :cls => cls.additional_properties, :api => api) -%>
+<% end -%>

data/lib/google/apis/generator/templates/_representation_type.tmpl

@@ -0,0 +1,10 @@
+<% if type.type == 'array' -%>
+<%= lead %>:class => Array do
+  include Representable::JSON::Collection
+  items<%= include('representation_type', :lead => ' ' , :type => type.items, :api => api) %>
+end
+<% elsif ['date', 'date-time'].include?(type.format) -%>
+<%= lead %>type: <%= type.generated_type %>
+<% elsif type.type == 'object' -%>
+<%= lead %>class: <%= type.generated_type %>, decorator: <%= type.generated_type %>::Representation
+<% end -%>

data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl}

@@ -1,4 +1,4 @@
-# Copyright 2010 Google Inc.
+# Copyright 2015 Google Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,16 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'google/api_client/request'
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
 
 module Google
-  class APIClient
-    ##
-    # Subclass of Request for backwards compatibility with pre-0.5.0 versions of the library
-    # 
-    # @deprecated
-    #   use {Google::APIClient::Request} instead
-    class Reference < Request
+  module Apis
+    module <%= api.module_name %>
+<% for cls in api.schemas.values.partition(&:variant).flatten -%>
+<%= indent(include('class', :cls => cls, :api => api), 6) -%>
+<% end -%>
     end
   end
 end

data/lib/google/apis/generator/templates/module.rb.tmpl

@@ -0,0 +1,40 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require '<%= to_path(api.qualified_name) %>/service.rb'
+require '<%= to_path(api.qualified_name) %>/classes.rb'
+require '<%= to_path(api.qualified_name) %>/representations.rb'
+
+module Google
+  module Apis
+    # <%= api.title %>
+    #
+    # <%= block_comment(api.description, 4, 1) %>
+    #
+<% if api.documentation_link -%>
+    # @see <%= api.documentation_link %>
+<% end -%>
+    module <%= api.module_name %>
+      VERSION = '<%= api.version %>'
+      REVISION = '<%= api.revision %>'
+<% if api.auth && api.auth.oauth2 -%>
+<%   for scope_string, scope in api.auth.oauth2.scopes -%>
+
+      # <%= scope.description %>
+      <%= scope.constant %> = '<%= scope_string %>'
+<%   end -%>
+<% end -%>
+    end
+  end
+end

data/lib/google/apis/generator/templates/representations.rb.tmpl

@@ -0,0 +1,32 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module <%= api.module_name %>
+<% for cls in api.schemas.values.partition(&:variant).flatten -%>
+<%= indent(include('representation_stub', :cls => cls), 6) -%>
+<% end -%>
+<% for cls in api.schemas.values.partition(&:variant).flatten -%>
+<%= indent(include('representation', :cls => cls, :api => api), 6) -%>
+<% end -%>
+    end
+  end
+end