checkability 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b81bedd5fd904185fc57a5627f6848dbb608ba3fa5155653c6d096aed6f4c95c
-  data.tar.gz: 29948f5309901c9769b899e4660c8d7a0677e29dbf2b1f36af663525dfc1d957
+  metadata.gz: d691bd54ab262dd07d0bdf1120d632a71003cfdc730002275d10333e21045526
+  data.tar.gz: 104e1558d7867413f25e838d3db9aaf54d2a7f96b412dd1121149e9528c9f95d
 SHA512:
-  metadata.gz: 693df60213127f59a954ef39977c86ad78ac32198b478f7f55e45a8b4df900c3b61cd1d58ac3540db9557979545908266bb2a9c3de60f5051227e079ae6d6444
-  data.tar.gz: 45e80fe8b9b1bf424e529c93b48d66329772bc776dfbccf8055539ca832f219ac3f67685a11621ff4dfb32c23f6d7cebe819f92530d864fda84f60aa74c04aee
+  metadata.gz: 42816cf5985cfcc1d0f680496f0fdde3fd3263f87a4b12010f9d3f33694481703c8ed3785531914cfd5143982001c6fbe2977a52de789d7c559720048d3657ec
+  data.tar.gz: 00e84b4caa4c5fae3eea6ae4e7e1fb0c3550e29948c81df7a85aaf4ea8ae98bf1083e3559b1583d28243faecdd477ebdbb8b7eab33318cd6571f15b5a08b52a0

data/lib/checkability.rb

@@ -9,7 +9,7 @@ require_relative 'checkability/external_api_checker'
 require_relative 'checkability/external_api_connector'
 require_relative 'checkability/validator'
 require_relative 'checkability/acts_as_checkable'
-require_relative 'checkability/chain_of_resp/handler'
-require_relative 'checkability/chain_of_resp/abstract_handler'
+require_relative 'checkability/checker'
+require_relative 'checkability/abstract_checker'
 
 ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/{chain_of_resp/abstract_handler.rb → abstract_checker.rb}

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
-require_relative 'handler'
+require_relative 'checker'
 
-module ChainOfResp
+module Checkability
   # @abstract
-  class AbstractHandler < ChainOfResp::Handler
+  class AbstractChecker < Checker
     # @return [Handler]
     attr_reader :stop_process_on_failure, :stop_process_on_success
-    attr_accessor :handler, :result
+    attr_accessor :success_message, :failure_message, :handler
 
     def initialize(opts = {})
       @stop_process_on_failure = opts[:stop_process_on_failure] || false
       @stop_process_on_success = opts[:stop_process_on_success] || false
+      @success_message = opts[:success_message] || 'Success.'
+      @failure_message = opts[:failure_message] || 'Failed.'
+
       @next_handler = nil
       post_initialize(opts) # implemented in subclass
     end
@@ -32,11 +35,32 @@ module ChainOfResp
     # @return [Boolean, nil]
     def handle(request)
       check = check_value(request) # imlemented in subclass
+
       return true  if check && stop_process_on_success
 
       return false if !check && stop_process_on_failure
 
       handler&.handle(request)
     end
+
+    def check_value(checkable)
+      result, message = result_and_message(checkable)
+      checkable.messages << message
+      result
+    end
+
+    def result_and_message(checkable)
+      result = _result(checkable)
+      str = result ? success_message : failure_message
+      [result, message(str, result)]
+    rescue StandardError => e
+      [false, message(e, false)]
+    end
+
+    def _result; end
+
+    def message(str, res)
+      "#{res}::#{str}"
+    end
   end
 end

data/lib/checkability/acts_as_checkable.rb

@@ -12,7 +12,10 @@ module Checkability
 
     class_methods do
       def acts_as_checkable(options = {})
-        raise ArgumentError, "Hash expected, got #{options.class.name}" if !options.is_a?(Hash) && !options.empty?
+        if !options.is_a?(Hash) && !options.empty?
+          raise ArgumentError,
+                "Hash expected, got #{options.class.name}"
+        end
 
         class_attribute :checkable_conf
 
@@ -23,7 +26,8 @@ module Checkability
     attr_accessor :allowed, :messages
 
     def perform_check
-      _setup
+      self.allowed = nil
+      self.messages = []
       self.allowed = Checkability::Checkable.new(self).check(checkable_conf)
       messages << "#{allowed}::'#{_value}' is #{_allowness}. "
     end
@@ -38,10 +42,7 @@ module Checkability
       checkable_conf[:attr_name] || :value
     end
 
-    def _setup
-      self.allowed = nil
-      self.messages = []
-    end
+    def _setup; end
 
     def _allowness
       allowed ? 'ALLOWED' : 'NOT allowed'

data/lib/checkability/checkable.rb

@@ -20,29 +20,34 @@ module Checkability
     #
     # validator.handle(request)
     #
-    def check(opts = {})
+    def check(opts)
+      handler_confs = opts[:handler_confs]
       first_handler_name = opts[:first_handler]
-      _handlers(opts)[first_handler_name].handle(checkable)
-    rescue StandardError => e
-      checkable.messages << "false::#{e}: #{opts}."
-      false
+      first_handler = _handlers(handler_confs)[first_handler_name]
+
+      first_handler.handle(checkable)
+      #    rescue StandardError => e
+      #      checkable.messages << "false::#{e}: #{opts}."
+      #      false
     end
 
     private
 
-    def _handlers(opts)
-      handler_confs = opts[:handler_confs]
-      handlers = {}
-      handler_confs.each do |handler_name, handler_conf|
-        handlers[handler_name] = _make_handler(handler_name, handler_conf)
-      end
+    def _handlers(handler_confs)
+      handlers = _make_handlers(handler_confs)
       handlers.each do |handler_name, handler|
         next_handler_name = handler_confs[handler_name][:next_handler]
-        handler.next_handler(handlers[next_handler_name])
+        handler.next_handler(handlers[next_handler_name]) if handlers[next_handler_name]
+      end
+    end
+
+    def _make_handlers(handler_confs)
+      handler_confs.transform_values do |handler_conf|
+        _make_handler(handler_conf)
       end
     end
 
-    def _make_handler(_name, conf)
+    def _make_handler(conf)
       k = Checkability.const_get conf[:name].to_s.camelize
       k.new(conf)
     end

data/lib/checkability/{chain_of_resp/handler.rb → checker.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module ChainOfResp
+module Checkability
   # @abstract
-  class Handler
+  class Checker
     # @abstract
     #
     # @param [Handler] handler
@@ -15,7 +15,7 @@ module ChainOfResp
     # @param [String] request
     #
     # @return [String, nil]
-    def handle(_request)
+    def handle(_handler)
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
 
@@ -27,5 +27,14 @@ module ChainOfResp
     def check_value(_request)
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
+
+    # @abstract
+    #
+    # @param [String] request
+    #
+    # @return [Boolean, true|false]
+    def result_and_message(_object)
+      raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+    end
   end
 end

data/lib/checkability/external_api_checker.rb

@@ -7,11 +7,10 @@ require 'json'
 
 # frozen_string_literal: true
 
-require_relative 'chain_of_resp/abstract_handler'
 module Checkability
   # Checks if postcode exists in external API
   #
-  class ExternalApiChecker < ChainOfResp::AbstractHandler
+  class ExternalApiChecker < AbstractChecker
     attr_reader :path, :path_suffix, :check_method, :connection, :http_verb,
                 :failure_message, :success_message
 
@@ -20,39 +19,27 @@ module Checkability
       @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
-              .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
-      result, message = _result_and_message
-      checkable.messages << message
-      result
-    end
-
     private
 
-    def _message(str, res)
-      "#{res}::#{path}: #{str}"
-    end
+    def _result(checkable)
+      resp = connection
+             .connect
+             .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
+      return false unless resp.status == 200
 
-    def _parsed(resp)
-      JSON.parse(resp.body)
+      check_method.call(_parsed(resp))
     end
 
-    def _result_and_message
-      return [false, _message(@resp.status, false)] unless @resp.status == 200
-
-      return [true, _message(success_message, true)] if check_method
-                                                        .call(_parsed(@resp))
+    def message(str, res)
+      str = "#{path}: #{str}"
+      super(str, res)
+    end
 
-      [false, _message(failure_message, false)]
-    rescue StandardError => e
-      [false, _message(e, false)]
+    def _parsed(resp)
+      JSON.parse(resp.body)
     end
   end
 end

data/lib/checkability/storage_checker.rb

@@ -1,33 +1,31 @@
 # frozen_string_literal: true
 
-require_relative 'chain_of_resp/abstract_handler'
+require_relative 'abstract_checker'
 module Checkability
   # Checks if postcode exists in Storage
   #
-  class StorageChecker < ChainOfResp::AbstractHandler
-    attr_reader :storage_class
+  class StorageChecker < AbstractChecker
+    attr_reader :storage_class, :attr_name
 
     def post_initialize(conf = {})
       @storage_class = conf[:storage_class]
+      @attr_name = conf[:attr_name] || :value
     end
 
-    def check_value(checkable)
-      value = checkable.value.upcase
-      result = _present_in_storage(value)
-      checkable.messages << (
-        result ? _message('Found', result) : _message('Not found', result))
-      result
+    private
+
+    def _result(checkable)
+      value = _normalize_value(checkable.send(attr_name))
+      storage_class.where(attr_name => value).present?
     end
 
-    def _present_in_storage(value)
-      storage_class.where(value: value)
-                   .or(storage_class.where(value: value.strip))
-                   .or(storage_class.where(value: value.delete(' ')))
-                   .present?
+    def message(str, res)
+      str = "Allowed #{storage_class}s list: #{str}"
+      super(str, res)
     end
 
-    def _message(str, res)
-      "#{res}::Allowed #{storage_class}s list: #{str}."
+    def _normalize_value(value)
+      value.delete(' ').upcase
     end
   end
 end

data/lib/checkability/validator.rb

@@ -3,27 +3,17 @@
 module Checkability
   # Checks if postcode comply with regex
   #
-  class Validator < ChainOfResp::AbstractHandler
+  class Validator < AbstractChecker
     attr_reader :format
 
     def post_initialize(conf = {})
       @format = conf[:format]
     end
 
-    def check_value(checkable)
-      result, message = _result_and_message(checkable)
-      checkable.messages << message
-      result
-    end
-
     private
 
-    def _result_and_message(checkable)
-      if (checkable.value.delete(' ') =~ format[:regex]).nil?
-        [false, "false::Value is NOT COMPLY with format of #{format[:name]}."]
-      else
-        [true, "true::Value is COMPLY with format of #{format[:name]}."]
-      end
+    def _result(checkable)
+      !(checkable.value.delete(' ') =~ format[:regex]).nil?
     end
   end
 end

data/lib/checkability/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Checkability
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Eremeev
@@ -23,10 +23,10 @@ files:
 - Rakefile
 - bin/checkability
 - lib/checkability.rb
+- lib/checkability/abstract_checker.rb
 - lib/checkability/acts_as_checkable.rb
-- lib/checkability/chain_of_resp/abstract_handler.rb
-- lib/checkability/chain_of_resp/handler.rb
 - lib/checkability/checkable.rb
+- lib/checkability/checker.rb
 - lib/checkability/external_api_checker.rb
 - lib/checkability/external_api_connector.rb
 - lib/checkability/railtie.rb