grpc_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8aae2f11b010914bcd6e84eea94e8eb737c315c5e149c8a2d895ebbafe6ccc28
+  data.tar.gz: 0dd0a8cc4921d8c669f6d69dd8ed86d8f2445fc739ff08a49dc2d1ae1e3011a2
+SHA512:
+  metadata.gz: e0d9d5e8232259bbfff5db29f3652f6492cd9202be0e6d1118267bb646b1e3abf657d68cbb5266dc55214cfe5b4ae09f4f7029aff972961f50f7b3a883d89d33
+  data.tar.gz: 5e892e677f953685d353bd34845ce9ae16eaeb18fd77626f0699d72f13fcb3c9709380672ed3a836111d9f94c45c991b6b0684168e1933f0dd27736e241b3a29

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at south37777@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_server.gemspec
+gemspec
+
+gem "pry"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    grpc_server (0.0.1)
+      grpc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    google-protobuf (3.13.0)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    grpc (1.31.1)
+      google-protobuf (~> 3.12)
+      googleapis-common-protos-types (~> 1.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  grpc_server!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nao Minami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# GrpcServer
+Simple utility class for using gRPC server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc_server'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install grpc_server
+
+## Usage
+By using `GrpcServer` class, you can run a gRPC server in the specified configuration.
+
+```ruby
+require "grpc_server"
+
+server = GrpcServer.new(
+  port:         3000,      # Listen port
+  threads:      30,        # The size of the thread pool
+  interceptors: [...],     # An array of GRPC::ServerInterceptor objects
+  signals:      ["TERM"],  # Signals for graceful shutdown
+)
+server.set_handler(XXX)  # Set handler here
+server.run  # Start to run
+```
+
+## Example
+By using [examples/server.rb](https://github.com/south37/grpc_server/blob/master/examples/server.rb), gRPC server start to listen on `0.0.0.0:50051`.
+
+```console
+$ bundle exec ruby examples/server.rb
+I, [2020-08-20T20:31:16.470412 #26572]  INFO -- : gRPC server starting...
+I, [2020-08-20T20:31:16.470594 #26572]  INFO -- : * Max threads: 30
+I, [2020-08-20T20:31:16.470632 #26572]  INFO -- : * Environment: unknown
+I, [2020-08-20T20:31:16.470646 #26572]  INFO -- : * Listening on tcp://0.0.0.0:50051
+I, [2020-08-20T20:31:16.470654 #26572]  INFO -- : Use Ctrl-C to stop
+```
+
+The server supports [GRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), we can check it by using [grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe).
+
+```console
+$ grpc-health-probe -addr=:50051
+status: SERVING
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/south37/grpc_server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/south37/grpc_server/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GrpcServer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/south37/grpc_server/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_server"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/server.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+$stdout.sync = true
+
+require "grpc_server"
+
+server = GrpcServer.new
+server.run

data/grpc_server.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/grpc_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_server"
+  spec.version       = GrpcServer::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Simple utility class for using gRPC server}
+  spec.description   = %q{Simple utility class for using gRPC server}
+  spec.homepage      = "https://github.com/south37/grpc_server"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/south37/grpc_server"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "grpc"
+end

data/lib/grpc_server.rb

@@ -0,0 +1,24 @@
+require "grpc_server/engine"
+require "grpc_server/version"
+
+class GrpcServer
+  # @param [String] host
+  # @param [Integer] port
+  # @param [Integer] threads the size of the thread pool the server uses to
+  #     run its threads. No more concurrent requests can be made than the
+  #     size of the thread pool
+  # @param [String] env
+  # @param [Array<GRPC::ServerInterceptor>] interceptors An array of
+  #     GRPC::ServerInterceptor objects that will be used for intercepting
+  #     server handlers to provide extra functionality.
+  # @param [Array<String>] signals List of String representing signals that
+  #     the user would like to send to the server for graceful shutdown
+  # @param [Logger] logger
+  def initialize(**kwargs)
+    @engine = Engine.new(**kwargs)
+  end
+
+  extend Forwardable
+
+  def_delegators :@engine, :set_handler, :run, :stop
+end

data/lib/grpc_server/engine.rb

@@ -0,0 +1,89 @@
+require "grpc"
+require "grpc/health/checker"
+require "logger"
+
+class GrpcServer
+  class Engine
+    DEFAULT_HOST                      = "0.0.0.0"
+    DEFAULT_PORT                      = 50051
+    DEFAULT_THREADS                   = 30
+    DEFAULT_ENV                       = "unknown"
+    DEFAULT_GRACEFUL_SHUTDOWN_SIGNALS = [
+      "TERM",
+      "INT",
+    ].freeze
+
+    # @param [String] host
+    # @param [Integer] port
+    # @param [Integer] threads the size of the thread pool the server uses to
+    #     run its threads. No more concurrent requests can be made than the
+    #     size of the thread pool
+    # @param [String] env
+    # @param [Array<GRPC::ServerInterceptor>] interceptors An array of
+    #     GRPC::ServerInterceptor objects that will be used for intercepting
+    #     server handlers to provide extra functionality.
+    # @param [Array<String>] signals List of String representing signals that
+    #     the user would like to send to the server for graceful shutdown
+    # @param [Logger] logger
+    def initialize(host:         DEFAULT_HOST,
+                   port:         DEFAULT_PORT,
+                   threads:      DEFAULT_THREADS,
+                   env:          DEFAULT_ENV,
+                   interceptors: [],
+                   signals:      DEFAULT_GRACEFUL_SHUTDOWN_SIGNALS,
+                   logger:       nil)
+      @host    = host
+      @port    = port
+      @threads = threads
+      @env     = env
+      @logger  = logger || Logger.new($stdout)
+      @signals = signals
+
+      @server = GRPC::RpcServer.new(
+        pool_size:    @threads,
+        interceptors: interceptors,
+      )
+      @server.add_http2_port("#{@host}:#{@port}", :this_port_is_insecure)
+
+      # Setup Health Cheker.
+      # cf. https://github.com/grpc/grpc/blob/master/doc/health-checking.md
+      @server.handle(health_checker)
+      register_service_to_health_checker!(service: "")
+    end
+
+    # @param [GRPC::GenericService] service
+    def set_handler(service)
+      @server.handle(service)
+      register_service_to_health_checker!(service: service.service_name)
+    end
+
+    def run
+      @logger.info("gRPC server starting...")
+      @logger.info("* Max threads: #{@threads}")
+      @logger.info("* Environment: #{@env}")
+      @logger.info("* Listening on tcp://#{@host}:#{@port}")
+      @logger.info("Use Ctrl-C to stop")
+      @server.run_till_terminated_or_interrupted(@signals)
+      @logger.info("Exiting")
+    end
+
+    def stop
+      @server.stop
+    end
+
+  private
+
+    # @param [String] service
+    def register_service_to_health_checker!(service:)
+      health_checker.add_status(
+        service,
+        Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING,
+      )
+    end
+
+    # @return [Grpc::Health::Checker]
+    def health_checker
+      @health_checker ||= Grpc::Health::Checker.new
+    end
+  end
+end

data/lib/grpc_server/version.rb

@@ -0,0 +1,3 @@
+class GrpcServer
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: grpc_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple utility class for using gRPC server
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/server.rb
+- grpc_server.gemspec
+- lib/grpc_server.rb
+- lib/grpc_server/engine.rb
+- lib/grpc_server/version.rb
+homepage: https://github.com/south37/grpc_server
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/south37/grpc_server
+  source_code_uri: https://github.com/south37/grpc_server
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Simple utility class for using gRPC server
+test_files: []