cloudtasker 0.11.rc1 → 0.11.1

data/lib/active_job/queue_adapters/cloudtasker_adapter.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# ActiveJob docs: http://guides.rubyonrails.org/active_job_basics.html
+# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters
+
+module ActiveJob
+  module QueueAdapters
+    # == Cloudtasker adapter for Active Job
+    #
+    # To use Cloudtasker set the queue_adapter config to +:cloudtasker+.
+    #
+    #   Rails.application.config.active_job.queue_adapter = :cloudtasker
+    class CloudtaskerAdapter
+      SERIALIZATION_FILTERED_KEYS = [
+        'executions', # Given by the worker at processing
+        'provider_job_id', # Also given by the worker at processing
+        'priority' # Not used
+      ].freeze
+
+      # Enqueues the given ActiveJob instance for execution
+      #
+      # @param job [ActiveJob::Base] The ActiveJob instance
+      #
+      # @return [Cloudtasker::CloudTask] The Google Task response
+      #
+      def enqueue(job)
+        build_worker(job).schedule
+      end
+
+      # Enqueues the given ActiveJob instance for execution at a given time
+      #
+      # @param job [ActiveJob::Base] The ActiveJob instance
+      # @param precise_timestamp [Integer] The timestamp at which the job must be executed
+      #
+      # @return [Cloudtasker::CloudTask] The Google Task response
+      #
+      def enqueue_at(job, precise_timestamp)
+        build_worker(job).schedule(time_at: Time.at(precise_timestamp))
+      end
+
+      private
+
+      def build_worker(job)
+        job_serialization = job.serialize.except(*SERIALIZATION_FILTERED_KEYS)
+
+        JobWrapper.new(
+          job_id: job_serialization.delete('job_id'),
+          job_queue: job_serialization.delete('queue_name'),
+          job_args: [job_serialization]
+        )
+      end
+
+      # == Job Wrapper for the Cloudtasker adapter
+      #
+      # Executes jobs scheduled by the Cloudtasker ActiveJob adapter
+      class JobWrapper #:nodoc:
+        include Cloudtasker::Worker
+
+        # Executes the given serialized ActiveJob call.
+        # - See https://api.rubyonrails.org/classes/ActiveJob/Core.html#method-i-serialize
+        #
+        # @param [Hash] job_serialization The serialized ActiveJob call
+        #
+        # @return [any] The execution of the ActiveJob call
+        #
+        def perform(job_serialization, *_extra_options)
+          job_executions = job_retries < 1 ? 0 : (job_retries + 1)
+
+          job_serialization.merge!(
+            'job_id' => job_id,
+            'queue_name' => job_queue,
+            'provider_job_id' => task_id,
+            'executions' => job_executions,
+            'priority' => nil
+          )
+
+          Base.execute job_serialization
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/batch/job.rb

@@ -62,6 +62,10 @@ module Cloudtasker
       # @return [Cloudtasker::Batch::Job] The attached batch.
       #
       def self.for(worker)
+        # Load extension if not loaded already on the worker class
+        worker.class.include(Extension::Worker) unless worker.class <= Extension::Worker
+
+        # Add batch capability
         worker.batch = new(worker)
       end
 

data/lib/cloudtasker/batch/middleware.rb

@@ -16,6 +16,8 @@ module Cloudtasker
         Cloudtasker.configure do |config|
           config.server_middleware { |c| c.add(Middleware::Server) }
         end
+
+        # Inject worker extension on main module
         Cloudtasker::Worker.include(Extension::Worker)
       end
     end

data/lib/cloudtasker/cli.rb

@@ -64,6 +64,7 @@ module Cloudtasker
       return false unless File.exist?('./config/environment.rb')
 
       require 'rails'
+      require 'cloudtasker/engine'
       require File.expand_path('./config/environment.rb')
     end
 

data/lib/cloudtasker/engine.rb

@@ -5,10 +5,14 @@ module Cloudtasker
   class Engine < ::Rails::Engine
     isolate_namespace Cloudtasker
 
-    initializer 'cloudtasker', before: :load_config_initializers do
+    config.before_initialize do
+      # Mount cloudtasker processing endpoint
       Rails.application.routes.append do
         mount Cloudtasker::Engine, at: '/cloudtasker'
       end
+
+      # Add ActiveJob adapter
+      require 'active_job/queue_adapters/cloudtasker_adapter' if defined?(::ActiveJob::Railtie)
     end
 
     config.generators do |g|

data/lib/cloudtasker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudtasker
-  VERSION = '0.11.rc1'
+  VERSION = '0.11.1'
 end

data/lib/cloudtasker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/try'
 
 require 'cloudtasker/version'
 require 'cloudtasker/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudtasker
 version: !ruby/object:Gem::Version
-  version: 0.11.rc1
+  version: 0.11.1
 platform: ruby
 authors:
 - Arnaud Lachaume
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -310,7 +324,6 @@ files:
 - README.md
 - Rakefile
 - _config.yml
-- app/controllers/cloudtasker/application_controller.rb
 - app/controllers/cloudtasker/worker_controller.rb
 - bin/console
 - bin/setup
@@ -343,6 +356,7 @@ files:
 - gemfiles/semantic_logger_4.7.0.gemfile
 - gemfiles/semantic_logger_4.7.2.gemfile
 - gemfiles/semantic_logger_4.7.gemfile
+- lib/active_job/queue_adapters/cloudtasker_adapter.rb
 - lib/cloudtasker.rb
 - lib/cloudtasker/authentication_error.rb
 - lib/cloudtasker/authenticator.rb
@@ -401,7 +415,7 @@ metadata:
   homepage_uri: https://github.com/keypup-io/cloudtasker
   source_code_uri: https://github.com/keypup-io/cloudtasker
   changelog_uri: https://github.com/keypup-io/cloudtasker/master/tree/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -412,12 +426,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.0
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Background jobs for Ruby using Google Cloud Tasks (beta)
 test_files: []

data/app/controllers/cloudtasker/application_controller.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Cloudtasker
-  # Base Cloudtasker controller
-  class ApplicationController < ActionController::Base
-    skip_before_action :verify_authenticity_token
-  end
-end