rails-cloud-tasks 0.0.1

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: 2b46bc62d822e6eb44925df67eb91ce37e862c48b3c2e7a7543f9ae14a7e6caa
4
+ data.tar.gz: 26455a3286ab916efca56b6947bf867a877976fa0215229927454b166fdf90bc
5
+ SHA512:
6
+ metadata.gz: 3eef0b2920d83f6fea101e10eb1386cfab2300fc06f9c89f85ba3279496d7897d223c69227dd10d770ce42ec5f726443e7e785de6567cea353c0657f8400e4f8
7
+ data.tar.gz: ca08441f14690818fa2203f73de2c22c6cd5ab98f25b264c67291cad76094d8a378bb69aa91246fba293cc08f3d609d13a0451a8b21ec4fd9366b1a9d781ff65
@@ -0,0 +1,98 @@
1
+ name: Github CI
2
+
3
+ on:
4
+ pull_request:
5
+ branches:
6
+ - '**'
7
+ push:
8
+ branches:
9
+ - main
10
+
11
+ jobs:
12
+ linter:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v2
16
+
17
+ - name: Set up Ruby 2.7
18
+ uses: actions/setup-ruby@v1
19
+ with:
20
+ ruby-version: 2.7
21
+
22
+ - name: Install bundler
23
+ run: gem install bundler
24
+
25
+ - name: Cache dependencies
26
+ uses: actions/cache@v1
27
+ with:
28
+ path: vendor/bundle
29
+ key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}
30
+
31
+ - name: Install dependencies
32
+ run: bundle install
33
+
34
+ - name: Lint
35
+ run: bundle exec rubocop
36
+
37
+ build:
38
+ runs-on: ubuntu-latest
39
+ steps:
40
+ - uses: actions/checkout@v2
41
+
42
+ - name: Set up Ruby 2.7
43
+ uses: actions/setup-ruby@v1
44
+ with:
45
+ ruby-version: 2.7
46
+
47
+ - name: Install bundler
48
+ run: gem install bundler
49
+
50
+ - name: Cache dependencies
51
+ uses: actions/cache@v1
52
+ with:
53
+ path: vendor/bundle
54
+ key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}
55
+
56
+ - name: Install dependencies
57
+ run: bundle install
58
+
59
+ - name: Build the package
60
+ run: bundle exec gem build
61
+
62
+ unit:
63
+ runs-on: ubuntu-latest
64
+ steps:
65
+ - uses: actions/checkout@v2
66
+
67
+ - name: Set up Ruby 2.7
68
+ uses: actions/setup-ruby@v1
69
+ with:
70
+ ruby-version: 2.7
71
+
72
+ - name: Install bundler
73
+ run: gem install bundler
74
+
75
+ - name: Cache dependencies
76
+ uses: actions/cache@v1
77
+ with:
78
+ path: vendor/bundle
79
+ key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}
80
+
81
+ - name: Install dependencies
82
+ run: bundle install
83
+
84
+ - name: Prepare coverage
85
+ run: |
86
+ curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
87
+ chmod +x ./cc-test-reporter
88
+ ./cc-test-reporter before-build
89
+
90
+ - name: Run unit tests
91
+ run: bundle exec rspec
92
+ env:
93
+ COVERAGE: true
94
+
95
+ - name: Report coverage
96
+ run: GIT_COMMIT_SHA=$(git rev-parse HEAD) GIT_BRANCH=`[[ -z "$GITHUB_HEAD_REF" ]] && echo ${GITHUB_REF/refs\/heads\/} || echo $GITHUB_HEAD_REF` ./cc-test-reporter after-build -t simplecov --exit-code $?
97
+ env:
98
+ CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
@@ -0,0 +1,42 @@
1
+ name: Release CI
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - v*
7
+
8
+ jobs:
9
+ release:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v2
13
+
14
+ - name: Set up Ruby 2.7
15
+ uses: actions/setup-ruby@v1
16
+ with:
17
+ ruby-version: 2.7
18
+
19
+ - name: Install bundler
20
+ run: gem install bundler
21
+
22
+ - name: Cache dependencies
23
+ uses: actions/cache@v1
24
+ with:
25
+ path: vendor/bundle
26
+ key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}-2.7
27
+
28
+ - name: Install dependencies
29
+ run: bundle install
30
+
31
+ - name: Build package
32
+ run: bundle exec gem build -o rails-cloud-tasks.gem
33
+
34
+ - name: Setup RubyGems credentials
35
+ run: |
36
+ mkdir -p $HOME/.gem
37
+ touch $HOME/.gem/credentials
38
+ chmod 0600 $HOME/.gem/credentials
39
+ printf -- "---\n:rubygems: ${{ secrets.RUBYGEMS_API_TOKEN }}\n" > $HOME/.gem/credentials
40
+
41
+ - name: Push package
42
+ run: gem push --key rubygems rails-cloud-tasks.gem
@@ -0,0 +1,20 @@
1
+ /.bundle/
2
+ /Gemfile.lock
3
+ /coverage/
4
+ /spec/reports/
5
+
6
+ # Ignore all logfiles and tempfiles.
7
+ /log/*
8
+ /tmp/*
9
+ !/log/.keep
10
+ !/tmp/.keep
11
+
12
+ .DS_Store
13
+
14
+ /coverage
15
+ .ruby-gemset
16
+ *.swp
17
+ *.swo
18
+ .rvmrc
19
+ /pkg
20
+ \.idea/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --require spec_helper
2
+ --order random
@@ -0,0 +1,23 @@
1
+ AllCops:
2
+ TargetRubyVersion: 2.4
3
+ DisplayCopNames: true
4
+ NewCops: enable
5
+
6
+ Layout/HashAlignment:
7
+ EnforcedColonStyle: table
8
+
9
+ Layout/LineLength:
10
+ Max: 100
11
+
12
+ Metrics/MethodLength:
13
+ Max: 15
14
+
15
+ Naming/FileName:
16
+ Exclude:
17
+ - lib/rails-cloud-tasks.rb
18
+
19
+ Style/Documentation:
20
+ Enabled: false
21
+
22
+ Style/FrozenStringLiteralComment:
23
+ Enabled: false
@@ -0,0 +1 @@
1
+ 2.7.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in api_client.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,87 @@
1
+ ![Github CI](https://github.com/flamingo-run/rails-cloud-tasks/workflows/Github%20CI/badge.svg)
2
+ [![Maintainability](https://api.codeclimate.com/v1/badges/00d8532b0dd6a345474a/maintainability)](https://codeclimate.com/github/flamingo-run/rails-cloud-tasks/maintainability)
3
+ [![Test Coverage](https://api.codeclimate.com/v1/badges/00d8532b0dd6a345474a/test_coverage)](https://codeclimate.com/github/flamingo-run/rails-cloud-tasks/test_coverage)
4
+ [![ruby](https://img.shields.io/badge/ruby-2.7-red.svg)]()
5
+
6
+ # Rails Cloud Tasks
7
+
8
+ ## APIs
9
+
10
+ The following APIs must be enabled in your project(s):
11
+
12
+ - [Cloud Tasks API](https://console.cloud.google.com/marketplace/product/google/cloudtasks.googleapis.com)
13
+ - [Admin SDK API](https://console.cloud.google.com/marketplace/product/google/admin.googleapis.com)
14
+
15
+ ## Setup
16
+
17
+ ### As an application (when contributing)
18
+
19
+ - Install packages:
20
+
21
+ ```
22
+ bundle install
23
+ ```
24
+
25
+ ### As a package (when inside another application)
26
+
27
+ - Add the gem to application's Gemfile:
28
+ ```
29
+ gem 'rails-cloud-tasks'
30
+ ```
31
+
32
+ - Add an initializer:
33
+ ```ruby
34
+ # ./config/initializers/rails_cloud_tasks.rb
35
+
36
+ require 'rails-cloud-tasks'
37
+
38
+ RailsCloudTasks.configure do |config|
39
+ config.project_id = 'my-gcp-project' # This is not needed if running on GCE
40
+ config.location_id = 'us-central1'
41
+
42
+ # Base url used by Cloud Tasks to reach your application and run the tasks
43
+ config.host = 'https://myapplication.host.com'
44
+ config.tasks_path = '/v2/tasks' # default: '/tasks'
45
+
46
+ # Inject routes into application
47
+ config.inject_routes
48
+ end
49
+ ```
50
+
51
+ - Add a Job class:
52
+ ```ruby
53
+ # ./app/jobs/application_job.rb
54
+
55
+ class ApplicationJob < ActiveJob::Base
56
+ queue_as 'my-default-queue'
57
+ end
58
+
59
+
60
+ # ./app/jobs/my_first_job.rb
61
+
62
+ class MyFirstJob < ApplicationJob
63
+ # Here you may override the queue, if needed
64
+ queue_as 'some-other-queue'
65
+
66
+ def perform(attrs)
67
+ # Execute stuff
68
+ end
69
+ end
70
+ ```
71
+
72
+ - Enqueue a job:
73
+ ```ruby
74
+ MyJob.perform_later(attrs)
75
+ ```
76
+ ## Tests
77
+
78
+ To run tests:
79
+
80
+ ```
81
+ bundle exec rspec
82
+ ```
83
+
84
+
85
+ ## Version
86
+
87
+ Use [Semantic versioning](https://semver.org/).
@@ -0,0 +1,28 @@
1
+ require 'active_support'
2
+ require 'rails_cloud_tasks/rack/errors'
3
+
4
+ module RailsCloudTasks
5
+ extend ActiveSupport::Autoload
6
+
7
+ autoload :Adapter
8
+ autoload :AppEngine
9
+ autoload :Configuration
10
+ autoload :Version
11
+
12
+ module Rack
13
+ extend ActiveSupport::Autoload
14
+
15
+ autoload :Jobs
16
+ autoload :Tasks
17
+ end
18
+
19
+ attr_writer :config
20
+
21
+ def self.configure
22
+ yield(config)
23
+ end
24
+
25
+ def self.config
26
+ @config ||= Configuration.new
27
+ end
28
+ end
@@ -0,0 +1,57 @@
1
+ require 'google-cloud-tasks'
2
+
3
+ module RailsCloudTasks
4
+ class Adapter
5
+ attr_reader :client
6
+
7
+ delegate :project_id, :location_id, :host, :tasks_path, :auth, to: 'RailsCloudTasks.config'
8
+
9
+ def initialize(client = Google::Cloud::Tasks.cloud_tasks)
10
+ @client = client
11
+ end
12
+
13
+ def enqueue(job, timestamp = nil)
14
+ path = client.queue_path(project: project_id, location: location_id, queue: job.queue_name)
15
+ task = build_task(job, timestamp)
16
+
17
+ begin
18
+ client.create_task(parent: path, task: task)
19
+ rescue Google::Cloud::FailedPreconditionError => e
20
+ raise e if e.details != 'Queue does not exist.'
21
+
22
+ client.create_queue(build_queue(path))
23
+ retry
24
+ end
25
+ end
26
+
27
+ def enqueue_at(job, timestamp)
28
+ enqueue(job, timestamp.to_i)
29
+ end
30
+
31
+ private
32
+
33
+ def url
34
+ "#{host}#{tasks_path}"
35
+ end
36
+
37
+ def build_task(job, timestamp)
38
+ {
39
+ http_request: {
40
+ http_method: :POST,
41
+ url: url,
42
+ body: { job: job.serialize }.to_json
43
+ }.merge(auth),
44
+ schedule_time: timestamp && Google::Protobuf::Timestamp.new.tap do |ts|
45
+ ts.seconds = timestamp
46
+ end
47
+ }.compact
48
+ end
49
+
50
+ def build_queue(path)
51
+ {
52
+ parent: path.split('/queues').first,
53
+ queue: { name: path }
54
+ }
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,38 @@
1
+ require 'google-cloud-tasks'
2
+ require 'net/http'
3
+
4
+ module RailsCloudTasks
5
+ module AppEngine
6
+ class << self
7
+ def project_id
8
+ @project_id ||= metadata('project/project-id')
9
+ end
10
+
11
+ def service_account_email
12
+ @service_account_email ||= metadata('instance/service-accounts/default/email')
13
+ end
14
+
15
+ def reset!
16
+ @project_id = nil
17
+ @service_account_email = nil
18
+ end
19
+
20
+ protected
21
+
22
+ def metadata(path)
23
+ return nil unless ::Google::Auth::GCECredentials.on_gce?
24
+
25
+ uri = URI("http://metadata.google.internal/computeMetadata/v1/#{path}")
26
+
27
+ req = Net::HTTP::Get.new(uri)
28
+ req['Metadata-Flavor'] = 'Google'
29
+
30
+ Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(req) }.body
31
+ rescue Errno::EHOSTDOWN
32
+ # This error occurs sporadically when trying to resolve the metadata endpoint
33
+ # locally. It is unlikely to occur when running on GCE.
34
+ nil
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,37 @@
1
+ module RailsCloudTasks
2
+ class Configuration
3
+ attr_accessor :project_id, :location_id, :host, :tasks_path, :jobs, :auth
4
+
5
+ def initialize
6
+ @jobs = Set.new
7
+ @project_id = AppEngine.project_id
8
+ @tasks_path = '/tasks'
9
+ @auth = authenticate
10
+ end
11
+
12
+ def inject_routes
13
+ tasks_path = @tasks_path
14
+
15
+ Rails.application.routes.append do
16
+ post "#{tasks_path}/:job_class", to: RailsCloudTasks::Rack::Jobs
17
+ post tasks_path, to: RailsCloudTasks::Rack::Tasks
18
+ end
19
+ end
20
+
21
+ private
22
+
23
+ def authenticate
24
+ email = AppEngine.service_account_email || Google::Auth.get_application_default.issuer
25
+
26
+ {
27
+ oidc_token: {
28
+ service_account_email: email
29
+ }
30
+ }
31
+ rescue RuntimeError, Errno::EHOSTDOWN
32
+ # EHOSTDOWN occurs sporadically when trying to resolve the metadata endpoint
33
+ # locally. It is unlikely to occur when running on GCE.
34
+ {}
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,5 @@
1
+ module RailsCloudTasks
2
+ module Rack
3
+ class InvalidPayloadError < StandardError; end
4
+ end
5
+ end
@@ -0,0 +1,42 @@
1
+ require 'json'
2
+ require 'rack'
3
+
4
+ module RailsCloudTasks
5
+ module Rack
6
+ class Jobs
7
+ class << self
8
+ def call(env)
9
+ job_class = extract_job_class(env)
10
+
11
+ request = ::Rack::Request.new(env)
12
+ job_args = extract_args(request)
13
+ job_class.perform_now(job_args)
14
+
15
+ response(200, { error: nil })
16
+ rescue Rack::InvalidPayloadError => e
17
+ response(422, { error: e.message })
18
+ rescue StandardError => e
19
+ response(500, { error: e.message })
20
+ end
21
+
22
+ private
23
+
24
+ def extract_job_class(env)
25
+ env.dig('action_dispatch.request.path_parameters', :job_class)
26
+ .constantize
27
+ end
28
+
29
+ def extract_args(request)
30
+ body = request.body.read
31
+ JSON.parse(body)
32
+ rescue JSON::ParserError, KeyError
33
+ raise Rack::InvalidPayloadError
34
+ end
35
+
36
+ def response(status, body)
37
+ [status, { 'Content-Type' => 'application/json' }, [body.to_json]]
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,36 @@
1
+ require 'json'
2
+ require 'rack'
3
+
4
+ module RailsCloudTasks
5
+ module Rack
6
+ class Tasks
7
+ class << self
8
+ def call(env)
9
+ request = ::Rack::Request.new(env)
10
+ job = extract_job(request)
11
+
12
+ ActiveJob::Base.execute(job)
13
+
14
+ response(200, { error: nil })
15
+ rescue Rack::InvalidPayloadError => e
16
+ response(400, { error: e.cause.message })
17
+ rescue StandardError => e
18
+ response(500, { error: e.message })
19
+ end
20
+
21
+ private
22
+
23
+ def extract_job(request)
24
+ body = request.body.read
25
+ JSON.parse(body).fetch('job')
26
+ rescue JSON::ParserError, KeyError
27
+ raise Rack::InvalidPayloadError
28
+ end
29
+
30
+ def response(status, body)
31
+ [status, { 'Content-Type' => 'application/json' }, [body.to_json]]
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,3 @@
1
+ module RailsCloudTasks
2
+ VERSION = '0.0.1'.freeze
3
+ end
@@ -0,0 +1,41 @@
1
+ lib = File.expand_path('lib', __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'rails_cloud_tasks/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'rails-cloud-tasks'
7
+ spec.version = RailsCloudTasks::VERSION
8
+ spec.authors = ['Guilherme Araújo']
9
+ spec.email = ['guilhermeama@gmail.com']
10
+
11
+ spec.summary = 'Rails Cloud Tasks'
12
+ spec.description = 'This gem is a wrapper on Google Cloud Tasks'
13
+ spec.homepage = 'http://github.com/flamingo-run/rails-cloud-tasks'
14
+ spec.license = 'Apache License 2.0'
15
+
16
+ spec.bindir = 'exe'
17
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
18
+ spec.require_paths = ['lib']
19
+
20
+ spec.required_ruby_version = '>= 2.4'
21
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
22
+ f.match(%r{^(test|spec|features)/})
23
+ end
24
+
25
+ spec.add_dependency 'activesupport', '>= 4'
26
+ spec.add_dependency 'google-cloud-tasks', '>= 2'
27
+ spec.add_development_dependency 'rails', '>= 4'
28
+
29
+ spec.add_development_dependency 'bundler'
30
+ spec.add_development_dependency 'pry'
31
+ spec.add_development_dependency 'pry-nav'
32
+ spec.add_development_dependency 'rake'
33
+ spec.add_development_dependency 'rspec'
34
+ spec.add_development_dependency 'rspec-its'
35
+ spec.add_development_dependency 'rspec-rails'
36
+ spec.add_development_dependency 'rubocop'
37
+ spec.add_development_dependency 'rubocop-rspec'
38
+ spec.add_development_dependency 'shoulda-matchers'
39
+ spec.add_development_dependency 'simplecov'
40
+ spec.add_development_dependency 'webmock'
41
+ end
metadata ADDED
@@ -0,0 +1,271 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rails-cloud-tasks
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Guilherme Araújo
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-01-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '4'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '4'
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: '2'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '2'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rails
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '4'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '4'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: pry-nav
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rake
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rspec-its
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rspec-rails
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop-rspec
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: shoulda-matchers
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ - !ruby/object:Gem::Dependency
196
+ name: simplecov
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - ">="
200
+ - !ruby/object:Gem::Version
201
+ version: '0'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: '0'
209
+ - !ruby/object:Gem::Dependency
210
+ name: webmock
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - ">="
214
+ - !ruby/object:Gem::Version
215
+ version: '0'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - ">="
221
+ - !ruby/object:Gem::Version
222
+ version: '0'
223
+ description: This gem is a wrapper on Google Cloud Tasks
224
+ email:
225
+ - guilhermeama@gmail.com
226
+ executables: []
227
+ extensions: []
228
+ extra_rdoc_files: []
229
+ files:
230
+ - ".github/workflows/main.yaml"
231
+ - ".github/workflows/release.yml"
232
+ - ".gitignore"
233
+ - ".rspec"
234
+ - ".rubocop.yml"
235
+ - ".ruby-version"
236
+ - Gemfile
237
+ - LICENSE
238
+ - README.md
239
+ - lib/rails-cloud-tasks.rb
240
+ - lib/rails_cloud_tasks/adapter.rb
241
+ - lib/rails_cloud_tasks/app_engine.rb
242
+ - lib/rails_cloud_tasks/configuration.rb
243
+ - lib/rails_cloud_tasks/rack/errors.rb
244
+ - lib/rails_cloud_tasks/rack/jobs.rb
245
+ - lib/rails_cloud_tasks/rack/tasks.rb
246
+ - lib/rails_cloud_tasks/version.rb
247
+ - rails-cloud-tasks.gemspec
248
+ homepage: http://github.com/flamingo-run/rails-cloud-tasks
249
+ licenses:
250
+ - Apache License 2.0
251
+ metadata: {}
252
+ post_install_message:
253
+ rdoc_options: []
254
+ require_paths:
255
+ - lib
256
+ required_ruby_version: !ruby/object:Gem::Requirement
257
+ requirements:
258
+ - - ">="
259
+ - !ruby/object:Gem::Version
260
+ version: '2.4'
261
+ required_rubygems_version: !ruby/object:Gem::Requirement
262
+ requirements:
263
+ - - ">="
264
+ - !ruby/object:Gem::Version
265
+ version: '0'
266
+ requirements: []
267
+ rubygems_version: 3.1.4
268
+ signing_key:
269
+ specification_version: 4
270
+ summary: Rails Cloud Tasks
271
+ test_files: []