cloudenvoy 0.3.0 → 0.4.2

data/examples/sinatra/README.md

@@ -0,0 +1,41 @@
+# Example usage with Rails
+
+## Run using the local gcloud Pub/Sub emulator
+
+1. Install dependencies: `bundle install`
+2. Intall the Pub/Sub emulator: `gcloud components install pubsub-emulator && gcloud components update`
+3. Run the Pub/Sub emulator: `gcloud beta emulators pubsub start`
+4. Launch the server: `foreman start`
+5. Open a Rails console: `./bin/console`
+6. Create the topics and subscriptions (one time setup - no need to redo it until you restart the pubsub emulator)
+```ruby
+Cloudenvoy.setup_publishers
+Cloudenvoy.setup_subscribers
+```
+7. Publish messages:
+```ruby
+HelloPublisher.publish('Some message')
+```
+8. Tail the logs to see how message get processed by `HelloSubscriber`
+
+## Run using GCP Pub/Sub
+
+1. Ensure that your [Google Cloud SDK](https://cloud.google.com/sdk/docs/quickstarts) is setup.
+2. Install dependencies: `bundle install`
+3. Start an [ngrok](https://ngrok.com) tunnel: `ngrok http 3000`
+4. Edit the [initializer](./config/initializers/cloudenvoy.rb) 
+    * Add the configuration of your GCP Pub/Sub
+    * Set `config.processor_host` to the ngrok http or https url
+    * Set `config.mode` to `:production`
+5. Launch the server: `foreman start`
+6. Open a Rails console: `./bin/console`
+7. Create the topics and subscriptions (one time setup)
+```ruby
+Cloudenvoy.setup_publishers
+Cloudenvoy.setup_subscribers
+```
+8. Publish messages
+```ruby
+HelloPublisher.publish('Some message')
+```
+9. Tail the logs to see how message get processed by `HelloSubscriber`

data/examples/sinatra/app/publishers/hello_publisher.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class HelloPublisher
+  include Cloudenvoy::Publisher
+
+  cloudenvoy_options topic: 'hello-msgs'
+
+  #
+  # Set message metadata (attributes)
+  #
+  # @param [String] msg The message to publish
+  #
+  # @return [Hash] The message metadata
+  #
+  def metadata(msg)
+    {
+      kind: msg.start_with?('Hello') ? 'hello' : 'regular'
+    }
+  end
+
+  #
+  # Format the payload.
+  #
+  # @param [String] msg The message to publish
+  #
+  # @return [Hash] The formatted message
+  #
+  def payload(msg)
+    {
+      type: 'message',
+      content: msg
+    }
+  end
+end

data/examples/sinatra/app/subscribers/hello_subscriber.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class HelloSubscriber
+  include Cloudenvoy::Subscriber
+
+  cloudenvoy_options topic: 'hello-msgs'
+
+  #
+  # Process a pub/sub message
+  #
+  # @param [Cloudenvoy::Message] message The message to process.
+  #
+  def process(message)
+    logger.info("Received message #{message.payload.dig('content')}")
+  end
+end

data/examples/sinatra/app.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Force logging to be realtime
+STDOUT.sync = true
+
+# Require project files
+require 'sinatra'
+Dir.glob('./config/initializers/*.rb').each { |file| require file }
+Dir.glob('./app/publishers/*.rb').each { |file| require file }
+Dir.glob('./app/subscribers/*.rb').each { |file| require file }
+
+#---------------------------------------------------
+# Routes
+#---------------------------------------------------
+
+get '/' do
+  'Hello!'
+end
+
+post '/cloudenvoy/receive' do
+  begin
+    # Authenticate request
+    Cloudenvoy::Authenticator.verify!(params['token'])
+
+    # Parse message descriptor
+    content = request.body.read
+    msg_descriptor = JSON.parse(content).except('token')
+
+    # Process message descriptor
+    Cloudenvoy::Subscriber.execute_from_descriptor(msg_descriptor)
+    return 204
+  rescue Cloudenvoy::InvalidSubscriberError
+    # 404: Message delivery will be retried
+    return 404
+  rescue StandardError => e
+    # 422: Message delivery will be retried
+    logger.info([e.message, e.backtrace].flatten.join("\n"))
+    return 422
+  end
+end

data/examples/sinatra/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require File.expand_path('../app.rb', __dir__)
+
+require 'irb'
+IRB.start(__FILE__)

data/examples/sinatra/config/initializers/cloudenvoy.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Require cloudenvoy and its extensions
+require 'cloudenvoy'
+
+Cloudenvoy.configure do |config|
+  #
+  # Secret used to authenticate job requests
+  #
+  config.secret = 'some-secret'
+
+  #
+  # GCP Configuration
+  #
+  config.gcp_project_id = 'some-project'
+  config.gcp_sub_prefix = 'my-app'
+
+  #
+  # Domain
+  #
+  # config.processor_host = 'https://xxxx.ngrok.io'
+  #
+  config.processor_host = 'http://localhost:3000'
+
+  #
+  # Uncomment to process messages via Pub/Sub.
+  # Requires a ngrok tunnel.
+  #
+  # config.mode = :production
+end

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cloudenvoy (0.2.0)
+    cloudenvoy (0.4.1)
       activesupport
       google-cloud-pubsub (~> 2.0)
       jwt
@@ -53,70 +53,78 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.3.0)
+    appraisal (2.4.0)
       bundler
       rake
       thor (>= 0.14.0)
     arel (9.0.0)
-    ast (2.4.1)
+    ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
     crass (1.0.6)
-    diff-lcs (1.4.2)
-    erubi (1.9.0)
-    faraday (1.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-    gapic-common (0.3.4)
-      google-protobuf (~> 3.12, >= 3.12.2)
-      googleapis-common-protos (>= 1.3.9, < 2.0)
-      googleapis-common-protos-types (>= 1.0.4, < 2.0)
-      googleauth (~> 0.9)
-      grpc (~> 1.25)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    gapic-common (0.4.1)
+      faraday (~> 1.3)
+      google-protobuf (~> 3.15, >= 3.15.2)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      googleauth (~> 0.15, >= 0.15.1)
+      grpc (~> 1.36)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    google-cloud-core (1.5.0)
+    google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
-    google-cloud-env (1.3.3)
+    google-cloud-env (1.5.0)
       faraday (>= 0.17.3, < 2.0)
-    google-cloud-errors (1.0.1)
-    google-cloud-pubsub (2.0.0)
+    google-cloud-errors (1.1.0)
+    google-cloud-pubsub (2.5.0)
       concurrent-ruby (~> 1.1)
       google-cloud-core (~> 1.5)
       google-cloud-pubsub-v1 (~> 0.0)
-    google-cloud-pubsub-v1 (0.1.2)
+    google-cloud-pubsub-v1 (0.4.0)
       gapic-common (~> 0.3)
       google-cloud-errors (~> 1.0)
       grpc-google-iam-v1 (>= 0.6.10, < 2.0)
-    google-protobuf (3.13.0-universal-darwin)
-    googleapis-common-protos (1.3.10)
-      google-protobuf (~> 3.11)
-      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+    google-protobuf (3.15.8)
+    googleapis-common-protos (1.3.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
       grpc (~> 1.27)
-    googleapis-common-protos-types (1.0.5)
-      google-protobuf (~> 3.11)
-    googleauth (0.13.1)
+    googleapis-common-protos-types (1.0.6)
+      google-protobuf (~> 3.14)
+    googleauth (0.16.1)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.14)
-    grpc (1.32.0-universal-darwin)
-      google-protobuf (~> 3.13)
+    grpc (1.37.0)
+      google-protobuf (~> 3.15)
       googleapis-common-protos-types (~> 1.0)
-    grpc-google-iam-v1 (0.6.10)
-      google-protobuf (~> 3.11)
-      googleapis-common-protos (>= 1.3.10, < 2.0)
+    grpc-google-iam-v1 (0.6.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
       grpc (~> 1.27)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     jwt (2.2.2)
-    loofah (2.6.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -125,20 +133,24 @@ GEM
       mimemagic (~> 0.3.2)
     memoist (0.16.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    nio4r (2.5.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     os (1.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -167,29 +179,30 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
     retriable (3.1.2)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (4.0.1)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.9)
-      rspec-expectations (~> 3.9)
-      rspec-mocks (~> 3.9)
-      rspec-support (~> 3.9)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -199,9 +212,11 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-rspec (1.37.0)
       rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    signet (0.14.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    semantic_logger (4.7.4)
+      concurrent-ruby (~> 1.0)
+    signet (0.15.0)
       addressable (~> 2.3)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.5, < 3.0)
@@ -209,18 +224,18 @@ GEM
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    thor (1.0.1)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    timecop (0.9.1)
-    tzinfo (1.2.7)
+    timecop (0.9.4)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.1)
-    webmock (3.8.3)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -240,9 +255,10 @@ DEPENDENCIES
   rspec-rails
   rubocop (= 0.76.0)
   rubocop-rspec (= 1.37.0)
+  semantic_logger
   sqlite3
   timecop
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.9