obscured-heartbeat 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae2d04d162ad5089169eca9fa8d2e9a9a90a9a16d0974c2ae16ec20ed8952c13
+  data.tar.gz: a20d2f5ede017743cb53f969e3aa38dba0f18762ab64149dea46f4febd4abe5e
+SHA512:
+  metadata.gz: 8a7b1ab7fbed3de4ce68b808271aa5f6bb4221925cc0e9fc36daf4865149b5829fe451dc5e9a4e4fdb3f6174d0221d9c39dd78820b5885f26262daab9063b7b4
+  data.tar.gz: 66a78de3328732348e182b7a67de67aa12164596d2c0af6f57c9dcc0191cc79fbd16850653dcc1397c98c48701a2fd1bad764042c03f4cb5bf2fb8bb140ecb9d

data/.codeclimate.yml

@@ -0,0 +1,28 @@
+version: "2"
+checks:
+  complex-logic:
+    config:
+      threshold: 10
+  file-lines:
+    enabled: false
+  method-complexity:
+    config:
+      threshold: 15
+  method-lines:
+    config:
+      threshold: 250
+  similar-code:
+    enabled: false
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-71
+  coffeelint:
+    enabled: true
+  eslint:
+    enabled: true
+  csslint:
+    enabled: true
+exclude_patterns:
+- "tests/"
+- "spec/"

data/.github/workflows/gem-push.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_AUTH_TOKEN}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_AUTH_TOKEN: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.idea/
+coverage/

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Max: 50
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 15
+Naming/FileName:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+obscured-heartbeat

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter 'version'
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,17 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=4a1a54eeae5b7c8b3f49b4164c7ed1c9042bee5b0e734d0283ac61294b006cfa
+language: ruby
+bundler_args: --with development
+rvm:
+  - 2.6.3
+services:
+  - mongodb
+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
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in obscured-heartbeat.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    obscured-heartbeat (1.0.0)
+      activesupport
+      mongoid
+      mongoid_search
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    bson (4.12.0)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    docile (1.3.4)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    fast-stemmer (1.0.2)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    mongo (2.14.0)
+      bson (>= 4.8.2, < 5.0.0)
+    mongoid (7.2.1)
+      activemodel (>= 5.1, < 6.2)
+      mongo (>= 2.10.5, < 3.0.0)
+    mongoid_search (0.4.0)
+      fast-stemmer (~> 1.0.0)
+      mongoid (>= 5.0.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_bot
+  obscured-heartbeat!
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,88 @@
+[![Vulnerabilities](https://snyk.io/test/github/gonace/obscured.heartbeat/badge.svg)](https://snyk.io/test/github/gonace/obscured.heartbeat)
+[![Build Status](https://travis-ci.org/gonace/Obscured.Heartbeat.svg?branch=master)](https://travis-ci.org/gonace/Obscured.Heartbeat)
+[![Test Coverage](https://codeclimate.com/github/gonace/Obscured.Heartbeat/badges/coverage.svg)](https://codeclimate.com/github/gonace/Obscured.Heartbeat)
+[![Code Climate](https://codeclimate.com/github/gonace/Obscured.Heartbeat/badges/gpa.svg)](https://codeclimate.com/github/gonace/Obscured.Heartbeat)
+
+# Obscured::Heartbeat
+## Introduction
+Obscured Heartbeat adds heartbeat to a separate collection for an entity (Document), the naming of the class (Mongoid Document) is used for naming the heartbeat collection, so if the class is named "Host" the collection name will end up being "host_heartbeat".
+
+## Installation
+### Requirements
+- activesupport
+- mongoid
+- mongoid_search
+
+##### Add this line to your application's Gemfile
+```ruby
+gem 'obscured-heartbeat', :git => 'https://github.com/gonace/Obscured.Heartbeat.git', :branch => 'master'
+```
+
+##### Execute
+```
+$ bundle
+```
+
+### Usage
+#### Base
+Use this in files where you create non-default log collections.
+```ruby
+require 'obscured-heartbeat'
+```
+
+
+### Example
+#### Document
+```ruby
+require 'obscured-heartbeat'
+
+module Obscured
+  class Host
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Obscured::Heartbeat::Tracker
+    
+    field :name, type: String
+    field :hostname, type: String
+  end
+end
+
+
+host = Obscured::Host.create(:name => "John Doe", :hostname => "domain.tld")
+heartbeat = host.add_heartbeat(distribution: { name: 'Ubuntu', release: '19.04', codename: 'disco', description: 'Ubuntu 19.04' }, hostname: 'host.domain.tld', ip_address: '10.0.1.1', uptime: Time.now.to_i)
+
+#returns array of heartbeats for document (proprietor)
+host.get_heartbeat
+host.heartbeats
+
+#returns heartbeat by id
+host.get_heartbeat(heartbeat.id.to_s)
+
+#returns array of heartbeats by predefined params, supports pagination
+host.find_heartbeats({ hostname: "domain.tld" }, { limit: 20, skip: 0, order: :created_at.desc, only: [:id, :distrubuton, :hostname, :ip_address, :uptime, :created_at, :updated_at, :proprietor] })
+
+#retuns array of heartbeats
+host.search_heartbeats("domain.tld", { limit: 20, skip: 0, order: :created_at.desc })
+```
+
+#### Service
+```ruby
+module Obscured
+  class HostHeartbeatService
+    include Mongoid::Timeline::Service::Base
+  end
+end
+
+module Obscured
+  class PackageSynchronizer
+    def initialize(host)
+      @host = host
+      @service = Obscured::HostHeartbeatService.new
+    end
+
+    def last_heartbeat
+      @host.by(proprietor: { host_id: host.id }).last
+    end
+  end
+end
+```

data/lib/obscured-heartbeat.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+require 'mongoid_search'
+
+Mongoid::Search.setup do |cfg|
+  cfg.strip_symbols = /["]/
+  cfg.strip_accents = //
+end
+
+require 'obscured-heartbeat/record'
+require 'obscured-heartbeat/service'
+require 'obscured-heartbeat/tracker'
+
+module Mongoid
+  module Heartbeat
+  end
+end

data/lib/obscured-heartbeat/record.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+require 'mongoid_search'
+
+module Mongoid
+  module Heartbeat
+    module Record
+      extend ActiveSupport::Concern
+
+      included do
+        include Mongoid::Document
+        include Mongoid::Search
+        include Mongoid::Timestamps
+
+        field :distribution, type: Hash
+        field :hostname, type: String
+        field :ip_address, type: String
+        field :uptime, type: Integer
+        field :proprietor, type: Hash
+
+        index({ hostname: 1 }, background: true)
+        index({ _keywords: 1 }, background: true)
+
+        search_in :id, :hostname, :ip_address, proprietor: %i[host_id gateway_id]
+      end
+
+      module ClassMethods
+        def make(params = {})
+          raise ArgumentError, 'distribution missing' if params[:distribution].blank?
+          raise ArgumentError, 'hostname missing' if params[:hostname].blank?
+          raise ArgumentError, 'ip_address missing' if params[:ip_address].blank?
+          raise ArgumentError, 'uptime missing' if params[:uptime].blank?
+          raise ArgumentError, 'proprietor missing' if params[:proprietor].blank?
+
+          doc = new
+          doc.distribution = params[:distribution]
+          doc.hostname = params[:hostname]
+          doc.ip_address = params[:ip_address]
+          doc.uptime = params[:uptime]
+          doc.proprietor = params[:proprietor]
+          doc
+        end
+
+        def make!(params = {})
+          doc = make(params)
+          doc.save!
+          doc
+        end
+
+        def by(params = {}, options = {})
+          limit = options[:limit].blank? ? nil : options[:limit].to_i
+          skip = options[:skip].blank? ? nil : options[:skip].to_i
+          order = options[:order].blank? ? :created_at.desc : options[:order]
+          only = options[:only].blank? ? %i[id distrubuton hostname ip_address uptime created_at updated_at proprietor] : options[:only]
+
+          query = {}
+          query[:hostname] = params[:hostname] if params[:hostname]
+          params[:proprietor]&.map { |k, v| query.merge!("proprietor.#{k}" => v) }
+
+          criterion = where(query).only(only).limit(limit).skip(skip)
+          criterion = criterion.order_by(order) if order
+
+          docs = criterion.to_a
+          docs
+        end
+      end
+    end
+  end
+end

data/lib/obscured-heartbeat/service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Heartbeat
+    module Service
+      module Base
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def all(criterion = {})
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.all(criterion).to_a
+          end
+        end
+
+        def find(*args)
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.find(*args)
+          end
+        end
+
+        def find_by(attrs = {})
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.find_by(attrs).to_a
+          end
+        end
+
+        def where(expression)
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.where(expression).to_a
+          end
+        end
+
+        def by(params = {}, options = {})
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.by(params, options)
+          end
+        end
+
+        def delete(id)
+          Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+            m.where(id: id.to_s).delete
+          end
+        end
+
+        class Record
+          include Mongoid::Heartbeat::Record
+        end
+      end
+    end
+  end
+end

data/lib/obscured-heartbeat/tracker.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Mongoid
+  module Heartbeat
+    module Tracker
+      extend ActiveSupport::Concern
+
+      class Record
+        include Mongoid::Heartbeat::Record
+      end
+
+      # Adds heartbeat to the x_heartbeat collection for document. This is
+      # only called on manually.
+      #
+      # @example Add heartbeat.
+      #   document.add_heartbeat
+      #
+      # @return [ document ]
+      def add_heartbeat(event)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.make!(event.merge(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id }))
+        end
+      end
+
+      # Get an heartbeat from the x_heartbeat collection for document. This is
+      # only called on manually.
+      #
+      # @example Get heartbeat.
+      #   document.get_heartbeat(id)
+      #
+      # @return [ document ]
+      def get_heartbeat(id)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.find(id)
+        end
+      end
+
+      # Get heartbeats from the x_heartbeat collection for document by proprietor. This is
+      # only called on manually.
+      #
+      # @example Get heartbeats.
+      #   document.get_heartbeats
+      #   document.heartbeats
+      #
+      # @return [ documents ]
+      def get_heartbeats
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.by(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id })
+        end
+      end
+      alias heartbeats get_heartbeats
+
+      # Find heartbeats from the x_heartbeat collection for document. This is
+      # only called on manually.
+      #
+      # @example Get heartbeats.
+      #   document.find_heartbeats(params, options)
+      #
+      # @return [ documents ]
+      def find_heartbeats(params, options)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.by({ proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id } }.merge(params), options)
+        end
+      end
+
+      # Search heartbeats from the x_heartbeat collection for document. This is
+      # only called on manually.
+      #
+      # @example Get heartbeats.
+      #   document.search_heartbeats(text, options)
+      #
+      # @return [ documents ]
+      def search_heartbeats(text, options)
+        limit = options[:limit].blank? ? nil : options[:limit].to_i
+        skip = options[:skip].blank? ? nil : options[:skip].to_i
+        order = options[:order].blank? ? :created_at.desc : options[:order]
+
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          criteria = m.full_text_search(text)
+          criteria = criteria.order_by(order) if order
+          criteria = criteria.limit(limit).skip(skip)
+
+          docs = criteria.to_a
+          docs
+        end
+      end
+
+      # Edit an heartbeat from the x_heartbeat collection by id. This is
+      # only called on manually.
+      #
+      # @example Get heartbeat.
+      #   document.edit_heartbeat(id, params)
+      #
+      # @return [ document ]
+      def edit_heartbeat(id, params = {})
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          hb = m.where(id: id).first
+          hb.hostname = params[:hostname] if params[:hostname]
+          hb.save
+          hb
+        end
+      end
+
+      # Delete an heartbeat from the x_heartbeat collection by id. This is
+      # only called on manually.
+      #
+      # @example Get heartbeat.
+      #   document.delete_heartbeat(id)
+      #
+      # @return [ document ]
+      def delete_heartbeat(id)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.where(id: id).delete
+        end
+      end
+
+      # Clear heartbeats from the x_heartbeat collection for document. This is
+      # only called on manually.
+      #
+      # @example Get heartbeats.
+      #   document.clear_heartbeats
+      #
+      # @return [ documents ]
+      def clear_heartbeats
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_heartbeat") do |m|
+          m.where(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id }).delete
+        end
+      end
+    end
+  end
+end

data/lib/obscured-heartbeat/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Heartbeat
+    VERSION = '1.0.0'
+  end
+end

data/obscured-heartbeat.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'obscured-heartbeat/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'obscured-heartbeat'
+  gem.version       = Mongoid::Heartbeat::VERSION
+  gem.authors       = ['Erik Hennerfors']
+  gem.email         = ['erik.hennerfors@obscured.se']
+  gem.description   = 'Default database heartbeat ability'
+  gem.summary       = 'Default database heartbeat ability'
+  gem.homepage      = 'https://github.com/gonace/Obscured.Heartbeat'
+
+  gem.required_ruby_version = '>= 2'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'mongoid'
+  gem.add_dependency 'mongoid_search'
+
+  gem.add_development_dependency 'factory_bot'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,11 @@
+spec:
+  options:
+    raise_not_found_error: false
+  clients:
+    default:
+      database: heartbeat_testing
+      hosts:
+        - localhost:27017
+      options:
+        max_pool_size: 100
+        min_pool_size: 5

data/spec/factories/gateway_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/gateway_document'
+
+FactoryBot.define do
+  factory :gateway, class: Obscured::Gateway do
+    name { 'Gateway Sweden' }
+    hostname { 'gateway.domain.tld' }
+  end
+end

data/spec/factories/heartbeat_factory.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/obscured-heartbeat/record'
+
+FactoryBot.define do
+  factory :heartbeat, class: Mongoid::Heartbeat::Record do
+    distribution {
+      {
+        name: 'Ubuntu',
+        release: '19.04',
+        codename: 'disco',
+        description: 'Ubuntu 19.04'
+      }
+    }
+    hostname { 'host.domain.tld' }
+    ip_address { '10.0.1.1' }
+    uptime { 1561391862 }
+
+    trait :with_host do
+      proprietor { { host_id: BSON::ObjectId.new } }
+    end
+  end
+end

data/spec/factories/host_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/host_document'
+
+FactoryBot.define do
+  factory :host, class: Obscured::Host do
+    name { 'host' }
+    hostname { 'hostname.domain.tld' }
+  end
+end

data/spec/helpers/gateway_document.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Obscured
+  class Gateway
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Heartbeat::Tracker
+
+    store_in collection: 'gateways'
+
+    field :name, type: String
+    field :hostname, type: String
+  end
+end

data/spec/helpers/host_document.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Obscured
+  class Host
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Heartbeat::Tracker
+
+    store_in collection: 'hosts'
+
+    field :name, type: String
+    field :hostname, type: String
+  end
+end

data/spec/helpers/host_service.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Heartbeat
+    module Service
+      class Host
+        include Mongoid::Heartbeat::Service::Base
+      end
+    end
+  end
+end

data/spec/host_service_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/host_document'
+require_relative 'helpers/host_service'
+
+
+describe Mongoid::Heartbeat::Service::Host do
+  let!(:host) { FactoryBot.create(:host) }
+  let!(:host2) { FactoryBot.create(:host, hostname: 'host2.domain.tld') }
+  let!(:service) { Mongoid::Heartbeat::Service::Host.new }
+  let!(:template) {
+    {
+      distribution: {
+        name: 'Ubuntu',
+        release: '19.04',
+        codename: 'disco',
+        description: 'Ubuntu 19.04'
+      },
+      hostname: 'host.domain.tld',
+      ip_address: '10.0.1.1',
+      uptime: Time.now.to_i
+    }
+  }
+
+  before(:each) do
+    5.times do
+      host.add_heartbeat(template)
+    end
+
+    3.times do
+      host2.add_heartbeat(template.merge(hostname: host2.hostname))
+    end
+  end
+
+  describe 'all' do
+    let(:response) { service.all }
+
+    it { expect(response.to_a.count).to eq(8) }
+  end
+
+  describe 'find' do
+    let!(:heartbeat) { host.add_heartbeat(template) }
+    let(:response) { service.find(heartbeat.id) }
+
+    it { expect(response).to_not be(nil) }
+    it { expect(response.id).to eq(heartbeat.id) }
+  end
+
+  describe 'find_by' do
+    let!(:heartbeat) { host.add_heartbeat(template) }
+    let(:response) { service.find_by(hostname: 'host.domain.tld') }
+
+    it { expect(response).to_not be(nil) }
+    it { expect(response.count).to eq(1) }
+  end
+
+  describe 'by' do
+    context 'proprietor' do
+      let(:response) { service.by(proprietor: { host_id: host.id }) }
+
+      it { expect(response.count).to eq(5) }
+    end
+  end
+
+  describe 'where' do
+    context 'returns correct documents' do
+      let(:response) { service.where(hostname: 'host2.domain.tld') }
+
+      it { expect(response.count).to eq(3) }
+    end
+  end
+
+  describe 'delete' do
+    context 'deletes document by id' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+
+      it { expect(service.delete(heartbeat.id)).to eq(1) }
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Pull in test utilities
+require 'factory_bot'
+require 'pp'
+require 'rspec'
+require 'simplecov'
+
+# pull in the code
+require_relative '../lib/obscured-heartbeat'
+
+Mongoid.load!(File.join(File.dirname(__FILE__), '/config/mongoid.yml'), 'spec')
+Mongo::Logger.logger.level = Logger::ERROR
+
+RSpec.configure do |c|
+  c.order = :random
+  c.filter_run :focus
+  c.run_all_when_everything_filtered = true
+
+  c.include FactoryBot::Syntax::Methods
+
+  c.before(:suite) do
+    FactoryBot.find_definitions
+    Mongoid.purge!
+
+    Mongoid::Search.setup do |cfg|
+      cfg.strip_symbols = /[\"]/
+      cfg.strip_accents = //
+    end
+  end
+
+  c.before(:each) do
+    Mongoid.purge!
+  end
+
+  c.after(:suite) do
+    Mongoid.purge!
+  end
+end

data/spec/tracker_multiple_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/host_document'
+require_relative 'helpers/gateway_document'
+
+
+describe Mongoid::Heartbeat::Tracker do
+  let(:host) { FactoryBot.create(:host) }
+  let(:gateway) { FactoryBot.create(:gateway) }
+  let!(:template) {
+    {
+      distribution: {
+        name: 'Ubuntu',
+        release: '19.04',
+        codename: 'disco',
+        description: 'Ubuntu 19.04'
+      },
+      hostname: 'host.domain.tld',
+      ip_address: '10.0.1.1',
+      uptime: Time.now.to_i
+    }
+  }
+
+  describe 'write heartbeat' do
+    context 'validates that that heartbeats is written to correct collection' do
+      let!(:host_heartbeat) { host.add_heartbeat(template) }
+      let!(:gateway_heartbeat) { gateway.add_heartbeat(template) }
+
+      context 'for host' do
+        it { expect(host_heartbeat.hostname).to eq(template[:hostname]) }
+        it { expect(host_heartbeat.proprietor).to eq(host_id: host.id) }
+
+        context 'get heartbeat' do
+          let!(:heartbeat) { host.add_heartbeat(template) }
+          let!(:response) { host.get_heartbeat(heartbeat.id) }
+
+          it { expect(response.hostname).to eq(template[:hostname]) }
+          it { expect(response.proprietor).to eq("host_id" => host.id) }
+        end
+
+        context 'get heartbeats' do
+          let!(:response) { host.get_heartbeats }
+
+          it { expect(response.length).to eq(1) }
+        end
+
+        context 'find heartbeats' do
+          let!(:heartbeat) { host.add_heartbeat(template) }
+          let!(:heartbeat) { host.add_heartbeat(template) }
+          let!(:heartbeat3) { host.add_heartbeat(template) }
+          let!(:response) { host.find_heartbeats({ hostname: template[:hostname] }, { }) }
+
+          it { expect(response.length).to eq(3) }
+        end
+
+        context 'search heartbeats' do
+          before(:each) do
+            10.times do
+              host.add_heartbeat(template)
+            end
+          end
+
+          let!(:heartbeat) { host.add_heartbeat(template) }
+          let!(:heartbeat2) { host.add_heartbeat(template) }
+          let!(:response) { host.search_heartbeats(host.id, limit: 5) }
+
+          it { expect(response.length).to eq(5) }
+        end
+      end
+
+      context 'for gateway' do
+        it { expect(gateway_heartbeat.hostname).to eq(template[:hostname]) }
+        it { expect(gateway_heartbeat.proprietor).to eq(gateway_id: gateway.id) }
+
+        context 'get heartbeat' do
+          let!(:heartbeat) { gateway.add_heartbeat(template) }
+          let!(:response) { gateway.get_heartbeat(heartbeat.id) }
+
+          it { expect(response.id).to eq(heartbeat.id) }
+          it { expect(response.hostname).to eq(template[:hostname]) }
+          it { expect(response.proprietor).to eq("gateway_id" => gateway.id) }
+        end
+
+        context 'get heartbeats' do
+          let!(:response) { gateway.get_heartbeats }
+
+          it { expect(response.length).to eq(1) }
+        end
+
+        context 'find heartbeats' do
+          let!(:heartbeat) { gateway.add_heartbeat(template) }
+          let!(:heartbeat2) { gateway.add_heartbeat(template) }
+          let!(:heartbeat3) { gateway.add_heartbeat(template) }
+          let!(:response) { host.find_heartbeats({ hostname: template[:hostname] }, limit: 1) }
+
+          it { expect(response.length).to eq(1) }
+        end
+
+        context 'search heartbeats' do
+          before(:each) do
+            10.times do
+              gateway.add_heartbeat(template)
+            end
+          end
+          let!(:response) { gateway.search_heartbeats(gateway.id, limit: 5) }
+
+          it { expect(response.length).to eq(5) }
+        end
+      end
+    end
+  end
+end

data/spec/tracker_single_spec.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/host_document'
+
+
+describe Mongoid::Heartbeat::Tracker do
+  let(:host) { FactoryBot.create(:host) }
+  let(:host2) { FactoryBot.create(:host, hostname: 'host2.domain.tld') }
+  let!(:template) {
+    {
+      distribution: {
+        name: 'Ubuntu',
+        release: '19.04',
+        codename: 'disco',
+        description: 'Ubuntu 19.04'
+      },
+      hostname: 'host.domain.tld',
+      ip_address: '10.0.1.1',
+      uptime: Time.now.to_i
+    }
+  }
+
+  describe 'heartbeat' do
+    context 'add heartbeat' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+
+      it { expect(heartbeat.hostname).to eq(template[:hostname]) }
+      it { expect(heartbeat.proprietor).to eq(host_id: host.id) }
+    end
+
+    context 'get heartbeat' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+      let(:response) { host.get_heartbeat(heartbeat.id) }
+
+      it { expect(response.id).to eq(heartbeat.id) }
+      it { expect(response.hostname).to eq(heartbeat.hostname) }
+    end
+
+    context 'get heartbeats' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+      let!(:heartbeat2) { host.add_heartbeat(template) }
+      let(:response) { host.get_heartbeats }
+
+      it { expect(response.count).to eq(2) }
+    end
+
+    context 'find heartbeats' do
+      let(:response) { host.find_heartbeats({ hostname: host.hostname }, {}) }
+
+      before(:each) do
+        host.add_heartbeat(template.merge(hostname: host.hostname))
+        host.add_heartbeat(template.merge(hostname: host.hostname))
+        host.add_heartbeat(template.merge(hostname: 'foo.bar.tld'))
+      end
+
+      it { expect(response.count).to eq(2) }
+    end
+
+    context 'search heartbeats' do
+      before(:each) do
+        10.times do
+          host.add_heartbeat(template)
+        end
+
+        5.times do
+          host2.add_heartbeat(template)
+        end
+      end
+
+      context 'via id with limit' do
+        let(:response) { host.search_heartbeats(host.id.to_s, limit: 5) }
+
+        it { expect(response.count).to eq(5) }
+      end
+
+      context 'via hostname with limit' do
+        let(:response) { host.search_heartbeats(template[:hostname], limit: 10) }
+
+        it { expect(response.length).to eq(10) }
+      end
+    end
+
+    context 'edit heartbeat' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+
+      context 'updates message for the event' do
+        before(:each) do
+          host.edit_heartbeat(heartbeat.id, hostname: 'host3.domain.tld')
+        end
+
+        it { expect(host.get_heartbeat(heartbeat.id).hostname).to eq('host3.domain.tld') }
+      end
+    end
+
+    context 'delete heartbeat' do
+      let!(:heartbeat) { host.add_heartbeat(template) }
+
+      context 'deletes the event' do
+        before(:each) do
+          host.delete_heartbeat(heartbeat.id)
+        end
+
+        it { expect(host.get_heartbeat(heartbeat.id)).to be_nil }
+      end
+    end
+
+    context 'clear heartbeats' do
+      before(:each) do
+        10.times do
+          host.add_heartbeat(template)
+        end
+      end
+
+      it { expect(host.get_heartbeats.count).to be(10) }
+
+      context 'clear all event' do
+        before(:each) do
+          host.clear_heartbeats
+        end
+
+        it { expect(host.get_heartbeats.count).to be(0) }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: obscured-heartbeat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erik Hennerfors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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: 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Default database heartbeat ability
+email:
+- erik.hennerfors@obscured.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/obscured-heartbeat.rb
+- lib/obscured-heartbeat/record.rb
+- lib/obscured-heartbeat/service.rb
+- lib/obscured-heartbeat/tracker.rb
+- lib/obscured-heartbeat/version.rb
+- obscured-heartbeat.gemspec
+- spec/config/mongoid.yml
+- spec/factories/gateway_factory.rb
+- spec/factories/heartbeat_factory.rb
+- spec/factories/host_factory.rb
+- spec/helpers/gateway_document.rb
+- spec/helpers/host_document.rb
+- spec/helpers/host_service.rb
+- spec/host_service_spec.rb
+- spec/setup.rb
+- spec/tracker_multiple_spec.rb
+- spec/tracker_single_spec.rb
+homepage: https://github.com/gonace/Obscured.Heartbeat
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Default database heartbeat ability
+test_files:
+- spec/config/mongoid.yml
+- spec/factories/gateway_factory.rb
+- spec/factories/heartbeat_factory.rb
+- spec/factories/host_factory.rb
+- spec/helpers/gateway_document.rb
+- spec/helpers/host_document.rb
+- spec/helpers/host_service.rb
+- spec/host_service_spec.rb
+- spec/setup.rb
+- spec/tracker_multiple_spec.rb
+- spec/tracker_single_spec.rb