nexaas-auditor 1.0.0

data/lib/nexaas/auditor/stats_subscriber.rb

@@ -0,0 +1,17 @@
+module Nexaas
+  module Auditor
+    class StatsSubscriber < Subscriber
+
+      def tracker
+        Nexaas::Auditor.tracker
+      end
+
+      private
+
+      def event_method_name(name)
+        "track_event_#{name.downcase.gsub('.', '_')}"
+      end
+
+    end
+  end
+end

data/lib/nexaas/auditor/subscriber.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/class/subclasses'
+
+module Nexaas
+  module Auditor
+    class Subscriber
+
+      def self.subscribe_all
+        subscribers = []
+        subclasses.each do |klass|
+          subscribers << klass.subscribe()
+        end
+        subscribers
+      end
+
+      def self.subscribe(options={})
+        subscriber = options.fetch(:subscriber) { ::ActiveSupport::Notifications }
+        subscriber.subscribe(pattern, new)
+      end
+
+      def self.pattern
+        raise "Not Implemented, override in subclass and provide a regex or string."
+      end
+
+      # Dispatcher that converts incoming events to method calls.
+      def call(name, start, finish, event_id, payload)
+        method_name = event_method_name(name)
+        if respond_to?(method_name)
+          send(method_name, name, start, finish, event_id, payload)
+        end
+      end
+
+      private
+
+      def event_method_name(name)
+        raise "Not Implemented, override in subclass."
+      end
+
+    end
+  end
+end

data/lib/nexaas/auditor/version.rb

@@ -0,0 +1,5 @@
+module Nexaas
+  module Auditor
+    VERSION = "1.0.0"
+  end
+end

data/lib/nexaas/auditor.rb

@@ -0,0 +1,57 @@
+require 'active_support/notifications'
+
+require 'nexaas/auditor/version'
+require 'nexaas/auditor/configuration'
+require 'nexaas/auditor/subscriber'
+require 'nexaas/auditor/logs_subscriber'
+require 'nexaas/auditor/stats_subscriber'
+require 'nexaas/auditor/adapters/nunes'
+require 'nexaas/auditor/rails_subscriber'
+require 'nexaas/auditor/audit_logger'
+require 'nexaas/auditor/statistics_trackers/base'
+require 'nexaas/auditor/statistics_trackers/log'
+require 'nexaas/auditor/statistics_trackers/stathat'
+require 'nexaas/auditor/statistics_tracker'
+
+module Nexaas
+  module Auditor
+
+    extend SingleForwardable
+    # forwards Nexaas::Auditor.instrument to ActiveSupport::Notifications.instrument
+    single_delegate :instrument => ActiveSupport::Notifications
+
+    class << self
+
+      def configure
+        # if configuration.enabled has not been set yet (is still 'nil'), set to true.
+        configuration.enabled = true if configuration.enabled.nil?
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def logger
+        Thread.current[:_nexaas_auditor_logger] ||= AuditLogger.new
+      end
+
+      def tracker
+        Thread.current[:_nexaas_auditor_tracker] ||= StatisticsTracker.setup(
+          configuration.statistics_service,
+          configuration.statistics_namespace
+        )
+      end
+
+      def subscribe_all
+        subscribers = []
+        subscribers << LogsSubscriber.subscribe_all if configuration.log_app_events
+        subscribers << StatsSubscriber.subscribe_all if configuration.track_app_events
+        subscribers << RailsSubscriber.subscribe_all if configuration.track_rails_events
+        subscribers
+      end
+
+    end
+
+  end
+end

data/nexaas-auditor.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nexaas/auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nexaas-auditor"
+  spec.version       = Nexaas::Auditor::VERSION
+  spec.authors       = ["Rodrigo Tassinari de Oliveira"]
+  spec.email         = ["rodrigo@pittlandia.net"]
+
+  spec.summary       = %q{Common code for audit logs and statistcs tracking for Nexaas Rails apps, via ActiveSupport::Instrumentation.}
+  spec.description   = %q{Common code for audit logs and statistcs tracking for Nexaas Rails apps, via ActiveSupport::Instrumentation.}
+  spec.homepage      = "https://github.com/myfreecomm/nexaas-auditor"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "test_notifier", "~> 2.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: nexaas-auditor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rodrigo Tassinari de Oliveira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: test_notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Common code for audit logs and statistcs tracking for Nexaas Rails apps,
+  via ActiveSupport::Instrumentation.
+email:
+- rodrigo@pittlandia.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- lib/nexaas/auditor.rb
+- lib/nexaas/auditor/adapters/nunes.rb
+- lib/nexaas/auditor/audit_logger.rb
+- lib/nexaas/auditor/configuration.rb
+- lib/nexaas/auditor/logs_subscriber.rb
+- lib/nexaas/auditor/rails_subscriber.rb
+- lib/nexaas/auditor/statistics_tracker.rb
+- lib/nexaas/auditor/statistics_trackers/base.rb
+- lib/nexaas/auditor/statistics_trackers/log.rb
+- lib/nexaas/auditor/statistics_trackers/stathat.rb
+- lib/nexaas/auditor/stats_subscriber.rb
+- lib/nexaas/auditor/subscriber.rb
+- lib/nexaas/auditor/version.rb
+- nexaas-auditor.gemspec
+homepage: https://github.com/myfreecomm/nexaas-auditor
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Common code for audit logs and statistcs tracking for Nexaas Rails apps,
+  via ActiveSupport::Instrumentation.
+test_files: []