cloudtasker 0.9.5 → 0.10.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8cde6f4433e688dce340d17a5194f9be7b0136a0bf472a8b46eed67223d4c7
-  data.tar.gz: b803d0a9d1247f9da6cc09086008e916feaff43aa180edbd6489673f9c628e44
+  metadata.gz: d4cba7de3e429d612adf6c9c2f4424b6ef73db39d4db93b70804800300011e1b
+  data.tar.gz: 3775cdf3f16430cf8decd49dfc28be9e26f0ef6a63d45224bdc5ed11b13a86fc
 SHA512:
-  metadata.gz: d7029b923e28b15a5021d86c76109eb8c56515ee6f193aa1a7664f251d3d47161e4fb61544c6ff5eebc09b233f0f0cedb45e32e99c6eb9c463049cfac77d2bb7
-  data.tar.gz: 2ae3a73d3e375ffc71851adcefd3b4bfbdff7803220461fd26da655698dbb6833e0310eca308667476eb8a01b6b07c28fb4c9235b5f01738bac4bc7758c7cc51
+  metadata.gz: 5e2e15dc54fad72e3508763855a99804b591126968ccbcaccd8211d51b8b1e28bf6d2907c746f2b14c53c3c065ce1eb06871f30b39419df1f3d7b8a4e1b1fded
+  data.tar.gz: a2808491a7251b5212587351deb84a99f688a62f7a54c3f5b9c8ebe3a3b6a1ca6adda6ffe898424069223cef8260f1a49c8a086010c0e59dedc5e50ed371e830

data/.rubocop.yml

@@ -2,7 +2,7 @@ require: rubocop-rspec
 
 AllCops:
   Exclude:
-    - 'gemfiles/**/*'
+    - 'gemfiles/vendor/**/*'
     - 'vendor/**/*'
 
 Metrics/ClassLength:

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+services:
+  - redis-server
+before_install: gem install bundler -v 2.0.2
+before_script: bundle exec rubocop
+gemfile:
+  - gemfiles/google_cloud_tasks_1.0.gemfile
+  - gemfiles/google_cloud_tasks_1.1.gemfile
+  - gemfiles/google_cloud_tasks_1.2.gemfile
+  - gemfiles/google_cloud_tasks_1.3.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile

data/Appraisals

@@ -23,19 +23,3 @@ end
 appraise 'rails-6.0' do
   gem 'rails', '6.0'
 end
-
-appraise 'semantic_logger-3.4' do
-  gem 'semantic_logger', '3.4.1'
-end
-
-appraise 'semantic_logger-4.6' do
-  gem 'semantic_logger', '4.6.1'
-end
-
-appraise 'semantic_logger-4.7.0' do
-  gem 'semantic_logger', '4.7.0'
-end
-
-appraise 'semantic_logger-4.7.2' do
-  gem 'semantic_logger', '4.7.2'
-end

data/CHANGELOG.md

@@ -1,27 +1,5 @@
 # Changelog
 
-## [v0.9.5](https://github.com/keypup-io/cloudtasker/tree/v0.9.5) (2021-08-25)
-
-[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.9.4...v0.9.5)
-
-**Fixed bugs:**
-- Dependencies: Require `try` from `activesupport`. This was preventing non-Rails projects from properly running Cloudtasker jobs.
-- WorkerController: remove useless inheritance from local ApplicationController. The parent controller was not always loaded on Rails 5 which in turn created issues with authenticity token. Fixes [#40](https://github.com/keypup-io/cloudtasker/issues/40)
-
-## [v0.9.4](https://github.com/keypup-io/cloudtasker/tree/v0.9.4) (2020-10-05)
-
-[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.9.3...v0.9.4)
-
-**Fixed bugs:**
-- Logging: fix log processing with `semantic_logger` `v4.7.2`. Accept any args on block passed to the logger.
-
-## [v0.9.3](https://github.com/keypup-io/cloudtasker/tree/v0.9.3) (2020-06-25)
-
-[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.9.2...v0.9.3)
-
-**Fixed bugs:**
-- Google Cloud Tasks: lock version to `~> 1.0` (Google recently released a v2 which changes its bindings completely). An [issue](https://github.com/keypup-io/cloudtasker/issues/11) has been raised to upgrade Cloudtasker to `google-cloud-tasks` `v2`.
-
 ## [v0.9.2](https://github.com/keypup-io/cloudtasker/tree/v0.9.2) (2020-03-04)
 
 [Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.9.1...v0.9.2)

data/README.md

@@ -224,7 +224,7 @@ Cloudtasker.configure do |config|
   # 
   # config.max_retries = 10
 
-  # 
+  #
   # Specify the redis connection hash.
   #
   # This is ONLY required in development for the Cloudtasker local server and in
@@ -235,6 +235,24 @@ Cloudtasker.configure do |config|
   # Default: redis-rb connects to redis://127.0.0.1:6379/0
   #
   # config.redis = { url: 'redis://localhost:6379/5' }
+
+  #
+  # Set to true to store job arguments in Redis instead of sending arguments as part
+  # of the job payload to Google Cloud Tasks.
+  #
+  # This is useful if you expect to process jobs with payloads exceeding 100KB, which
+  # is the limit enforced by Google Cloud Tasks.
+  #
+  # You can set this configuration parameter to a KB value if you want to store jobs
+  # args in redis only if the JSONified arguments payload exceeds that threshold.
+  #
+  # Default: false
+  #
+  # Store all job payloads in Redis:
+  # config.store_payloads_in_redis = true
+  #
+  # Store all job payloads in Redis exceeding 50 KB:
+  # config.store_payloads_in_redis = 50
 end
 ```
 
@@ -639,6 +657,27 @@ Google Cloud Tasks enforces a limit of 100 KB for job payloads. Taking into acco
 
 Any excessive job payload (> 100 KB) will raise a `Cloudtasker::MaxTaskSizeExceededError`, both in production and development mode.
 
+#### Option 1: Use Cloudtasker optional support for payload storage in Redis
+Cloudtasker provides optional support for storing argument payloads in Redis instead of sending them to Google Cloud Tasks.
+
+To enable it simply put the following in your Cloudtasker initializer:
+```ruby
+# config/initializers/cloudtasker.rb
+
+Cloudtasker.configure do |config|
+  # Enable Redis support. Specify your redis connection
+  config.redis = { url: 'redis://localhost:6379/5' }
+
+  # Store all job payloads in Redis:
+  config.store_payloads_in_redis = true
+
+  # OR: store all job payloads in Redis exceeding 50 KB:
+  # config.store_payloads_in_redis = 50
+end
+```
+
+#### Option 2: Do it yourself solution
+
 If you feel that a job payload is going to get big, prefer to store the payload using a datastore (e.g. Redis) and pass a reference to the job to retrieve the payload inside your job `perform` method.
 
 E.g. Define a job like this

data/app/controllers/cloudtasker/application_controller.rb

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

data/app/controllers/cloudtasker/worker_controller.rb

@@ -2,10 +2,7 @@
 
 module Cloudtasker
   # Handle execution of workers
-  class WorkerController < ActionController::Base
-    # No need for CSRF verification on API endpoints
-    skip_before_action :verify_authenticity_token
-
+  class WorkerController < ApplicationController
     # Authenticate all requests.
     before_action :authenticate!
 

data/cloudtasker.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'fugit'
-  spec.add_dependency 'google-cloud-tasks', '~> 1.0'
+  spec.add_dependency 'google-cloud-tasks'
   spec.add_dependency 'jwt'
   spec.add_dependency 'redis'
 
@@ -43,7 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '0.76.0'
   spec.add_development_dependency 'rubocop-rspec', '1.37.0'
-  spec.add_development_dependency 'semantic_logger'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock'
 

data/gemfiles/google_cloud_tasks_1.0.gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "google-cloud-tasks", "1.0"
+gem 'google-cloud-tasks', '1.0'
 
-gemspec path: "../"
+gemspec path: '../'