thecore_background_jobs 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee01019e2607dbaff7a4a46a87b61ee683fe8f8a9c4d5df41c2b470b4b034db0
-  data.tar.gz: e4635d0e13829866e0346f94216b252a656f45ad69f88a2c9510a4cc6cb0901e
+  metadata.gz: af6494d8654aefdbec32dc6b96ffbd27626e627c99f7892c3311edbfdcc76c9f
+  data.tar.gz: 3979727c571745860488e5ac7d3f71777932f8bfa05bf3b243b8737c5444e30f
 SHA512:
-  metadata.gz: c3c1fd37a029cef7107cd6a362a079661a2f2ef1f9abca2847d652afb6b6908ace2c2df7e8f78233c87cd109193446f7de31e0ac734d06da6e68b83311c5a934
-  data.tar.gz: f13d71b0a66a81abc7a5f0512415aaec231bc44cee147e6186cf062bad9d34963603ed3df6d35926c7d85e56f521adf8863558b384b82bb867d55c7a717b536b
+  metadata.gz: a25e00814257c2569c157ac5cd3be4119670e761ec2be11e8c91b262b37d922463b27eb965fdbf6fa620e66c1f5245bf8918cb0dd239e179bb9ae7fef810506b
+  data.tar.gz: 0f359b0dd89b545146ed2c1f16b12d766455d02e85637bf7e766285af7bcf88e7a60f074c53f8ac88a4b4e6029759da33ad024dc16c894b1179a124b92edee46

data/README.md

@@ -1,64 +1,28 @@
-Dependencies
-------------
+# ThecoreBackgroundJobs
+Short description and motivation.
 
-This gem depends on tiny\_tds, which depends on some debian packages to
-be installed:
+## Usage
+How to use my plugin.
 
-    sudo apt install freetds-dev redis-server
+## Installation
+Add this line to your application's Gemfile:
 
-Sidekiq setup
--------------
+```ruby
+gem "thecore_background_jobs"
+```
 
-The following script asks for the installation directory of the main Thecore App and from that it retrieves the needed information.
+And then execute:
+```bash
+$ bundle
+```
 
-    echo "Please provide the path to the app:";read APPPATH
-    APPNAME=$(basename "$APPPATH")
-    CURDIR=$(pwd)
-    cd $APPPATH
-    BUNDLEBIN=$(which bundle)
-    cd $CURDIR
-    cat <<EOM | sudo tee "/lib/systemd/system/sidekiq-$APPNAME.service"
-    [Unit]
-    Description=sidekiq-$APPNAME
-    After=syslog.target network.target redis-server.service
+Or install it yourself as:
+```bash
+$ gem install thecore_background_jobs
+```
 
-    [Service]
-    WorkingDirectory=$APPPATH
-    ExecStart=$BUNDLEBIN exec "sidekiq -e production" 
-    User=${SUDO_USER:-$(whoami)}
-    Type=simple
-    RestartSec=1
-    Restart=on-failure
+## Contributing
+Contribution directions go here.
 
-    # output goes to /var/log/syslog
-    StandardOutput=syslog
-    StandardError=syslog
-    SyslogIdentifier=sidekiq-$APPNAME
-
-    [Install]
-    WantedBy=multi-user.target
-    EOM
-
-Then enable it:
-
-    sudo systemctl enable sidekiq-$APPNAME
-
-and start:
-
-    sudo service sidekiq-$APPNAME start
-
-Now you can access the web ui, i.e.
-
-    https://yourtld/sidekiq
-
-And you can manually test it in rails console:
-
-    RAILS_ENV=production rails runner ImportFromFtpWorker.perform_async
-
-If you'd like to have the scheduled job run repeatedly, then add
-**config/sidekiq.yml** with content like:
-
-    schedule:
-      hello_world:
-        cron: '0 * * * * *'   # Runs once per minute
-        class: HelloWorld
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,36 +1,3 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+require "bundler/setup"
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ThecoreBackgroundJobs'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test
+require "bundler/gem_tasks"

data/app/workers/demo_worker.rb

@@ -1,8 +1,8 @@
 class DemoWorker
-  include Sidekiq::Worker
-  sidekiq_options retry: false, queue: "#{ENV["COMPOSE_PROJECT_NAME"]}_default"
-
-  def perform(*args)
-    puts "Worker is working"
-  end
+    include Sidekiq::Worker
+    sidekiq_options retry: false, queue: "#{ENV["COMPOSE_PROJECT_NAME"]}_default"
+    
+    def perform(*args)
+        puts "Worker is working"
+    end
 end

data/config/initializers/abilities.rb

@@ -0,0 +1,14 @@
+module Abilities
+    class ThecoreBackgroundJobs
+        include CanCan::Ability
+        def initialize user
+            # Main abilities file for Thecore applications
+            if user.present?
+                # Users' abilities
+                if user.admin?
+                    # Admins' abilities
+                end
+            end
+        end
+    end
+end

data/config/initializers/add_to_db_migrations.rb

@@ -0,0 +1 @@
+Rails.application.config.paths['db/migrate'] << File.expand_path("../../db/migrate", __dir__)

data/config/initializers/after_initialize.rb

@@ -0,0 +1,6 @@
+Rails.application.configure do
+    config.after_initialize do
+        ThecoreBackgroundJobs.update_cron_schedules
+        ThecoreSettings::Setting.send(:include, ThecoreBackgroundSettingsConcern)
+    end
+end

data/config/initializers/concern_thecore_settings.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module ThecoreBackgroundSettingsConcern
+    extend ActiveSupport::Concern
+    included do
+        after_save :reload_schedules, if: :saved_change_to_raw?
+        
+        def reload_schedules
+            # Reload changes to schedule
+            ThecoreBackgroundJobs.update_cron_schedules if self.ns == "schedules" && !self.raw.blank?
+        end
+    end
+end

data/config/initializers/{sidekiq-thecore.rb → queues_config.rb}

@@ -1,14 +1,3 @@
-# require 'sidekiq'
-
-# current_db = rand(1..15)
-
-# Sidekiq.configure_server do |config|
-#     config.redis = { :namespace => "#{ENV['COMPOSE_PROJECT_NAME'] || 'notset'}", :url => "#{ENV['REDIS_URL']}/#{current_db}" }
-# end
-# Sidekiq.configure_client do |config|
-#     config.redis = { :namespace => "#{ENV['COMPOSE_PROJECT_NAME'] || 'notset'}", :url => "#{ENV['REDIS_URL']}/#{current_db}" }
-# end
-
 # Set the default queue name for the analysis job to the queue adapter default.
 Rails.application.config.active_storage.queues.analysis = "#{ENV['COMPOSE_PROJECT_NAME'] || 'notset'}_storage_analysis"
 

data/config/routes.rb

@@ -1,9 +1,9 @@
 Rails.application.routes.draw do
-  require 'sidekiq/web'
-  require 'sidekiq-scheduler/web'
-  
-  # Allow any authenticated User with admin capability
-  authenticate :user, lambda { |u| u.admin? } do
-    mount Sidekiq::Web => '/sidekiq'
-  end
+    require 'sidekiq/web'
+    require 'sidekiq-scheduler/web'
+    
+    # Allow any authenticated User with admin capability
+    authenticate :user, lambda { |u| u.admin? } do
+        mount Sidekiq::Web => '/sidekiq'
+    end
 end

data/lib/thecore_background_jobs/engine.rb

@@ -1,15 +1,4 @@
-require 'thecore_backend_commons'
 module ThecoreBackgroundJobs
   class Engine < ::Rails::Engine
-
-    initializer 'thecore_background_jobs.add_to_migrations' do |app|
-      unless app.root.to_s.match root.to_s
-        # APPEND TO MAIN APP MIGRATIONS FROM THIS GEM
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
-      end
-    end
-
   end
 end

data/lib/thecore_background_jobs.rb

@@ -1,8 +1,7 @@
-require 'thecore_backend_commons'
 require 'redis-namespace'
 require 'sidekiq'
-require "sidekiq-scheduler"
-require "sidekiq-failures"
+require 'sidekiq-scheduler'
+require 'sidekiq-failures'
 require "thecore_background_jobs/engine"
 
 module ThecoreBackgroundJobs

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: thecore_background_jobs
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Gabriele Tassoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: thecore_backend_commons
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sidekiq-failures
   requirement: !ruby/object:Gem::Requirement
@@ -80,30 +66,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Thecorized thecore_background_jobs full description.
+description: Adds Background workers functionality and management to Thecore.
 email:
-- gabriele.tassoni@gmail.com
+- g.tassoni@bancolini.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/workers/demo_worker.rb
-- config/initializers/after_initialize_for_thecore_backgrond_commons.rb
-- config/initializers/sidekiq-thecore.rb
-- config/initializers/thecore_background_settings_concern.rb
+- config/initializers/abilities.rb
+- config/initializers/add_to_db_migrations.rb
+- config/initializers/after_initialize.rb
+- config/initializers/concern_thecore_settings.rb
+- config/initializers/queues_config.rb
 - config/routes.rb
-- lib/admin_constraint.rb
 - lib/tasks/thecore_background_jobs_tasks.rake
 - lib/thecore_background_jobs.rb
 - lib/thecore_background_jobs/engine.rb
 - lib/thecore_background_jobs/version.rb
-homepage: https://www.taris.it
-licenses:
-- MIT
-metadata: {}
+homepage: https://github.com/gabrieletassoni/thecore_background_jobs
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gabrieletassoni/thecore_background_jobs
+  source_code_uri: https://github.com/gabrieletassoni/thecore_background_jobs
+  changelog_uri: https://github.com/gabrieletassoni/thecore_background_jobs/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -122,5 +111,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: Thecorized thecore_background_jobs
+summary: Background workers for Thecore
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2017 Gabriele Tassoni
-
-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/config/initializers/after_initialize_for_thecore_backgrond_commons.rb

@@ -1,10 +0,0 @@
-Rails.application.configure do
-  config.after_initialize do
-    ThecoreBackgroundJobs.update_cron_schedules
-    # Good place for sending concerns about modules
-    # i.e.
-    # ModelName.send(:include, ModelNameConcern)
-    # - ModelNameConcern can be defined in config/initializers folder in order to be sure it's automatically loaded during engine bootstrap
-    ThecoreSettings::Setting.send(:include, ThecoreBackgroundSettingsConcern)
-  end
-end

data/config/initializers/thecore_background_settings_concern.rb

@@ -1,13 +0,0 @@
-require 'active_support/concern'
-
-module ThecoreBackgroundSettingsConcern
-  extend ActiveSupport::Concern
-  included do
-    after_save :reload_schedules, if: :saved_change_to_raw?
-
-    def reload_schedules
-      # Reload changes to schedule
-      ThecoreBackgroundJobs.update_cron_schedules if self.ns == "schedules" && !self.raw.blank?
-    end
-  end
-end

data/lib/admin_constraint.rb

@@ -1,7 +0,0 @@
-class AdminConstraint
-  def matches?(request)
-    return false unless request.session[:user_id]
-    user = User.find request.session[:user_id]
-    user && user.admin?
-  end
-end