checkability 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 148d47cb845c2354cee354d4852b43054a2af514
+  data.tar.gz: 91c98f1a5e3cbf800290b645c516db1c69419c17
+SHA512:
+  metadata.gz: f2052db80385a337dd9567ff890f56c299ae99f3341eb1734f701b8f5d536713ffde8fd148f36a358aabcbcc140a9517bca1d49688e200327835e36d02fa104c
+  data.tar.gz: 024178f440d540b3bd9ef2df354793ac137f8bf338902da587881cee4929147d1d698b59eb7419e63b569caf1c1853aa7e3985835c1e19efad40ebfdbfa29f68

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Andrey Eremeev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Checkability
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkability'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install checkability
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/checkability.rb

@@ -0,0 +1,6 @@
+require "checkability/version"
+require "checkability/checkable"
+require "checkability/storage_checker"
+require "checkability/external_api_checker"
+require "checkability/external_api_connector"
+require "checkability/validator"

data/lib/checkability/checkable.rb

@@ -0,0 +1,25 @@
+# Checks if postcode exists in Storage
+#
+module Checkability
+  class Checkable
+    attr_reader :checkable
+
+    def initialize(checkable)
+      @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
+    #   e.g. [storage_checker, external_api_checker]
+    def check(algoritm = nil, checkers = [])
+      algoritm.call( 
+        checkers.map do |checker| 
+          checker.check_value(checkable)
+        end
+      )
+    end
+  end
+end

data/lib/checkability/external_api_checker.rb

@@ -0,0 +1,42 @@
+#require 'faraday_middleware'
+require 'faraday'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+# Checks if postcode exists in Storage
+#
+module Checkability
+  class ExternalApiChecker
+    attr_reader :path, :check_method, :connection
+
+    def initialize(conf={})
+      @path = conf[:path]
+      @check_method = conf[:check_method]
+      @connection = Checkability::ExternalApiConnector.new(conf).connect
+    end
+
+    def check_value(checkable)
+      @resp = connection.get(checkable.value.gsub(' ',''))
+      result, message = _result_and_message
+      checkable.messages << message
+      result
+    end
+
+    private
+
+    def _message(str); "#{path}: #{str}";     end
+
+    def _parsed(resp); JSON.parse(resp.body); end
+
+    def _result_and_message
+      return [false, _message(@resp.status)] unless @resp.status == 200
+
+      return [true, _message('Found.')] if check_method.call(_parsed(@resp))
+
+      [false, _message('Not found in allowed areas.')]
+    rescue Exception => e
+      [false, _message(e)]
+    end
+  end
+end

data/lib/checkability/external_api_connector.rb

@@ -0,0 +1,18 @@
+# Create connection
+#
+module Checkability
+  class ExternalApiConnector
+    attr_reader :path
+
+    def initialize(conf)
+      @path = conf[:path]
+    end
+
+    def connect
+      Faraday.new(:url => self.path) do |faraday|
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/checkability/railtie.rb

@@ -0,0 +1,4 @@
+module Checkability
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/checkability/storage_checker.rb

@@ -0,0 +1,26 @@
+# Checks if postcode exists in Storage
+#
+module Checkability
+  class StorageChecker
+    attr_reader :storage_class
+
+    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
+    end
+
+    def _message(str)
+      "Allowed #{storage_class}s list: #{str}."
+    end
+  end
+end

data/lib/checkability/validator.rb

@@ -0,0 +1,25 @@
+# Checks if postcode exists in Storage
+#
+module Checkability
+  class Validator
+    attr_reader :format
+
+    def initialize(conf={})
+      @format = conf[:format]
+    end
+
+    def check_value(checkable)
+      result, message = _result_and_message(checkable)
+      checkable.messages << message
+      result
+    end
+    
+    def _result_and_message(checkable)
+      if (checkable.value.gsub(' ','') =~ 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

data/lib/checkability/version.rb

@@ -0,0 +1,3 @@
+module Checkability
+  VERSION = '0.1.0'
+end

data/lib/tasks/checkability_tasks.rake

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: checkability
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Eremeev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-30 00:00:00.000000000 Z
+dependencies: []
+description: Provide Checkers functionality.
+email:
+- andrey.eremeyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/checkability.rb
+- lib/checkability/checkable.rb
+- lib/checkability/external_api_checker.rb
+- lib/checkability/external_api_connector.rb
+- lib/checkability/railtie.rb
+- lib/checkability/storage_checker.rb
+- lib/checkability/validator.rb
+- lib/checkability/version.rb
+- lib/tasks/checkability_tasks.rake
+homepage: https://github.com/azazelo/checkability
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/azazelo/checkability
+  source_code_uri: https://rubygems.org
+  changelog_uri: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Provide Checkers functionality.
+test_files: []