checkability 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 148d47cb845c2354cee354d4852b43054a2af514
-  data.tar.gz: 91c98f1a5e3cbf800290b645c516db1c69419c17
+SHA256:
+  metadata.gz: ae53afa68f33c527bee835d3c84e304c7596f46665cc41ff1df67b2e4189f595
+  data.tar.gz: 8de80e50a31b5e3c7b2f498b8c81de8793b4d80f9a4665653dd12be745331721
 SHA512:
-  metadata.gz: f2052db80385a337dd9567ff890f56c299ae99f3341eb1734f701b8f5d536713ffde8fd148f36a358aabcbcc140a9517bca1d49688e200327835e36d02fa104c
-  data.tar.gz: 024178f440d540b3bd9ef2df354793ac137f8bf338902da587881cee4929147d1d698b59eb7419e63b569caf1c1853aa7e3985835c1e19efad40ebfdbfa29f68
+  metadata.gz: 32ed1b0305e36d037d38bde6acf78f4c7d4ae04e49764d4129fb5d9f455cf349607131ea17b5a500a0f47ab38f31698d06eeaec07dc9a014b030518be42e66fa
+  data.tar.gz: cec99b497500443955ef650e56948037e8e7855456f14aa66a491e71ecd884c9d1553c64bbb10fd7a1ce23ae535fa1d42bb730a0979bfead71db07a625bc2407

data/README.md

@@ -1,9 +1,56 @@
 # Checkability
-Short description and motivation.
+
+Add to application checkers functionality  
+  
+Checker could be any object of Ruby 
+which respond to method check_value  
+with return of true|false
 
 ## Usage
 How to use my plugin.
 
+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:
 
@@ -26,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/Rakefile

@@ -1,3 +1,5 @@
-require "bundler/setup"
+# frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/bin/checkability

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/checkability'
+
+puts '-----------------'
+puts ''
+puts 'Gem provide acts_as_checkable addon to active record models'
+puts "Version: #{Checkability::VERSION}"
+puts ''
+puts '-----------------'

data/lib/checkability.rb

@@ -1,6 +1,13 @@
-require "checkability/version"
-require "checkability/checkable"
-require "checkability/storage_checker"
-require "checkability/external_api_checker"
-require "checkability/external_api_connector"
-require "checkability/validator"
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+require_relative 'checkability/version'
+require_relative 'checkability/checkable'
+require_relative 'checkability/storage_checker'
+require_relative 'checkability/external_api_checker'
+require_relative 'checkability/external_api_connector'
+require_relative 'checkability/validator'
+require_relative 'checkability/acts_as_checkable'
+
+ActiveRecord::Base.include Checkability::ActsAsCheckable

data/lib/checkability/acts_as_checkable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Checkability
+  # Adding class and instance methods
+  #
+  module ActsAsCheckable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_checkable(options = {})
+        raise ArgumentError, "Hash expected, got #{options.class.name}" if !options.is_a?(Hash) && !options.empty?
+
+        class_attribute :checkable_conf
+
+        self.checkable_conf = options
+      end
+    end
+
+    attr_accessor :allowed, :messages
+
+    def perform_check
+      _setup
+      self.allowed = _check
+      messages << "#{allowed}::'#{value}' is #{_allowness}. "
+    end
+
+    private
+
+    def _setup
+      self.allowed = nil
+      self.messages = []
+    end
+
+    def _allowness
+      allowed ? 'ALLOWED' : 'NOT allowed'
+    end
+
+    def _check
+      Checkability::Checkable.new(self).check(checkable_conf)
+    end
+  end
+end

data/lib/checkability/checkable.rb

@@ -1,6 +1,9 @@
-# Checks if postcode exists in Storage
-#
+# frozen_string_literal: true
+
 module Checkability
+  # Implements check method to Iterate on chechers
+  # Possible to implemet as Iterator in future
+  #
   class Checkable
     attr_reader :checkable
 
@@ -8,18 +11,30 @@ module Checkability
       @checkable = checkable
     end
 
-    # sentence is a proc 
-    #   like { |a,b,c| a && ( b || c ) } 
-    #   where a,b,c are checkers 
-    #   and each should return [true, message] or [false, message]
-    # checkers is an array of checker objects
+    # strategy is a proc
+    #   like { |a,b,c| a && ( b || c ) }
+    #   where a,b,c are checkers
+    #   and each should return true|false
+    # checker_confs is an array of checker_conf hashes
     #   e.g. [storage_checker, external_api_checker]
-    def check(algoritm = nil, checkers = [])
-      algoritm.call( 
-        checkers.map do |checker| 
-          checker.check_value(checkable)
-        end
-      )
+    def check(opts = {})
+      results = []
+      opts[:checker_confs].each do |checker_conf|
+        results << (res = _checker_to_check_value(checker_conf))
+        break if res && checker_conf[:stop_process_if_success]
+        break if res == false && checker_conf[:stop_process_if_failure]
+      end
+      opts[:strategy].call(results)
+    end
+
+    private
+
+    def _checker_to_check_value(checker_conf)
+      k = "Checkability::#{checker_conf[:name].to_s.camelize}".constantize
+      k.new(checker_conf).check_value(checkable)
+    rescue NameError => e
+      checkable.messages << "false::#{e}: #{checker_conf[:name]}."
+      false
     end
   end
-end
+end

data/lib/checkability/external_api_checker.rb

@@ -1,23 +1,31 @@
-#require 'faraday_middleware'
+# frozen_string_literal: true
+
 require 'faraday'
 require 'net/http'
 require 'net/https'
 require 'json'
 
-# Checks if postcode exists in Storage
-#
 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={})
+    def initialize(conf = {})
       @path = conf[:path]
+      @http_verb = conf[:http_verb] || :get
+      @path_suffix = conf[:path_suffix] || ''
       @check_method = conf[:check_method]
-      @connection = Checkability::ExternalApiConnector.new(conf).connect
+      @failure_message = conf[:failure_message] || 'Failed.'
+      @success_message = conf[:success_message] || 'Success.'
+      @connection = Checkability::ExternalApiConnector.new(conf)
     end
 
     def check_value(checkable)
-      @resp = connection.get(checkable.value.gsub(' ',''))
+      @resp = connection
+              .connect
+              .send(http_verb, "#{checkable.value.delete(' ')}#{path_suffix}")
       result, message = _result_and_message
       checkable.messages << message
       result
@@ -25,18 +33,23 @@ module Checkability
 
     private
 
-    def _message(str); "#{path}: #{str}";     end
+    def _message(str, res)
+      "#{res}::#{path}: #{str}"
+    end
 
-    def _parsed(resp); JSON.parse(resp.body); end
+    def _parsed(resp)
+      JSON.parse(resp.body)
+    end
 
     def _result_and_message
-      return [false, _message(@resp.status)] unless @resp.status == 200
+      return [false, _message(@resp.status, false)] unless @resp.status == 200
 
-      return [true, _message('Found.')] if check_method.call(_parsed(@resp))
+      return [true, _message(success_message, true)] if check_method
+                                                        .call(_parsed(@resp))
 
-      [false, _message('Not found in allowed areas.')]
-    rescue Exception => e
-      [false, _message(e)]
+      [false, _message(failure_message, false)]
+    rescue StandardError => e
+      [false, _message(e, false)]
     end
   end
-end
+end

data/lib/checkability/external_api_connector.rb

@@ -1,6 +1,8 @@
-# Create connection
-#
+# frozen_string_literal: true
+
 module Checkability
+  # Create connection
+  #
   class ExternalApiConnector
     attr_reader :path
 
@@ -9,10 +11,10 @@ module Checkability
     end
 
     def connect
-      Faraday.new(:url => self.path) do |faraday|
+      Faraday.new(url: path) do |faraday|
         faraday.headers['Content-Type'] = 'application/json'
         faraday.adapter Faraday.default_adapter
       end
     end
   end
-end
+end

data/lib/checkability/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
   class Railtie < ::Rails::Railtie
   end

data/lib/checkability/storage_checker.rb

@@ -1,26 +1,32 @@
-# Checks if postcode exists in Storage
-#
+# frozen_string_literal: true
+
 module Checkability
+  # Checks if postcode exists in Storage
+  #
   class StorageChecker
     attr_reader :storage_class
 
-    def initialize(conf={})
+    def initialize(conf = {})
       @storage_class = conf[:storage_class]
     end
 
     def check_value(checkable)
       value = checkable.value.upcase
-      result = 
-        storage_class.where(     value: value )
-        .or( storage_class.where(value: value.strip) )
-        .or( storage_class.where(value: value.gsub(' ','')) )
-        .present?
-      checkable.messages << (result ? _message('Found') : _message('Not found'))
+      result = _present_in_storage(value)
+      checkable.messages << (
+        result ? _message('Found', result) : _message('Not found', result))
       result
     end
 
-    def _message(str)
-      "Allowed #{storage_class}s list: #{str}."
+    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?
+    end
+
+    def _message(str, res)
+      "#{res}::Allowed #{storage_class}s list: #{str}."
     end
   end
-end
+end

data/lib/checkability/validator.rb

@@ -1,10 +1,12 @@
-# Checks if postcode exists in Storage
-#
+# frozen_string_literal: true
+
 module Checkability
+  # Checks if postcode comply with regex
+  #
   class Validator
     attr_reader :format
 
-    def initialize(conf={})
+    def initialize(conf = {})
       @format = conf[:format]
     end
 
@@ -13,13 +15,15 @@ module Checkability
       checkable.messages << message
       result
     end
-    
+
+    private
+
     def _result_and_message(checkable)
-      if (checkable.value.gsub(' ','') =~ format[:regex]).nil?
-        [false, "Value is not comply with format of #{format[:name]}."]
+      if (checkable.value.delete(' ') =~ format[:regex]).nil?
+        [false, "false::Value is NOT COMPLY with format of #{format[:name]}."]
       else
-        [true, "Value comply with format of #{format[:name]}."]
+        [true, "true::Value is COMPLY with format of #{format[:name]}."]
       end
     end
   end
-end
+end

data/lib/checkability/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Checkability
-  VERSION = '0.1.0'
+  VERSION = '0.5.0'
 end

data/lib/tasks/checkability_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :checkability do
 #   # Task goes here

metadata

@@ -1,26 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Eremeev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies: []
 description: Provide Checkers functionality.
 email:
 - andrey.eremeyev@gmail.com
-executables: []
+executables:
+- checkability
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/checkability
 - lib/checkability.rb
+- lib/checkability/acts_as_checkable.rb
 - lib/checkability/checkable.rb
 - lib/checkability/external_api_checker.rb
 - lib/checkability/external_api_connector.rb
@@ -37,7 +40,7 @@ metadata:
   homepage_uri: https://github.com/azazelo/checkability
   source_code_uri: https://rubygems.org
   changelog_uri: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,16 +48,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Provide Checkers functionality.
 test_files: []