obscured-timeline 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0e1584c8287352150fb7ec886112dadb191da1dda84f12221c17d02b9ea3b56
+  data.tar.gz: 6db5ea73e99f2d7ee20bbbe14d9e2ff36752dd32e8f4487345fd252966c7bd34
+SHA512:
+  metadata.gz: d447fec014fe51a9d58397bccbc79b0754fccf8102e80fe3a36a4ec2b111101a3958b11baa6415c237f9724f8c00727d0bedd075987894b2f8b38653eba3801f
+  data.tar.gz: a457a5e1aac0222ab6c3b144294faf4c64b0621f11fed394cdd2a069aaf1c59b6535e45bfe186a023922e5ad34c0a8f5ee0d6ee3ce69bd75797d901aab752fbc

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/.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-timeline

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

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=2a254563f48d490eab9b9e9682ea30c8b13d221d06bb1fed6e3c045124b49e6c
+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-timeline.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    obscured-timeline (1.0.0)
+      activesupport
+      mongoid
+      mongoid_search
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    bson (4.8.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    fast-stemmer (1.0.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    mongo (2.11.4)
+      bson (>= 4.4.2, < 5.0.0)
+    mongoid (7.1.0)
+      activemodel (>= 5.1, < 6.1)
+      mongo (>= 2.7.0, < 3.0.0)
+    mongoid_search (0.3.6)
+      fast-stemmer (~> 1.0.0)
+      mongoid (>= 3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_bot
+  obscured-timeline!
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,94 @@
+[![Vulnerabilities](https://snyk.io/test/github/gonace/obscured.timeline/badge.svg)](https://snyk.io/test/github/gonace/obscured.timeline)
+[![Build Status](https://travis-ci.org/gonace/Obscured.Timeline.svg?branch=master)](https://travis-ci.org/gonace/Obscured.Timeline)
+[![Test Coverage](https://codeclimate.com/github/gonace/Obscured.Timeline/badges/coverage.svg)](https://codeclimate.com/github/gonace/Obscured.Timeline)
+[![Code Climate](https://codeclimate.com/github/gonace/Obscured.Timeline/badges/gpa.svg)](https://codeclimate.com/github/gonace/Obscured.Timeline)
+
+# Obscured::Timeline
+## Introduction
+Obscured timeline adds event to a separate collection for an entity (Document), the naming of the class (Mongoid Document) is used for naming the timeline collection, so if the class is named "Account" the collection name will end up being "account_timeline".
+
+## Installation
+### Requirements
+- activesupport
+- mongoid
+- mongoid_search
+
+##### Add this line to your application's Gemfile
+```ruby
+gem 'obscured-timeline', :git => 'https://github.com/gonace/Obscured.Timeline.git', :branch => 'master'
+```
+
+##### Execute
+```
+$ bundle
+```
+
+### Usage
+#### Base
+Use this in files where you create non-default log collections.
+```ruby
+require 'obscured-timeline'
+```
+
+
+### Example
+#### Document
+```ruby
+require 'obscured-timeline'
+
+module Obscured
+  class Account
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Obscured::Timeline::Tracker
+    
+    field :name, type: String
+    field :email, type: String
+    field :locked, type: Boolean, default: false
+  end
+
+  def lock!
+    self.locked = true
+    self.add_event(type: :security, message: "Account has been locked!", producer: self.username)
+    save
+  end
+end
+
+
+account = Obscured::Account.create(:name => "John Doe", :email => "john.doe@obscured.se")
+event = account.add_event(type: :comment, message: "Lorem ipsum dolor sit amet?", producer: "homer.simpson@obscured.se")
+
+#returns array of events for document (proprietor)
+account.get_events 
+
+#returns event by id
+account.get_event(event.id.to_s)
+
+#returns array of events by predefined params, supports pagination
+account.find_events({ type: nil, producer: nil }, { limit: 20, skip: 0, order: :created_at.desc, only: [:id, :type, :message, :producer, :created_at, :updated_at, :proprietor] })
+
+#retuns array of events
+account.search_events("homer.simpson@obscured.se", { type: :comment, limit: 20, skip: 0, order: :created_at.desc }) 
+```
+
+#### Service
+```ruby
+module Obscured
+  class AccountTimelineService
+    include Mongoid::Timeline::Service::Base
+  end
+end
+
+module Obscured
+  class AccountSynchronizer
+    def initialize(account)
+      @account = account
+      @service = Obscured::AccountTimelineService.new
+    end
+
+    def timeline
+      @service.by(proprietor: { account_id: account.id })
+    end
+  end
+end
+```

data/lib/obscured-timeline.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-timeline/record'
+require 'obscured-timeline/service'
+require 'obscured-timeline/tracker'
+
+module Mongoid
+  module Timeline
+  end
+end

data/lib/obscured-timeline/record.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+require 'mongoid_search'
+
+module Mongoid
+  module Timeline
+    module Record
+      extend ActiveSupport::Concern
+
+      included do
+        include Mongoid::Document
+        include Mongoid::Search
+        include Mongoid::Timestamps
+
+        field :type, type: Symbol
+        field :severity, type: Symbol, default: :informational
+        field :message, type: String
+        field :producer, type: String
+        field :proprietor, type: Hash
+
+        index({ type: 1 }, background: true)
+        index({ producer: 1 }, background: true)
+        index({ _keywords: 1 }, background: true)
+
+        search_in :id, :type, :producer
+      end
+
+      module ClassMethods
+        def make(params = {})
+          raise ArgumentError, 'type missing' if params[:type].blank?
+          raise ArgumentError, 'type must be a symbol' unless params[:type].instance_of?(Symbol)
+          raise ArgumentError, 'message missing' if params[:message].nil?
+          raise ArgumentError, 'producer missing' if params[:producer].blank?
+          raise ArgumentError, 'proprietor missing' if params[:proprietor].blank?
+
+          doc = new
+          doc.type = params[:type]
+          doc.severity = params[:severity].to_sym unless params[:severity].blank?
+          doc.message = params[:message]
+          doc.producer = params[:producer]
+          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 type message producer created_at updated_at proprietor] : options[:only]
+
+          query = {}
+          query[:type] = params[:type].to_sym if params[:type]
+          query[:severity] = params[:severity].to_sym if params[:severity]
+          query[:producer] = params[:producer].to_sym if params[:producer]
+          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-timeline/service.rb

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

data/lib/obscured-timeline/tracker.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Mongoid
+  module Timeline
+    module Tracker
+      extend ActiveSupport::Concern
+
+      class Record
+        include Mongoid::Timeline::Record
+      end
+
+      # Adds event to the x_timeline collection for document. This is
+      # only called on manually.
+      #
+      # @example Add event.
+      #   document.add_event
+      #
+      # @return [ document ]
+      def add_event(event)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.make!(event.merge(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id }))
+        end
+      end
+
+      # Get an event from the x_timeline collection for document. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.get_event(id)
+      #
+      # @return [ document ]
+      def get_event(id)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.find(id)
+        end
+      end
+
+      # Get events from the x_timeline collection for document by proprietor. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.get_events
+      #   document.events
+      #
+      # @return [ documents ]
+      def get_events
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.by(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id })
+        end
+      end
+      alias events get_events
+
+      # Find events from the x_timeline collection for document. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.find_events(params, options)
+      #
+      # @return [ documents ]
+      def find_events(params, options)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.by({ proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id } }.merge(params), options)
+        end
+      end
+
+      # Search events from the x_timeline collection for document. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.search_events(text, options)
+      #
+      # @return [ documents ]
+      def search_events(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}_timeline") do |m|
+          query = {}
+          query[:type] = options[:type].to_sym if options[:type]
+          query[:severity] = options[:severity].to_sym if options[:severity]
+
+          criteria = m.where(query).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 event from the x_timeline collection by id. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.edit_event(id, params)
+      #
+      # @return [ document ]
+      def edit_event(id, params = {})
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          event = m.where(id: id).first
+          event.message = params[:message] if params[:message]
+          event.save
+          event
+        end
+      end
+
+      # Delete an event from the x_timeline collection by id. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.get_event(id)
+      #
+      # @return [ document ]
+      def delete_event(id)
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.where(id: id).delete
+        end
+      end
+
+      # Clear events from the x_timeline collection for document. This is
+      # only called on manually.
+      #
+      # @example Get event.
+      #   document.clear_events
+      #
+      # @return [ documents ]
+      def clear_events
+        Record.with(collection: "#{self.class.name.demodulize.downcase}_timeline") do |m|
+          m.where(proprietor: { "#{self.class.name.demodulize.downcase}_id".to_sym => id }).delete
+        end
+      end
+    end
+  end
+end

data/lib/obscured-timeline/version.rb

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

data/obscured-timeline.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'obscured-timeline/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'obscured-timeline'
+  gem.version       = Mongoid::Timeline::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.licenses      = ['MIT']
+  gem.authors       = ['Erik Hennerfors']
+  gem.email         = ['erik.hennerfors@obscured.se']
+  gem.description   = 'Mongoid extension to handles a timeline of events for an entity (e.g. User)'
+  gem.summary       = 'Mongoid extension that adds the ability to handle events in a timeline for a entity (e.g. User)'
+  gem.homepage      = 'https://github.com/gonace/Obscured.Timeline'
+
+  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/account_service_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/account_document'
+require_relative 'helpers/account_service'
+
+
+describe Mongoid::Timeline::Service::Account do
+  let!(:account) { Obscured::Account.new(email: 'homer.simpsons@obscured.se') }
+  let!(:message) { 'Praesent a massa dui. Etiam eget purus consequat, mollis erat et, rhoncus tortor.' }
+  let!(:service) { Mongoid::Timeline::Service::Account.new }
+
+  before(:each) do
+    2.times do
+      account.add_event(type: :event, message: message, producer: account.email)
+    end
+    5.times do
+      account.add_event(type: :comment, message: message, producer: account.email)
+    end
+    5.times do
+      account.add_event(type: :change, message: message, producer: account.email)
+    end
+  end
+
+  describe 'all' do
+    let(:response) { service.all }
+
+    it { expect(response.count).to eq(12) }
+  end
+
+  describe 'find' do
+    let!(:event) { account.add_event(type: :change, message: message, producer: account.id) }
+    let(:response) { service.find(event.id) }
+
+    it { expect(response).to_not be(nil) }
+    it { expect(response.id).to eq(event.id) }
+  end
+
+  describe 'find_by' do
+    let!(:event) { account.add_event(type: :change, message: message, producer: account.id) }
+    let(:response) { service.find_by(type: :change) }
+
+    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: { account_id: account.id }) }
+
+      it { expect(response.length).to eq(12) }
+    end
+
+    context 'type' do
+      let(:response) { service.by(type: :comment) }
+
+      it { expect(response.count).to eq(5) }
+    end
+
+    context 'proprietor and type' do
+      let(:response) { service.by(type: :event, proprietor: { account_id: account.id }) }
+
+      it { expect(response.length).to eq(2) }
+    end
+  end
+
+  describe 'where' do
+    context 'returns correct documents' do
+      let(:response) { service.where(type: :event) }
+
+      it { expect(response.count).to eq(2) }
+    end
+  end
+
+  describe 'delete' do
+    context 'deletes document by id' do
+      let!(:event) { account.add_event(type: :change, message: message, producer: account.id) }
+
+      it { expect(service.delete(event.id.to_s)).to eq(1) }
+    end
+  end
+end

data/spec/config/mongoid.yml

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

data/spec/factories/event_factory.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/obscured-timeline/record'
+
+FactoryBot.define do
+  factory :event, class: Mongoid::Timeline::Record do
+    type { :comment }
+    message { 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.' }
+    producer { 'homer.simpson@obscured.se' }
+    proprietor { {} }
+
+
+    trait :as_comment do
+      type { :comment }
+    end
+
+    trait :as_change do
+      type { :change }
+    end
+
+    trait :with_account do
+      proprietor { { account_id: BSON::ObjectId.new } }
+    end
+  end
+end

data/spec/helpers/account_document.rb

@@ -0,0 +1,11 @@
+module Obscured
+  class Account
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Timeline::Tracker
+
+    store_in collection: "accounts"
+
+    field :email, type: String
+  end
+end

data/spec/helpers/account_service.rb

@@ -0,0 +1,9 @@
+module Mongoid
+  module Timeline
+    module Service
+      class Account
+        include Mongoid::Timeline::Service::Base
+      end
+    end
+  end
+end

data/spec/helpers/organization_document.rb

@@ -0,0 +1,11 @@
+module Obscured
+  class Organization
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Timeline::Tracker
+
+    store_in collection: "organizations"
+
+    field :name, type: String
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Pull in test utilities
+require 'simplecov'
+require 'factory_bot'
+require 'pp'
+require 'rspec'
+
+# pull in the code
+require_relative '../lib/obscured-timeline'
+
+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,109 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/account_document'
+require_relative 'helpers/organization_document'
+
+
+describe Mongoid::Timeline::Tracker do
+  let!(:account_email) { 'homer.simpson@obscured.se' }
+  let!(:message) { 'Praesent a massa dui. Etiam eget purus consequat, mollis erat et, rhoncus tortor.' }
+  let(:account) { Obscured::Account.new(email: account_email) }
+  let(:organization) { Obscured::Organization.new(name: 'adeprimose') }
+
+  describe 'write event' do
+    context 'validates that that events is written to correct collection' do
+      before(:each) do
+        account.save!
+        organization.save
+      end
+      let!(:account_event) { account.add_event(type: :comment, message: message, producer: account.email) }
+      let!(:organization_event) { organization.add_event(type: :change, message: message, producer: account.email) }
+
+      context 'for account' do
+        it { expect(account_event.type).to eq(:comment) }
+        it { expect(account_event.message).to eq(message) }
+        it { expect(account_event.proprietor).to eq(account_id: account.id) }
+
+        context 'get event' do
+          let!(:event) { account.add_event(type: :comment, message: message, producer: account.email) }
+          let!(:response) { account.get_event(event.id) }
+
+          it { expect(response.id).to eq(event.id) }
+          it { expect(response.type).to eq(event.type) }
+          it { expect(response.message).to eq(event.message) }
+        end
+
+        context 'get events' do
+          let!(:response) { account.get_events }
+
+          it { expect(response.count).to eq(1) }
+        end
+
+        context 'find events' do
+          let!(:event) { account.add_event(type: :comment, message: message, producer: account.email) }
+          let!(:event2) { account.add_event(type: :foobar, message: message, producer: account.email) }
+          let!(:event3) { account.add_event(type: :foobar, message: message, producer: account.email) }
+          let!(:response) { account.find_events({ type: :foobar }, { }) }
+
+          it { expect(response.count).to eq(2) }
+        end
+
+        context 'search events' do
+          before(:each) do
+            10.times do
+              account.add_event(type: :comment, message: message, producer: account.email)
+            end
+          end
+
+          let!(:event) { account.add_event(type: :comment, message: message, producer: account.email) }
+          let!(:event2) { account.add_event(type: :comment, message: message, producer: account.email) }
+          let!(:response) { account.search_events(account.email, limit: 5) }
+
+          it { expect(response.count).to eq(5) }
+        end
+      end
+
+      context 'for organization' do
+        it { expect(organization_event.type).to eq(:change) }
+        it { expect(organization_event.message).to eq(message) }
+        it { expect(organization_event.proprietor).to eq(organization_id: organization.id) }
+
+        context 'get event' do
+          let!(:event) { organization.add_event(type: :comment, message: message, producer: organization.id) }
+          let!(:response) { organization.get_event(event.id) }
+
+          it { expect(response.id).to eq(event.id) }
+          it { expect(response.type).to eq(event.type) }
+          it { expect(response.message).to eq(event.message) }
+        end
+
+        context 'get events' do
+          let!(:response) { organization.get_events }
+
+          it { expect(response.count).to eq(1) }
+        end
+
+        context 'find events' do
+          let!(:event) { organization.add_event(type: :comment, message: message, producer: organization.id) }
+          let!(:event2) { organization.add_event(type: :foobar, message: message, producer: organization.id) }
+          let!(:event3) { organization.add_event(type: :foobar, message: message, producer: organization.id) }
+          let!(:response) { account.find_events({ type: :comment }, limit: 1) }
+
+          it { expect(response.count).to eq(1) }
+        end
+
+        context 'search events' do
+          before(:each) do
+            10.times do
+              organization.add_event(type: :comment, message: message, producer: organization.id)
+            end
+          end
+          let!(:response) { organization.search_events(organization.id, limit: 5) }
+
+          it { expect(response.count).to eq(5) }
+        end
+      end
+    end
+  end
+end

data/spec/tracker_single_spec.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+require_relative 'helpers/account_document'
+
+
+describe Mongoid::Timeline::Tracker do
+  let!(:account_email) { 'homer.simpson@obscured.se' }
+  let!(:type) { :comment }
+  let!(:message) { 'Praesent a massa dui. Etiam eget purus consequat, mollis erat et, rhoncus tortor.' }
+  let(:account) { Obscured::Account.new(email: account_email) }
+
+  describe 'event' do
+    before(:each) do
+      account.save!
+    end
+
+    context 'add event' do
+      let!(:event) { account.add_event(type: type, message: message, producer: account.id) }
+
+      it { expect(event.type).to eq(type) }
+      it { expect(event.message).to eq(message) }
+      it { expect(event.proprietor).to eq(account_id: account.id) }
+    end
+
+    context 'get event' do
+      let!(:event) { account.add_event(type: type, message: message, producer: account.id) }
+      let(:response) { account.get_event(event.id) }
+
+      it { expect(response.id).to eq(event.id) }
+      it { expect(response.type).to eq(event.type) }
+      it { expect(response.message).to eq(event.message) }
+    end
+
+    context 'get events' do
+      let!(:event) { account.add_event(type: type, message: message, producer: account.id) }
+      let!(:event2) { account.add_event(type: type, message: message, producer: account.id) }
+      let(:response) { account.get_events }
+
+      it { expect(response.count).to eq(2) }
+    end
+
+    context 'find events' do
+      let(:response) { account.find_events({ type: :comment }, { }) }
+
+      before(:each) do
+        account.add_event(type: :comment, message: message, producer: account.id)
+        account.add_event(type: :comment, message: message, producer: account.id)
+        account.add_event(type: :foobar, message: message, producer: account.id)
+      end
+
+      it { expect(response.count).to eq(2) }
+    end
+
+    context 'search events' do
+      before(:each) do
+        5.times do
+          account.add_event(type: :payment, message: message, producer: account.id)
+        end
+
+        10.times do
+          account.add_event(type: :comment, message: message, producer: account.id)
+        end
+      end
+
+      context 'with limit' do
+        let(:response) { account.search_events(account.id, limit: 5) }
+
+        it { expect(response.count).to eq(5) }
+      end
+
+      context 'with limit and type' do
+        let(:response) { account.search_events(account.id, limit: 10, type: :payment) }
+
+        it { expect(response.count).to eq(10) }
+      end
+    end
+
+    context 'edit event' do
+      let!(:event) { account.add_event(type: type, message: message, producer: account.id) }
+
+      context 'updates message for the event' do
+        before(:each) do
+          account.edit_event(event.id, message: 'This is is a new message')
+        end
+
+        it { expect(account.get_event(event.id).message).to eq('This is is a new message') }
+      end
+    end
+
+    context 'delete event' do
+      let!(:event) { account.add_event(type: type, message: message, producer: account.id) }
+
+      context 'deletes the event' do
+        before(:each) do
+          account.delete_event(event.id)
+        end
+
+        it { expect(account.get_event(event.id)).to be_nil }
+      end
+    end
+
+    context 'clear events' do
+      before(:each) do
+        2.times do
+          account.add_event(type: :event, message: message, producer: account.email)
+        end
+        5.times do
+          account.add_event(type: :comment, message: message, producer: account.email)
+        end
+        5.times do
+          account.add_event(type: :change, message: message, producer: account.email)
+        end
+      end
+
+      it { expect(account.get_events.count).to be(12) }
+
+      context 'clear all event' do
+        before(:each) do
+          account.clear_events
+        end
+
+        it { expect(account.get_events.count).to be(0) }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: obscured-timeline
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erik Hennerfors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-20 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: Mongoid extension to handles a timeline of events for an entity (e.g.
+  User)
+email:
+- erik.hennerfors@obscured.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/obscured-timeline.rb
+- lib/obscured-timeline/record.rb
+- lib/obscured-timeline/service.rb
+- lib/obscured-timeline/tracker.rb
+- lib/obscured-timeline/version.rb
+- obscured-timeline.gemspec
+- spec/account_service_spec.rb
+- spec/config/mongoid.yml
+- spec/factories/event_factory.rb
+- spec/helpers/account_document.rb
+- spec/helpers/account_service.rb
+- spec/helpers/organization_document.rb
+- spec/setup.rb
+- spec/tracker_multiple_spec.rb
+- spec/tracker_single_spec.rb
+homepage: https://github.com/gonace/Obscured.Timeline
+licenses:
+- MIT
+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: Mongoid extension that adds the ability to handle events in a timeline for
+  a entity (e.g. User)
+test_files:
+- spec/account_service_spec.rb
+- spec/config/mongoid.yml
+- spec/factories/event_factory.rb
+- spec/helpers/account_document.rb
+- spec/helpers/account_service.rb
+- spec/helpers/organization_document.rb
+- spec/setup.rb
+- spec/tracker_multiple_spec.rb
+- spec/tracker_single_spec.rb