simple_endpoint 0.1.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d160bdac054393e08f0451d7117a710140cd02614d8bc7d212de43e8fe4caf
-  data.tar.gz: e6af102683834cf488a5dce4589e27c356e0994485679722a94569cae8a2e258
+  metadata.gz: cafc4ae0561d731416cdf3b2118ffbf06bc8a871b749965c4c08456f8eaa2aed
+  data.tar.gz: cf96b321cfb718850a9556b5abe05d0130462efa2a5d44ec10597b8c01796f18
 SHA512:
-  metadata.gz: f20a4512bbce57067e072a6f7d67b73a88fd606b5b9e01af7d71ab7b4460d9e71c603e05e3205853506d4f05d8295eef121f07a7e730cad610ed4a878d038f04
-  data.tar.gz: a46a439a455f21f4e83914210aeeb1d4b6fa29996cc4fbb1499484baee633bc58abf7f1b264f7cc767fe54e2d5f64dcc1969045a5f45879dc6dcbe1632f8feec
+  metadata.gz: b4594e5c903c2cf287ec2183586fe521f00cee1ba898ee1e5da871efaf7eab0a10ec1808ab297073e28a6df4e16499831c833c7a551fc3c56b95c5e5c087e584
+  data.tar.gz: 46839e10421d39641931055e06bbce36154b62dd2e763910d7661130c55156bfbf6352b50bf6b7fe8cfdf13e39c5b846980972f288e646ccd6aeac8d62e98903

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1
+
+executors:
+  test_executor:
+    docker:
+      - image: circleci/ruby:${RUBY_VERSION}
+    working_directory: ~/simple_endpoint
+
+jobs:
+  build:
+    environment:
+      RUBY_VERSION: << parameters.ruby_version >>
+      BUNDLER_VERSION: 2.1.4
+    executor: test_executor
+    parameters:
+      ruby_version:
+        type: string
+    steps:
+      - checkout
+
+      - run:
+          name: 'Install bundler'
+          command: 'gem install bundler'
+
+      - run:
+          name: Install dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+
+      # - run:
+      #     name: Run Rubocop
+      #     command: bundle exec rubocop
+
+      - run:
+          name: Run Tests
+          command: bundle exec rspec
+
+workflows:
+  build_and_test:
+    jobs:
+      - build:
+          name: 'ruby 2.6.8'
+          ruby_version: 2.6.8
+      - build:
+          name: 'ruby 2.7.0'
+          ruby_version: 2.7.0

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/.rubocop.yml

@@ -1,13 +1,26 @@
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'simple_endpoint.gemspec'
+
+Style/Documentation:
+  Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
+    Max: 120
+
+Style/FrozenStringLiteralComment:
   Enabled: true
-  Max: 120
 
 Metrics/BlockLength:
-  Exclude:
-    - 'spec/**'
+  IgnoredMethods: ['describe','context']
 
-Style/Documentation:
+RSpec/DescribeClass:
   Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4

data/.ruby-gemset

@@ -0,0 +1 @@
+simple_endpoint

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/CHANGES.md

@@ -0,0 +1,11 @@
+simple_endpoint changelog
+=====================
+
+[2022-02-09] Version 1.0.1
+---------------------------
+- Add Ruby 2.7+ support
+
+[2020-01-25] Version 1.0.0
+---------------------------
+**Breaking changes**
+- [PR #6](https://github.com/differencialx/simple_endpoint/pull/6): Added ability to pass additional options from controller tot handlers, such as options for serialization, to avoid setting them inside trailblazer operation.

data/README.md

@@ -1,4 +1,6 @@
 # SimpleEndpoint
+[![<differencialx>](https://circleci.com/gh/differencialx/simple_endpoint.svg?style=svg)](https://circleci.com/gh/differencialx/simple_endpoint)
+[![Gem Version](https://img.shields.io/gem/v/simple_endpoint.svg)](https://rubygems.org/gems/simple_endpoint)
 
 Dry-matcher free implementation of trailblazer endpoint.
 
@@ -6,8 +8,7 @@ Dry-matcher free implementation of trailblazer endpoint.
 Add this to your Gemfile:
 
 ```ruby
-gem 'simple_endpoint' # not released yet
-gem 'simple_endpoint', github: 'differencialx/simple_endpoint', :branch => 'master'
+gem 'simple_endpoint', '~> 1.0.0'
 ```
 
 ## Getting Started
@@ -47,8 +48,8 @@ class ApplicationController < ActionController::Base
 
   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 }
+      success: -> (result, **opts) { render json: result['model'], **opts, status: 200 },
+      invalid: -> (result, **) { render json: result['contract.default'].errors, serializer: ErrorSerializer, status: :unprocessable_entity }
     }
   end
 end
@@ -73,7 +74,8 @@ Now you are able to use `endpoint` method at other controllers
 | `: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 |
+| `:before_response` | no | {} | Allow to process code before specific case handler |
+| `:renderer_options` | no | {} | Allow to pass serializer options from controller and Will available inside handler as second parameter.
 
 
 #### Simple endpoint call
@@ -101,7 +103,7 @@ class PostsController < ApplicationController
     {
       success: -> (result) { result.success? && is_it_raining? },
       invalid: -> (result) { result.failure? && is_vasya_in_the_house? }
-      ... # other cases 
+      ... # other cases
     }
   end
 
@@ -156,7 +158,7 @@ class PostsController < ApplicationController
 
   def default_handler
     {
-      success: -> (result) { head :ok }
+      success: -> (result, **) { head :ok }
     }
   end
 end
@@ -175,7 +177,7 @@ class PostsController < ApplicationController
 
   def different_handler
     {
-      success: -> (result) { render json: { message: 'Nice!' }, status: :created }
+      success: -> (result, **) { render json: { message: 'Nice!' }, status: :created }
     }
   end
 end
@@ -231,17 +233,40 @@ class PostsController < ApplicationController
   def create
     endpoint operation: Post::Create,
              before_response: before_render_actions
-    end 
+    end
   end
 
   private
 
   def before_response_actions
     {
-      success: -> (result) { response.headers['Some-header'] = result[:some_data] }
+      success: -> (result, **) { response.headers['Some-header'] = result[:some_data] }
     }
   end
 end
 ```
 
 Code above will put data from operation result into response haeders before render
+
+
+#### Pass additional options from controller
+
+```ruby
+class PostsController < ApplicationController
+  def create
+    endpoint operation: Post::Create,
+             renderer_options: { serializer: SerializerClass }
+    end
+  end
+
+  private
+
+  def default_handler
+    {
+      # renderer_options will be available as **opts
+      success: -> (result, **opts) { render json: result['model'], **opts, status: 200 },
+      invalid: -> (result, **) { render json: result['contract.default'].errors, serializer: ErrorSerializer, status: :unprocessable_entity }
+    }
+  end
+end
+```

data/lib/simple_endpoint/version.rb

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

data/lib/simple_endpoint.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
-require 'simple_endpoint/version'
-
+# rubocop:disable Metrics/ParameterLists
 module SimpleEndpoint
   module Controller
-    def endpoint(operation:, different_cases: {}, different_hander: {}, options: {}, before_response: {})
+    def endpoint(operation:,
+                 different_cases: {},
+                 different_handler: {},
+                 options: {},
+                 before_response: {},
+                 renderer_options: {})
       Endpoint.call(
         operation,
-        default_handler.merge(different_hander),
+        default_handler.merge(different_handler),
         default_cases.merge(different_cases),
+        renderer_options,
         before_response,
-        endpoint_options.merge(options)
+        **endpoint_options.merge(options)
       )
     end
 
@@ -30,15 +35,15 @@ module SimpleEndpoint
   end
 
   class Endpoint
-    def self.call(operation, handler, cases, before_response = {}, **args)
+    def self.call(operation, handler, cases, renderer_options = {}, before_response = {}, **args)
       result = operation.call(**args)
-      new.call(result, cases, handler, before_response)
+      new.call(result, cases, renderer_options, handler, before_response)
     end
 
-    def call(result, cases, handler = {}, before_response = {})
+    def call(result, cases, renderer_options = {}, 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)
+      procees_handler(matched_case, before_response, result, renderer_options) unless before_response.empty?
+      procees_handler(matched_case, handler, result, renderer_options, UnhadledResultError)
     end
 
     def matched_case(cases, result)
@@ -48,19 +53,16 @@ module SimpleEndpoint
       matched_case
     end
 
-    def procees_handler(matched_case, handler, result, exception_class = nil)
+    def procees_handler(matched_case, handler, result, renderer_options, exception_class = nil)
       if handler.key?(matched_case)
-        handler.dig(matched_case)&.(result)
+        handler[matched_case]&.(result, **renderer_options)
       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
+      cases.detect { |_kase, condition| condition.call(result) }&.first
     end
   end
 
@@ -124,3 +126,4 @@ module SimpleEndpoint
     You can move this to separate singleton class
   LARGE_ERROR
 end
+# rubocop:enable Metrics/ParameterLists

data/simple_endpoint.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['differencialx@gmail.com']
 
   spec.summary       = 'Simple implementation of Trailblazer endpoint'
-  spec.description   = 'Simple implementation of Trailblazer endpoint'
-  spec.homepage      = ''
+  spec.description   = 'Dry-matcher free implementation of trailblazer endpoint, with ability to redefine matchers and handlers behavior for separate controllers or actions.'
+  spec.homepage      = 'https://github.com/differencialx/simple_endpoint'
 
   # 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.
@@ -32,9 +32,10 @@ Gem::Specification.new do |spec|
   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 'bundler', '>= 2.1.0'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '~> 1.25.1'
+  spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: simple_endpoint
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Alex Bal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2022-02-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'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,20 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,19 +94,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple implementation of Trailblazer endpoint
+description: Dry-matcher free implementation of trailblazer endpoint, with ability
+  to redefine matchers and handlers behavior for separate controllers or actions.
 email:
 - differencialx@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGES.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -101,7 +118,7 @@ files:
 - lib/simple_endpoint.rb
 - lib/simple_endpoint/version.rb
 - simple_endpoint.gemspec
-homepage: ''
+homepage: https://github.com/differencialx/simple_endpoint
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
@@ -120,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple implementation of Trailblazer endpoint

data/.travis.yml

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

data/Gemfile.lock

@@ -1,63 +0,0 @@
-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