gapic-generator 0.1.1

data/bin/protoc-gen-ruby_gapic

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright 2018 Google LLC
+#
+# 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
+#
+#     https://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.
+
+$LOAD_PATH.unshift ::File.expand_path("../../lib", __FILE__)
+require "gapic/runner"
+require "google/protobuf/compiler/plugin.pb"
+
+# Ensure that no encoding conversions are done on STDIN and STDOUT
+# since we are passing binary data back and forth. Otherwise these
+# streams will be mangled on Windows.
+STDIN.binmode
+STDOUT.binmode
+
+request = Google::Protobuf::Compiler::CodeGeneratorRequest.decode STDIN.read
+
+# Run the request
+response = Gapic::Runner.run request
+
+STDOUT.print response.serialize

data/default-rubocop.yml

@@ -0,0 +1,10 @@
+# This file is to be used as the default config for formatting the generated files.
+# We can't reference the generated .rubocop.yml file because Rubocop is so clevar
+# that it won't find the google-style gem unless the file is referenced here.
+inherit_gem:
+  google-style: google-style.yml
+
+AllCops:
+  Exclude:
+    - "*.gemspec"
+    - "test/**/*"

data/gem_templates/binary.erb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+<%= render partial: "shared/header" -%>
+
+gem "gapic-generator"
+require "gapic/runner"
+require "google/protobuf/compiler/plugin.pb"
+
+# Ensure that no encoding conversions are done on STDIN and STDOUT
+# since we are passing binary data back and forth. Otherwise these
+# streams will be mangled on Windows.
+STDIN.binmode
+STDOUT.binmode
+
+request = Google::Protobuf::Compiler::CodeGeneratorRequest.decode STDIN.read
+
+# Run the request, specifying the <%= gem_name %> generator
+response = Gapic::Runner.run request, generator: :<%= gem_name %>
+
+STDOUT.print response.serialize

data/gem_templates/dockerfile.erb

@@ -0,0 +1,39 @@
+<%= render partial: "shared/header" -%>
+
+##
+# Builder image.
+# Creates /workspace/gapic-generator-<%= gem_name %>.gem
+# to be copied into the final runtime image.
+##
+FROM ruby:2.6-stretch as builder
+WORKDIR /workspace
+
+# Copy code from the local directory.
+COPY . /workspace/
+
+# Create a build of the gapic-generator-<%= gem_name %> gem from source.
+RUN gem build -o gapic-generator-<%= gem_name %>.gem \
+              gapic-generator-<%= gem_name %>.gemspec
+
+
+##
+# Runtime image.
+# Installs the generator executables, common protos, and an entrypoint.
+##
+FROM ruby:2.6-stretch
+WORKDIR /workspace
+
+# Install common protos.
+COPY --from=gcr.io/gapic-images/api-common-protos:beta /protos/ /workspace/common-protos/
+
+# Copy gems from the builder.
+COPY --from=builder /workspace/*.gem /workspace/
+
+# Install the subgenerator and other needed tools.
+RUN gem install grpc-tools gapic-generator-<%= gem_name %>.gem \
+    && rm gapic-generator-<%= gem_name %>.gem \
+    && mkdir -p --mode=777 /.cache
+
+# Install the entrypoint.
+COPY ./docker-entrypoint.sh /workspace/entrypoint.sh
+ENTRYPOINT ["/workspace/entrypoint.sh"]

data/gem_templates/entrypoint.erb

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+<%= render partial: "shared/license" -%>
+
+# enable extended globbing for flag pattern matching
+shopt -s extglob
+
+# Parse out options.
+while true; do
+  case "$1" in
+    --ruby-<%= gem_name %>* ) echo "Skipping unrecognized ruby-<%= gem_name %> flag: $1" >&2; shift ;;
+    --* | +([[:word:][:punct:]]) ) shift ;;
+    * ) break ;;
+  esac
+done
+
+mkdir -p /workspace/out/lib
+exec grpc_tools_ruby_protoc \
+        --proto_path=/workspace/common-protos/ --proto_path=/workspace/in/ \
+        --ruby_out=/workspace/out/lib \
+        --grpc_out=/workspace/out/lib \
+        --ruby_<%= gem_name %>_out=/workspace/out/ \
+        --ruby_<%= gem_name %>_opt="configuration=/workspace/config.yml" \
+        `find /workspace/in/ -name *.proto`

data/gem_templates/gapic_sh.erb

@@ -0,0 +1,97 @@
+#!/bin/bash
+
+<%= render partial: "shared/license" -%>
+
+set -e
+
+CMD="$0"
+
+# Set variables used by this script.
+# All of these are set in options below, and all but PLUGIN_OPTIONS and
+# PROTO_PATH are required.
+IMAGE=
+IN=
+OUT=
+PLUGIN_OPTIONS=
+PROTO_PATH=`pwd`
+GAPIC_SERVICE_CONFIG=
+
+# Print help and exit.
+function show_help {
+  cat << EOF
+Usage: $CMD --image IMAGE --in IN_DIR --out OUT_DIR [--path PATH_DIR]
+
+Required arguments:
+      --image     The Docker image to use. The script will attempt to pull
+                    it if it is not present.
+  -i, --in        A directory containing the protos describing the API
+                    to be generated.
+  -o, --out       Destination directory for the completed client library.
+      --config    Location of the GAPIC service configuration .yml file.
+
+Optional arguments:
+  -p, --path      The base import path for the protos. Assumed to be the
+                    current working directory if unspecified.
+  -h, --help      This help information.
+EOF
+
+  exit 0
+}
+
+# Parse out options.
+while true; do
+  case "$1" in
+    -h | --help ) show_help ;;
+    --image ) IMAGE="$2"; shift 2 ;;
+    -i | --in ) IN="$2"; shift 2 ;;
+    -o | --out ) OUT="$2"; shift 2 ;;
+    -p | --path ) PROTO_PATH=$2; shift 2 ;;
+    --config ) GAPIC_SERVICE_CONFIG=$2; shift 2 ;;
+    --* ) PLUGIN_OPTIONS="$PLUGIN_OPTIONS $1 $2"; shift 2 ;;
+    -- ) shift; break; ;;
+    * ) break ;;
+  esac
+done
+
+# Ensure that all required options are set.
+if [ -z "$IMAGE" ] || [ -z "$IN" ] || [ -z "$OUT" ]; then
+  cat << EOF
+Required argument missing.
+The --image, --in, and --out arguments are all required.
+Run $CMD --help for more information.
+EOF
+
+  exit 64
+fi
+
+# Ensure that the input directory exists (and is a directory).
+if ! [ -d ${PROTO_PATH}/${IN} ]; then
+  cat << EOF
+Directory does not exist: ${PROTO_PATH}/${IN}
+EOF
+  exit 2
+fi
+
+# Ensure Docker is running and seems healthy.
+# This is mostly a check to bubble useful errors quickly.
+docker ps > /dev/null
+
+# If the output directory does not exist, create it.
+mkdir -p $OUT
+
+# If the output directory is not empty, warn (but continue).
+if [ "$(ls -A $OUT )" ]; then
+  cat << EOF
+Warning: Output directory is not empty.
+EOF
+fi
+
+# Generate the client library.
+docker run \
+  --mount type=bind,source=${PROTO_PATH}/${IN},destination=/workspace/in/${IN},readonly \
+  --mount type=bind,source=${PROTO_PATH}/${GAPIC_SERVICE_CONFIG},destination=/workspace/config.yml,readonly \
+  --mount type=bind,source=${PROTO_PATH}/${OUT},destination=/workspace/out \
+  --rm \
+  --user $UID \
+  $IMAGE \
+  $PLUGIN_OPTIONS

data/gem_templates/gemfile.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gapic-generator-<%= gem_name %>.gemspec
+gemspec

data/gem_templates/gemspec.erb

@@ -0,0 +1,36 @@
+<%= render partial: "shared/header" -%>
+
+
+lib = File.expand_path "lib", __dir__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+require "gapic/generator/<%= gem_name %>/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gapic-generator-<%= gem_name %>"
+  spec.version       = Gapic::Generator::<%= gem_class_prefix %>::VERSION
+  spec.authors       = ["Ernest Landrito", "Chris Smith", "Mike Moore"]
+  spec.email         = ["landrito@google.com", "quartzmo@gmail.com",
+                        "mike@blowmage.com"]
+
+  spec.licenses      = ["Apache-2.0"]
+
+  spec.summary       = "An API Client Generator for Ruby in Ruby!"
+  spec.homepage      = "https://github.com/googleapis/gapic-generator-ruby"
+
+  spec.files         = Dir.glob("bin/*") + Dir.glob("lib/**/*.rb") +
+                       Dir.glob("templates/**/*.{rb,erb}") +
+                       Dir.glob("*.md")
+  spec.bindir        = "bin"
+  spec.executables   = ["protoc-gen-ruby_<%= gem_name %>"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack", "~> 5.2"
+  spec.add_dependency "gapic-generator", "~> 0.0.0.dev"
+  spec.add_dependency "protobuf", "~> 3.8"
+  spec.add_dependency "rubocop", "~> 0.61"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/gem_templates/generator.erb

@@ -0,0 +1,37 @@
+<%= render partial: "shared/header" -%>
+
+
+require "gapic/generators/default_generator"
+
+module Gapic
+  module Generators
+    # The generator orchestrates the rendering of templates for
+    # <%= gem_class_prefix %> projects.
+    class <%= gem_class_prefix %>Generator < DefaultGenerator
+      # Initializes the generator.
+      #
+      # @param api [Gapic::Schema::Api] The API model/context to
+      #   generate.
+      def initialize api
+        super
+
+        # Configure to use prefer <%= gem_class_prefix %> templates
+        template_path = File.join __dir__,
+                                  "../../../templates/<%= gem_name %>"
+        use_templates! template_path
+
+        # Configure these helper method to be used by the generator
+        # use_helpers! :helper_method1, :helper_method2, :helper_method3
+      end
+
+      # Generates all the files for the API.
+      #
+      # @return [Array<
+      #   Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
+      #   The files that were generated for the API.
+      def generate
+        super
+      end
+    end
+  end
+end

data/gem_templates/gitignore.erb

@@ -0,0 +1,10 @@
+Gemfile.lock
+.DS_STORE
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/gem_templates/rakefile.erb

@@ -0,0 +1,29 @@
+<%= render partial: "shared/header" -%>
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rake/testtask"
+
+RuboCop::RakeTask.new # Configuration is in .rubocop.yml
+Rake::TestTask.new :test do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+desc "Run the CI build"
+task :ci do
+  puts "\nBUILDING gapic-generator-<%= gem_name %>\n"
+  puts "\ngapic-generator-<%= gem_name %> rubocop\n"
+  Rake::Task[:rubocop].invoke
+  puts "\ngapic-generator-<%= gem_name %> test\n"
+  Rake::Task[:test].invoke
+end
+
+desc "Build the docker image."
+task :image, :name do |_t, args|
+  image_name = args[:name] || "ruby-gapic-generator-<%= gem_name %>"
+  sh "docker build -t #{image_name} ."
+end
+
+task default: :ci

data/gem_templates/readme.erb

@@ -0,0 +1,69 @@
+# <%= gem_class_prefix %> Generator for Ruby
+
+Create Ruby clients from a protocol buffer description of an API.
+
+**Note** This project is a preview. Please try it out and let us know what you think,
+but there are currently no guarantees of stability or support.
+
+## Usage
+### Install the Proto Compiler
+This generator relies on the Protocol Buffer Compiler to [orchestrate] the
+client generation.
+
+```sh
+# Declare the protobuf version to use.
+$ export PROTOBUF_VERSION=3.6.1
+
+# Declare the target installation system.
+# export SYSTEM=osx
+$ export SYSTEM=linux
+
+# Get the precompiled protobuf compiler.
+$ curl --location https://github.com/google/protobuf/releases/download/v${PROTOBUF_VERSION}/protoc-${PROTOBUF_VERSION}-linux-x86_64.zip > usr/src/protoc/protoc-${PROTOBUF_VERSION}.zip
+$ cd /usr/src/protoc/
+$ unzip protoc-${PROTOBUF_VERSION}.zip
+$ rm protoc-${PROTOBUF_VERSION}.zip
+
+# Link the protoc to the path.
+$ ln -s /usr/src/protoc/bin/protoc /usr/local/bin/protoc
+$ mkdir -p /protos/
+
+# Move the common protobuf files to the local include folder.
+$ cp -R /usr/src/protoc/include/* /usr/local/include/
+```
+
+[orchestrate]: https://developers.google.com/protocol-buffers/docs/reference/ruby-generated
+
+### Build and Install the Generator
+This tool is in pre-alpha so it is not yet released to RubyGems. You will have to
+build the generator from scratch.
+
+```sh
+$ git clone https://github.com/googleapis/gapic-generator-ruby.git
+$ cd gapic-generator-ruby
+$ gem build gapic-generator.gemspec
+$ gem install gapic-generator-0.1.0.gem
+$ which protoc-gen-ruby_gapic
+> {Non-empty path}
+```
+
+### Generate an API
+Installing this generator exposes `protoc-gen-ruby_gapic` on the PATH. By doing
+so, it gives the protobuf compiler the CLI option `--ruby_gapic_out` on which
+you can specify an output path for this generator.
+
+If you want to experiment with an already-existing API, one example is available.
+Note: You need to clone the googleapis repository from GitHub, and change
+to a special branch:
+```sh
+# Get the protos and it's dependencies.
+$ git clone git@github.com:googleapis/api-common-protos.git
+$ git clone git@github.com:googleapis/googleapis.git
+$ cd googleapis
+$ git checkout --track -b input-contract origin/input-contract
+
+# Now you're ready to compile the API.
+$ protoc google/<%= gem_name %>/vision/v1/*.proto \
+    --proto_path=../api-common-protos/ --proto_path=. \
+    --ruby_gapic_out=/dest/
+```

data/gem_templates/rubocop.erb

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - expected_output/**/*
+
+Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: omit_parentheses
+  AllowParenthesesInMultilineCall: true
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses