activejob-google_cloud_tasks 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b87f633a0a1136d387856e90c6e7869210058f
-  data.tar.gz: f03242b34db220550e8805843a1210fc9935bf24
+  metadata.gz: cef40a41790c74095ed991cd458ed8763162a88d
+  data.tar.gz: f475614b69bcb9399a6c2aa599efacc3676cf706
 SHA512:
-  metadata.gz: 854e667c2c581a28820a2e0df8658b9fc093163d49ac6a76343442178a1f5b177399cb07d37aa86b2cf69809cdbe127024523fa8f75c13aa75a0d07edf34dc09
-  data.tar.gz: 447b61ebce8ceb3d62c22fdab23a939947740a44340181e57094dfe151e3a71ce7a37d1da0b5b839cb3e1105652272d5401d6d155e07008ffd276ddc298c710c
+  metadata.gz: 6aad201da402e146372e57efda259511ea85385ec373a1f4af9251de6d171f89e8066675a4afbdfced02cd4d7d36a682024f562336b99959e2d3325e359a5b4d
+  data.tar.gz: 5720b7da001b0e62fc1a87c4b4939599085f02b824a640e85b1181fc716f338bd15864526602165d42cb63276fc7ffcf6da5cac1276a37d3665cdf0cdd18192f

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+/credentials.tar.gz
+/client-secret.json

data/.travis.yml

@@ -1,7 +1,13 @@
----
 sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.17.1
+- 2.4
+- 2.5
+before_install:
+- openssl aes-256-cbc -K $encrypted_63c75f50f8e0_key -iv $encrypted_63c75f50f8e0_iv -in credentials.tar.gz.enc -out credentials.tar.gz -d
+- tar -xzf credentials.tar.gz
+- export GOOGLE_APPLICATION_CREDENTIALS=${TRAVIS_BUILD_DIR}/client-secret.json
+- gem install bundler -v 1.17.1
+script:
+- bundle exec rake spec

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    activejob-google_cloud_tasks (0.1.1)
+    activejob-google_cloud_tasks (0.1.2)
       activejob
       activesupport
       google-cloud-tasks (~> 0.2.6)
-      rack
+      rack (>= 2.0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,38 +1,97 @@
 # Activejob::GoogleCloudTasks
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activejob/google_cloud_tasks`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/kawabatas/activejob-google_cloud_tasks.svg?branch=master)](https://travis-ci.org/kawabatas/activejob-google_cloud_tasks)
+[![Gem Version](https://badge.fury.io/rb/activejob-google_cloud_tasks.svg)](https://badge.fury.io/rb/activejob-google_cloud_tasks)
 
-TODO: Delete this and the text above, and describe your gem
+Google Cloud Tasks adapter for ActiveJob
+
+## Prerequisites
+- [Creating App Engine Queues](https://cloud.google.com/tasks/docs/creating-appengine-queues)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activejob-google_cloud_tasks'
+gem 'activejob-google_cloud_tasks', '>= 0.1.2'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+First, change the ActiveJob backend.
 
-Or install it yourself as:
+``` ruby
+Rails.application.config.active_job.queue_adapter = Activejob::GoogleCloudTasks::Adapter.new(
+  project: 'MY_GOOGLE_CLOUD_TASKS_PROJECT',
+  location: 'MY_GOOGLE_CLOUD_TASKS_LOCATION'
+)
+```
 
-    $ gem install activejob-google_cloud_tasks
+Second, mount the rack application.
 
-## Usage
+``` ruby
+Rails.application.routes.draw do
+  mount Activejob::GoogleCloudTasks::Rack, at: Activejob::GoogleCloudTasks::Config.path
+end
+```
 
-TODO: Write usage instructions here
+Write the Job class and code to use it.
 
-## Development
+Note: perform argument is one and it must be hash.
 
-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.
+``` ruby
+class SampleJob < ApplicationJob
+  queue_as :default
+  def perform(args)
+    puts "hello, #{args[:name]}!"
+  end
+end
+```
+
+``` ruby
+class SampleController < ApplicationController
+  def job
+    SampleJob.perform_later({name: 'ken'})
+  end
+end
+```
+
+### Adapter
+``` ruby
+Rails.application.config.active_job.queue_adapter = Activejob::GoogleCloudTasks::Adapter.new(
+  project: 'MY_GOOGLE_CLOUD_TASKS_PROJECT',
+  location: 'MY_GOOGLE_CLOUD_TASKS_LOCATION',
+
+  cloud_tasks_client: Google::Cloud::Tasks.new(
+    version: :v2beta3,
+    credentials: 'path/to/keyfile.json'
+  )
+)
+```
 
-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).
+#### Argument Reference
+- `project` - (Required) The ID of the Google Cloud project in which the Cloud Tasks belongs.
+
+- `location` - (Required) The Location of the Cloud Tasks.
+
+- `cloud_tasks_client` - (Optional) The instance of `Google::Cloud::Tasks`. Please see [`Google::Cloud::Tasks.new`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-tasks/latest/Google/Cloud/Tasks.html#new-class_method) for details. Default: `Google::Cloud::Tasks.new(version: :v2beta3)`
+
+### Config
+```
+Activejob::GoogleCloudTasks::Config.path = '/foo'
+```
+
+- `path` - (Optional) The path which the Cloud Tasks service forwards the task request to the worker. Default: `/activejobs`
+
+## Development
+
+``` sh
+$ bundle exec rake spec
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activejob-google_cloud_tasks.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kawabatas/activejob-google_cloud_tasks.
 
 ## License
 

data/activejob-google_cloud_tasks.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'rack', ">= 2.0.6"
   spec.add_runtime_dependency 'activejob'
   spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'google-cloud-tasks', '~> 0.2.6'

data/lib/activejob/google_cloud_tasks/adapter.rb

@@ -5,10 +5,10 @@ require 'google/cloud/tasks/v2beta3/cloud_tasks_client'
 module Activejob
   module GoogleCloudTasks
     class Adapter
-      def initialize(project:, location:)
+      def initialize(project:, location:, cloud_tasks_client: Google::Cloud::Tasks.new(version: :v2beta3))
         @project = project
         @location = location
-        @cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta3)
+        @cloud_tasks_client = cloud_tasks_client
       end
 
       def enqueue(job, attributes = {})

data/lib/activejob/google_cloud_tasks/version.rb

@@ -1,5 +1,5 @@
 module Activejob
   module GoogleCloudTasks
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob-google_cloud_tasks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kawabata Shintaro
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.6
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - activejob-google_cloud_tasks.gemspec
 - bin/console
 - bin/setup
+- credentials.tar.gz.enc
 - lib/activejob/google_cloud_tasks.rb
 - lib/activejob/google_cloud_tasks/adapter.rb
 - lib/activejob/google_cloud_tasks/config.rb