cloudtasker 0.5.0 → 0.8.2

data/lib/cloudtasker/redis_client.rb

@@ -4,9 +4,7 @@ require 'redis'
 
 module Cloudtasker
   # A wrapper with helper methods for redis
-  module RedisClient
-    module_function
-
+  class RedisClient
     # Suffix added to cache keys when locking them
     LOCK_KEY_PREFIX = 'cloudtasker/lock'
 
@@ -50,9 +48,10 @@ module Cloudtasker
     # Acquire a lock on a cache entry.
     #
     # @example
-    #   RedisClient.with_lock('foo')
-    #     content = RedisClient.fetch('foo')
-    #     RedisClient.set(content.merge(bar: 'bar).to_json)
+    #   redis = RedisClient.new
+    #   redis.with_lock('foo')
+    #     content = redis.fetch('foo')
+    #     redis.set(content.merge(bar: 'bar).to_json)
     #   end
     #
     # @param [String] cache_key The cache key to access.

data/lib/cloudtasker/unique_job/job.rb

@@ -100,10 +100,10 @@ module Cloudtasker
       #
       # Return the Cloudtasker redis client.
       #
-      # @return [Class] The Cloudtasker::RedisClient wrapper.
+      # @return [Cloudtasker::RedisClient] The cloudtasker redis client.
       #
       def redis
-        Cloudtasker::RedisClient
+        @redis ||= Cloudtasker::RedisClient.new
       end
 
       #

data/lib/cloudtasker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudtasker
-  VERSION = '0.5.0'
+  VERSION = '0.8.2'
 end

data/lib/cloudtasker/worker.rb

@@ -6,6 +6,7 @@ module Cloudtasker
     # Add class method to including class
     def self.included(base)
       base.extend(ClassMethods)
+      base.attr_writer :job_queue
       base.attr_accessor :job_args, :job_id, :job_meta, :job_reenqueued, :job_retries
     end
 
@@ -32,8 +33,9 @@ module Cloudtasker
     # @return [Cloudtasker::Worker, nil] The instantiated worker.
     #
     def self.from_hash(hash)
-      # Symbolize payload keys
+      # Symbolize metadata keys and stringify job arguments
       payload = JSON.parse(hash.to_json, symbolize_names: true)
+      payload[:job_args] = JSON.parse(payload[:job_args].to_json)
 
       # Extract worker parameters
       klass_name = payload&.dig(:worker)
@@ -44,7 +46,7 @@ module Cloudtasker
       return nil unless worker_klass.include?(self)
 
       # Return instantiated worker
-      worker_klass.new(payload.slice(:job_args, :job_id, :job_meta, :job_retries))
+      worker_klass.new(payload.slice(:job_queue, :job_args, :job_id, :job_meta, :job_retries))
     rescue NameError
       nil
     end
@@ -80,7 +82,7 @@ module Cloudtasker
       # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_async(*args)
-        perform_in(nil, *args)
+        schedule(args: args)
       end
 
       #
@@ -92,7 +94,7 @@ module Cloudtasker
       # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_in(interval, *args)
-        new(job_args: args).schedule(interval: interval)
+        schedule(args: args, time_in: interval)
       end
 
       #
@@ -104,7 +106,21 @@ module Cloudtasker
       # @return [Cloudtasker::CloudTask] The Google Task response
       #
       def perform_at(time_at, *args)
-        new(job_args: args).schedule(time_at: time_at)
+        schedule(args: args, time_at: time_at)
+      end
+
+      #
+      # Enqueue a worker with explicity options.
+      #
+      # @param [Array<any>] args The job arguments.
+      # @param [Time, Integer] time_in The delay in seconds.
+      # @param [Time, Integer] time_at The time at which the job should run.
+      # @param [String, Symbol] queue The queue on which the worker should run.
+      #
+      # @return [Cloudtasker::CloudTask] The Google Task response
+      #
+      def schedule(args: nil, time_in: nil, time_at: nil, queue: nil)
+        new(job_args: args, job_queue: queue).schedule({ interval: time_in, time_at: time_at }.compact)
       end
 
       #
@@ -123,11 +139,30 @@ module Cloudtasker
     # @param [Array<any>] job_args The list of perform args.
     # @param [String] job_id A unique ID identifying this job.
     #
-    def initialize(job_args: [], job_id: nil, job_meta: {}, job_retries: 0)
-      @job_args = job_args
+    def initialize(job_queue: nil, job_args: nil, job_id: nil, job_meta: {}, job_retries: 0)
+      @job_args = job_args || []
       @job_id = job_id || SecureRandom.uuid
       @job_meta = MetaStore.new(job_meta)
       @job_retries = job_retries || 0
+      @job_queue = job_queue
+    end
+
+    #
+    # Return the class name of the worker.
+    #
+    # @return [String] The class name.
+    #
+    def job_class_name
+      self.class.to_s
+    end
+
+    #
+    # Return the queue to use for this worker.
+    #
+    # @return [String] The name of queue.
+    #
+    def job_queue
+      (@job_queue ||= self.class.cloudtasker_options_hash[:queue] || Config::DEFAULT_JOB_QUEUE).to_s
     end
 
     #
@@ -198,10 +233,10 @@ module Cloudtasker
     # Return a new instance of the worker with the same args and metadata
     # but with a different id.
     #
-    # @return [<Type>] <description>
+    # @return [Cloudtasker::Worker] <description>
     #
     def new_instance
-      self.class.new(job_args: job_args, job_meta: job_meta)
+      self.class.new(job_queue: job_queue, job_args: job_args, job_meta: job_meta)
     end
 
     #
@@ -215,7 +250,8 @@ module Cloudtasker
         job_id: job_id,
         job_args: job_args,
         job_meta: job_meta.to_h,
-        job_retries: job_retries
+        job_retries: job_retries,
+        job_queue: job_queue
       }
     end
 

data/lib/cloudtasker/worker_handler.rb

@@ -5,7 +5,7 @@ require 'google/cloud/tasks'
 module Cloudtasker
   # Build, serialize and schedule tasks on the processing backend.
   class WorkerHandler
-    attr_reader :worker, :job_args
+    attr_reader :worker
 
     # Alrogith used to sign the verification token
     JWT_ALG = 'HS256'
@@ -46,7 +46,8 @@ module Cloudtasker
             'Authorization' => "Bearer #{Authenticator.verification_token}"
           },
           body: worker_payload.to_json
-        }
+        },
+        queue: worker.job_queue
       }
     end
 
@@ -64,7 +65,8 @@ module Cloudtasker
     #
     def worker_payload
       @worker_payload ||= {
-        worker: worker.class.to_s,
+        worker: worker.job_class_name,
+        job_queue: worker.job_queue,
         job_id: worker.job_id,
         job_args: worker.job_args,
         job_meta: worker.job_meta.to_h

data/lib/cloudtasker/worker_logger.rb

@@ -11,7 +11,7 @@ module Cloudtasker
     end
 
     # Only log the job meta information by default (exclude arguments)
-    DEFAULT_CONTEXT_PROCESSOR = ->(worker) { worker.to_h.slice(:worker, :job_id, :job_meta) }
+    DEFAULT_CONTEXT_PROCESSOR = ->(worker) { worker.to_h.slice(:worker, :job_id, :job_meta, :job_queue) }
 
     #
     # Build a new instance of the class.

data/lib/cloudtasker/worker_wrapper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'cloudtasker/worker'
+
+module Cloudtasker
+  # A worker class used to schedule jobs without actually
+  # instantiating the worker class. This is useful for middlewares
+  # needing to enqueue jobs in a Rails initializer. Rails 6 complains
+  # about instantiating workers in an iniitializer because of autoloading
+  # in zeitwerk mode.
+  #
+  # Downside of this wrapper: any cloudtasker_options specified on on the
+  # worker_class will be ignored.
+  #
+  # See: https://github.com/rails/rails/issues/36363
+  #
+  class WorkerWrapper
+    include Worker
+
+    attr_accessor :worker_name
+
+    #
+    # Build a new instance of the class.
+    #
+    # @param [String] worker_class The name of the worker class.
+    # @param [Hash] **opts The worker arguments.
+    #
+    def initialize(worker_name:, **opts)
+      @worker_name = worker_name
+      super(opts)
+    end
+
+    #
+    # Override parent. Return the underlying worker class name.
+    #
+    # @return [String] The worker class.
+    #
+    def job_class_name
+      worker_name
+    end
+
+    #
+    # Return a new instance of the worker with the same args and metadata
+    # but with a different id.
+    #
+    # @return [Cloudtasker::WorkerWrapper] <description>
+    #
+    def new_instance
+      self.class.new(worker_name: worker_name, job_queue: job_queue, job_args: job_args, job_meta: job_meta)
+    end
+  end
+end

data/lib/tasks/setup_queue.rake

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
 require 'cloudtasker/backend/google_cloud_task'
+require 'cloudtasker/config'
+
+ENV['GOOGLE_AUTH_SUPPRESS_CREDENTIALS_WARNINGS'] ||= 'true'
 
 namespace :cloudtasker do
-  desc 'Setup the Cloud Task queue'
+  desc 'Setup a Cloud Task queue. (default options: ' \
+    "name=#{Cloudtasker::Config::DEFAULT_JOB_QUEUE}, " \
+    "concurrency=#{Cloudtasker::Config::DEFAULT_QUEUE_CONCURRENCY}, " \
+    "retries=#{Cloudtasker::Config::DEFAULT_QUEUE_RETRIES})"
   task setup_queue: :environment do
-    Cloudtasker::Backend::GoogleCloudTask.setup_queue
+    puts Cloudtasker::Backend::GoogleCloudTask.setup_queue(
+      name: ENV['name'],
+      concurrency: ENV['concurrency'],
+      retries: ENV['retries']
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudtasker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Arnaud Lachaume
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Manage GCP Cloud Tasks in your app. (alpha)
+description: Background jobs for Ruby using Google Cloud Tasks (beta)
 email:
 - arnaud.lachaume@keypup.io
 executables:
@@ -247,12 +261,13 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - app/controllers/cloudtasker/application_controller.rb
 - app/controllers/cloudtasker/worker_controller.rb
 - bin/console
@@ -307,7 +322,6 @@ files:
 - lib/cloudtasker/local_server.rb
 - lib/cloudtasker/meta_store.rb
 - lib/cloudtasker/middleware/chain.rb
-- lib/cloudtasker/railtie.rb
 - lib/cloudtasker/redis_client.rb
 - lib/cloudtasker/testing.rb
 - lib/cloudtasker/unique_job.rb
@@ -329,6 +343,7 @@ files:
 - lib/cloudtasker/worker.rb
 - lib/cloudtasker/worker_handler.rb
 - lib/cloudtasker/worker_logger.rb
+- lib/cloudtasker/worker_wrapper.rb
 - lib/tasks/setup_queue.rake
 homepage: https://github.com/keypup-io/cloudtasker
 licenses:
@@ -356,5 +371,5 @@ rubyforge_project:
 rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
-summary: Manage GCP Cloud Tasks in your app. (alpha)
+summary: Background jobs for Ruby using Google Cloud Tasks (beta)
 test_files: []

data/Gemfile.lock

@@ -1,263 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cloudtasker (0.5.0)
-      activesupport
-      fugit
-      google-cloud-tasks
-      jwt
-      redis
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (6.0.0)
-      actionpack (= 6.0.0)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.0)
-      actionpack (= 6.0.0)
-      activejob (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
-      mail (>= 2.7.1)
-    actionmailer (6.0.0)
-      actionpack (= 6.0.0)
-      actionview (= 6.0.0)
-      activejob (= 6.0.0)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.0)
-      actionpack (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
-      nokogiri (>= 1.8.5)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.0)
-      activesupport (= 6.0.0)
-      globalid (>= 0.3.6)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activestorage (6.0.0)
-      actionpack (= 6.0.0)
-      activejob (= 6.0.0)
-      activerecord (= 6.0.0)
-      marcel (~> 0.3.1)
-    activesupport (6.0.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    crass (1.0.5)
-    diff-lcs (1.3)
-    erubi (1.9.0)
-    et-orbi (1.2.2)
-      tzinfo
-    faraday (0.17.0)
-      multipart-post (>= 1.2, < 3)
-    fugit (1.3.3)
-      et-orbi (~> 1.1, >= 1.1.8)
-      raabro (~> 1.1)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    google-cloud-tasks (1.3.1)
-      google-gax (~> 1.8)
-      googleapis-common-protos (>= 1.3.9, < 2.0)
-      googleapis-common-protos-types (>= 1.0.4, < 2.0)
-      grpc-google-iam-v1 (~> 0.6.9)
-    google-gax (1.8.1)
-      google-protobuf (~> 3.9)
-      googleapis-common-protos (>= 1.3.9, < 2.0)
-      googleauth (~> 0.9)
-      grpc (~> 1.24)
-      rly (~> 0.2.3)
-    google-protobuf (3.10.1-universal-darwin)
-    googleapis-common-protos (1.3.9)
-      google-protobuf (~> 3.0)
-      googleapis-common-protos-types (~> 1.0)
-      grpc (~> 1.0)
-    googleapis-common-protos-types (1.0.4)
-      google-protobuf (~> 3.0)
-    googleauth (0.10.0)
-      faraday (~> 0.12)
-      jwt (>= 1.4, < 3.0)
-      memoist (~> 0.16)
-      multi_json (~> 1.11)
-      os (>= 0.9, < 2.0)
-      signet (~> 0.12)
-    grpc (1.25.0-universal-darwin)
-      google-protobuf (~> 3.8)
-      googleapis-common-protos-types (~> 1.0)
-    grpc-google-iam-v1 (0.6.9)
-      googleapis-common-protos (>= 1.3.1, < 2.0)
-      grpc (~> 1.0)
-    hashdiff (1.0.0)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    jwt (2.2.1)
-    loofah (2.3.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    memoist (0.16.1)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.13.0)
-    multi_json (1.14.1)
-    multipart-post (2.1.1)
-    nio4r (2.5.2)
-    nokogiri (1.10.5)
-      mini_portile2 (~> 2.4.0)
-    os (1.0.1)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.1)
-    raabro (1.1.6)
-    rack (2.0.7)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.0.0)
-      actioncable (= 6.0.0)
-      actionmailbox (= 6.0.0)
-      actionmailer (= 6.0.0)
-      actionpack (= 6.0.0)
-      actiontext (= 6.0.0)
-      actionview (= 6.0.0)
-      activejob (= 6.0.0)
-      activemodel (= 6.0.0)
-      activerecord (= 6.0.0)
-      activestorage (= 6.0.0)
-      activesupport (= 6.0.0)
-      bundler (>= 1.3.0)
-      railties (= 6.0.0)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    redis (4.1.3)
-    rly (0.2.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.36.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    signet (0.12.0)
-      addressable (~> 2.3)
-      faraday (~> 0.9)
-      jwt (>= 1.5, < 3.0)
-      multi_json (~> 1.10)
-    sprockets (4.0.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.4.0)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    timecop (0.9.1)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    webmock (3.7.6)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    websocket-driver (0.7.1)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.2.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal
-  bundler (~> 2.0)
-  cloudtasker!
-  rails
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rspec-rails
-  rubocop (= 0.76.0)
-  rubocop-rspec
-  sqlite3
-  timecop
-  webmock
-
-BUNDLED WITH
-   2.0.2