cloudtasker 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa7ae9744ddccc745bae1202b99e3891f9ba1035fe26eec3663cfa705ae22e1
-  data.tar.gz: 92d090b796b74c09803ccb4e7cf9468f230b9aeb5df51eb8c630b677988a49b4
+  metadata.gz: 8721e878a098657f0c3974670df6373c873d1df2fa1042b97d9b37d7a1118299
+  data.tar.gz: ffd5652b0220a833f603682fdb4392a850b13b185bd7516dd170f5314d1b4af6
 SHA512:
-  metadata.gz: 7284aa0d993977e53c40d9ecdcc05cca8a0448a32f1189a5f50e38afc538581eac491c47443f0b9c39c0bd0288ce5d6693da0ae07efb8eee93a447276da6e656
-  data.tar.gz: 256a041b899f4a4b1e52f8d5ded83fc4bc370fd7ead98873658f60e107d60cf45c7817d019f13565d4cbd8bb2a0b58ce0a78db2aaaf7de023a37c299103c6a0b
+  metadata.gz: f0f98ff0e0062b28be192f8353363a736f5cb315eb14f86f577586de070127642d123617e8e831dea84271cada640ea3b9ec642ea75f3f9a12cd494432b9e178
+  data.tar.gz: a04500924970efdbc0ceb9364314e0426c92800a4c571b839432de5b9f2faa04e678a67186b0dfd2b32222e8d8606e39ce51b0922ba9687ea827271174dcb23d

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [v0.5.0](https://github.com/keypup-io/cloudtasker/tree/v0.5.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.4.0...v0.5.0)
+
+## [v0.4.0](https://github.com/keypup-io/cloudtasker/tree/v0.4.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.3.0...v0.4.0)
+
+## [v0.3.0](https://github.com/keypup-io/cloudtasker/tree/v0.3.0) (2019-11-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.2.0...v0.3.0)
+
+## [v0.2.0](https://github.com/keypup-io/cloudtasker/tree/v0.2.0) (2019-11-18)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/v0.1.0...v0.2.0)
+
+## [v0.1.0](https://github.com/keypup-io/cloudtasker/tree/v0.1.0) (2019-11-17)
+
+[Full Changelog](https://github.com/keypup-io/cloudtasker/compare/c137feb1ceaaaa4e2fecac0d1f0b4c73151ae002...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudtasker (0.5.0)
+    cloudtasker (0.6.0)
       activesupport
       fugit
       google-cloud-tasks
@@ -84,9 +84,19 @@ GEM
       tzinfo
     faraday (0.17.0)
       multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
     fugit (1.3.3)
       et-orbi (~> 1.1, >= 1.1.8)
       raabro (~> 1.1)
+    github_changelog_generator (1.15.0)
+      activesupport
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     google-cloud-tasks (1.3.1)
@@ -143,6 +153,8 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
     os (1.0.1)
     parallel (1.18.0)
     parser (2.6.5.0)
@@ -181,6 +193,7 @@ GEM
     rainbow (3.0.0)
     rake (10.5.0)
     redis (4.1.3)
+    retriable (3.1.2)
     rly (0.2.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -214,6 +227,9 @@ GEM
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     signet (0.12.0)
       addressable (~> 2.3)
       faraday (~> 0.9)
@@ -249,6 +265,7 @@ DEPENDENCIES
   appraisal
   bundler (~> 2.0)
   cloudtasker!
+  github_changelog_generator
   rails
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -10,6 +10,27 @@ Cloudtasker also provides optional modules for running [cron jobs](docs/CRON_JOB
 
 A local processing server is also available in development. This local server processes jobs in lieu of Cloud Tasks and allow you to work offline.
 
+## Summary
+
+1. [Installation](#installation)
+2. [Get started with Rails](#get-started-with-rails)
+3. [Configuring Cloudtasker](#configuring-cloudtasker)
+    1. [Cloud Tasks authentication & permissions](#cloud-tasks-authentication--permissions)
+    2. [Cloudtasker initializer](#cloudtasker-initializer)
+4. [Enqueuing jobs](#enqueuing-jobs)
+5. [Extensions](#extensions)
+6. [Working locally](#working-locally)
+    1. [Option 1: Cloudtasker local server](#option-1-cloudtasker-local-server)
+    2. [Option 2: Using ngrok](#option-2-using-ngrok)
+7. [Logging](#logging)
+    1. [Configuring a logger](#configuring-a-logger)
+    2. [Logging context](#logging-context)
+8. [Error Handling](#error-handling)
+    1. [HTTP Error codes](#http-error-codes)
+    2. [Error callbacks](#error-callbacks)
+    3. [Max retries](#max-retries)
+9. [Best practices building workers](#best-practices-building-workers)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -77,7 +98,7 @@ Launch Rails and the local Cloudtasker processing server (or add `cloudtasker` t
 > cloudtasker
 ```
 
-Open a Rails console and enqueue your job
+Open a Rails console and enqueue some jobs
 ```ruby
   # Process job as soon as possible
   DummyWorker.perform_async('foo')
@@ -290,7 +311,7 @@ Want to test your application end to end with Google Cloud Task? Then [ngrok](ht
 
 First start your ngrok tunnel and take note of the :
 ```bash
-ngrok tls 3000
+ngrok http 3000
 ```
 
 Take note of your ngrok domain and configure Cloudtasker to use Google Cloud Task in development via ngrok.
@@ -394,7 +415,7 @@ Jobs failing will automatically return an HTTP error to Cloud Task and trigger a
 Jobs failing will automatically return the following HTTP error code to Cloud Tasks, based on the actual reason:
 
 | Code | Description |
-|------|-------------|-----------|
+|------|-------------|
 | 205 | The job is dead and has been removed from the queue |
 | 404 | The job has specified an incorrect worker class.  |
 | 422 | An error happened during the execution of the worker (`perform` method) |
@@ -574,7 +595,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alachaum/cloudtasker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/keypup-io/cloudtasker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -582,7 +603,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Cloudtasker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alachaum/cloudtasker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cloudtasker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/keypup-io/cloudtasker/blob/master/CODE_OF_CONDUCT.md).
 
 ## Author
 

data/Rakefile

@@ -2,7 +2,13 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'github_changelog_generator/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'keypup-io'
+  config.project = 'cloudtasker'
+end

data/app/controllers/cloudtasker/worker_controller.rb

@@ -16,13 +16,15 @@ module Cloudtasker
     # Run a worker from a Cloud Task payload
     #
     def run
-      WorkerHandler.execute_from_payload!(
-        request.params.slice(:worker, :job_id, :job_args, :job_meta).merge(
-          job_retries: job_retries
-        )
-      )
+      # Build payload
+      payload = request.params
+                       .slice(:worker, :job_id, :job_args, :job_meta)
+                       .merge(job_retries: job_retries)
+
+      # Process payload
+      WorkerHandler.execute_from_payload!(payload)
       head :no_content
-    rescue Cloudtasker::DeadWorkerError
+    rescue DeadWorkerError
       # 205: job will NOT be retried
       head :reset_content
     rescue InvalidWorkerError

data/cloudtasker.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Arnaud Lachaume']
   spec.email         = ['arnaud.lachaume@keypup.io']
 
-  spec.summary       = 'Manage GCP Cloud Tasks in your app. (alpha)'
-  spec.description   = 'Manage GCP Cloud Tasks in your app. (alpha)'
+  spec.summary       = 'Background jobs for Ruby using Google Cloud Tasks (alpha)'
+  spec.description   = 'Background jobs for Ruby using Google Cloud Tasks (alpha)'
   spec.homepage      = 'https://github.com/keypup-io/cloudtasker'
   spec.license       = 'MIT'
 
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '0.76.0'

data/lib/cloudtasker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudtasker
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudtasker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Arnaud Lachaume
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Manage GCP Cloud Tasks in your app. (alpha)
+description: Background jobs for Ruby using Google Cloud Tasks (alpha)
 email:
 - arnaud.lachaume@keypup.io
 executables:
@@ -247,6 +261,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -356,5 +371,5 @@ rubyforge_project:
 rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
-summary: Manage GCP Cloud Tasks in your app. (alpha)
+summary: Background jobs for Ruby using Google Cloud Tasks (alpha)
 test_files: []