cloudtasker 0.1.0

data/lib/cloudtasker/unique_job/lock/no_op.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Lock
+      # Equivalent to no lock
+      class NoOp < BaseLock
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/lock/until_executed.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Lock
+      # Conflict if any other job with the same args is scheduled or moved to execution
+      # while the first job is pending or executing.
+      class UntilExecuted < BaseLock
+        #
+        # Acquire a lock for the job and trigger a conflict
+        # if the lock could not be acquired.
+        #
+        def schedule
+          job.lock!
+          yield
+        rescue LockError
+          conflict_instance.on_schedule { yield }
+        end
+
+        #
+        # Acquire a lock for the job and trigger a conflict
+        # if the lock could not be acquired.
+        #
+        def execute
+          job.lock!
+          yield
+          job.unlock!
+        rescue LockError
+          conflict_instance.on_execute { yield }
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/lock/until_executing.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Lock
+      # Conflict if any other job with the same args is scheduled
+      # while the first job is pending.
+      class UntilExecuting < BaseLock
+        #
+        # Acquire a lock for the job and trigger a conflict
+        # if the lock could not be acquired.
+        #
+        def schedule
+          job.lock!
+          yield
+        rescue LockError
+          conflict_instance.on_schedule { yield }
+        end
+
+        #
+        # Release the lock and perform the job.
+        #
+        def execute
+          job.unlock!
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/lock/while_executing.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Lock
+      # Conflict if any other job with the same args is moved to execution
+      # while the first job is executing.
+      class WhileExecuting < BaseLock
+        #
+        # Acquire a lock for the job and trigger a conflict
+        # if the lock could not be acquired.
+        #
+        def execute
+          job.lock!
+          yield
+          job.unlock!
+        rescue LockError
+          conflict_instance.on_execute { yield }
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/lock_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    class LockError < StandardError
+    end
+  end
+end

data/lib/cloudtasker/unique_job/middleware.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'cloudtasker/redis_client'
+
+require_relative 'lock_error'
+require_relative 'config'
+
+require_relative 'conflict_strategy/base_strategy'
+require_relative 'conflict_strategy/raise'
+require_relative 'conflict_strategy/reject'
+require_relative 'conflict_strategy/reschedule'
+
+require_relative 'lock/base_lock'
+require_relative 'lock/no_op'
+require_relative 'lock/until_executed'
+require_relative 'lock/until_executing'
+require_relative 'lock/while_executing'
+
+require_relative 'job'
+
+require_relative 'middleware/client'
+require_relative 'middleware/server'
+
+module Cloudtasker
+  module UniqueJob
+    # Registration module
+    module Middleware
+      def self.configure
+        Cloudtasker.configure do |config|
+          config.client_middleware { |c| c.add(Middleware::Client) }
+          config.server_middleware { |c| c.add(Middleware::Server) }
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/middleware/client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Middleware
+      # Client middleware, invoked when jobs are scheduled
+      class Client
+        def call(worker)
+          Job.new(worker).lock_instance.schedule { yield }
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/unique_job/middleware/server.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module UniqueJob
+    module Middleware
+      # Server middleware, invoked when jobs are executed
+      class Server
+        def call(worker)
+          Job.new(worker).lock_instance.execute { yield }
+        end
+      end
+    end
+  end
+end

data/lib/cloudtasker/version.rb

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

data/lib/cloudtasker/worker.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  # Cloud Task based workers
+  module Worker
+    # Add class method to including class
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.attr_accessor :job_args, :job_id, :job_meta, :job_reenqueued
+    end
+
+    #
+    # Return a worker instance from a serialized worker.
+    # A worker can be serialized by calling `MyWorker#to_json`
+    #
+    # @param [String] json Worker serialized as json.
+    #
+    # @return [Cloudtasker::Worker, nil] The instantiated worker.
+    #
+    def self.from_json(json)
+      from_hash(JSON.parse(json))
+    rescue JSON::ParserError
+      nil
+    end
+
+    #
+    # Return a worker instance from a worker hash description.
+    # A worker hash description is typically generated by calling `MyWorker#to_h`
+    #
+    # @param [Hash] hash A worker hash description.
+    #
+    # @return [Cloudtasker::Worker, nil] The instantiated worker.
+    #
+    def self.from_hash(hash)
+      # Symbolize payload keys
+      payload = JSON.parse(hash.to_json, symbolize_names: true)
+
+      # Extract worker parameters
+      klass_name = payload&.dig(:worker)
+      return nil unless klass_name
+
+      # Check that worker class is a valid worker
+      worker_klass = Object.const_get(klass_name)
+      return nil unless worker_klass.include?(self)
+
+      # Return instantiated worker
+      worker_klass.new(payload.slice(:job_args, :job_id, :job_meta))
+    rescue NameError
+      nil
+    end
+
+    # Module class methods
+    module ClassMethods
+      #
+      # Set the worker runtime options.
+      #
+      # @param [Hash] opts The worker options
+      #
+      # @return [<Type>] <description>
+      #
+      def cloudtasker_options(opts = {})
+        opt_list = opts&.map { |k, v| [k.to_s, v] } || [] # stringify
+        @cloudtasker_options_hash = Hash[opt_list]
+      end
+
+      #
+      # Return the worker runtime options.
+      #
+      # @return [Hash] The worker runtime options.
+      #
+      def cloudtasker_options_hash
+        @cloudtasker_options_hash
+      end
+
+      #
+      # Enqueue worker in the backgroundf.
+      #
+      # @param [Array<any>] *args List of worker arguments
+      #
+      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      #
+      def perform_async(*args)
+        perform_in(nil, *args)
+      end
+
+      #
+      # Enqueue worker and delay processing.
+      #
+      # @param [Integer, nil] interval The delay in seconds.
+      # @param [Array<any>] *args List of worker arguments.
+      #
+      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      #
+      def perform_in(interval, *args)
+        new(job_args: args).schedule(interval: interval)
+      end
+
+      #
+      # Enqueue worker and delay processing.
+      #
+      # @param [Time, Integer] time_at The time at which the job should run.
+      # @param [Array<any>] *args List of worker arguments
+      #
+      # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+      #
+      def perform_at(time_at, *args)
+        new(job_args: args).schedule(time_at: time_at)
+      end
+    end
+
+    #
+    # Build a new worker instance.
+    #
+    # @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_args = job_args
+      @job_id = job_id || SecureRandom.uuid
+      @job_meta = MetaStore.new(job_meta)
+    end
+
+    #
+    # Execute the worker by calling the `perform` with the args.
+    #
+    # @return [Any] The result of the perform.
+    #
+    def execute
+      Cloudtasker.config.server_middleware.invoke(self) do
+        perform(*job_args)
+      end
+    end
+
+    #
+    # Enqueue a worker, with or without delay.
+    #
+    # @param [Integer] interval The delay in seconds.
+    #
+    # @param [Time, Integer] interval The time at which the job should run
+    #
+    # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+    #
+    def schedule(interval: nil, time_at: nil)
+      Cloudtasker.config.client_middleware.invoke(self) do
+        Task.new(self).schedule(interval: interval, time_at: time_at)
+      end
+    end
+
+    #
+    # Helper method used to re-enqueue the job. Re-enqueued
+    # jobs keep the same job_id.
+    #
+    # This helper may be useful when jobs must pause activity due to external
+    # factors such as when a third-party API is throttling the rate of API calls.
+    #
+    # @param [Integer] interval Delay to wait before processing the job again (in seconds).
+    #
+    # @return [Google::Cloud::Tasks::V2beta3::Task] The Google Task response
+    #
+    def reenqueue(interval)
+      @job_reenqueued = true
+      schedule(interval: interval)
+    end
+
+    #
+    # Return a new instance of the worker with the same args and metadata
+    # but with a different id.
+    #
+    # @return [<Type>] <description>
+    #
+    def new_instance
+      self.class.new(job_args: job_args, job_meta: job_meta)
+    end
+
+    #
+    # Return a hash description of the worker.
+    #
+    # @return [Hash] The worker hash description.
+    #
+    def to_h
+      {
+        worker: self.class.to_s,
+        job_id: job_id,
+        job_args: job_args,
+        job_meta: job_meta.to_h
+      }
+    end
+
+    #
+    # Return a json representation of the worker.
+    #
+    # @param [Array<any>] *args Arguments passed to to_json.
+    #
+    # @return [String] The worker json representation.
+    #
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
+    #
+    # Equality operator.
+    #
+    # @param [Any] other The object to compare.
+    #
+    # @return [Boolean] True if the object is equal.
+    #
+    def ==(other)
+      other.is_a?(self.class) && other.job_id == job_id
+    end
+  end
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: cloudtasker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arnaud Lachaume
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: timecop
+  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: rails
+  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: rspec-rails
+  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: sqlite3
+  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'
+description: Manage GCP Cloud Tasks in your app.
+email:
+- arnaud.lachaume@keypup.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/cloudtasker/application_controller.rb
+- app/controllers/cloudtasker/worker_controller.rb
+- bin/console
+- bin/setup
+- cloudtasker.gemspec
+- config/routes.rb
+- lib/cloudtasker.rb
+- lib/cloudtasker/authentication_error.rb
+- lib/cloudtasker/authenticator.rb
+- lib/cloudtasker/batch.rb
+- lib/cloudtasker/batch/batch_progress.rb
+- lib/cloudtasker/batch/config.rb
+- lib/cloudtasker/batch/extension/worker.rb
+- lib/cloudtasker/batch/job.rb
+- lib/cloudtasker/batch/middleware.rb
+- lib/cloudtasker/batch/middleware/server.rb
+- lib/cloudtasker/config.rb
+- lib/cloudtasker/cron.rb
+- lib/cloudtasker/cron/config.rb
+- lib/cloudtasker/cron/job.rb
+- lib/cloudtasker/cron/middleware.rb
+- lib/cloudtasker/cron/middleware/server.rb
+- lib/cloudtasker/cron/schedule.rb
+- lib/cloudtasker/engine.rb
+- lib/cloudtasker/invalid_worker_error.rb
+- lib/cloudtasker/meta_store.rb
+- lib/cloudtasker/middleware/chain.rb
+- lib/cloudtasker/redis_client.rb
+- lib/cloudtasker/task.rb
+- lib/cloudtasker/unique_job.rb
+- lib/cloudtasker/unique_job/config.rb
+- lib/cloudtasker/unique_job/conflict_strategy/base_strategy.rb
+- lib/cloudtasker/unique_job/conflict_strategy/raise.rb
+- lib/cloudtasker/unique_job/conflict_strategy/reject.rb
+- lib/cloudtasker/unique_job/conflict_strategy/reschedule.rb
+- lib/cloudtasker/unique_job/job.rb
+- lib/cloudtasker/unique_job/lock/base_lock.rb
+- lib/cloudtasker/unique_job/lock/no_op.rb
+- lib/cloudtasker/unique_job/lock/until_executed.rb
+- lib/cloudtasker/unique_job/lock/until_executing.rb
+- lib/cloudtasker/unique_job/lock/while_executing.rb
+- lib/cloudtasker/unique_job/lock_error.rb
+- lib/cloudtasker/unique_job/middleware.rb
+- lib/cloudtasker/unique_job/middleware/client.rb
+- lib/cloudtasker/unique_job/middleware/server.rb
+- lib/cloudtasker/version.rb
+- lib/cloudtasker/worker.rb
+homepage: https://github.com/keypup-io/cloudtasker
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Manage GCP Cloud Tasks in your app.
+test_files: []