cloudenvoy 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d42680109f30e014cb88dff9c7dc4fad3479f4cfd47131eb934c23ae0e08b2
-  data.tar.gz: af8a2e13e9f44dfc4af98e421084772a4961833a44faeb72b113aaa2e19ea825
+  metadata.gz: 797f52c1101a9e1727d691794494be30e2d8d40a196d64316563596fb071d91b
+  data.tar.gz: e4975868db644a18733020bd78b216aa3ad2a1fb6293c554dc88f39405c39483
 SHA512:
-  metadata.gz: 6449a39dc1bb6e066e9020d824f9c204930e3c32e07c42a9464a2d48ef2b6dc4c179a302236dbaae56f525c7fca3bda33c5ce1fcdb7f03a2234e807a706baab1
-  data.tar.gz: 1271d88b89fc101ad5dccf86236983ff8bfaea72cdcbee52ce6bd484eb79c8cbbc4c312d73e4a73133a1bc60fb88362f49e7a663ca251ba9c0f9b2849f343fe4
+  metadata.gz: 056d422ee16380228e6e7e8b774669f1935fec652cfd7fad840f776096fa566e5cc6a6eecb0d4cd9839323e9a65f9bb4866d38d927d86ac0475c58af98e868c0
+  data.tar.gz: 1e43db1aa3f40ea7727c2bd588133bac7187e7d98a04624c6c855c29ee0f48e6375594e5c791c8f1c62b0cd47775071383fb6183fb7a960afa3c638e3b1832a7

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,5 +1,21 @@
 # Changelog
 
+## [v0.5.0](https://github.com/keypup-io/cloudenvoy/tree/v0.5.0) (2022-03-11)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.2...v0.5.0)
+
+**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)

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)
@@ -35,6 +35,9 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'cloudenvoy'
+
+# For Ruby 3 support, please use v0.5.rc1
+gem 'cloudenvoy, '~> 0.5.rc1'
 ```
 
 And then execute:
@@ -80,7 +83,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 +103,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!
 
@@ -40,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.6.2'
+
 # Messaging via GCP Pub/Sub
 gem 'cloudenvoy', path: '../../'