activejob-google_cloud_tasks-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4694c9ea8efd4f67ea12ae5011035fe264b532f8bb0e99a82d8137b5d584ba49
+  data.tar.gz: 4e2c1e6eeba5dcffdc2bc0b4fcad1823c144dbb252ccf4c0a7aca71ac8528671
+SHA512:
+  metadata.gz: aab00a20ed4211c65c9c2882b8c9a50dba29d1cf085da1881491e7ff91e5aa37767a266dcb8ad79c63dc3492e0d916844b41e1c24a6693cce493ac68b786cd40
+  data.tar.gz: 8a06da299780bbf8601f3cf7c6a708ea1ce52f0a6e3ac4a5966a20d42ca5d49b5c378c05b4365874d9d4aa7efab43f13d541c840bb5d038193f03b4b5999ced9

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activejob-google_cloud_tasks-http.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# ActiveJob::GoogleCloudTasks::HTTP
+
+ActiveJob::GoogleCloudTasks::HTTP is an ActiveJob adapter for running jobs via Google Cloud Tasks. As the name suggests it only supports HTTP targets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activejob-google_cloud_tasks-http'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-google_cloud_tasks-http
+
+## Usage
+
+### Setup
+
+Configure an adapter instance and pass it to Active Job:
+
+```ruby
+Rails.application.config.active_job.queue_adapter = ActiveJob::GoogleCloudTasks::HTTP::Adapter.new(
+  project: 'a-gcp-project-name',
+  location: 'asia-northeast1',
+  url: 'https://an-endpoint-to-perform-jobs.a.run.app/_jobs',
+  client: Google::Cloud::Tasks.new(version: :v2beta3), # optional
+  task_options: { # optional
+    oidc_token: {
+      service_account_email: 'cloudrun-invoker@a-gcp-project-name.iam.gserviceaccount.com'
+    }
+  }
+)
+```
+
+A name passed to `queue_as` will be used to identify which Cloud Tasks queue will be used by the job:
+
+```ruby
+class GoodJob < ApplicationJob
+  queue_as :a_queue_name
+
+  # ...
+end
+```
+
+Mount the Rack application to set up an endpoint for performing jobs:
+
+```ruby
+# in config/routes.rb
+mount ActiveJob::GoogleCloudTasks::HTTP::Rack.new, at: '/_jobs'
+```
+
+Note that this rack app itself does not have any authentication mechanism.
+
+### Testing
+
+Requiring `active_job/google_cloud_tasks/http/inline` makes the adapter skip enqueueing jobs to Google Cloud Tasks. Once a job is enqueued, it will perform the job immediately.
+
+```ruby
+require 'active_job/google_cloud_tasks/http/inline' unless Rails.env.production?
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/esminc/activejob-google_cloud_tasks-http.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activejob-google_cloud_tasks-http.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_job/google_cloud_tasks/http/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-google_cloud_tasks-http"
+  spec.version       = ActiveJob::GoogleCloudTasks::HTTP::VERSION
+  spec.authors       = ["hibariya"]
+  spec.email         = ["hibariya@gmail.com"]
+
+  spec.summary       = %q{ActiveJob adapter for Google Cloud Tasks HTTP targets.}
+  spec.description   = %q{ActiveJob adapter for Google Cloud Tasks HTTP targets.}
+  spec.homepage      = "https://github.com/esminc/activejob-google_cloud_tasks-http"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activejob"
+  spec.add_runtime_dependency "google-cloud-tasks"
+  spec.add_runtime_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_job/google_cloud_tasks/http"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_job/google_cloud_tasks/http.rb

@@ -0,0 +1,9 @@
+module ActiveJob
+  module GoogleCloudTasks
+    module HTTP
+      autoload :Adapter, 'active_job/google_cloud_tasks/http/adapter'
+      autoload :Rack,    'active_job/google_cloud_tasks/http/rack'
+      autoload :VERSION, 'active_job/google_cloud_tasks/http/version'
+    end
+  end
+end

data/lib/active_job/google_cloud_tasks/http/adapter.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'google/cloud/tasks'
+
+module ActiveJob
+  module GoogleCloudTasks
+    module HTTP
+      class Adapter
+        def initialize(project:, location:, url:, task_options: {}, client: nil)
+          @project = project
+          @location = location
+          @url = url
+          @task_options = task_options
+          @client = client
+        end
+
+        def enqueue(job, attributes = {})
+          path = client.queue_path(@project, @location, job.queue_name)
+          task = build_task(job, attributes)
+
+          client.create_task path, task
+        end
+
+        def enqueue_at(job, scheduled_at)
+          enqueue job, scheduled_at: scheduled_at
+        end
+
+        private
+
+        def client
+          @client ||= Google::Cloud::Tasks.new(version: :v2beta3)
+        end
+
+        def build_task(job, attributes)
+          task = {
+            http_request: {
+              http_method: :POST,
+              url: @url,
+              headers: {'Content-Type' => 'application/json'},
+              body: JSON.dump(job: job.serialize).force_encoding(Encoding::ASCII_8BIT),
+              **@task_options
+            }
+          }
+
+          task[:schedule_time] = Google::Protobuf::Timestamp.new(seconds: attributes[:scheduled_at].to_i) if attributes.has_key?(:scheduled_at)
+
+          task
+        end
+      end
+    end
+  end
+end
+

data/lib/active_job/google_cloud_tasks/http/inline.rb

@@ -0,0 +1,17 @@
+require 'active_job/google_cloud_tasks/http/adapter'
+
+module ActiveJob
+  module GoogleCloudTasks
+    module HTTP
+      module Inlining
+        def enqueue(job, *)
+          ActiveJob::Base.execute job.serialize
+        end
+
+        alias enqueue_at enqueue
+      end
+
+      Adapter.prepend Inlining
+    end
+  end
+end

data/lib/active_job/google_cloud_tasks/http/rack.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'rack'
+
+module ActiveJob
+  module GoogleCloudTasks
+    module HTTP
+      class Rack
+        class PayloadError < StandardError; end
+
+        def call(env)
+          request = ::Rack::Request.new(env)
+          payload = extract_payload(request)
+
+          ActiveJob::Base.execute payload
+
+          [200, {}, ['ok']]
+        rescue PayloadError => e
+          [400, {}, [e.cause.message]]
+        rescue => e
+          [500, {}, [e.message]]
+        end
+
+        private
+
+        def extract_payload(request)
+          JSON.parse(request.body.read).fetch('job')
+        rescue JSON::ParserError, KeyError
+          raise PayloadError
+        end
+      end
+    end
+  end
+end

data/lib/active_job/google_cloud_tasks/http/version.rb

@@ -0,0 +1,7 @@
+module ActiveJob
+  module GoogleCloudTasks
+    module HTTP
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: activejob-google_cloud_tasks-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hibariya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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: rack
+  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: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: ActiveJob adapter for Google Cloud Tasks HTTP targets.
+email:
+- hibariya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activejob-google_cloud_tasks-http.gemspec
+- bin/console
+- bin/setup
+- lib/active_job/google_cloud_tasks/http.rb
+- lib/active_job/google_cloud_tasks/http/adapter.rb
+- lib/active_job/google_cloud_tasks/http/inline.rb
+- lib/active_job/google_cloud_tasks/http/rack.rb
+- lib/active_job/google_cloud_tasks/http/version.rb
+homepage: https://github.com/esminc/activejob-google_cloud_tasks-http
+licenses: []
+metadata: {}
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveJob adapter for Google Cloud Tasks HTTP targets.
+test_files: []