simple_endpoint 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08fd87cf913813e20513e0e14925d45a4f9fdeb582f0db492641b4df3284e629'
-  data.tar.gz: 42e7eea35744ff8f43afae1fe342997048dd9c42b053d2b0e178ee667f9886f1
+  metadata.gz: 88057b74fb64a0b700c891f2f9d4fe47d1e7270558562421eb20ec6cc509609b
+  data.tar.gz: eb33a881d475b47de26b0e00fafe671981708447a1c51e400fed13a5fef6a789
 SHA512:
-  metadata.gz: 2e473a5e5b115b0e15e03316683dfd952c0c368be5ad7db85f25b439e27fac4638bdca131548d04391d54d223cfa95faf22417b721897e83426896068fe2b1f6
-  data.tar.gz: 660bd34909b0d962ad41583f17219fe9b3108bc4a987a5acc1c8cb17ac4aece8e0b1a78c68b8600b243a0ddce2f6b263f6c6b573e472e72b705ad4f744b18150
+  metadata.gz: 3a5409549ff3eb0c0237838064ff9cdb9a95b9177b745573a8039e34370beead5b20a50b7baa5bb58c3bb397d581d706bf33e4ad9d28fc2c7fa6e53b052b3746
+  data.tar.gz: 949d6f100a2026f194b63cb1cd40284652a6a622ede5e18eb55872f5db8f570258c966c4ddfc8ebc16ff73a29f81fe2e87a62e1f879104da8ebf7270246b6c57

data/.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/decouplio
+    docker:
+      - image: ruby:2.6.0
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - decouplio-{{ checksum "Gemfile.lock" }}
+            - decouplio-
+      - run:
+          name: Install dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+
+      - save_cache:
+          key: decouplio-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run Tests
+          command: bundle exec rspec

data/.rubocop.yml

@@ -1,13 +1,23 @@
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.5.1
+  Exclude:
+    - 'simple_endpoint.gemspec'
+
+Style/Documentation:
+  Enabled: false
 
 Metrics/LineLength:
+    Max: 120
+
+Style/FrozenStringLiteralComment:
   Enabled: true
-  Max: 120
 
 Metrics/BlockLength:
-  Exclude:
-    - 'spec/**'
+  ExcludedMethods: ['describe','context']
 
-Style/Documentation:
+RSpec/DescribeClass:
   Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4

data/CHNAGES.md

@@ -0,0 +1,7 @@
+simple_endpoint changelog
+=====================
+
+[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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_endpoint (0.1.6)
+    simple_endpoint (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,10 +10,10 @@ GEM
     byebug (10.0.2)
     coderay (1.1.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.4)
     method_source (0.9.2)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -37,7 +37,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.60.0)
+    rubocop (0.61.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
@@ -45,8 +45,10 @@ GEM
       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)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
@@ -56,7 +58,8 @@ DEPENDENCIES
   pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
+  rubocop (~> 0.61.0)
+  rubocop-rspec
   simple_endpoint!
 
 BUNDLED WITH

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,7 +8,7 @@ Dry-matcher free implementation of trailblazer endpoint.
 Add this to your Gemfile:
 
 ```ruby
-gem 'simple_endpoint'
+gem 'simple_endpoint', '~> 1.0.0'
 ```
 
 ## Getting Started
@@ -46,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,6 +75,7 @@ Now you are able to use `endpoint` method at other controllers
 | `: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 |
+| `:renderer_options` | no | {} | Allow to pass serializer options from controller and Will available inside handler as second parameter.
 
 
 #### Simple endpoint call
@@ -100,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
 
@@ -155,7 +158,7 @@ class PostsController < ApplicationController
 
   def default_handler
     {
-      success: -> (result) { head :ok }
+      success: -> (result, **) { head :ok }
     }
   end
 end
@@ -174,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
@@ -230,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.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 
 require 'simple_endpoint/version'
-
+# rubocop:disable Metrics/ParameterLists
 module SimpleEndpoint
   module Controller
-    def endpoint(operation:, different_cases: {}, different_handler: {}, options: {}, before_response: {})
+    def endpoint(operation:,
+                 different_cases: {},
+                 different_handler: {},
+                 options: {},
+                 before_response: {},
+                 renderer_options: {})
       Endpoint.call(
         operation,
         default_handler.merge(different_handler),
         default_cases.merge(different_cases),
+        renderer_options,
         before_response,
         endpoint_options.merge(options)
       )
@@ -30,15 +36,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 +54,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.dig(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 +127,4 @@ module SimpleEndpoint
     You can move this to separate singleton class
   LARGE_ERROR
 end
+# rubocop:enable Metrics/ParameterLists

data/lib/simple_endpoint/version.rb

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

data/simple_endpoint.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rubocop', '~> 0.61.0'
+  spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_endpoint
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Bal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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: 0.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,12 +102,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
+- CHNAGES.md
 - Gemfile
 - Gemfile.lock
 - LICENSE

data/.travis.yml

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