activejob-google_cloud_tasks-http 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 4694c9ea8efd4f67ea12ae5011035fe264b532f8bb0e99a82d8137b5d584ba49
4
+ data.tar.gz: 4e2c1e6eeba5dcffdc2bc0b4fcad1823c144dbb252ccf4c0a7aca71ac8528671
5
+ SHA512:
6
+ metadata.gz: aab00a20ed4211c65c9c2882b8c9a50dba29d1cf085da1881491e7ff91e5aa37767a266dcb8ad79c63dc3492e0d916844b41e1c24a6693cce493ac68b786cd40
7
+ data.tar.gz: 8a06da299780bbf8601f3cf7c6a708ea1ce52f0a6e3ac4a5966a20d42ca5d49b5c378c05b4365874d9d4aa7efab43f13d541c840bb5d038193f03b4b5999ced9
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ Gemfile.lock
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.5
7
+ before_install: gem install bundler -v 2.0.2
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in activejob-google_cloud_tasks-http.gemspec
6
+ gemspec
@@ -0,0 +1,76 @@
1
+ # ActiveJob::GoogleCloudTasks::HTTP
2
+
3
+ ActiveJob::GoogleCloudTasks::HTTP is an ActiveJob adapter for running jobs via Google Cloud Tasks. As the name suggests it only supports HTTP targets.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'activejob-google_cloud_tasks-http'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install activejob-google_cloud_tasks-http
20
+
21
+ ## Usage
22
+
23
+ ### Setup
24
+
25
+ Configure an adapter instance and pass it to Active Job:
26
+
27
+ ```ruby
28
+ Rails.application.config.active_job.queue_adapter = ActiveJob::GoogleCloudTasks::HTTP::Adapter.new(
29
+ project: 'a-gcp-project-name',
30
+ location: 'asia-northeast1',
31
+ url: 'https://an-endpoint-to-perform-jobs.a.run.app/_jobs',
32
+ client: Google::Cloud::Tasks.new(version: :v2beta3), # optional
33
+ task_options: { # optional
34
+ oidc_token: {
35
+ service_account_email: 'cloudrun-invoker@a-gcp-project-name.iam.gserviceaccount.com'
36
+ }
37
+ }
38
+ )
39
+ ```
40
+
41
+ A name passed to `queue_as` will be used to identify which Cloud Tasks queue will be used by the job:
42
+
43
+ ```ruby
44
+ class GoodJob < ApplicationJob
45
+ queue_as :a_queue_name
46
+
47
+ # ...
48
+ end
49
+ ```
50
+
51
+ Mount the Rack application to set up an endpoint for performing jobs:
52
+
53
+ ```ruby
54
+ # in config/routes.rb
55
+ mount ActiveJob::GoogleCloudTasks::HTTP::Rack.new, at: '/_jobs'
56
+ ```
57
+
58
+ Note that this rack app itself does not have any authentication mechanism.
59
+
60
+ ### Testing
61
+
62
+ 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.
63
+
64
+ ```ruby
65
+ require 'active_job/google_cloud_tasks/http/inline' unless Rails.env.production?
66
+ ```
67
+
68
+ ## Development
69
+
70
+ 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.
71
+
72
+ 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).
73
+
74
+ ## Contributing
75
+
76
+ Bug reports and pull requests are welcome on GitHub at https://github.com/esminc/activejob-google_cloud_tasks-http.
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,31 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "active_job/google_cloud_tasks/http/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "activejob-google_cloud_tasks-http"
8
+ spec.version = ActiveJob::GoogleCloudTasks::HTTP::VERSION
9
+ spec.authors = ["hibariya"]
10
+ spec.email = ["hibariya@gmail.com"]
11
+
12
+ spec.summary = %q{ActiveJob adapter for Google Cloud Tasks HTTP targets.}
13
+ spec.description = %q{ActiveJob adapter for Google Cloud Tasks HTTP targets.}
14
+ spec.homepage = "https://github.com/esminc/activejob-google_cloud_tasks-http"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_runtime_dependency "activejob"
26
+ spec.add_runtime_dependency "google-cloud-tasks"
27
+ spec.add_runtime_dependency "rack"
28
+ spec.add_development_dependency "bundler", "~> 1.17"
29
+ spec.add_development_dependency "rake", "~> 10.0"
30
+ spec.add_development_dependency "rspec", "~> 3.0"
31
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "active_job/google_cloud_tasks/http"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,9 @@
1
+ module ActiveJob
2
+ module GoogleCloudTasks
3
+ module HTTP
4
+ autoload :Adapter, 'active_job/google_cloud_tasks/http/adapter'
5
+ autoload :Rack, 'active_job/google_cloud_tasks/http/rack'
6
+ autoload :VERSION, 'active_job/google_cloud_tasks/http/version'
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,52 @@
1
+ require 'json'
2
+ require 'google/cloud/tasks'
3
+
4
+ module ActiveJob
5
+ module GoogleCloudTasks
6
+ module HTTP
7
+ class Adapter
8
+ def initialize(project:, location:, url:, task_options: {}, client: nil)
9
+ @project = project
10
+ @location = location
11
+ @url = url
12
+ @task_options = task_options
13
+ @client = client
14
+ end
15
+
16
+ def enqueue(job, attributes = {})
17
+ path = client.queue_path(@project, @location, job.queue_name)
18
+ task = build_task(job, attributes)
19
+
20
+ client.create_task path, task
21
+ end
22
+
23
+ def enqueue_at(job, scheduled_at)
24
+ enqueue job, scheduled_at: scheduled_at
25
+ end
26
+
27
+ private
28
+
29
+ def client
30
+ @client ||= Google::Cloud::Tasks.new(version: :v2beta3)
31
+ end
32
+
33
+ def build_task(job, attributes)
34
+ task = {
35
+ http_request: {
36
+ http_method: :POST,
37
+ url: @url,
38
+ headers: {'Content-Type' => 'application/json'},
39
+ body: JSON.dump(job: job.serialize).force_encoding(Encoding::ASCII_8BIT),
40
+ **@task_options
41
+ }
42
+ }
43
+
44
+ task[:schedule_time] = Google::Protobuf::Timestamp.new(seconds: attributes[:scheduled_at].to_i) if attributes.has_key?(:scheduled_at)
45
+
46
+ task
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+
@@ -0,0 +1,17 @@
1
+ require 'active_job/google_cloud_tasks/http/adapter'
2
+
3
+ module ActiveJob
4
+ module GoogleCloudTasks
5
+ module HTTP
6
+ module Inlining
7
+ def enqueue(job, *)
8
+ ActiveJob::Base.execute job.serialize
9
+ end
10
+
11
+ alias enqueue_at enqueue
12
+ end
13
+
14
+ Adapter.prepend Inlining
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,33 @@
1
+ require 'json'
2
+ require 'rack'
3
+
4
+ module ActiveJob
5
+ module GoogleCloudTasks
6
+ module HTTP
7
+ class Rack
8
+ class PayloadError < StandardError; end
9
+
10
+ def call(env)
11
+ request = ::Rack::Request.new(env)
12
+ payload = extract_payload(request)
13
+
14
+ ActiveJob::Base.execute payload
15
+
16
+ [200, {}, ['ok']]
17
+ rescue PayloadError => e
18
+ [400, {}, [e.cause.message]]
19
+ rescue => e
20
+ [500, {}, [e.message]]
21
+ end
22
+
23
+ private
24
+
25
+ def extract_payload(request)
26
+ JSON.parse(request.body.read).fetch('job')
27
+ rescue JSON::ParserError, KeyError
28
+ raise PayloadError
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,7 @@
1
+ module ActiveJob
2
+ module GoogleCloudTasks
3
+ module HTTP
4
+ VERSION = "0.1.0"
5
+ end
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,139 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: activejob-google_cloud_tasks-http
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - hibariya
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-10-04 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activejob
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: google-cloud-tasks
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rack
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.17'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.17'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.0'
97
+ description: ActiveJob adapter for Google Cloud Tasks HTTP targets.
98
+ email:
99
+ - hibariya@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".travis.yml"
106
+ - Gemfile
107
+ - README.md
108
+ - Rakefile
109
+ - activejob-google_cloud_tasks-http.gemspec
110
+ - bin/console
111
+ - bin/setup
112
+ - lib/active_job/google_cloud_tasks/http.rb
113
+ - lib/active_job/google_cloud_tasks/http/adapter.rb
114
+ - lib/active_job/google_cloud_tasks/http/inline.rb
115
+ - lib/active_job/google_cloud_tasks/http/rack.rb
116
+ - lib/active_job/google_cloud_tasks/http/version.rb
117
+ homepage: https://github.com/esminc/activejob-google_cloud_tasks-http
118
+ licenses: []
119
+ metadata: {}
120
+ post_install_message:
121
+ rdoc_options: []
122
+ require_paths:
123
+ - lib
124
+ required_ruby_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: '0'
129
+ required_rubygems_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ requirements: []
135
+ rubygems_version: 3.0.3
136
+ signing_key:
137
+ specification_version: 4
138
+ summary: ActiveJob adapter for Google Cloud Tasks HTTP targets.
139
+ test_files: []