active_job_reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c09df3f74f6e36b4c812e7376ec9bf582453caa
+  data.tar.gz: 55e742befd0eac0b6c685da7a3da7d60dc5145e3
+SHA512:
+  metadata.gz: 2df2ecb5940484d8e6860fd605f15be109ec48ce2ef506b436b69b0911d310ccd22ec45a8328f8f3f55d9bafa2c5bdba0a46e00e431bef338f1e0b5aa5059106
+  data.tar.gz: 3d162bdd88acc9684dfe067c03a91c6718b9981f38de4c60edff56cdfc064837905229f6b1d71459a35039856117265f68c835ea4d895e0864c163ccc1c4f4c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Leonardo Diez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# Active Job Reporter
+Monitoring and reporting for ActiveJob.
+
+[![Gem](https://img.shields.io/gem/v/active_job_reporter.svg)](https://rubygems.org/gems/active_job_reporter)
+[![Travis](https://img.shields.io/travis/podemos-info/active_job_reporter/master.svg)](https://travis-ci.org/podemos-info/active_job_reporter)
+[![Codecov](https://img.shields.io/codecov/c/github/podemos-info/active_job_reporter.svg)](https://codecov.io/gh/podemos-info/active_job_reporter)
+
+## Features
+* Minimalistic approach to ActiveJob monitoring, database based to avoid additional dependencies.
+* Filter jobs by status (`enqueued`, `running` or `finished`), user, resource or result (`ok`, `error` or custom).
+* Messages log by job.
+* Automatic basic exception handling during errors.
+* Allows to override built-in Job model.
+
+## Usage
+
+1. Add `ReportableJob` concern to your jobs. You can add to `ApplicationJob` to avoid adding to every job. Jobs will be tracked automatically.
+
+```ruby
+include ActiveJobReporter::ReportableJob
+```
+
+2. Define `current_user` method in your jobs to relate them to users. Use `arguments` variable to retrieve `perform` call arguments. Using keyword arguments with the same name would allow you to define at `ApplicationJob`.
+
+```ruby
+def current_user
+  arguments.first&.fetch(:admin_user, nil)
+end
+```
+
+3. Define `related_objects` method in your jobs to relate them to other application records.
+
+```ruby
+def related_objects
+  [ arguments.first&.fetch(:order, nil), *arguments.first&.fetch(:items, []) ].compact
+end
+```
+
+4. Add log messages and result code inside your jobs `perform` methods. `log` method allows to specify type of message and complex messages (stored as JSON in database). Use `self.result` to store the result of the job (won't be saved until the end of the process). If not specified, result will be `:ok` or `:error`, when the `perform` method raises an exception.
+
+```ruby
+  def perform(**params)
+    if has_issues?
+      log :issues, raw: "raw test message"
+      self.result = :issues
+    end
+
+    if params[:raise]
+      a = 1 / 0
+    end
+
+    log :user, key: "test.user_message.#{result}", params: { user_id: 1, number: 12 }
+  end
+```
+
+5. Application models related to jobs can use the `HasJobs` concern to simplify access to them.
+
+```ruby
+class Resource < ApplicationRecord
+  include ActiveJobReporter::HasJobs
+end
+```
+
+Then, access to jobs can be made from `jobs` association method.
+
+```ruby
+2.4.1 :001 > Resource.first.jobs.count
+ => 1
+2.4.1 :002 > Resource.first.jobs.running.count
+ => 0
+```
+
+6. If an application `Job` model is needed (to extend it or avoid using a qualified name), it can be defined using the `JobConcern` concern and specifying the class name in the initializer file.
+
+```ruby
+# in app/models/job.rb
+class Job < ActiveRecord::Base
+  include ActiveJobReporter::JobConcern
+end
+
+# in config/initializers/active_job_reporter.rb
+ActiveJobReporter.configure do |config|
+  ...
+
+  # The class name for jobs
+  config.jobs_class_name = "Job"
+
+  ...
+end
+```
+
+## Installation
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_reporter'
+```
+
+2. Update bundle
+
+```bash
+$ bundle
+```
+
+3. Run installer 
+
+Add `jobs`, `job_objects` and `job_messages` tables to your database and an initializer file for configuration:
+
+```bash
+$ bundle exec rails generate active_job_reporter:install
+$ bundle exec rake db:migrate
+```
+
+## Changelog
+
+#### 0.1.0
+
+* First version.
+
+## Contributing
+Issues and PRs are welcomed.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "ActivejobReporter"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+task default: :spec

data/lib/active_job_reporter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "active_job_reporter/version"
+require "active_job_reporter/configuration"
+require "active_job_reporter/core"
+require "active_job_reporter/job_concern"
+require "active_job_reporter/has_jobs"
+require "active_job_reporter/reportable_job"
+require "active_job_reporter/engine" if defined?(Rails::Engine)
+require "active_job_reporter/defaults"

data/lib/active_job_reporter/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  class Configuration
+    attr_accessor :jobs_table_name, :user_class_name, :job_class_name
+
+    def user_class
+      @user_class ||= user_class_name.constantize
+    end
+  end
+end

data/lib/active_job_reporter/core.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  module_function
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    configuration.instance_eval(&Proc.new)
+  end
+end

data/lib/active_job_reporter/defaults.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ActiveJobReporter.configure do |config|
+  config.jobs_table_name = "jobs"
+  config.user_class_name = "User"
+  config.job_class_name = "ActiveJobReporter::Job"
+end

data/lib/active_job_reporter/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  class Engine < ::Rails::Engine
+    paths["app/models"] << "lib/active_job_reporter/models"
+  end
+end

data/lib/active_job_reporter/has_jobs.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveJobReporter
+  module HasJobs
+    extend ::ActiveSupport::Concern
+
+    included do
+      has_many :job_objects, as: :object, class_name: "ActiveJobReporter::JobObject"
+      has_many :jobs, through: :job_objects, class_name: ActiveJobReporter.configuration.job_class_name
+    end
+  end
+end

data/lib/active_job_reporter/job_concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveJobReporter
+  module JobConcern
+    extend ::ActiveSupport::Concern
+
+    included do
+      self.table_name = ActiveJobReporter.configuration.jobs_table_name
+
+      enum status: [:enqueued, :running, :finished]
+
+      validates :job_id, :job_type, presence: true
+
+      has_many :job_objects
+
+      has_many :messages, foreign_key: "job_id", class_name: "ActiveJobReporter::JobMessage"
+
+      belongs_to :user, class_name: ActiveJobReporter.configuration.user_class, optional: true
+    end
+
+    def add_message(type:, message:)
+      messages << JobMessage.create(message_type: type, message: message)
+    end
+  end
+end

data/lib/active_job_reporter/models/active_job_reporter/job.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  class Job < ActiveRecord::Base
+    include ActiveJobReporter::JobConcern
+  end
+end

data/lib/active_job_reporter/models/active_job_reporter/job_message.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  class JobMessage < ActiveRecord::Base
+    store :message, coder: JSON
+
+    belongs_to :job
+
+    validates :message_type, :message, presence: true
+  end
+end

data/lib/active_job_reporter/models/active_job_reporter/job_object.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  class JobObject < ActiveRecord::Base
+    belongs_to :job
+    belongs_to :object, polymorphic: true
+  end
+end

data/lib/active_job_reporter/reportable_job.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveJobReporter
+  module ReportableJob
+    extend ::ActiveSupport::Concern
+
+    included do
+      before_enqueue do |job|
+        job.update_status(:enqueued)
+      end
+
+      around_perform do |job, block|
+        job.update_status(:running)
+        begin
+          job.result = :ok
+          block.call
+        rescue StandardError => err
+          job.log :error, raw: err.message
+          job.result = :error
+          raise
+        ensure
+          job.update_status(:finished)
+        end
+      end
+    end
+
+    def update_status(status)
+      job_record.status = status
+      job_record.save
+    end
+
+    def result
+      job_record.result.to_sym
+    end
+
+    def result=(result)
+      job_record.result = result
+    end
+
+    def log(type, **message)
+      job_record.add_message type: type, message: message
+    end
+
+    private
+
+    def job_record
+      @job_record ||= ActiveJobReporter::Job.find_or_initialize_by(job_id: job_id) do |job_record|
+        job_record.job_type = self.class.name
+        job_record.user = current_user if respond_to? :current_user
+        if respond_to? :related_objects
+          (related_objects || []).each do |object|
+            job_record.job_objects.build(object: object)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_job_reporter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveJobReporter
+  VERSION = "0.1.0"
+end

data/lib/activejob_reporter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActivejobReporter
+  VERSION = "0.1.0"
+end

data/lib/generators/active_job_reporter/install_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module ActiveJobReporter
+  # Installs ActiveJobReporter in a rails app.
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    class_option(
+      :jobs_table_name,
+      type: :string,
+      default: "jobs",
+      desc: "Jobs table name, `jobs` by default."
+    )
+
+    desc "Generates an initializer file for configuring ActiveJobReporter." \
+         "Also generates a migration to add jobs tables."
+
+    def create_migration_file
+      migration_template "create_jobs.rb.erb", File.join("db", "migrate", "create_jobs.rb")
+    end
+
+    def create_initializer
+      template "active_job_reporter.rb.erb", File.join("config", "initializers", "active_job_reporter.rb")
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+
+    def jobs_table_name
+      options.jobs_table_name
+    end
+  end
+end

data/lib/generators/active_job_reporter/templates/active_job_reporter.rb.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+ActiveJobReporter.configure do |config|
+  config.jobs_table_name = "<%= jobs_table_name %>"
+
+  # The class name for jobs
+  # config.jobs_class_name = "ActiveJobReporter::Job"
+
+  # The class name for users that will launch jobs
+  # config.user_class_name = "User"
+end

data/lib/generators/active_job_reporter/templates/create_jobs.rb.erb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# This migration creates the `<%= jobs_table_name %>` table.
+class CreateJobs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= jobs_table_name %> do |t|
+      t.string :job_id, null: false
+      t.string :job_type, null: false
+      t.integer :status, null: false, index: true
+      t.text :result
+      t.integer :user_id, index: true
+      t.timestamps
+    end
+
+    add_index :<%= jobs_table_name %>, [:job_id], unique: true
+
+    create_table :<%= jobs_table_name.singularize %>_objects do |t|
+      t.belongs_to :job, foreign_key: { to_table: :<%= jobs_table_name %> }, index: true
+      t.belongs_to :object, polymorphic: true, index: true
+    end
+
+    create_table :<%= jobs_table_name.singularize %>_messages do |t|
+      t.belongs_to :job, foreign_key: { to_table: :<%= jobs_table_name %> }, index: true
+      t.string :message_type, null: false
+      t.datetime :created_at, null: false
+      t.text :message, null: false
+    end
+  end
+end

data/lib/tasks/active_job_reporter_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :activejob_reporter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: active_job_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonardo Diez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Monitoring and reporting for ActiveJob.
+email:
+- leiodd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_job_reporter.rb
+- lib/active_job_reporter/configuration.rb
+- lib/active_job_reporter/core.rb
+- lib/active_job_reporter/defaults.rb
+- lib/active_job_reporter/engine.rb
+- lib/active_job_reporter/has_jobs.rb
+- lib/active_job_reporter/job_concern.rb
+- lib/active_job_reporter/models/active_job_reporter/job.rb
+- lib/active_job_reporter/models/active_job_reporter/job_message.rb
+- lib/active_job_reporter/models/active_job_reporter/job_object.rb
+- lib/active_job_reporter/reportable_job.rb
+- lib/active_job_reporter/version.rb
+- lib/activejob_reporter/version.rb
+- lib/generators/active_job_reporter/install_generator.rb
+- lib/generators/active_job_reporter/templates/active_job_reporter.rb.erb
+- lib/generators/active_job_reporter/templates/create_jobs.rb.erb
+- lib/tasks/active_job_reporter_tasks.rake
+homepage: https://github.com/podemos-info/active_job_reporter
+licenses:
+- MIT
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Monitoring and reporting for ActiveJob.
+test_files: []