simple_endpoint 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8d160bdac054393e08f0451d7117a710140cd02614d8bc7d212de43e8fe4caf
+  data.tar.gz: e6af102683834cf488a5dce4589e27c356e0994485679722a94569cae8a2e258
+SHA512:
+  metadata.gz: f20a4512bbce57067e072a6f7d67b73a88fd606b5b9e01af7d71ab7b4460d9e71c603e05e3205853506d4f05d8295eef121f07a7e730cad610ed4a878d038f04
+  data.tar.gz: a46a439a455f21f4e83914210aeeb1d4b6fa29996cc4fbb1499484baee633bc58abf7f1b264f7cc767fe54e2d5f64dcc1969045a5f45879dc6dcbe1632f8feec

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/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**'
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -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 simple_endpoint.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    simple_endpoint (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    method_source (0.9.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  simple_endpoint!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 differencialx
+
+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,247 @@
+# SimpleEndpoint
+
+Dry-matcher free implementation of trailblazer endpoint.
+
+## Installation
+Add this to your Gemfile:
+
+```ruby
+gem 'simple_endpoint' # not released yet
+gem 'simple_endpoint', github: 'differencialx/simple_endpoint', :branch => 'master'
+```
+
+## Getting Started
+
+Include simple endpoint to your base controller
+
+```ruby
+class ApplicationController < ActionController::Base
+  include SimpleEndpoint::Controller
+end
+```
+
+Define `default_cases` method to specify trailblazer operation result handling
+
+```ruby
+class ApplicationController < ActionController::Base
+  include SimpleEndpoint::Controller
+
+  private
+
+  def default_cases
+    {
+      success: -> (result) { result.success? },
+      invalid: -> (result) { result.failure? }
+    }
+  end
+end
+```
+
+Define `default_handler` method to specify how to handle each case
+
+```ruby
+class ApplicationController < ActionController::Base
+  include SimpleEndpoint::Controller
+
+  private
+
+  def default_handler
+    {
+      success: -> (result) { render json: result['model'], **result['render_options'] status: 200 },
+      invalid: -> (result) { render json: result['contract.default'].errors, serializer: ErrorSerializer, status: :unprocessable_entity }
+    }
+  end
+end
+```
+
+`OperationIsNotHandled` error will be raised if `#default_cases` doesn't contain case for specific operation result.
+
+`UnhadledResultError` will be raised if `#default_handler` doesn't contain for some cases.
+
+`NotImplementedError` will be raised if `default_cases` or `default_handler` methods aren't defined.
+
+
+### #endpoint method
+
+Now you are able to use `endpoint` method at other controllers
+
+`#endpoint` method has next signature:
+
+| Key | Required | Default value | Description  |
+|---|---|---|---|
+| `:operation` | yes | - | Traiblazer operation class |
+| `:different_cases`| no | {} | Cases that should be redefined for exact `#endpoint` call |
+| `:different_handler` | no | {} | Case of handler that should be handled in different way |
+| `:options` | no | {} | Additional hash which will be merged to `#ednpoint_options` method result before operation execution |
+| `:before_render` | no | {} | Allow to process code before specific case handler |
+
+
+#### Simple endpoint call
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create
+  end
+end
+```
+
+#### Redefining cases for specific controller
+
+If you need to redefine operation result handling for specific controller you can do next
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create
+  end
+
+  private
+
+  def default_cases
+    {
+      success: -> (result) { result.success? && is_it_raining? },
+      invalid: -> (result) { result.failure? && is_vasya_in_the_house? }
+      ... # other cases 
+    }
+  end
+
+  def is_it_raining?
+    WeatherForecast.for_today.raining?
+  end
+
+  def is_vasya_in_the_house?
+    User.find_by(login: 'vasya').signed_in?
+  end
+end
+```
+
+Note that it'll override `ApplicationController#default_cases`
+
+#### Redefining cases for specific controller action
+
+Code below will redefine only `success` operation handling logic of `#default_cases` method, it doesn't matter where `#default_cases` was defined, at `ApplicationController` or `PostsController`
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation:       Post::Create,
+             different_cases: different_cases
+  end
+
+  private
+
+  def different_cases
+    {
+      success: -> (result) { result.success? && is_vasya_in_the_house? }
+    }
+  end
+
+  def is_vasya_in_the_house?
+    User.find_by(login: 'vasya').signed_in?
+  end
+end
+```
+
+#### Redefining handler for specific controller
+
+If you need to redefine handler logic, simply redefine `#default_handler` method
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create
+  end
+
+  private
+
+  def default_handler
+    {
+      success: -> (result) { head :ok }
+    }
+  end
+end
+```
+
+#### Redefining handler for specific controller action
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create,
+             different_handler: different_handler
+  end
+
+  private
+
+  def different_handler
+    {
+      success: -> (result) { render json: { message: 'Nice!' }, status: :created }
+    }
+  end
+end
+
+```
+
+#### Defining default params for trailblazer operation
+
+Default `#endpoint_options` method implementation
+
+```ruby
+  def endpoint_options
+    { params: params }
+  end
+```
+
+Redefining `endpoint_options`
+
+```ruby
+class PostsController < ApplicationController
+
+  private
+
+  def endpoint_options
+    { params: permitted_params }
+  end
+
+  def permitted_params
+    params.permit(:some, :attributes)
+  end
+end
+```
+
+#### Passing additional params to operation
+
+`options` will be merged with `#endpoint_options` method result and trailblazer operation will be executed with such params: `Post::Create.(params: params, current_user: current_user)`
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create,
+             options: { current_user: current_user }
+  end
+end
+```
+
+#### Before handler actions
+
+You can do some actions before `#default_handler` execution
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create,
+             before_response: before_render_actions
+    end 
+  end
+
+  private
+
+  def before_response_actions
+    {
+      success: -> (result) { response.headers['Some-header'] = result[:some_data] }
+    }
+  end
+end
+```
+
+Code above will put data from operation result into response haeders before render

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simple_endpoint'
+
+# 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/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/lib/simple_endpoint/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleEndpoint
+  VERSION = '0.1.2'
+end

data/lib/simple_endpoint.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'simple_endpoint/version'
+
+module SimpleEndpoint
+  module Controller
+    def endpoint(operation:, different_cases: {}, different_hander: {}, options: {}, before_response: {})
+      Endpoint.call(
+        operation,
+        default_handler.merge(different_hander),
+        default_cases.merge(different_cases),
+        before_response,
+        endpoint_options.merge(options)
+      )
+    end
+
+    private
+
+    def endpoint_options
+      { params: params }
+    end
+
+    def default_handler
+      raise NotImplementedError, HANDLER_ERROR_MESSAGE
+    end
+
+    def default_cases
+      raise NotImplementedError, CASES_ERROR_MESSAGE
+    end
+  end
+
+  class Endpoint
+    def self.call(operation, handler, cases, before_response = {}, **args)
+      result = operation.call(**args)
+      new.call(result, cases, handler, before_response)
+    end
+
+    def call(result, cases, handler = {}, before_response = {})
+      matched_case = matched_case(cases, result)
+      procees_handler(matched_case, before_response, result) unless before_response.empty?
+      procees_handler(matched_case, handler, result, UnhadledResultError)
+    end
+
+    def matched_case(cases, result)
+      matched_case = obtain_matched_case(cases, result)
+      raise OperationIsNotHandled, OPERATION_IS_NOT_HANDLER_ERROR unless matched_case
+
+      matched_case
+    end
+
+    def procees_handler(matched_case, handler, result, exception_class = nil)
+      if handler.key?(matched_case)
+        handler.dig(matched_case)&.(result)
+      elsif exception_class
+        raise exception_class, "Key: #{matched_case} is not present at #{handler}"
+      end
+    end
+
+    def obtain_matched_case(cases, result)
+      matched_case = cases.each { |kase, condition| break kase if condition.call(result) }
+      return if matched_case.is_a?(Hash)
+
+      matched_case
+    end
+  end
+
+  class OperationIsNotHandled < StandardError; end
+  class UnhadledResultError < StandardError; end
+
+  OPERATION_IS_NOT_HANDLER_ERROR = 'Current operation result is not handled at #default_cases method'
+  HANDLER_ERROR_MESSAGE = <<-LARGE_ERROR
+    Please implement default_handler via case statement
+
+    EXAMPLE:
+    ###############################################
+
+    # Can be put into ApplicationController and redefined in subclasses
+
+    private
+
+    def default_handler
+      -> (kase, result) do
+        case kase
+        when :success then render :json ...
+        else
+          # just in case you forgot to add handler for some of case
+          SimpleEndpoint::UnhadledResultError, 'Oh nooooo!!! Really???!!'
+        end
+      end
+    end
+
+    ###############################################
+
+    OR
+
+    You can move this logic to separate singleton class
+  LARGE_ERROR
+
+  CASES_ERROR_MESSAGE = <<-LARGE_ERROR
+    Please implement default cases conditions via hash
+
+    EXAMPLE:
+    ###############################################
+    # default trailblazer-endpoint logic, you can change it
+    # Can be put into ApplicationController and redefined in subclasses
+
+    private
+
+    def default_cases
+      {
+        present:         -> (result) { result.success? && result["present"] }
+        success:         -> (result) { result.success? },
+        created:         -> (result) { result.success? && result["model.action"] == :new }
+        invalid:         -> (result) { result.failure? },
+        not_found:       -> (result) { result.failure? && result["result.model"] && result["result.model"].failure? },
+        unauthenticated: -> (result) { result.failure? && result["result.policy.default"] && result["result.policy.default"].failure? }
+      }
+    end
+
+    ###############################################
+
+    OR
+
+    You can move this to separate singleton class
+  LARGE_ERROR
+end

data/simple_endpoint.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_endpoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_endpoint'
+  spec.version       = SimpleEndpoint::VERSION
+  spec.authors       = ['Alex Bal']
+  spec.email         = ['differencialx@gmail.com']
+
+  spec.summary       = 'Simple implementation of Trailblazer endpoint'
+  spec.description   = 'Simple implementation of Trailblazer endpoint'
+  spec.homepage      = ''
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) 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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: simple_endpoint
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Alex Bal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-10 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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple implementation of Trailblazer endpoint
+email:
+- differencialx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_endpoint.rb
+- lib/simple_endpoint/version.rb
+- simple_endpoint.gemspec
+homepage: ''
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Simple implementation of Trailblazer endpoint
+test_files: []