google-api-client 0.50.0 → 0.53.0

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

@@ -1,124 +0,0 @@
-# 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

@@ -1,43 +0,0 @@
-<% if cls.type == 'object' || (cls.type == 'hash' && cls.properties.length > 0) -%>
-
-# <%= 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 %>`
-<% if property.format == 'byte' -%>
-  # NOTE: Values are automatically base64 encoded/decoded in the client library.
-<% end -%>
-  # @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 %>] if args.key?(:<%= property.generated_name %>)
-<%   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

@@ -1,92 +0,0 @@
-
-# <%= 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

@@ -1,51 +0,0 @@
-<% 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 ['uint64', 'int64'].include?(property.format) %> :numeric_string => true,<%end%><% 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

@@ -1,17 +0,0 @@
-<% 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 -%>
-
-  include Google::Apis::Core::JsonObjectSupport
-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

@@ -1,10 +0,0 @@
-<% 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/apis/generator/templates/classes.rb.tmpl

@@ -1,29 +0,0 @@
-# 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('class', :cls => cls, :api => api), 6) -%>
-<% end -%>
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

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

@@ -1,61 +0,0 @@
-# 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 '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  %>
-      # <%= api.title %>
-      #
-      # <%= block_comment(api.description, 6, 2) %>
-      #
-      # @example
-      #    require '<%= to_path(api.qualified_name) %>'
-      #
-      #    <%= api.name %> = <%= api.qualified_name %> # Alias the module
-      #    service = <%= api.name %>::<%= api.service_name %>.new
-      #
-<% if api.documentation_link -%>
-      # @see <%= api.documentation_link %>
-<% end -%>
-      class <%= api.service_name %> < Google::Apis::Core::BaseService
-<% for param in api.parameters.values.reject {|p| p.name == 'fields'} -%>
-        # @return [<%= param.generated_type %>]
-        #  <%= block_comment(param.description, 8, 2) %>
-        attr_accessor :<%= param.generated_name %>
-
-<% end -%>
-        def initialize
-          super('<%= api.root_url %>', '<%= api.service_path %>')
-          @batch_path = '<%= api.batch_path %>'
-        end
-<% for api_method in api.all_methods -%>
-<%= indent(include('method', :api_method => api_method, :api => api), 8) -%>
-<% end -%>
-
-        protected
-
-        def apply_command_defaults(command)
-<% for param in api.parameters.values.reject {|p| p.name == 'fields'} -%>
-          command.query['<%= param.name %>'] = <%= param.generated_name %> unless <%= param.generated_name %>.nil?
-<% end -%>
-        end
-      end
-    end
-  end
-end

data/lib/google/apis/generator.rb

@@ -1,71 +0,0 @@
-# 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 'google/apis/discovery_v1'
-require 'google/apis/generator/annotator'
-require 'google/apis/generator/model'
-require 'google/apis/generator/template'
-require 'active_support/inflector'
-require 'yaml'
-
-module Google
-  module Apis
-    # Generates ruby classes for APIs from discovery documents
-    # @private
-    class Generator
-      Discovery = Google::Apis::DiscoveryV1
-
-      # Load templates
-      def initialize(api_names: nil, api_names_out: nil)
-        @names = Google::Apis::Generator::Names.new(api_names_out || File.join(Google::Apis::ROOT, 'api_names_out.yaml'),
-                                                    api_names || File.join(Google::Apis::ROOT, 'api_names.yaml'))
-        @module_template = Template.load('module.rb')
-        @service_template = Template.load('service.rb')
-        @classes_template = Template.load('classes.rb')
-        @representations_template = Template.load('representations.rb')
-      end
-
-      # Generates ruby source for an API
-      #
-      # @param [String] json
-      #  API Description, as JSON text
-      # @return [Hash<String,String>]
-      #  Hash of generated files keyed by path
-      def render(json)
-        api = parse_description(json)
-        Annotator.process(api, @names)
-        base_path = ActiveSupport::Inflector.underscore(api.qualified_name)
-        context = {
-          'api' => api
-        }
-        files = {}
-        files[base_path + '.rb'] = @module_template.render(context)
-        files[File.join(base_path, 'service.rb')] = @service_template.render(context)
-        files[File.join(base_path, 'classes.rb')] = @classes_template.render(context)
-        files[File.join(base_path, 'representations.rb')] = @representations_template.render(context)
-        files
-      end
-
-      # Dump mapping of API names
-      # @return [String] Mapping of paths to ruby names in YAML format
-      def dump_api_names
-        @names.dump
-      end
-
-      def parse_description(json)
-        Discovery::RestDescription::Representation.new(Discovery::RestDescription.new).from_json(json)
-      end
-    end
-  end
-end