activejob-google_cloud_tasks-http 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06b5da976d41cd61619702524da58f0dea6226b3f6b5510455d5556afb5a5910
+  data.tar.gz: 567bdda0e0b4e4f6e279c3bfce9508ba795035366c279d9e45cde6b9d638e47d
+SHA512:
+  metadata.gz: b9c65beebd8426e212fae8b5266f5ae911c1ff28f343be83d4e8003af23e7690a0a7c20c4c1cf16ebfbdee52c88436dacee3fb4db00d17a45e1de50549757b6a
+  data.tar.gz: ea19d25710b97c8b38afbb258da990e338457f38c88da277ef3dd1bcf41ff1931eca60d158c90378d2ac2178a9886af11e95dcbb8e4f4268754a8034f7dfd797

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hibariya@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hibariya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveJob::GoogleCloudTasks::HTTP project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/esminc/activejob-google_cloud_tasks-http/blob/master/CODE_OF_CONDUCT.md).

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,32 @@
+
+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"
+  spec.license       = "MIT"
+
+  # 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.3"
+    end
+  end
+end

data/lib/activejob-google_cloud_tasks-http.rb

@@ -0,0 +1 @@
+require 'active_job/google_cloud_tasks/http'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: activejob-google_cloud_tasks-http
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+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"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- 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
+- lib/activejob-google_cloud_tasks-http.rb
+homepage: https://github.com/esminc/activejob-google_cloud_tasks-http
+licenses:
+- MIT
+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: []