cloudtasker 0.2.0 → 0.7.0

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '6.0'
+
+gemspec path: '../'

data/gemfiles/rails_6.0.gemfile.lock

@@ -0,0 +1,263 @@
+PATH
+  remote: ..
+  specs:
+    cloudtasker (0.2.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.19.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.1)
+    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 (= 6.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  rubocop (= 0.76.0)
+  rubocop-rspec
+  sqlite3
+  timecop
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/lib/cloudtasker.rb

@@ -6,11 +6,14 @@ require 'cloudtasker/version'
 require 'cloudtasker/config'
 
 require 'cloudtasker/authentication_error'
+require 'cloudtasker/dead_worker_error'
 require 'cloudtasker/invalid_worker_error'
 
 require 'cloudtasker/middleware/chain'
 require 'cloudtasker/authenticator'
-require 'cloudtasker/task'
+require 'cloudtasker/cloud_task'
+require 'cloudtasker/worker_logger'
+require 'cloudtasker/worker_handler'
 require 'cloudtasker/meta_store'
 require 'cloudtasker/worker'
 
@@ -25,9 +28,24 @@ module Cloudtasker
     yield(config)
   end
 
+  #
+  # Return the Cloudtasker configuration.
+  #
+  # @return [Cloudtasker::Config] The Cloudtasker configuration.
+  #
   def self.config
     @config ||= Config.new
   end
+
+  #
+  # Return the Cloudtasker logger.
+  #
+  # @return [Logger] The Cloudtasker logger.
+  #
+  def self.logger
+    config.logger
+  end
 end
 
+require 'cloudtasker/railtie' if defined?(Rails)
 require 'cloudtasker/engine' if defined?(::Rails::Engine)

data/lib/cloudtasker/backend/google_cloud_task.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Cloudtasker
+  module Backend
+    # Manage tasks pushed to GCP Cloud Task
+    class GoogleCloudTask
+      attr_accessor :gcp_task
+
+      #
+      # Create the queue configured in Cloudtasker if it does not already exist.
+      #
+      # @return [Google::Cloud::Tasks::V2beta3::Queue] The queue
+      #
+      def self.setup_queue
+        client.get_queue(queue_path)
+      rescue Google::Gax::RetryError
+        client.create_queue(
+          client.location_path(config.gcp_project_id, config.gcp_location_id),
+          name: queue_path,
+          retry_config: { max_attempts: -1 }
+        )
+      end
+
+      #
+      # Return the Google Cloud Task client.
+      #
+      # @return [Google::Cloud::Tasks] The Google Cloud Task client.
+      #
+      def self.client
+        @client ||= ::Google::Cloud::Tasks.new(version: :v2beta3)
+      end
+
+      #
+      # Return the cloudtasker configuration. See Cloudtasker#configure.
+      #
+      # @return [Cloudtasker::Config] The library configuration.
+      #
+      def self.config
+        Cloudtasker.config
+      end
+
+      #
+      # Return the fully qualified path for the Cloud Task queue.
+      #
+      # @return [String] The queue path.
+      #
+      def self.queue_path
+        client.queue_path(
+          config.gcp_project_id,
+          config.gcp_location_id,
+          config.gcp_queue_id
+        )
+      end
+
+      #
+      # Return a protobuf timestamp specifying how to wait
+      # before running a task.
+      #
+      # @param [Integer, nil] schedule_time A unix timestamp.
+      #
+      # @return [Google::Protobuf::Timestamp, nil] The protobuff timestamp
+      #
+      def self.format_schedule_time(schedule_time)
+        return nil unless schedule_time
+
+        # Generate protobuf timestamp
+        Google::Protobuf::Timestamp.new.tap { |e| e.seconds = schedule_time.to_i }
+      end
+
+      #
+      # Find a task by id.
+      #
+      # @param [String] id The task id.
+      #
+      # @return [Cloudtasker::Backend::GoogleCloudTask, nil] The retrieved task.
+      #
+      def self.find(id)
+        resp = client.get_task(id)
+        resp ? new(resp) : nil
+      rescue Google::Gax::RetryError
+        nil
+      end
+
+      #
+      # Create a new task.
+      #
+      # @param [Hash] payload The task payload.
+      #
+      # @return [Cloudtasker::Backend::GoogleCloudTask, nil] The created task.
+      #
+      def self.create(payload)
+        # Format payload
+        payload = payload.merge(
+          schedule_time: format_schedule_time(payload[:schedule_time])
+        ).compact
+
+        # Create task
+        resp = client.create_task(queue_path, payload)
+        resp ? new(resp) : nil
+      rescue Google::Gax::RetryError
+        nil
+      end
+
+      #
+      # Delete a task by id.
+      #
+      # @param [String] id The id of the task.
+      #
+      def self.delete(id)
+        client.delete_task(id)
+      rescue Google::Gax::RetryError
+        nil
+      end
+
+      #
+      # Build a new instance of the class.
+      #
+      # @param [Google::Cloud::Tasks::V2beta3::Task] resp The GCP Cloud Task response
+      #
+      def initialize(gcp_task)
+        @gcp_task = gcp_task
+      end
+
+      #
+      # Return a hash description of the task.
+      #
+      # @return [Hash] A hash description of the task.
+      #
+      def to_h
+        {
+          id: gcp_task.name,
+          http_request: gcp_task.to_h[:http_request],
+          schedule_time: gcp_task.to_h.dig(:schedule_time, :seconds).to_i,
+          retries: gcp_task.to_h[:response_count]
+        }
+      end
+    end
+  end
+end