ndr_support 5.4.2 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 07ba3c21f982adf4857b352bf87e1046dd393090
-  data.tar.gz: 5dd49f19587d0071d82565e1912a775ec065d986
+SHA256:
+  metadata.gz: 6e21f71716e6733363c47fb4fb1f457ec616a913902729cb40fa8a227a77d530
+  data.tar.gz: 9b251bf890fb3d835c256fe81d136d51327e749970c21bad0a77529e12655384
 SHA512:
-  metadata.gz: 58504a8eabba9ab32fb4ab2a0e6f935101614f92c7bcd7eb6db606d3404394290cd8f6f8d7921d7606ca42c1924e1183a7301882558a912c15c39c5644484088
-  data.tar.gz: cdcbd43264a63a9427bfdca4c5e0f57e51a8d29fb3273e247d7c06004dba86d98b788effc60823b33e8ba1950ef60ab78217cb4cdba6b67ff2b6d5174c99ce67
+  metadata.gz: f603f2982d2615bfc0a4b1963f324ee633a1e9fa8248c575ae52a74403b3dc514a1cbec13b2f162f351e297d6d3df50e9cd8ace0692571f3f8202603fd969598
+  data.tar.gz: 9c3248c3286b5eba6ebf757a8e1f43958c585718f768de8798be3d482a5cfda28e36dfba1286782d9701d587aa3bc7465828f5c576e17bf0ccce377ce974743f

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [Unreleased]
+*no unreleased changes*
+
+## 5.5.0 / 2018-11-16
+### Added
+* Add `ThreatScanner` to wrap ClamAV for virus detection (#10)
+
+### Fixed
+* Added missing bank holidays for 2017-2019 (#9)
+
+## 5.4.2 / 2018-08-06
+### Fixed
+* Fix Daterange equality comparisons
+
+## 5.4.1 / 2018-07-09
+### Fixed
+* ensure Range#exclude? is available
+
+## 5.4.0 / 2018-05-09
+### Added
+* Support Rails 5.2

data/code_safety.yml

@@ -14,6 +14,10 @@ file safety:
       risk. As a secondary protection, it''s excluded from the .gem file by ndr_support.gemspec'
     reviewed_by: brian.shand
     safe_revision: c88f5ac8c12fd657bb142144e0d3afaa7f9bc361
+  CHANGELOG.md:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: ea1f7dc9a164981570ee2ad7c38197fdb17a6880
   CODE_OF_CONDUCT.md:
     comments: 
     reviewed_by: timgentry
@@ -57,15 +61,15 @@ file safety:
   lib/ndr_support.rb:
     comments: 
     reviewed_by: josh.pencheon
-    safe_revision: 2685f35c907af6968a69eabb5ab9424b490d0f40
+    safe_revision: ed8ff421cc9353456af13a37049a07ce2545aac1
   lib/ndr_support/array.rb:
     comments: 
     reviewed_by: pauleves
     safe_revision: 4a4ed24d2cfe7e1736baadf4cf6e0fece6823be1
   lib/ndr_support/concerns/working_days.rb:
     comments: 
-    reviewed_by: pauleves
-    safe_revision: 5f9c98dcad6f6889d2431eb98cf07b1f5c3e57be
+    reviewed_by: josh.pencheon
+    safe_revision: e5671bd9435490d521028d02bc91ccb47c74c580
   lib/ndr_support/date_and_time_extensions.rb:
     comments: 
     reviewed_by: josh.pencheon
@@ -138,14 +142,18 @@ file safety:
     comments: 
     reviewed_by: timgentry
     safe_revision: 62337584a32e5c30c2e9af7cd998a9df684885cc
+  lib/ndr_support/threat_scanner.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: ed8ff421cc9353456af13a37049a07ce2545aac1
   lib/ndr_support/utf8_encoding.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: 29595e6431587ff9b7db6e3ad3abbb3577bff99c
+    reviewed_by: josh.pencheon
+    safe_revision: 8e024a4bacfd36e172aad4b800f1960faae0b4b6
   lib/ndr_support/utf8_encoding/control_characters.rb:
     comments: 
-    reviewed_by: timgentry
-    safe_revision: d210b982841611381a0df02d8f2db9c13e41e42f
+    reviewed_by: josh.pencheon
+    safe_revision: 8e024a4bacfd36e172aad4b800f1960faae0b4b6
   lib/ndr_support/utf8_encoding/force_binary.rb:
     comments: 
     reviewed_by: timgentry
@@ -156,16 +164,16 @@ file safety:
     safe_revision: f7adf44fc2772e1926df37abfd9041d41c303328
   lib/ndr_support/version.rb:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: a4ba32dcdab4a08db5851767282008ca3e7d8672
+    reviewed_by: josh.pencheon
+    safe_revision: ea1f7dc9a164981570ee2ad7c38197fdb17a6880
   lib/ndr_support/yaml/serialization_migration.rb:
     comments: 
     reviewed_by: timgentry
     safe_revision: 29595e6431587ff9b7db6e3ad3abbb3577bff99c
   ndr_support.gemspec:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: e8d08f6466acbdd4cbd6cbf90f1cfa45ffd656ec
+    reviewed_by: josh.pencheon
+    safe_revision: c197b91c07807345f2caf07ec4c14d8b9cbb4e53
   test/array_test.rb:
     comments: 
     reviewed_by: timgentry
@@ -236,8 +244,12 @@ file safety:
     safe_revision: 1955bf30ffe581610981f0148569e252cba02926
   test/test_helper.rb:
     comments: 
-    reviewed_by: brian.shand
-    safe_revision: 4533a155924f8a1415dd64e251a7f8311ece3bd8
+    reviewed_by: josh.pencheon
+    safe_revision: 34ae80f2952f0bfd18688541862774cbaaa6c5f5
+  test/threat_scanner_test.rb:
+    comments: 
+    reviewed_by: josh.pencheon
+    safe_revision: ed8ff421cc9353456af13a37049a07ce2545aac1
   test/utf8_encoding/control_characters_test.rb:
     comments: 
     reviewed_by: timgentry

data/lib/ndr_support.rb

@@ -13,6 +13,7 @@ require 'ndr_support/safe_file'
 require 'ndr_support/safe_path'
 require 'ndr_support/string/cleaning'
 require 'ndr_support/string/conversions'
+require 'ndr_support/threat_scanner'
 require 'ndr_support/utf8_encoding'
 require 'ndr_support/version'
 require 'ndr_support/yaml/serialization_migration'

data/lib/ndr_support/concerns/working_days.rb

@@ -50,6 +50,33 @@ module WorkingDays
     '2016-08-29', # Monday    - Summer bank holiday
     '2016-12-26', # Monday    - Boxing Day
     '2016-12-27', # Tuesday   - Christmas Day (substitute day)
+    # 2017
+    '2017-01-02', # Monday    - New Year's Day
+    '2017-04-14', # Friday    - Good Friday
+    '2017-04-17', # Monday    - Easter Monday
+    '2017-05-01', # Monday    - Early May bank holiday
+    '2017-05-29', # Monday    - Spring bank holiday
+    '2017-08-28', # Monday    - Summer bank holiday
+    '2017-12-25', # Monday    - Christmas Day
+    '2017-12-26', # Tuesday   - Boxing Day
+    # 2018
+    '2018-01-01', # Monday    - New Year's Day
+    '2018-03-30', # Friday    - Good Friday
+    '2018-04-02', # Monday    - Easter Monday
+    '2018-05-07', # Monday    - Early May bank holiday
+    '2018-05-28', # Monday    - Spring bank holiday
+    '2018-08-27', # Monday    - Summer bank holiday
+    '2018-12-25', # Tuesday   - Christmas Day
+    '2018-12-26', # Wednesday - Boxing Day
+    # 2019
+    '2019-01-01', # Tuesday   - New Year's Day
+    '2019-04-19', # Friday    - Good Friday
+    '2019-04-22', # Monday    - Easter Monday
+    '2019-05-06', # Monday    - Early May bank holiday
+    '2019-05-27', # Monday    - Spring bank holiday
+    '2019-08-26', # Monday    - Summer bank holiday
+    '2019-12-25', # Wednesday - Christmas Day
+    '2019-12-26', # Thursday  - Boxing Day
   ].map { |str| Date.parse(str) }
 
   # How many complete working days there are until the given

data/lib/ndr_support/threat_scanner.rb

@@ -0,0 +1,64 @@
+require 'English'
+
+# Runs a virus/malware check against the given path, using ClamAV.
+#
+# Sample usage:
+#
+#   # Call with a file object:
+#   ThreatScanner.new(@unknown_tempfile).check!
+#
+#   # ...or with a path:
+#   ThreatScanner.new('path/to/README').check!
+#
+class ThreatScanner
+  class Error < StandardError; end
+
+  class MissingFileError      < Error; end
+  class MissingScannerError   < Error; end
+  class ScannerOperationError < Error; end
+  class ThreatDetectedError   < Error; end
+
+  def self.installed?
+    system('which clamdscan > /dev/null 2>&1')
+  end
+
+  attr_reader :path
+
+  def initialize(path)
+    @path = path.respond_to?(:path) ? path.path : path
+  end
+
+  # Returns true if the given file is deemed safe, and false if it could not
+  # be checked. Raises if a threat is detected, or the file did not exist.
+  def check
+    check!
+  rescue MissingScannerError, ScannerOperationError
+    false
+  end
+
+  # Returns true if the given file is deemed safe, and raises an exception
+  # otherwise (if the file is unsafe / does not exist / scanner broke etc).
+  def check!
+    check_existence! && check_installed! && run_scanner!
+  end
+
+  private
+
+  def check_existence!
+    File.exist?(@path) || raise(MissingFileError, "#{@path} does not exist!")
+  end
+
+  def check_installed!
+    self.class.installed? || raise(MissingScannerError, 'no scanner is available')
+  end
+
+  def run_scanner!
+    `clamdscan --fdpass --quiet #{Shellwords.escape(@path)}`
+
+    case $CHILD_STATUS.exitstatus
+    when 0 then true
+    when 1 then raise(ThreatDetectedError, "possible virus detected at #{@path}!")
+    else        raise(ScannerOperationError, 'the scan was unable to complete')
+    end
+  end
+end

data/lib/ndr_support/utf8_encoding.rb

@@ -16,6 +16,9 @@ module UTF8Encoding
   # How should unmappable characters be escaped, when forcing encoding?
   REPLACEMENT_SCHEME = lambda { |char| '0x' + char.ord.to_s(16).rjust(2, '0') }
 
+  UTF8   = 'UTF-8'.freeze
+  BINARY = 'BINARY'.freeze
+
   # Returns a new string with valid UTF-8 encoding,
   # or raises an exception if encoding fails.
   def ensure_utf8(string, source_encoding = nil)
@@ -51,7 +54,7 @@ module UTF8Encoding
     ensure_utf8!(string, source_encoding)
   rescue UTF8CoercionError
     # ...before going back-to-basics, and replacing things that don't map:
-    string.encode!('UTF-8', 'BINARY', :fallback => REPLACEMENT_SCHEME)
+    string.encode!(UTF8, BINARY, :fallback => REPLACEMENT_SCHEME)
   end
 
   private
@@ -60,7 +63,7 @@ module UTF8Encoding
     candidates.detect do |encoding|
       begin
         # Attempt to encode as UTF-8 from source `encoding`:
-        string.encode!('UTF-8', encoding)
+        string.encode!(UTF8, encoding)
         # If that worked, we're done; otherwise, move on.
         string.valid_encoding?
       rescue EncodingError

data/lib/ndr_support/utf8_encoding/control_characters.rb

@@ -5,9 +5,7 @@ module UTF8Encoding
   # escaped, using standard replacement scheme.
   module ControlCharacters
     # The range of characters we consider:
-    CONTROL_CHARACTERS = /[\x00-\x1f]|\x7f/
-    # Exceptions that are allowed:
-    ALLOWED_CONTROL_CHARACTERS = %W( \x09 \x0a \x0d )
+    CONTROL_CHARACTERS = /[\x00-\x08]|[\x0b-\x0c]|[\x0e-\x1f]|\x7f/
 
     # Recursively escape any control characters in `object`.
     def escape_control_chars_in_object!(object)
@@ -31,11 +29,7 @@ module UTF8Encoding
     # Escapes in-place any control characters in `string`, before returning it.
     def escape_control_chars!(string)
       string.gsub!(CONTROL_CHARACTERS) do |character|
-        if ALLOWED_CONTROL_CHARACTERS.include?(character)
-          character
-        else
-          UTF8Encoding::REPLACEMENT_SCHEME[character]
-        end
+        UTF8Encoding::REPLACEMENT_SCHEME[character]
       end
       string
     end

data/lib/ndr_support/version.rb

@@ -3,5 +3,5 @@
 # This defines the NdrSupport version. If you change it, rebuild and commit the gem.
 # Use "rake build" to build the gem, see rake -T for all bundler rake tasks.
 module NdrSupport
-  VERSION = '5.4.2'
+  VERSION = '5.5.0'
 end

data/ndr_support.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '>= 5.0.0'
   spec.add_development_dependency 'mocha', '~> 1.1'
 
-  spec.add_development_dependency 'ndr_dev_support', '~> 3.0'
+  spec.add_development_dependency 'ndr_dev_support', '~> 3.1', '>= 3.1.3'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'listen', '< 3.1' # Bundle 1.12 should be (but isn't) resolving Ruby 2.1 issue
   spec.add_development_dependency 'guard-rubocop'

data/test/test_helper.rb

@@ -3,7 +3,7 @@ SimpleCov.start
 
 require 'minitest/autorun'
 require 'minitest/unit'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 
 require 'active_record'
 require 'active_support/time'

data/test/threat_scanner_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+# This tests our ThreatScanner extension
+class ThreatScannerTest < Minitest::Test
+  def setup
+    @tempfile = Tempfile.new
+    @scanner  = ThreatScanner.new(@tempfile)
+
+    ThreatScanner.stubs(installed?: true)
+    ThreatScanner.any_instance.stubs(:`)
+  end
+
+  def teardown
+    @tempfile.close!
+  end
+
+  test 'can be initialised with a file' do
+    assert_equal @tempfile.path, @scanner.path
+  end
+
+  test 'can be initialised with a path' do
+    scanner = ThreatScanner.new(@tempfile.path)
+    assert_equal @tempfile.path, scanner.path
+  end
+
+  test 'returns true if no threat is detected (when being strict)' do
+    Process::Status.any_instance.stubs(exitstatus: 0)
+    assert_equal true, @scanner.check!
+  end
+
+  test 'raises if a threat is detected (when being strict)' do
+    Process::Status.any_instance.stubs(exitstatus: 1)
+    assert_raises(ThreatScanner::ThreatDetectedError) { @scanner.check! }
+  end
+
+  test 'raises if the file does not exist (when being strict)' do
+    @tempfile.close!
+    assert_raises(ThreatScanner::MissingFileError) { @scanner.check! }
+  end
+
+  test 'raises if ClamAV is not installed (when being strict)' do
+    ThreatScanner.stubs(installed?: false)
+    assert_raises(ThreatScanner::MissingScannerError) { @scanner.check! }
+  end
+
+  test 'raises if there is an operational error (when being strict)' do
+    Process::Status.any_instance.stubs(exitstatus: 2)
+    assert_raises(ThreatScanner::ScannerOperationError) { @scanner.check! }
+  end
+
+  test 'returns true if no threat is detected (when being relaxed)' do
+    Process::Status.any_instance.stubs(exitstatus: 0)
+    assert_equal true, @scanner.check
+  end
+
+  test 'raises if a threat is detected (when being relaxed)' do
+    Process::Status.any_instance.stubs(exitstatus: 1)
+    assert_raises(ThreatScanner::ThreatDetectedError) { @scanner.check }
+  end
+
+  test 'raises if the file does not exist (when being relaxed)' do
+    @tempfile.close!
+    assert_raises(ThreatScanner::MissingFileError) { @scanner.check }
+  end
+
+  test 'returns false if ClamAV is not installed (when being relaxed)' do
+    ThreatScanner.stubs(installed?: false)
+    assert_equal false, @scanner.check
+  end
+
+  test 'returns false if there is an operational error (when being relaxed)' do
+    Process::Status.any_instance.stubs(exitstatus: 2)
+    assert_equal false, @scanner.check
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_support
 version: !ruby/object:Gem::Version
-  version: 5.4.2
+  version: 5.5.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -112,14 +112,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.3
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +232,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -258,6 +265,7 @@ files:
 - lib/ndr_support/string/cleaning.rb
 - lib/ndr_support/string/conversions.rb
 - lib/ndr_support/tasks.rb
+- lib/ndr_support/threat_scanner.rb
 - lib/ndr_support/utf8_encoding.rb
 - lib/ndr_support/utf8_encoding/control_characters.rb
 - lib/ndr_support/utf8_encoding/force_binary.rb
@@ -283,6 +291,7 @@ files:
 - test/string/cleaning_test.rb
 - test/string/conversions_test.rb
 - test/test_helper.rb
+- test/threat_scanner_test.rb
 - test/utf8_encoding/control_characters_test.rb
 - test/utf8_encoding/force_binary_test.rb
 - test/utf8_encoding_test.rb
@@ -307,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: NDR Support library
@@ -330,6 +339,7 @@ test_files:
 - test/string/cleaning_test.rb
 - test/string/conversions_test.rb
 - test/test_helper.rb
+- test/threat_scanner_test.rb
 - test/utf8_encoding/control_characters_test.rb
 - test/utf8_encoding/force_binary_test.rb
 - test/utf8_encoding_test.rb