grpc_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69604d01e1da353e7105f6110e06f8c48b305999
+  data.tar.gz: c80a46aca528d456321c02b5163187a59c1373ae
+SHA512:
+  metadata.gz: 9c9d04704d3cf67f116f5275f4acfde1aad8cd7e4b5ad0d9f0f43d05fdacd993f4c74973d2497d8b98a220dca4b1c0ba2a93735a18a0962f443476970c1ae32e
+  data.tar.gz: a4de43cf3407ff9bc4d42d7ba952640a149086626ffe3eedc85a1016c9ea489e3696a9deddc974a6d8842f3c81e467021e1c277e2298ba4b2cf9bdcd30000b8a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

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 i@qinix.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grpc_rails.gemspec
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'rails', '~> 5.0'
+gem 'sqlite3'
+gem 'pry'
+gem 'generator_spec'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eric Zhang
+
+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,41 @@
+# GrpcRails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/grpc_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Eric Zhang/grpc_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_rails"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/grpc_server

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+require 'grpc_rails'
+require 'active_support/core_ext/hash'
+
+options = {
+  host: '0.0.0.0',
+  port: 3001,
+  env: 'development',
+  config: 'config/grpc_rails.yml'
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: grpc_server [options]"
+
+  opts.on('-h HOST', '--host HOST', 'Host') do |value|
+    options[:host] = value
+  end
+
+  opts.on('-p PORT', '--port PORT', 'Port') do |value|
+    options[:port] = value
+  end
+
+  opts.on('-e RAILS_ENV', '--environment RAILS_ENV', 'RAILS_ENV') do |value|
+    options[:env] = value
+  end
+
+  opts.on('-c CONFIG_FILE', '--config CONFIG_FILE', 'Config file') do |value|
+    options[:config] = value
+  end
+end.parse!
+
+if File.exists? options[:config]
+  config = YAML.load(File.read(options[:config]))
+  options = config[options[:env]].symbolize_keys.merge(options)
+end
+
+puts "Serving #{options[:env]} in #{options[:host]}:#{options[:port]}"
+GrpcRails::Server.new(options[:host], options[:port], options[:env]).serve

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/grpc_rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grpc_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_rails"
+  spec.version       = GrpcRails::VERSION
+  spec.authors       = ["Eric Zhang"]
+  spec.email         = ["i@qinix.com"]
+
+  spec.summary       = %q{Support writting gRPC services inside Rails}
+  spec.description   = %q{Support writting gRPC services inside Rails}
+  spec.homepage      = "https://github.com/qinix/grpc_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   << 'grpc_server'
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties', '>= 4.1.0'
+  spec.add_dependency 'grpc', '~> 1.1'
+  spec.add_dependency 'grpc-tools', '~> 1.1'
+end

data/lib/grpc-rails.rb

@@ -0,0 +1 @@
+require 'grpc_rails'

data/lib/grpc_rails.rb

@@ -0,0 +1,6 @@
+require "grpc_rails/version"
+require 'grpc_rails/railtie'
+require 'grpc_rails/server'
+
+module GrpcRails
+end

data/lib/grpc_rails/railtie.rb

@@ -0,0 +1,19 @@
+require 'rails/railtie'
+
+module GrpcRails
+  class Railtie < Rails::Railtie
+    initializer 'grpc_rails.initialization' do |app|
+      $:.unshift "#{app.root}/app/services/base"
+    end
+
+    rake_tasks do
+      current_path = File.expand_path('..', __FILE__)
+      Dir["#{current_path}/tasks/*.rake"].each { |f| load f }
+    end
+
+    generators do
+      current_path = File.expand_path('..', __FILE__)
+      Dir["#{current_path}/../rails/generators/*.rb"].each { |f| require_relative f }
+    end
+  end
+end

data/lib/grpc_rails/server.rb

@@ -0,0 +1,52 @@
+require 'grpc'
+
+module GrpcRails
+  class Server
+    EXECUTABLES = ['bin/rails', 'script/rails']
+
+    def initialize(host='0.0.0.0', port=3001, env='development')
+      @host = host
+      @port = port
+      ENV['RAILS_ENV'] = env
+    end
+
+    def services
+      Dir["#{Rails.root}/app/services/**/*.rb"].each { |f| require f }
+
+      Dir["#{Rails.root}/app/services/*.rb"].map do |file|
+        class_name = file.split('/').last.sub(/\.rb$/, '').camelize
+        Object.const_get class_name
+      end
+    end
+
+    def serve
+      load_rails_environment!
+
+      @server ||= GRPC::RpcServer.new
+      @server.add_http2_port "#{@host}:#{@port}", :this_port_is_insecure
+      services.each { |service| @server.handle service }
+      @server.run_till_terminated
+    end
+
+    private
+
+    def load_rails_environment!
+      loop do
+        if exe = find_executable
+          Object.const_set(:APP_PATH, File.expand_path('config/application', Dir.pwd))
+          require File.expand_path('../environment', APP_PATH)
+          break
+        end
+
+        raise 'You are not in Rails project' if Pathname.new(Dir.pwd).root?
+
+        # Otherwise keep moving upwards in search of an executable.
+        Dir.chdir('..')
+      end
+    end
+
+    def find_executable
+      EXECUTABLES.find { |exe| File.file?(exe) }
+    end
+  end
+end

data/lib/grpc_rails/tasks/grpc.rake

@@ -0,0 +1,6 @@
+namespace :grpc do
+  desc 'Generate base services from protos defined in app/services/protos'
+  task generate_base_services: [:environment] do
+    exec "grpc_tools_ruby_protoc -I #{Rails.root}/app/services/protos --ruby_out=#{Rails.root}/app/services/base --grpc_out=#{Rails.root}/app/services/base #{Rails.root}/app/services/protos/*.proto"
+  end
+end

data/lib/grpc_rails/version.rb

@@ -0,0 +1,3 @@
+module GrpcRails
+  VERSION = "0.1.0"
+end

data/lib/rails/generators/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+
+module Grpc
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path '../templates', __FILE__
+    desc "Install grpc_rails file to your application."
+
+    def mkdirs
+      empty_directory 'app/services'
+      empty_directory 'app/services/base'
+      empty_directory 'app/services/protos'
+    end
+
+    def copy_config
+      template 'grpc_rails.yml', 'config/grpc_rails.yml'
+    end
+  end
+end

data/lib/rails/generators/templates/grpc_rails

@@ -0,0 +1 @@
+default: &default

data/lib/rails/generators/templates/grpc_rails.yml

@@ -0,0 +1,12 @@
+default: &default
+  host: 0.0.0.0
+  port: 3001
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: grpc_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Support writting gRPC services inside Rails
+email:
+- i@qinix.com
+executables:
+- grpc_server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/grpc_server
+- bin/setup
+- grpc_rails.gemspec
+- lib/grpc-rails.rb
+- lib/grpc_rails.rb
+- lib/grpc_rails/railtie.rb
+- lib/grpc_rails/server.rb
+- lib/grpc_rails/tasks/grpc.rake
+- lib/grpc_rails/version.rb
+- lib/rails/generators/install_generator.rb
+- lib/rails/generators/templates/grpc_rails
+- lib/rails/generators/templates/grpc_rails.yml
+homepage: https://github.com/qinix/grpc_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Support writting gRPC services inside Rails
+test_files: []