gapic-generator 0.4.0 → 0.6.1

data/lib/gapic/presenters/field_presenter.rb

@@ -95,21 +95,21 @@ module Gapic
         base_type =
           if field.message?
             type = message_ruby_type field.message
-            output ? type : "#{type}, Hash"
+            output ? type : "#{type}, ::Hash"
           elsif field.enum?
             # TODO: handle when arg message is nil and enum is the type
             message_ruby_type field.enum
           else
             case field.type
-            when 1, 2                              then "Float"
-            when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "Integer"
-            when 9, 12                             then "String"
-            when 8                                 then "Boolean"
+            when 1, 2                              then "::Float"
+            when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "::Integer"
+            when 9, 12                             then "::String"
+            when 8                                 then "::Boolean"
             else
-              "Object"
+              "::Object"
             end
           end
-        field.repeated? ? "Array<#{base_type}>" : base_type
+        field.repeated? ? "::Array<#{base_type}>" : base_type
       end
 
       def field_map_type entry_message, output
@@ -118,7 +118,7 @@ module Gapic
           key_field = field if field.name == "key"
           value_field = field if field.name == "value"
         end
-        class_name = output ? "Google::Protobuf::Map" : "Hash"
+        class_name = output ? "::Google::Protobuf::Map" : "::Hash"
         if key_field && value_field
           key_type = field_doc_types key_field, output
           value_type = field_doc_types value_field, output
@@ -141,7 +141,7 @@ module Gapic
           when 9, 12                             then "\"hello world\""
           when 8                                 then "true"
           else
-            "Object"
+            "::Object"
           end
         end
       end

data/lib/gapic/presenters/file_presenter.rb

@@ -39,7 +39,7 @@ module Gapic
       end
 
       def namespace
-        return @file.ruby_package if @file.ruby_package.present?
+        return ensure_absolute_namespace @file.ruby_package if @file.ruby_package.present?
         ruby_namespace_for_address address
       end
 

data/lib/gapic/presenters/gem_presenter.rb

@@ -33,7 +33,7 @@ module Gapic
       def packages
         @packages ||= begin
           packages = @api.generate_files.map(&:package).uniq.sort
-          packages.map { |p| PackagePresenter.new @api, p }.delete_if(&:empty?)
+          packages.map { |p| PackagePresenter.new self, @api, p }.delete_if(&:empty?)
         end
       end
 
@@ -44,7 +44,7 @@ module Gapic
       def services
         @services ||= begin
           files = @api.generate_files
-          files.map(&:services).flatten.map { |s| ServicePresenter.new @api, s }
+          files.map(&:services).flatten.map { |s| ServicePresenter.new self, @api, s }
         end
       end
 
@@ -134,7 +134,17 @@ module Gapic
       end
 
       def api_id
-        gem_config :api_id
+        raw_id = gem_config :api_id
+        return nil unless raw_id
+        raw_id.include?(".") ? raw_id : "#{raw_id}.googleapis.com"
+      end
+
+      def api_shortname
+        gem_config :api_shortname
+      end
+
+      def issue_tracker_url
+        gem_config :issue_tracker_url
       end
 
       def free_tier?
@@ -147,10 +157,36 @@ module Gapic
         gem_config(:yard_strict) != "false"
       end
 
+      def generic_endpoint?
+        gem_config(:generic_endpoint) == "true"
+      end
+
       def entrypoint_require
         packages.first.package_require
       end
 
+      def license_name
+        "MIT"
+      end
+
+      def extra_files
+        ["README.md", "LICENSE.md", ".yardopts"]
+      end
+
+      def dependencies
+        deps = { "gapic-common" => "~> 0.2" }
+        deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.0"] if iam_dependency?
+        extra_deps = gem_config :extra_dependencies
+        deps.merge! extra_deps if extra_deps
+        deps
+      end
+
+      def dependency_list
+        dependencies.to_a
+                    .map { |name, requirements| [name, Array(requirements)] }
+                    .sort_by { |name, _requirements| name }
+      end
+
       private
 
       def gem_config key

data/lib/gapic/presenters/method_presenter.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require "active_support/inflector"
-require "gapic/path_template"
+require "gapic/uri_template"
 require "gapic/ruby_info"
 require "gapic/helpers/namespace_helper"
 
@@ -27,13 +27,14 @@ module Gapic
     class MethodPresenter
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, method
+      def initialize service_presenter, api, method
+        @service_presenter = service_presenter
         @api = api
         @method = method
       end
 
       def service
-        ServicePresenter.new @api, @method.parent
+        @service_presenter
       end
 
       def name
@@ -64,13 +65,13 @@ module Gapic
 
       def doc_response_type
         ret = return_type
-        ret = "Gapic::Operation" if lro?
+        ret = "::Gapic::Operation" if lro?
         if server_streaming?
-          ret = "Enumerable<#{ret}>"
+          ret = "::Enumerable<#{ret}>"
         elsif paged?
           paged_type = paged_response_type
-          paged_type = "Gapic::Operation" if paged_type == "Google::Longrunning::Operation"
-          ret = "Gapic::PagedEnumerable<#{paged_type}>"
+          paged_type = "::Gapic::Operation" if paged_type == "::Google::Longrunning::Operation"
+          ret = "::Gapic::PagedEnumerable<#{paged_type}>"
         end
         ret
       end
@@ -123,7 +124,7 @@ module Gapic
           return [
             OpenStruct.new(
               name:      "operation",
-              doc_types: "Gapic::Operation"
+              doc_types: "::Gapic::Operation"
             )
           ]
         end
@@ -134,7 +135,7 @@ module Gapic
           ),
           OpenStruct.new(
             name:      "operation",
-            doc_types: "GRPC::ActiveCall::Operation"
+            doc_types: "::GRPC::ActiveCall::Operation"
           )
         ]
       end
@@ -150,9 +151,9 @@ module Gapic
       end
 
       def lro?
-        return paged_response_type == "Google::Longrunning::Operation" if paged?
+        return paged_response_type == "::Google::Longrunning::Operation" if paged?
 
-        message_ruby_type(@method.output) == "Google::Longrunning::Operation"
+        message_ruby_type(@method.output) == "::Google::Longrunning::Operation"
       end
 
       def client_streaming?
@@ -193,8 +194,7 @@ module Gapic
       # @return [Array<String>] The segment key names.
       #
       def routing_params
-        segments = Gapic::PathTemplate.parse method_path
-        segments.select { |s| s.is_a? Gapic::PathTemplate::Segment }.map(&:name)
+        Gapic::UriTemplate.parse_arguments method_path
       end
 
       def routing_params?
@@ -226,12 +226,12 @@ module Gapic
           message_ruby_type arg.enum
         else
           case arg.type
-          when 1, 2                              then "Float"
-          when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "Integer"
-          when 9, 12                             then "String"
-          when 8                                 then "Boolean"
+          when 1, 2                              then "::Float"
+          when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "::Integer"
+          when 9, 12                             then "::String"
+          when 8                                 then "::Boolean"
           else
-            "Object"
+            "::Object"
           end
         end
       end
@@ -256,7 +256,7 @@ module Gapic
           when 9, 12                             then "\"hello world\""
           when 8                                 then "true"
           else
-            "Object"
+            "::Object"
           end
         end
       end

data/lib/gapic/presenters/package_presenter.rb

@@ -27,13 +27,14 @@ module Gapic
       include Gapic::Helpers::FilepathHelper
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, package
+      def initialize gem_presenter, api, package
+        @gem_presenter = gem_presenter
         @api = api
         @package = package
       end
 
       def gem
-        GemPresenter.new @api
+        @gem_presenter
       end
 
       def name
@@ -63,7 +64,7 @@ module Gapic
           normal_services = services.select { |s| @api.delegate_service_for(s).nil? }
           # But include common services that delegate to normal services in this package.
           common_services = normal_services.flat_map { |s| @api.common_services_for s }
-          (normal_services + common_services).map { |s| ServicePresenter.new @api, s }
+          (normal_services + common_services).map { |s| ServicePresenter.new @gem_presenter, @api, s }
         end
       end
 

data/lib/gapic/presenters/resource_presenter.rb

@@ -14,8 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "gapic/path_template"
-require "ostruct"
+require "gapic/path_pattern"
 require "active_support/inflector"
 
 module Gapic
@@ -28,20 +27,10 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map do |template|
-          segments = Gapic::PathTemplate.parse template
-          OpenStruct.new(
-            template:    template,
-            segments:    segments,
-            arguments:   arguments_for(segments),
-            path_string: path_string_for(segments)
-          )
-        end
+        @patterns = resource.pattern.map { |pattern| PatternPresenter.new pattern }
 
         # Keep only patterns that can be used to create path helpers
-        @patterns.reject! do |pattern|
-          named_arg_patterns?(pattern.segments) || positional_args?(pattern.segments)
-        end
+        @patterns.filter!(&:useful_for_helpers?)
       end
 
       def name
@@ -60,33 +49,56 @@ module Gapic
         "#{ActiveSupport::Inflector.underscore name}_path"
       end
 
-      private
+      ##
+      # A presenter for a particular pattern
+      #
+      class PatternPresenter
+        def initialize pattern_string
+          @pattern = pattern_string
+          @parsed_pattern = Gapic::PathPattern.parse pattern_string
+          @path_string = build_path_string
+        end
 
-      def arguments_for segments
-        arg_segments(segments).map(&:name)
-      end
+        attr_reader :pattern, :path_string
 
-      def arg_segments segments
-        segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
-      end
+        def useful_for_helpers?
+          !@parsed_pattern.positional_segments? && !@parsed_pattern.nontrivial_pattern_segments?
+        end
 
-      def path_string_for segments
-        segments.map do |segment|
-          if segment.is_a? Gapic::PathTemplate::Segment
-            "\#{#{segment.name}}"
-          else
-            # Should be a String
-            segment
-          end
-        end.join
-      end
+        def arguments
+          @parsed_pattern.arguments
+        end
 
-      def positional_args? segments
-        arg_segments(segments).any?(&:positional?)
-      end
+        def formal_arguments
+          @parsed_pattern.arguments.map { |name| "#{name}:" }.join ", "
+        end
+
+        def arguments_key
+          @parsed_pattern.arguments.sort.join ":"
+        end
+
+        def arguments_with_dummy_values
+          @parsed_pattern.arguments.each_with_index.map { |name, index| "#{name}: \"value#{index}\"" }.join ", "
+        end
 
-      def named_arg_patterns? segments
-        arg_segments(segments).any?(&:pattern)
+        def expected_path_for_dummy_values
+          index = 0
+          @parsed_pattern.segments.map do |segment|
+            if segment.provides_arguments?
+              segment_dummy_path = segment.expected_path_for_dummy_values index
+              index += segment.arguments.length
+              segment_dummy_path
+            else
+              segment.pattern
+            end
+          end.join "/"
+        end
+
+        private
+
+        def build_path_string
+          @parsed_pattern.segments.map(&:path_string).join "/"
+        end
       end
     end
   end

data/lib/gapic/presenters/service_presenter.rb

@@ -27,14 +27,15 @@ module Gapic
       include Gapic::Helpers::FilepathHelper
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, service, parent_service: nil
+      def initialize gem_presenter, api, service, parent_service: nil
+        @gem_presenter = gem_presenter
         @api = api
         @service = service
         @parent_service = parent_service
       end
 
       def gem
-        GemPresenter.new @api
+        @gem_presenter
       end
 
       def file
@@ -42,12 +43,12 @@ module Gapic
       end
 
       def package
-        PackagePresenter.new @api, @service.parent.package
+        PackagePresenter.new @gem_presenter, @api, @service.parent.package
       end
 
       def methods
         @methods ||= begin
-          @service.methods.map { |m| MethodPresenter.new @api, m }
+          @service.methods.map { |m| MethodPresenter.new self, @api, m }
         end
       end
 
@@ -60,7 +61,7 @@ module Gapic
       def common_service_delegate
         unless defined? @common_service_delegate
           delegate = @api.delegate_service_for @service
-          @common_service_delegate = delegate ? ServicePresenter.new(@api, delegate) : nil
+          @common_service_delegate = delegate ? ServicePresenter.new(@gem_presenter, @api, delegate) : nil
         end
         @common_service_delegate
       end
@@ -74,7 +75,7 @@ module Gapic
         # into the KMS namespace.
         return common_service_delegate.namespace if common_service_delegate
 
-        return @service.ruby_package if @service.ruby_package.present?
+        return ensure_absolute_namespace @service.ruby_package if @service.ruby_package.present?
 
         namespace = ruby_namespace_for_address @service.address[0...-1]
         fix_namespace @api, namespace
@@ -89,20 +90,20 @@ module Gapic
       end
 
       def name
-        @service.name
+        @api.fix_service_name @service.name
       end
 
       # The namespace of the protos. This may be different from the client
       # namespace for a common service.
       def proto_namespace
-        return @service.ruby_package if @service.ruby_package.present?
+        return ensure_absolute_namespace @service.ruby_package if @service.ruby_package.present?
 
         namespace = ruby_namespace_for_address @service.address[0...-1]
         @api.override_proto_namespaces? ? fix_namespace(@api, namespace) : namespace
       end
 
       def proto_service_name_full
-        name_full = "#{proto_namespace}::#{name}"
+        name_full = "#{proto_namespace}::#{@service.name}"
         @api.override_proto_namespaces? ? fix_namespace(@api, name_full) : name_full
       end
 
@@ -187,6 +188,7 @@ module Gapic
       end
 
       def client_endpoint
+        return nil if generic_endpoint?
         @parent_service&.client_endpoint ||
           common_service_delegate&.client_endpoint ||
           @service.host ||
@@ -194,16 +196,16 @@ module Gapic
           "localhost"
       end
 
+      def generic_endpoint?
+        gem.generic_endpoint?
+      end
+
       def client_scopes
         common_service_delegate&.client_scopes ||
           @service.scopes ||
           default_config(:oauth_scopes)
       end
 
-      def client_proto_name
-        @service.address.join "."
-      end
-
       def credentials_name
         "Credentials"
       end
@@ -272,6 +274,10 @@ module Gapic
         service_file_path.sub ".rb", "_test.rb"
       end
 
+      def test_paths_file_path
+        service_file_path.sub ".rb", "_paths_test.rb"
+      end
+
       def test_client_operations_file_path
         service_file_path.sub ".rb", "_operations_test.rb"
       end
@@ -314,7 +320,7 @@ module Gapic
 
       def lro_service
         lro = @service.parent.parent.files.find { |file| file.name == "google/longrunning/operations.proto" }
-        return ServicePresenter.new @api, lro.services.first, parent_service: self unless lro.nil?
+        return ServicePresenter.new @gem_presenter, @api, lro.services.first, parent_service: self unless lro.nil?
       end
 
       def config_channel_args