internet_security_event 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6923d00090d3e6b18ace47b442146eedef8dc61a3a25cca68ba4080787db760
-  data.tar.gz: f8d9b8e164285b72fa9905590a389bb522552867d4cd20c435f415f1cb330cb8
+  metadata.gz: 3df07baf6dbb78e612229fee0043e79a955c01f7f1655c8e77a6a142340d4114
+  data.tar.gz: 53bd006f3735a68a8d8255e5c83245f636eb69bd9957c581fa65a6d094c0e0ea
 SHA512:
-  metadata.gz: e92aa02b66c60f44cb10bd4b9d1f0a70a14beb2d101d174ec4d6b2fa34d1952ce37646df26db470ad683541d0aa3fc746e53b61bc71e644b60d5b1de589df415
-  data.tar.gz: ec0d055bd386f1a15692e8f6044510cb4060f8b4bc56b54ebdb85d14376660125516a37840436404239e35a848d90640a7b45974afe07965d0793dbc590b31ee
+  metadata.gz: 2f3cdfec986f3112a037f78eb7579f6adca58b09361cfeea297a0c1d941409871312524cd14cf1bfa2534c50b255f7ebb4ec2e0d82085413d6096d5783f444ec
+  data.tar.gz: e49b5770d869368c49786ad8997cf85f4178f7cf52fef2eac957018db45c0ebeb0210d0bd225fc1339dc4bb215acacf52d37b55c9b0d5f205049d98b70de6621

data/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Run static code analysis
+        run: bundle exec rubocop
+  unit:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests without uploading code coverage
+        if: ${{ matrix.ruby != '3.0' }}
+        run: bundle exec rake
+      - name: Run tests and upload coverage to Code Climate
+        if: ${{ matrix.ruby == '3.0' }}
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_TOKEN }}
+        with:
+          coverageCommand: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  AllowSymlinksInCacheRootDirectory: true
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/LineLength:
+  Max: 160
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.1] - 2022-07-15
+
+### Changed
+- Emit a `warning` state instead of a `warn` state to match Riemann wording.
+
 ## [1.2.0] - 2019-02-28
 
 ### Changed

data/README.md

@@ -1,6 +1,6 @@
 # InternetSecurityEvent
 
-[![Build Status](https://travis-ci.com/smortex/internet_security_event.svg?branch=master)](https://travis-ci.com/smortex/internet_security_event)
+[![Build Status](https://github.com/smortex/internet_security_event/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/smortex/internet_security_event/actions/workflows/ci.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/bc64fb4f1c1088c15b8c/maintainability)](https://codeclimate.com/github/smortex/internet_security_event/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/bc64fb4f1c1088c15b8c/test_coverage)](https://codeclimate.com/github/smortex/internet_security_event/test_coverage)
 
@@ -38,7 +38,7 @@ certificate = OpenSSL::X509::Certificate.new(...)
 
 event = InternetSecurityEvent::X509Status.build(certificate)
 
-event[:state]       #=> 'ok', 'warn', 'critical'
+event[:state]       #=> 'ok', 'warning', 'critical'
 event[:description] #=> Human readable state
 event[:metric]      #=> an optional Float
 ```
@@ -81,4 +81,4 @@ License](https://opensource.org/licenses/MIT).
 
 Everyone interacting in the InternetSecurityEvent project’s codebases, issue
 trackers, chat rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/smortex/internet_security_event/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/smortex/internet_security_event/blob/main/CODE_OF_CONDUCT.md).

data/internet_security_event.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Build events describing the status of various internet services'
   spec.homepage      = 'https://github.com/smortex/internet_security_event'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -28,5 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
 end

data/lib/internet_security_event/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InternetSecurityEvent
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/lib/internet_security_event/x509_status.rb

@@ -15,7 +15,7 @@ module InternetSecurityEvent
       obj.to_e
     end
 
-    def to_e
+    def to_e # rubocop:disable Metrics/AbcSize
       {
         state:       state,
         description: description,
@@ -45,7 +45,7 @@ module InternetSecurityEvent
       if not_valid_yet? || expired_or_expire_soon?
         'critical'
       elsif expire_soonish?
-        'warn'
+        'warning'
       else
         'ok'
       end
@@ -80,31 +80,27 @@ module InternetSecurityEvent
     end
 
     # Stolen from ActionView, to avoid pulling a lot of dependencies
-    def distance_of_time_in_words_to_now(to_time)
+    def distance_of_time_in_words_to_now(to_time) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       distance_in_seconds = (to_time - now).round.abs
       distance_in_minutes = distance_in_seconds / 60
 
       case distance_in_minutes
       when 0                then 'less than 1 minute'
-      when 1...45           then pluralize_string('%d %s', distance_in_minutes, 'minute')
-      when 45...1440        then pluralize_string('about %d %s', (distance_in_minutes.to_f / 60.0).round, 'hour')
+      when 1...45           then pluralize_string('%d minute', distance_in_minutes)
+      when 45...1440        then pluralize_string('about %d hour', (distance_in_minutes.to_f / 60.0).round)
         # 24 hours up to 30 days
-      when 1440...43_200    then pluralize_string('%d %s', (distance_in_minutes.to_f / 1440.0).round, 'day')
+      when 1440...43_200    then pluralize_string('%d day', (distance_in_minutes.to_f / 1440.0).round)
         # 30 days up to 60 days
-      when 43_200...86_400  then pluralize_string('about %d %s', (distance_in_minutes.to_f / 43_200.0).round, 'month')
+      when 43_200...86_400  then pluralize_string('about %d month', (distance_in_minutes.to_f / 43_200.0).round)
         # 60 days up to 365 days
-      when 86_400...525_600 then pluralize_string('%d %s', (distance_in_minutes.to_f / 43_200.0).round, 'month')
+      when 86_400...525_600 then pluralize_string('%d month', (distance_in_minutes.to_f / 43_200.0).round)
       else
-        pluralize_string('about %d %s', (distance_in_minutes.to_f / 525_600.0).round, 'year')
+        pluralize_string('about %d year', (distance_in_minutes.to_f / 525_600.0).round)
       end
     end
 
-    def pluralize_string(string, number, word)
-      format(string, number, pluralize_word(number, word))
-    end
-
-    def pluralize_word(number, word)
-      word + (number.abs == 1 ? '' : 's')
+    def pluralize_string(string, number)
+      format(string, number) + (number == 1 ? '' : 's')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: internet_security_event
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Romain Tartière
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2022-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,16 +122,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - romain@blogreen.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -110,7 +153,7 @@ homepage: https://github.com/smortex/internet_security_event
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,15 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: Build events describing the status of various internet services
 test_files: []

data/.travis.yml

@@ -1,12 +0,0 @@
----
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT