gruf-commander 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c59f4d4bddadc12d9556193015afd51ad938873
+  data.tar.gz: c40f4cdae1e93b7f2acc56e4f15c9cab11efb743
+SHA512:
+  metadata.gz: 5ac8edc95b097eaf9b28bf3bc91935660c2ce40e384ec4002a6fb3fd8a53cfc1e4078085c0d2c5b711c6d3e1cfe2fc1869c9ede72a125c3425ff3cbdcf526b5a
+  data.tar.gz: 0d6b8177f2841c931f77264e0f4996666b7c7bd3b943e0217ddc9457eb4100b2064a16d8c465934fbde98b371056b46758f0a1a45cec420a621ec61892550b93

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Changelog for the gruf-commander gem. This includes internal history before the gem was made.
+
+### Pending release
+
+### 0.1.1
+
+- Initial public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at splittingred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,134 @@
+# Gruf Commander
+
+[![Build Status](https://travis-ci.com/bigcommerce/gruf-commander.svg?token=D3Cc4LCF9BgpUx4dpPpv&branch=master)](https://travis-ci.com/bigcommerce/gruf-commander) [![Gem Version](https://badge.fury.io/rb/gruf-commander.svg)](https://badge.fury.io/rb/gruf-commander) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf-commander.svg?branch=master)](https://inch-ci.org/github/bigcommerce/gruf-commander?branch=master)
+
+Assists with request/command-style syntax and separated validation layer in [gruf](https://github.com/bigcommerce/gruf)
+requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gruf-commander'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gruf-commander
+
+## Usage
+
+Gruf Commander supports the Command/Request design pattern. You create Request classes that perform validation,
+and then submit themselves to a Command. The Command class then performs the business logic by interacting
+with internal layers of the application, such as the service, DTO, or repository layers.
+
+First, in your gruf initializer, add the interceptor:
+
+```ruby
+Gruf.configure do |c|
+  c.interceptors.use(Gruf::Commander::RequestValidationInterceptor)
+end
+```
+
+Then you'll create your command and request classes:
+
+```ruby
+class CreateBoxCommand < Gruf::Commander::Command
+  def call(request)
+    Box.create!(width: request.width, height: request.height)
+  end
+end
+
+
+class CreateBoxRequest < Gruf::Commander::Request
+  attr_reader :width
+  attr_reader :height
+  
+  validate :validate_width, :validate_height
+  
+  def initialize(width:, height:)
+    @width = width
+    @height = height
+    super(command: CreateBoxCommand.new)
+  end
+  
+  private
+  
+  def validate_width
+    return if @width.to_i > 0    
+    errors.add(:width, :invalid_width, message: 'Please enter a valid width!')
+  end
+  
+  def validate_height
+    return if @height.to_i > 0    
+    errors.add(:height, :invalid_height, message: 'Please enter a valid height!')
+  end
+end
+```
+
+Then, in your gruf controller:
+
+```ruby
+def create_box
+  request = CreateBoxRequest.new(
+    width: request.message.width.to_i,
+    height: request.message.height.to_i,
+  )
+  box = request.submit!
+  Rpc::CreateBoxResponse.new(
+    box: Rpc::Box.new(height: box.height, width: box.width)
+  )
+end
+```
+
+Gruf Commander will automatically handle the validation errors to push back to the grpc server, properly sending an
+`GRPC::InvalidArgument` exception should validation fail.
+
+### Configuration
+
+You can configure the request validation options:
+
+|Config Name|Description|Default|
+|---|---|---|
+|`invalid_request_error_code`|Sets the gRPC error code sent back on failed validation.|`:invalid_argument`|
+|`invalid_request_app_error_code`|Sets the app error code sent back on failed validation.|`:invalid_request`|
+|`invalid_request_message`|Sets the error message sent back on failed validation.|Invalid Request|
+
+### Dependency Injection
+
+Gruf Commander works very well with DI systems such as [dry-rb](http://dry-rb.org/), since Request objects can simply
+just provide accessors to modify their attributes, and commands are simple plain classes that can have no strict 
+contract on initialization.
+
+We recommend using a DI system (such as dry-rb) to use with Gruf Commander, as it helps with testing and refactoring
+in more complex applications. 
+
+## Testing
+
+Tests are run via rspec:
+
+```bash
+bundle exec rspec
+```
+
+## License
+
+Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 
+
+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/gruf-commander.gemspec

@@ -0,0 +1,38 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gruf/commander/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-commander'
+  spec.version       = Gruf::Commander::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['splittingred@gmail.com']
+
+  spec.summary       = 'Command/request syntax helper for gruf'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/gruf-commander'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-commander.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'activemodel', '>= 4'
+end

data/lib/gruf/commander.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+require 'active_model'
+require_relative 'commander/version'
+require_relative 'commander/command'
+require_relative 'commander/request'
+require_relative 'commander/request_validation_interceptor'
+
+module Gruf
+  ##
+  # Base module for Gruf Commander
+  #
+  module Commander
+  end
+end

data/lib/gruf/commander/command.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Commander
+    ##
+    # Abstract class to be extended and implemented in your command classes.
+    #
+    class Command
+      ##
+      # @param [Request] request
+      #
+      # :nocov:
+      def call(request)
+        raise NotImplementedError, "Please implement :call on the command to handle #{request.class}"
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/gruf/commander/request.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Commander
+    ##
+    # Used when submitting requests from commands; utilize to issue a validation exception on a request
+    #
+    class InvalidRequest < StandardError
+      attr_reader :request
+
+      ##
+      # @param [Request] request
+      # @param [String] message
+      #
+      def initialize(request, message = '')
+        @request = request
+        super(message)
+      end
+    end
+
+    ##
+    # Base request class
+    #
+    class Request
+      include ActiveModel::Validations
+
+      # @var [Command] command
+      attr_reader :command
+
+      ##
+      # @param [Command] command
+      #
+      def initialize(command:)
+        @command = command
+      end
+
+      ##
+      # Validate and submit the request
+      #
+      # @raise [InvalidRequest] if the request is invalid
+      # rubocop:disable Style/RaiseArgs
+      def submit!
+        raise InvalidRequest.new(self) unless valid?
+        command.call(self)
+      end
+      # rubocop:enable Style/RaiseArgs
+    end
+  end
+end

data/lib/gruf/commander/request_validation_interceptor.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Commander
+    ##
+    # Does request validation error handling
+    #
+    class RequestValidationInterceptor < ::Gruf::Interceptors::ServerInterceptor
+      ##
+      # Intercept the request and properly handle validation failures
+      #
+      def call
+        yield # this returns the protobuf message
+      rescue Gruf::Commander::InvalidRequest => e
+        e.request.errors.details.each do |attr, errs|
+          errs.each_with_index do |err, idx|
+            add_field_error(attr, err.values.first.to_sym, e.request.errors.messages[attr].fetch(idx, ''))
+          end
+        end
+        fail!(
+          options.fetch(:invalid_request_error_code, :invalid_argument),
+          options.fetch(:invalid_request_app_error_code, :invalid_request),
+          options.fetch(:invalid_request_message, 'Invalid request')
+        )
+      end
+    end
+  end
+end

data/lib/gruf/commander/version.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# 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.
+#
+module Gruf
+  module Commander
+    VERSION = '0.1.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: gruf-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Command/request syntax helper for gruf
+email:
+- splittingred@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-commander.gemspec
+- lib/gruf/commander.rb
+- lib/gruf/commander/command.rb
+- lib/gruf/commander/request.rb
+- lib/gruf/commander/request_validation_interceptor.rb
+- lib/gruf/commander/version.rb
+homepage: https://github.com/bigcommerce/gruf-commander
+licenses: []
+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.14
+signing_key: 
+specification_version: 4
+summary: Command/request syntax helper for gruf
+test_files: []