checkability 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 148d47cb845c2354cee354d4852b43054a2af514
-  data.tar.gz: 91c98f1a5e3cbf800290b645c516db1c69419c17
+  metadata.gz: 7c20a76958ba1f8025605a3ded3101c8a0e3eeb2
+  data.tar.gz: 8b69ff85aea14d3726827e58954cc6efb8bdb502
 SHA512:
-  metadata.gz: f2052db80385a337dd9567ff890f56c299ae99f3341eb1734f701b8f5d536713ffde8fd148f36a358aabcbcc140a9517bca1d49688e200327835e36d02fa104c
-  data.tar.gz: 024178f440d540b3bd9ef2df354793ac137f8bf338902da587881cee4929147d1d698b59eb7419e63b569caf1c1853aa7e3985835c1e19efad40ebfdbfa29f68
+  metadata.gz: 4fe465c7c77639f20865c2e37df153615298df3b6284587660b030ec0833bedc5bcfb14e59a39252988d1276721ece24fa88d8000291ae188a50ff1897ebb8eb
+  data.tar.gz: 26494daaeae8b5497b2c2db96ee1c21ddfabf027b93a30e6b1dd91d06936f4dd4fdff616d2391cf5fa1620df07a7806fadb8b69899ee232619d95a67cfa0e8a0

data/README.md

@@ -1,9 +1,17 @@
 # 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 ruby class include Checkablilty
+next 
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/Rakefile

@@ -1,3 +1,3 @@
-require "bundler/setup"
+require 'bundler/setup'
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/checkability

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+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,11 @@
-require "checkability/version"
-require "checkability/checkable"
-require "checkability/storage_checker"
-require "checkability/external_api_checker"
-require "checkability/external_api_connector"
-require "checkability/validator"
+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,43 @@
+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 = {})
+        if !options.is_a?(Hash) && !options.empty?
+          raise ArgumentError, "Hash expected, got #{options.class.name}"
+        end
+
+        class_attribute :checkable_conf
+
+        self.checkable_conf = options
+      end
+    end
+
+    attr_accessor :allowed, :messages
+    def setup
+      self.allowed = nil
+      self.messages = []
+    end
+
+    def perform
+      setup
+      self.allowed = _check
+      messages << "#{self.class.name} '#{value}' is #{_allowness}. "
+    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,7 @@
-# Checks if postcode exists in Storage
-#
 module Checkability
+  # Implements check method to Iterate on chechers
+  # Possible to implemet as Iterator in future
+  #
   class Checkable
     attr_reader :checkable
 
@@ -8,18 +9,19 @@ 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]
+    # sentence is a proc
+    #   like { |a,b,c| a && ( b || c ) }
+    #   where a,b,c are checkers
+    #   and each should return true|false
     # checkers is an array of checker objects
     #   e.g. [storage_checker, external_api_checker]
-    def check(algoritm = nil, checkers = [])
-      algoritm.call( 
-        checkers.map do |checker| 
-          checker.check_value(checkable)
+    def check(conf)
+      conf[:algoritm].call(
+        conf[:checkers].map do |checker_name, checker_conf|
+          k = Checkability.const_get(checker_name.to_s.camelize)
+          k.new(checker_conf).check_value(checkable)
         end
       )
     end
   end
-end
+end

data/lib/checkability/external_api_checker.rb

@@ -1,23 +1,22 @@
-#require 'faraday_middleware'
 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
 
-    def initialize(conf={})
+    def initialize(conf = {})
       @path = conf[:path]
       @check_method = conf[:check_method]
-      @connection = Checkability::ExternalApiConnector.new(conf).connect
+      @connection = Checkability::ExternalApiConnector.new(conf)
     end
 
     def check_value(checkable)
-      @resp = connection.get(checkable.value.gsub(' ',''))
+      @resp = connection.connect.get(checkable.value.delete(' '))
       result, message = _result_and_message
       checkable.messages << message
       result
@@ -25,9 +24,13 @@ module Checkability
 
     private
 
-    def _message(str); "#{path}: #{str}";     end
+    def _message(str)
+      "#{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
@@ -35,8 +38,8 @@ module Checkability
       return [true, _message('Found.')] if check_method.call(_parsed(@resp))
 
       [false, _message('Not found in allowed areas.')]
-    rescue Exception => e
+    rescue StandardError => e
       [false, _message(e)]
     end
   end
-end
+end

data/lib/checkability/external_api_connector.rb

@@ -1,6 +1,6 @@
-# Create connection
-#
 module Checkability
+  # Create connection
+  #
   class ExternalApiConnector
     attr_reader :path
 
@@ -9,10 +9,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/storage_checker.rb

@@ -1,26 +1,29 @@
-# Checks if postcode exists in Storage
-#
 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?
+      result = _present_in_storage(value)
       checkable.messages << (result ? _message('Found') : _message('Not found'))
       result
     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?
+    end
+
     def _message(str)
       "Allowed #{storage_class}s list: #{str}."
     end
   end
-end
+end

data/lib/checkability/validator.rb

@@ -1,10 +1,10 @@
-# Checks if postcode exists in Storage
-#
 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 +13,13 @@ module Checkability
       checkable.messages << message
       result
     end
-    
+
     def _result_and_message(checkable)
-      if (checkable.value.gsub(' ','') =~ format[:regex]).nil?
+      if (checkable.value.delete(' ') =~ format[:regex]).nil?
         [false, "Value is not comply with format of #{format[:name]}."]
       else
         [true, "Value comply with format of #{format[:name]}."]
       end
     end
   end
-end
+end

data/lib/checkability/version.rb

@@ -1,3 +1,3 @@
 module Checkability
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Eremeev
@@ -13,14 +13,17 @@ 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