cloudenvoy 0.3.1 → 0.5.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8bd773adfe87f0e49c1670e33ecca0654fbfad1fa2e7ce45ae2cb820c1c7012
-  data.tar.gz: fc401a6aa31f68b9138bc52c77b66b9707d6d21d7e19cd6aaae11cbecb1a75e5
+  metadata.gz: 4caf2ea67d821c6523a55d6a0d3049216977a51f7e7660be453e70bdf33a92a6
+  data.tar.gz: 194c131bb03da874172331f3787ff76edd874eb704e802f13ef24396ad7bab30
 SHA512:
-  metadata.gz: 07d4494017e73cf4cb14c3d822d22c0b595ed8a669c4fe967cf1d9a29411a078a9fdc70d9507e70ac52a4b4801e3bce31295db008bd8b613f71efc70198d7200
-  data.tar.gz: dadea963a4ff4a566585d8f4462f6625de9064254c2781a0d62fbc6c3d3819c49fa67cce9917a59970b575ffc091b3b39478229859ced3b65a4a8e7f8d00b184
+  metadata.gz: 57cb75713b8e617724e9424b0781e9e40853bdd1e6b2687b2361acca406740edb739f8552aa62581832983f0f5685de05d72e03d52991a902975f20cd43ff55d
+  data.tar.gz: 67034935f6b83ee47b8afaaf8bbf7199d2466b929eee885834bf7d5c9fe5f3021d5767b21632852dabdd27a7b86105c7d8617459732da7084c3ea46d41407568

data/.github/workflows/lint_rubocop.yml

@@ -0,0 +1,20 @@
+name: Rubocop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0.1'
+          bundler-cache: true
+      - name: Lint codebase
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop

data/.github/workflows/{test.yml → test_ruby_2.5_2.6.yml}

@@ -1,10 +1,6 @@
-name: Test
+name: Ruby 2.5/2.6
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -12,30 +8,29 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.5.x'
-          - '2.6.x'
+          - '2.5.9'
+          - '2.6.7'
         appraisal:
           - 'rails-5.2'
           - 'rails-6.0'
+          - 'rails-6.1'
           - 'semantic_logger-3.4'
           - 'semantic_logger-4.6'
           - 'semantic_logger-4.7.0'
           - 'semantic_logger-4.7.2'
     steps:
-      - name: Setup System
-        run: sudo apt-get install libsqlite3-dev
       - uses: actions/checkout@v2
       - uses: zhulik/redis-action@1.1.0
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Build and test with Rake
         env:
             APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rubocop
           bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
           bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_2.7.yml

@@ -0,0 +1,36 @@
+name: Ruby 2.7
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.5'
+        appraisal:
+          - 'rails-5.2'
+          - 'rails-6.0'
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_3.x.yml

@@ -0,0 +1,35 @@
+name: Ruby 3.x
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.0.1'
+          # - '3.1.0'
+        appraisal:
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.gitignore

@@ -10,5 +10,8 @@
 /tmp/
 /log/*.log
 
+# Ignore lock files (e.g. Gemfile.lock)
+*.lock
+
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -5,6 +5,11 @@ AllCops:
     - 'gemfiles/**/*'
     - 'vendor/**/*'
 
+# Ruby 3.0: curly braces around last argument has meaning
+# See: https://github.com/rubocop/rubocop/issues/7641
+Style/BracesAroundHashParameters:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 150
 

data/Appraisals

@@ -1,25 +1,45 @@
 # frozen_string_literal: true
 
-appraise 'rails-5.2' do
-  gem 'rails', '5.2'
+if RUBY_VERSION < '3'
+  appraise 'rails-5.2' do
+    gem 'rails', '5.2'
+    gem 'rspec-rails'
+  end
+
+  appraise 'rails-6.0' do
+    gem 'rails', '6.0'
+    gem 'rspec-rails'
+  end
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '6.1'
+  gem 'rspec-rails'
 end
 
-appraise 'rails-6.0' do
-  gem 'rails', '6.0'
+if RUBY_VERSION >= '2.7'
+  appraise 'rails-7.0' do
+    gem 'rails', '7.0'
+    gem 'rspec-rails'
+  end
 end
 
 appraise 'semantic_logger-3.4' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '3.4.1'
 end
 
 appraise 'semantic_logger-4.6' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.6.1'
 end
 
 appraise 'semantic_logger-4.7.0' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.0'
 end
 
 appraise 'semantic_logger-4.7.2' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.2'
 end

data/CHANGELOG.md

@@ -1,12 +1,43 @@
 # Changelog
 
-## [v0.3.1](https://github.com/keypup-io/cloudenvoy/tree/v0.3.1) (2020-10-05)
+## [v0.5.rc1](https://github.com/keypup-io/cloudenvoy/tree/v0.5.rc1) (2022-01-05)
 
-[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.3.0...v0.3.1)
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.2...v0.5.rc1)
+
+**Improvements:**
+- Ruby 3: Rework method arguments to be compatible with Ruby 3
+- Tests: Separate test environment for Ruby 2 and Ruby 3
+- Tests: Do not load Rails by default and skip Rails-specific tests in non-Rails appraisals
+
+## [v0.4.2](https://github.com/keypup-io/cloudenvoy/tree/v0.4.2) (2021-10-25)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.1...v0.4.2)
+
+**Bug fix:**
+- Message processing: fix subscription parsing for topic names with dots.
+
+## [v0.4.1](https://github.com/keypup-io/cloudenvoy/tree/v0.4.1) (2020-10-06)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.0...v0.4.1)
+
+**Bug fix:**
+- Logging: log publisher and subscriber errors during execution
+- Rake tasks: fix early return statement when publisher or subscriber list is empty
+
+## [v0.4.0](https://github.com/keypup-io/cloudenvoy/tree/v0.4.0) (2020-10-05)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.3.1...v0.4.0)
 
 **Bug fix:**
 - Logging: fix log processing with `semantic_logger` `v4.7.2`. Accept any args on block passed to the logger.
 
+## [v0.3.1](https://github.com/keypup-io/cloudenvoy/tree/v0.3.1) (2020-10-05)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.3.0...v0.3.1)
+
+**Improvements:**
+- Development: auto-create topics in development mode when registering subscriptions.
+
 ## [v0.3.0](https://github.com/keypup-io/cloudenvoy/tree/v0.3.0) (2020-09-26)
 
 [Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.2.0...v0.3.0)

data/README.md

@@ -1,7 +1,5 @@
 ![Build Status](https://github.com/keypup-io/cloudenvoy/workflows/Test/badge.svg) [![Gem Version](https://badge.fury.io/rb/cloudenvoy.svg)](https://badge.fury.io/rb/cloudenvoy)
 
-**Note**: this gem is currently in alpha stage and has not been tested in production yet.
-
 # Cloudenvoy
 
 Cross-application messaging framework for GCP Pub/Sub.
@@ -12,6 +10,8 @@ Pub/Sub solves that event distribution problem by allowing developers to define
 
 Cloudenvoy works with the local pub/sub emulator as well, meaning that you can work offline without access to GCP.
 
+**Maturity**: The gem is relatively young but is production-friendly. We at Keypup have already processed hundreds of thousands of pub/sub messages through Cloudenvoy. If you spot any bug, feel free to report it! we're aiming at a `v1.0.0` around Q1 2022.
+
 ## Summary
 
 1. [Installation](#installation)
@@ -80,7 +80,7 @@ Cloudenvoy.configure do |config|
 end
 ```
 
-Define a publisher:
+Define a publisher or use generator: `rails generate cloudenvoy:publisher Dummy`
 ```ruby
 # app/publishers/dummy_publisher.rb
 
@@ -100,7 +100,7 @@ class DummyPublisher
 end
 ```
 
-Define a subscriber:
+Define a subscriber or use generator: `rails generate cloudenvoy:subscriber Dummy`
 ```ruby
 # app/subscribers/dummy_subscriber.rb
 

data/app/controllers/cloudenvoy/subscriber_controller.rb

@@ -2,7 +2,10 @@
 
 module Cloudenvoy
   # Handle execution of Cloudenvoy subscribers
-  class SubscriberController < ApplicationController
+  class SubscriberController < ActionController::Base
+    # No need for CSRF verification on API endpoints
+    skip_before_action :verify_authenticity_token
+
     # Authenticate all requests.
     before_action :authenticate!
 
@@ -22,10 +25,8 @@ module Cloudenvoy
     rescue InvalidSubscriberError
       # 404: Message delivery will be retried
       head :not_found
-    rescue StandardError => e
+    rescue StandardError
       # 422: Message delivery will be retried
-      Cloudenvoy.logger.error(e)
-      Cloudenvoy.logger.error(e.backtrace.join("\n"))
       head :unprocessable_entity
     end
 
@@ -42,7 +43,7 @@ module Cloudenvoy
         # Get raw body
         content = request.body.read
 
-        # Return content parsed as JSON and add job retries count
+        # Return content parsed as JSON
         JSON.parse(content).except('token')
       end
     end

data/cloudenvoy.gemspec

@@ -40,8 +40,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'semantic_logger'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock'
-
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'sqlite3'
 end

data/examples/rails/.ruby-version

@@ -1 +1 @@
-ruby-2.5.5
+ruby-3.0.0

data/examples/rails/Gemfile

@@ -3,11 +3,14 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.5.5'
+ruby '3.0.0'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0.2'
 
+# Server
+gem 'puma', '~> 5.5.2'
+
 # Messaging via GCP Pub/Sub
 gem 'cloudenvoy', path: '../../'