checkability 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9103b1dbf884f2321d45594731f4d2441c94130
-  data.tar.gz: 1c5b3869395f89014b151b559331629a9fe97317
+  metadata.gz: 3bb2e7105c2121726c166ed2656e3c0194b7a45f
+  data.tar.gz: a06d6cdd6ff33b35b91bf99022363898e9fb0019
 SHA512:
-  metadata.gz: f05066a5cbf7dd4197c554bb09e9943ffae04a6b979e3ac225e078026aedb17cf47eaec0e35700f1632645be083482e5d7463810cf8cad8aa65c37ca5a5a11d0
-  data.tar.gz: 24e5017bfeef613d25edcded8595966b040dd1ffffb4fe735260392631f938512d14a838cbbd3f7cb3f23f8fd82f729d6c6ece6b52d6a343159afba053d75feb
+  metadata.gz: 29345eba850827066c0f0a8f2c40c751cbc95d9e808373b13bb822c538316604ef61d813caafe7d7b7b93f0e84edb2a961b25d564957875b263ea1dadf0bd994
+  data.tar.gz: c66eb4665963b1e94f40d510f13b3ea2d21eb0244e79dcd1e80ddc781fa8a135fbc6a469553404995bdda4c76d614d684128d03149af529cd6b395704b1e7ad4

data/README.md

@@ -9,8 +9,47 @@ with return of true|false
 ## Usage
 How to use my plugin.
 
-inside of any ruby class include Checkablilty
-next 
+inside of any rails model do
+```ruby
+class SomeModel
+  acts_as_checkable strategy: proc { |a, b, c| a && (b || c) },
+                    checkers: uk_postcode_checkers
+end
+```
+where `uk_postcode_checkers` is method which returns hash with configurations  
+https://github.com/azazelo/postcode_checker/blob/master/app/models/concerns/u_k_postcode_checkers.rb  
+then in your controller:  
+```ruby
+class ChecksController < ApplicationController
+  def checking
+    @check = Check.new
+  end
+
+  def perform
+    @check = Check.new(value: check_params[:string])
+    message, alert_class =
+      if @check.valid?
+        @check.perform_check
+        [@check.messages.join('<br/>'), _alert_class(@check.allowed)]
+      else
+        [@check.errors.full_messages.join('<br/>'), _alert_class(false)]
+      end
+    redirect_to checking_path, flash: { now: message, alert_class: alert_class }
+  end
+
+  private
+
+  def _alert_class(cond)
+    cond ? 'success' : 'danger'
+  end
+
+  def check_params
+    params.permit(:string)
+  end
+end
+```
+for more detailed example see application   
+in https://github.com/azazelo/postcode_checker
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -34,3 +73,7 @@ Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Future works
+
+- [ ] Use ChainOfResponsibility pattern to simplify call of checkers

data/lib/checkability/acts_as_checkable.rb

@@ -27,7 +27,7 @@ module Checkability
       self.allowed = _check
       messages << "'#{value}' is #{_allowness}. "
     end
-    
+
     private
 
     def _setup

data/lib/checkability/checkable.rb

@@ -15,21 +15,23 @@ module Checkability
     #   and each should return true|false
     # checkers is an array of checker objects
     #   e.g. [storage_checker, external_api_checker]
-    def check(conf)
-      conf[:strategy].call(
-        conf[:checkers].map do |checker_name, checker_conf|
-          _checker_to_check_value(checker_name, checker_conf)
-        end
-      )
+    def check(opts = {})
+      results = []
+      opts[:checkers].each do |checker|
+        results << (res = _checker_to_check_value(checker))
+        break if res && checker[:stop_process_if_success]
+        break if res == false && checker[:stop_process_if_failure]
+      end
+      opts[:strategy].call(results)
     end
-    
+
     private
-    
-    def _checker_to_check_value(checker_name, checker_conf)
-      k = ("Checkability::#{checker_name.to_s.camelize}").constantize
-      k.new(checker_conf).check_value(checkable)
+
+    def _checker_to_check_value(checker)
+      k = "Checkability::#{checker[:name].to_s.camelize}".constantize
+      k.new(checker).check_value(checkable)
     rescue NameError => e
-      checkable.messages << "#{e}: #{checker_name}."
+      checkable.messages << "#{e}: #{checker[:name]}."
       false
     end
   end

data/lib/checkability/external_api_checker.rb

@@ -7,16 +7,22 @@ module Checkability
   # Checks if postcode exists in external API
   #
   class ExternalApiChecker
-    attr_reader :path, :check_method, :connection
+    attr_reader :path, :path_suffix, :check_method, :connection, :http_verb,
+                :failure_message, :success_message
 
     def initialize(conf = {})
       @path = conf[:path]
+      @http_verb = conf[:http_verb] || :get
+      @path_suffix = conf[:path_suffix] || ''
       @check_method = conf[:check_method]
+      @failure_message = conf[:failure_message] || 'Failed.'
+      @success_message = conf[:success_message] || 'Success.'
       @connection = Checkability::ExternalApiConnector.new(conf)
     end
 
     def check_value(checkable)
-      @resp = connection.connect.get(checkable.value.delete(' '))
+      @resp = connection.connect.send(http_verb,
+                                      checkable.value.delete(' ') + path_suffix)
       result, message = _result_and_message
       checkable.messages << message
       result
@@ -35,9 +41,10 @@ module Checkability
     def _result_and_message
       return [false, _message(@resp.status)] unless @resp.status == 200
 
-      return [true, _message('Found.')] if check_method.call(_parsed(@resp))
+      return [true, _message(success_message)] if check_method
+                                                  .call(_parsed(@resp))
 
-      [false, _message('Not found in allowed areas.')]
+      [false, _message(failure_message)]
     rescue StandardError => e
       [false, _message(e)]
     end

data/lib/checkability/validator.rb

@@ -14,11 +14,13 @@ module Checkability
       result
     end
 
+    private
+
     def _result_and_message(checkable)
       if (checkable.value.delete(' ') =~ format[:regex]).nil?
-        [false, "Value is not comply with format of #{format[:name]}."]
+        [false, "Value is NOT COMPLY with format of #{format[:name]}."]
       else
-        [true, "Value comply with format of #{format[:name]}."]
+        [true, "Value is COMPLY with format of #{format[:name]}."]
       end
     end
   end

data/lib/checkability/version.rb

@@ -1,3 +1,3 @@
 module Checkability
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey Eremeev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies: []
 description: Provide Checkers functionality.
 email: