cloudtasker 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d051d238265fe5c1b1e48203c121e7284a26340026ff481e4c6240703de073b
-  data.tar.gz: bb785d5f8f7834bb1ef885c9bb939a43925e933c34abcf94a9609b292813b03d
+  metadata.gz: 59faa788a8c1238974bac7f81169c7df4fc460e0b58d181918c7c9b087e6ea29
+  data.tar.gz: 106d98dc7571bd65f52774946b5e995f47e7c45be9b54dca41644946cd1c61d1
 SHA512:
-  metadata.gz: 81926768a084ba79aff1ae466f7dc2a11ac883c0b57f6fd41787dbedf3434d0979762158728c4548217bd06b0df2692e8bffe8cbd3d02bda447336610d4de2c0
-  data.tar.gz: 1ce88e8633716f8ea379affd0ef7c705ec7fc48ebdd100c0e6f525fd0e5ca61ac4f3349dde3c53ee7815e23761dbd8cfa9e1d6d2f0b1e80f9892d1b92065c61b
+  metadata.gz: 5a22f2df22f4b84a330bd613689f63b456cbcc6b87318d1501029e0794cedeb0951e73a7c974e93957c4333a674bdb47a6270995eb81bbe281f5ec5e56009f50
+  data.tar.gz: 84120f64e690ebcd06c93890c14278d1797620b1289b05f10a9d6846bff965febc06261aa560b3179315b64d26a1b193d19a65651d6b0b2f6ff46d54e779356f

data/.github/workflows/lint_rubocop.yml

@@ -0,0 +1,20 @@
+name: Rubocop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0.1'
+          bundler-cache: true
+      - name: Lint codebase
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop

data/.github/workflows/{test.yml → test_ruby_2.5_2.6.yml}

@@ -1,4 +1,4 @@
-name: Test
+name: Ruby 2.5/2.6
 
 on: [push, pull_request]
 
@@ -8,34 +8,37 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.5.x'
-          - '2.6.x'
+          - '2.5.9'
+          - '2.6.7'
         appraisal:
           - 'google-cloud-tasks-1.0'
           - 'google-cloud-tasks-1.1'
           - 'google-cloud-tasks-1.2'
           - 'google-cloud-tasks-1.3'
+          - 'google-cloud-tasks-1.4'
+          - 'google-cloud-tasks-1.5'
+          - 'google-cloud-tasks-2.0'
+          - 'google-cloud-tasks-2.1'
           - 'rails-5.2'
           - 'rails-6.0'
+          - 'rails-6.1'
           - 'semantic_logger-3.4'
           - 'semantic_logger-4.6'
           - 'semantic_logger-4.7.0'
           - 'semantic_logger-4.7.2'
     steps:
-      - name: Setup System
-        run: sudo apt-get install libsqlite3-dev
       - uses: actions/checkout@v2
       - uses: zhulik/redis-action@1.1.0
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Build and test with Rake
         env:
             APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rubocop
           bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
           bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_2.7.yml

@@ -0,0 +1,44 @@
+name: Ruby 2.7
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.5'
+        appraisal:
+          - 'google-cloud-tasks-1.0'
+          - 'google-cloud-tasks-1.1'
+          - 'google-cloud-tasks-1.2'
+          - 'google-cloud-tasks-1.3'
+          - 'google-cloud-tasks-1.4'
+          - 'google-cloud-tasks-1.5'
+          - 'google-cloud-tasks-2.0'
+          - 'google-cloud-tasks-2.1'
+          - 'rails-5.2'
+          - 'rails-6.0'
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_3.x.yml

@@ -0,0 +1,43 @@
+name: Ruby 3.x
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.0.1'
+          # - '3.1.0'
+        appraisal:
+          - 'google-cloud-tasks-1.0'
+          - 'google-cloud-tasks-1.1'
+          - 'google-cloud-tasks-1.2'
+          - 'google-cloud-tasks-1.3'
+          - 'google-cloud-tasks-1.4'
+          - 'google-cloud-tasks-1.5'
+          - 'google-cloud-tasks-2.0'
+          - 'google-cloud-tasks-2.1'
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /examples/rails/log/*.log
 /examples/rails/tmp/
+/gemfiles/*.gemfile.lock
 /log/
 /pkg/
 /spec/reports/

data/.rubocop.yml

@@ -5,6 +5,11 @@ AllCops:
     - 'gemfiles/**/*'
     - 'vendor/**/*'
 
+# Ruby 3.0: curly braces around last argument has meaning
+# See: https://github.com/rubocop/rubocop/issues/7641
+Style/BracesAroundHashParameters:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 200
 

data/Appraisals

@@ -1,41 +1,85 @@
 # frozen_string_literal: true
 
 appraise 'google-cloud-tasks-1.0' do
-  gem 'google-cloud-tasks', '1.0'
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.0.0'
 end
 
 appraise 'google-cloud-tasks-1.1' do
-  gem 'google-cloud-tasks', '1.1'
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.1.0'
 end
 
 appraise 'google-cloud-tasks-1.2' do
-  gem 'google-cloud-tasks', '1.2'
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.2.0'
 end
 
 appraise 'google-cloud-tasks-1.3' do
-  gem 'google-cloud-tasks', '1.3'
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.3.0'
 end
 
-appraise 'rails-5.2' do
-  gem 'rails', '5.2'
+appraise 'google-cloud-tasks-1.4' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.4.0'
 end
 
-appraise 'rails-6.0' do
-  gem 'rails', '6.0'
+appraise 'google-cloud-tasks-1.5' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 1.5.0'
+end
+
+appraise 'google-cloud-tasks-2.0' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 2.0.0'
+end
+
+appraise 'google-cloud-tasks-2.1' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
+  gem 'google-cloud-tasks', '~> 2.1.0'
+end
+
+if RUBY_VERSION < '3'
+  appraise 'rails-5.2' do
+    gem 'rails', '5.2'
+    gem 'rspec-rails'
+  end
+
+  appraise 'rails-6.0' do
+    gem 'rails', '6.0'
+    gem 'rspec-rails'
+  end
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '6.1'
+  gem 'rspec-rails'
+end
+
+if RUBY_VERSION >= '2.7'
+  appraise 'rails-7.0' do
+    gem 'rails', '7.0'
+    gem 'rspec-rails'
+  end
 end
 
 appraise 'semantic_logger-3.4' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '3.4.1'
 end
 
 appraise 'semantic_logger-4.6' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.6.1'
 end
 
 appraise 'semantic_logger-4.7.0' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.0'
 end
 
 appraise 'semantic_logger-4.7.2' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.2'
 end

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [v0.13.rc2](https://github.com/keypup-io/cloudtasker/tree/v0.13.rc2) (2022-01-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.12.2...v0.13.rc2)
+
+**Improvements:**
+- Dependencies: add support for google-cloud-tasks v2 and while keeping backward compatibility with v1. For existing projects, you may need to run `bundle update google-cloud-tasks` after upgrading cloudtasker to update google-cloud-tasks to the latest version.
+- Ruby 3: Rework method arguments to be compatible with Ruby 3
+- Tests: Separate test environment for Ruby 2 and Ruby 3
+- Tests: Do not load Rails by default and skip Rails-specific tests in non-Rails appraisals
+
 ## [v0.12.2](https://github.com/keypup-io/cloudtasker/tree/v0.12.2) (2021-12-31)
 
 [Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.12.1...v0.12.2)

data/README.md

@@ -12,7 +12,7 @@ Cloudtasker also provides optional modules for running [cron jobs](docs/CRON_JOB
 
 A local processing server is also available for development. This local server processes jobs in lieu of Cloud Tasks and allows you to work offline.
 
-**Maturity**: This gem is production-ready. We at Keypup have already processed millions of jobs using Cloudtasker and all related extensions (cron, batch and unique jobs). We are planning to release the official `v1.0.0` somewhere in 2021, in case we've missed any edge-case bug.
+**Maturity**: This gem is production-ready. We at Keypup have already processed millions of jobs using Cloudtasker and all related extensions (cron, batch and unique jobs). We are planning to release the official `v1.0.0` somewhere in 2022, in case we've missed any edge-case bug.
 
 ## Summary
 
@@ -51,6 +51,9 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'cloudtasker'
+
+# For Ruby 3 support, please use v0.13.rc1
+gem 'cloudtasker, '~> 0.13.rc1'
 ```
 
 And then execute:
@@ -1087,9 +1090,17 @@ To size the concurrency of your queues you should therefore take the most limiti
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+For tests, run `rake` to run the tests. Note that Rails is not in context by default, which means Rails-specific test will not run.
+For tests including Rails-specific tests, run `bundle exec appraisal rails-7.0 rake`
+For all context-specific tests (incl. Rails), run the [appraisal tests](Appraisals) using `bundle exec appraisal rake`.
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -2,13 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'github_changelog_generator/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
-
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.user = 'keypup-io'
-  config.project = 'cloudtasker'
-end

data/cloudtasker.gemspec

@@ -31,14 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'connection_pool'
   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'
   spec.add_dependency 'retriable'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-json_expectations', '~> 2.2'
@@ -47,8 +46,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'semantic_logger'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock'
-
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'sqlite3'
 end

data/docs/CRON_JOBS.md

@@ -45,12 +45,12 @@ You can maintain the list of cron jobs in a YAML file inside your config folder
 # Run job every minute
 some_schedule_name:
   worker: 'SomeCronWorker'
-  cron: => '* * * * *'
+  cron: '* * * * *'
   
 # Run job every hour on the fifteenth minute 
 other_cron_schedule:
   worker: 'OtherCronWorker'
-  cron: => '15 * * * *'
+  cron: '15 * * * *'
 ```
 
 Then register the jobs inside your Cloudtasker initializer this way:

data/gemfiles/google_cloud_tasks_1.0.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "google-cloud-tasks", "1.0"
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.0.0"
 
 gemspec path: "../"

data/gemfiles/google_cloud_tasks_1.1.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "google-cloud-tasks", "1.1"
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.1.0"
 
 gemspec path: "../"

data/gemfiles/google_cloud_tasks_1.2.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "google-cloud-tasks", "1.2"
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.2.0"
 
 gemspec path: "../"

data/gemfiles/google_cloud_tasks_1.3.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "google-cloud-tasks", "1.3"
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.3.0"
 
 gemspec path: "../"

data/gemfiles/google_cloud_tasks_1.4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.4.0"
+
+gemspec path: "../"

data/gemfiles/google_cloud_tasks_1.5.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 1.5.0"
+
+gemspec path: "../"

data/gemfiles/google_cloud_tasks_2.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 2.0.0"
+
+gemspec path: "../"

data/gemfiles/google_cloud_tasks_2.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "6.1"
+gem "google-cloud-tasks", "~> 2.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "5.2"
+gem "rspec-rails"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "6.0"
+gem "rspec-rails"
 
 gemspec path: "../"

data/gemfiles/{semantic_logger_4.7.gemfile → rails_6.1.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "semantic_logger", "4.7.2"
+gem "rails", "6.1"
+gem "rspec-rails"
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "7.0"
+gem "rspec-rails"
+
+gemspec path: "../"

data/gemfiles/semantic_logger_3.4.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "activesupport", "6.1"
 gem "semantic_logger", "3.4.1"
 
 gemspec path: "../"

data/gemfiles/semantic_logger_4.6.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "activesupport", "6.1"
 gem "semantic_logger", "4.6.1"
 
 gemspec path: "../"

data/gemfiles/semantic_logger_4.7.0.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "activesupport", "6.1"
 gem "semantic_logger", "4.7.0"
 
 gemspec path: "../"

data/gemfiles/semantic_logger_4.7.2.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "activesupport", "6.1"
 gem "semantic_logger", "4.7.2"
 
 gemspec path: "../"

data/lib/cloudtasker/backend/{google_cloud_task.rb → google_cloud_task_v1.rb}

@@ -6,34 +6,38 @@ require 'retriable'
 module Cloudtasker
   module Backend
     # Manage tasks pushed to GCP Cloud Task
-    class GoogleCloudTask
+    class GoogleCloudTaskV1
       attr_accessor :gcp_task
 
       #
       # Create the queue configured in Cloudtasker if it does not already exist.
       #
-      # @param [String] queue_name The relative name of the queue.
+      # @param [String] :name The queue name
+      # @param [Integer] :concurrency The queue concurrency
+      # @param [Integer] :retries The number of retries for the queue
       #
       # @return [Google::Cloud::Tasks::V2beta3::Queue] The queue
       #
-      def self.setup_queue(**opts)
+      def self.setup_queue(name: nil, concurrency: nil, retries: nil)
         # Build full queue path
-        queue_name = opts[:name] || Cloudtasker::Config::DEFAULT_JOB_QUEUE
+        queue_name = name || Cloudtasker::Config::DEFAULT_JOB_QUEUE
         full_queue_name = queue_path(queue_name)
 
         # Try to get existing queue
         client.get_queue(full_queue_name)
       rescue Google::Gax::RetryError
         # Extract options
-        concurrency = (opts[:concurrency] || Cloudtasker::Config::DEFAULT_QUEUE_CONCURRENCY).to_i
-        retries = (opts[:retries] || Cloudtasker::Config::DEFAULT_QUEUE_RETRIES).to_i
+        queue_concurrency = (concurrency || Cloudtasker::Config::DEFAULT_QUEUE_CONCURRENCY).to_i
+        queue_retries = (retries || Cloudtasker::Config::DEFAULT_QUEUE_RETRIES).to_i
 
         # Create queue on 'not found' error
         client.create_queue(
           client.location_path(config.gcp_project_id, config.gcp_location_id),
-          name: full_queue_name,
-          retry_config: { max_attempts: retries },
-          rate_limits: { max_concurrent_dispatches: concurrency }
+          {
+            name: full_queue_name,
+            retry_config: { max_attempts: queue_retries },
+            rate_limits: { max_concurrent_dispatches: queue_concurrency }
+          }
         )
       end
 
@@ -113,7 +117,7 @@ module Cloudtasker
       #
       # @param [String] id The task id.
       #
-      # @return [Cloudtasker::Backend::GoogleCloudTask, nil] The retrieved task.
+      # @return [Cloudtasker::Backend::GoogleCloudTaskV1, nil] The retrieved task.
       #
       def self.find(id)
         resp = with_gax_retries { client.get_task(id) }
@@ -128,7 +132,7 @@ module Cloudtasker
       #
       # @param [Hash] payload The task payload.
       #
-      # @return [Cloudtasker::Backend::GoogleCloudTask, nil] The created task.
+      # @return [Cloudtasker::Backend::GoogleCloudTaskV1, nil] The created task.
       #
       def self.create(payload)
         payload = format_task_payload(payload)