hanami-events-cloud_pubsub 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 852603b14e6c264281e40be86dad5e487ac3e77759dd9564b3be400fa519618e
-  data.tar.gz: b5a85a233718c80e8704219010e1fe86075609249776846929a7b0a5c2ed849e
+SHA1:
+  metadata.gz: 97f77c6262cd320d8cfdbe03c2ebddcc69008d45
+  data.tar.gz: 5dd8219a8cf755fb32bfb75c8f4e3306bff6715b
 SHA512:
-  metadata.gz: beaf55c053904c12b69c64f2797a959dafa733d30e4364bc62e868a3cb9e78c654c392b58a97b7090e0fd3f705af6a1618cea2a7213e030976135160af2346a4
-  data.tar.gz: d540a62c81a7d25564768b7f539d91894176bea80527f59001da2429a08e3615925ef90207000a43cefb6db26b599f0046e2fd786e4e895204c2eeab052bd396
+  metadata.gz: 4c971196c9903b9466bed196532fda7d9bd4658d05c5a5ecac841ef6caec31aa0b1d356befccfc0ee5f4fa7a55436463f4b1e8faef7c9f9590f321869f28edba
+  data.tar.gz: 501ad612c1ab074e7d9ce4809770b4aa1423250e4e7b88e1f45db3f3fa7b942877c50e00a69c07b6e056ca4d0a11cd02a36622c82947b1ba513dbe04143be5b7

data/.rubocop_todo.yml

@@ -1,24 +1,28 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-11 14:37:44 -0400 using RuboCop version 0.54.0.
+# on 2018-06-13 22:39:48 -0400 using RuboCop version 0.54.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 3
+# Offense count: 1
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
     - 'examples/server.rb'
-    - 'lib/hanami/events/cloud_pubsub/cli.rb'
 
-# Offense count: 22
+# Offense count: 23
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    hanami-events-cloud_pubsub (1.0.0)
+    hanami-events-cloud_pubsub (1.0.1)
       dry-configurable (~> 0.7.0)
       google-cloud-pubsub (~> 0.30.2)
       hanami-cli (~> 0.2.0)

data/README.md

@@ -3,15 +3,37 @@
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```ruby
+bundle add hanami-events-cloud_pubsub
+```
+
+If using Hanami, register the adapter in your `config/environment.rb`:
 
 ```ruby
-gem 'hanami-events-cloud_pubsub'
+# config/environment.rb
+# ...
+require_relative './../lib/my_app'
+require_relative './../apps/web/application'
+# ...
+
+require 'hanami/events/cloud_pubsub/register' # <----
 ```
 
-And then execute:
+Configure the pubsub adapter how you want (optional):
 
-    $ bundle
+```ruby
+# config/environment.rb
+
+Hanami.configure do
+  environment :development do
+    cloud_pubsub do |config|
+      config.pubsub = { project_id: 'emulator' }
+      config.logger = Hanami.logger
+      # ...
+    end
+  end
+end
+```
 
 ## Usage
 
@@ -22,27 +44,12 @@ This gem is compatible with the
 should pass this:
 
 ```ruby
-$events.subscribe('user.deleted', id: 'my-subscriber-id') do |payload|
+Hanami.events.subscribe('user.deleted', id: 'my-subscriber-id') do |payload|
   puts "Deleted user: #{payload}"
 end
 ```
 
-2. If you want mixin behavior, follow this example until [this patch is
-merged](https://github.com/hanami/events/pull/76)
-
-```ruby
-class WelcomeMailer
-  include Hanami::Events::CloudPubsub::Mixin
-
-  subscribe_to $events, 'user.created', id: 'welcome-mailer'
-
-  def call(payload)
-    payload
-  end
-end
-```
-
-3. Responding to events is done in a different process via the CLI.
+2. Responding to events is done in a different process via the CLI.
 
 First, create a config file:
 

data/lib/hanami/events/adapter/cloud_pubsub.rb

@@ -41,8 +41,6 @@ module Hanami
         # @param event_name [Symbol, String] the event name
         # @param block [Block] to execute when event is broadcasted
         def subscribe(event_name, id:, &block)
-          return false unless listening?
-
           logger.debug("Subscribed listener \"#{id}\" for event \"#{event_name}\"")
 
           @subscribers << Subscriber.new(event_name, block, logger)
@@ -56,15 +54,6 @@ module Hanami
           pubs.each(&:stop).map(&:wait!)
         end
 
-        def listen(should_listen = true)
-          @listen = should_listen
-          self
-        end
-
-        def listening?
-          !!@listen # rubocop:disable Style/DoubleNegation
-        end
-
         private
 
         attr_reader :logger

data/lib/hanami/events/cloud_pubsub/cli.rb

@@ -28,13 +28,9 @@ module Hanami
 
             option :config,
                    type: :string,
-                   default: './config/cloudpubsub.rb',
+                   default: './config/boot.rb',
                    desc: 'Config file which is loaded before starting the runner'
 
-            option :project_id,
-                   type: :string,
-                   desc: 'Project ID for the project'
-
             def call(opts)
               setup_env(opts)
               parse_opts(opts)
@@ -55,7 +51,6 @@ module Hanami
 
             def setup_env(opts)
               ENV['PUBSUB_EMULATOR_HOST'] ||= 'localhost:8085' if opts[:emulator]
-              CloudPubsub.setup
             end
 
             def start_server
@@ -85,23 +80,14 @@ module Hanami
             end
 
             def parse_opts(opts)
-              @project_id = opts[:project_id]
               @emulator = opts[:emulator]
               @config = opts[:config]
             end
 
             def build_runner
-              pubsub_opts = {}
-
-              pubsub_opts[:project_id] = 'emulator' if @emulator
-              pubsub_opts[:project_id] = @project_id if @project_id
-
-              pubsub = Google::Cloud::Pubsub.new pubsub_opts
-              $events = Hanami::Events.initialize(:cloud_pubsub,
-                                                  pubsub: pubsub,
-                                                  logger: logger,
-                                                  listen: true)
-              @runner = Runner.new(logger: logger, adapter: $events.adapter)
+              Hanami::Components.resolve 'events'
+              events = Hanami::Components['events']
+              @runner = Runner.new(logger: logger, adapter: events.adapter)
             end
 
             def logger

data/lib/hanami/events/cloud_pubsub/integration.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Integration
+        # Helpers use to setup all integration with hanami
+        module Setup
+          module_function
+
+          def setup
+            register_events_adapter
+            register_hanami_component
+            hook_into_all
+            add_configuration_helpers
+          end
+
+          def register_events_adapter
+            ::Hanami::Events::Adapter.register(:cloud_pubsub) do
+              require 'hanami/events/adapter/cloud_pubsub'
+              ::Hanami::Events::Adapter::CloudPubsub
+            end
+          end
+
+          def register_hanami_component
+            ::Hanami::Components.register 'events' do
+              requires 'logger', 'code'
+
+              prepare { require 'hanami/events/cloud_pubsub' }
+
+              resolve do |conf|
+                CloudPubsub.configure do |config|
+                  conf.cloud_pubsub.each { |blk| blk.call(config) }
+                end
+
+                ::Hanami::Events.initialize(
+                  :cloud_pubsub,
+                  pubsub: Google::Cloud::Pubsub.new,
+                  logger: Hanami::Components['logger']
+                )
+              end
+            end
+          end
+
+          def hook_into_all
+            require 'hanami/components'
+            # Unfortunately, hanami does not provide a way to add the component
+            # requirements easily, so we take the old requirements and append 'events'
+            requirements_for_all = ::Hanami::Components.component('all').send(:requirements)
+
+            ::Hanami::Components.register 'all' do
+              requires(*requirements_for_all, 'events')
+              resolve { true }
+            end
+          end
+
+          def add_configuration_helpers
+            require 'hanami/utils/load_paths'
+            require 'hanami/configuration'
+            ::Hanami::Configuration.include(Integration::Configuration)
+            ::Hanami.extend Integration::EasyAccess
+          end
+        end
+
+        # Extra configuration methods for Hanami
+        #
+        # @example Use emulator in development
+        #   # config/environment.rb
+        #   Hanami.configure do
+        #     environment :development do
+        #       cloud_pubsub do |conf|
+        #         conf.pubsub = { project_id: 'emulator' }
+        #       end
+        #     end
+        #   end
+        module Configuration
+          def cloud_pubsub(&blk)
+            if block_given?
+              settings[:cloud_pubsub] ||= []
+              settings[:cloud_pubsub] << blk
+            end
+
+            settings[:cloud_pubsub]
+          end
+        end
+
+        # Easy access to events, i.e. Hanami.events
+        module EasyAccess
+          def events
+            Hanami::Components['events']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/register.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'hanami/components'
+require 'hanami/configuration'
+require_relative 'integration'
+
+module Hanami
+  module Events
+    module CloudPubsub
+      # Register all the things needed to integrate with hanami
+      module Register
+        Integration::Setup.setup
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/version.rb

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '1.0.0'
+      VERSION = '1.0.1'
     end
   end
 end

data/lib/hanami/events/cloud_pubsub.rb

@@ -6,7 +6,6 @@ require 'hanami/events/cloud_pubsub/middleware/stack'
 require 'hanami/events/cloud_pubsub/middleware/logging'
 require 'hanami/events/cloud_pubsub/middleware/auto_acknowledge'
 require 'hanami/events/cloud_pubsub/runner'
-require 'hanami/events/cloud_pubsub/mixin'
 require 'google/cloud/pubsub'
 require 'dry-configurable'
 
@@ -23,6 +22,11 @@ module Hanami
           setting :push, 4
         end
       end
+
+      setting :pubsub do |conf_hash|
+        conf_hash.each { |key, val| Google::Cloud::Pubsub.configure[key] = val }
+      end
+
       setting :project_id, reader: true
       setting :logger, Logger.new(STDOUT), reader: true
       setting :subscriptions_loader, proc {
@@ -53,14 +57,6 @@ module Hanami
         Middleware::Logging.new,
         Middleware::AutoAcknowledge.new
       )
-
-      def self.setup
-        Hanami::Events::Adapter.register(:cloud_pubsub) do
-          require_relative 'adapter/cloud_pubsub'
-
-          ::Hanami::Events::Adapter::CloudPubsub
-        end
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ian Ker-Seymer
@@ -139,11 +139,12 @@ files:
 - lib/hanami/events/cloud_pubsub/cli.rb
 - lib/hanami/events/cloud_pubsub/handler.rb
 - lib/hanami/events/cloud_pubsub/health_check_server.rb
+- lib/hanami/events/cloud_pubsub/integration.rb
 - lib/hanami/events/cloud_pubsub/listener.rb
 - lib/hanami/events/cloud_pubsub/middleware/auto_acknowledge.rb
 - lib/hanami/events/cloud_pubsub/middleware/logging.rb
 - lib/hanami/events/cloud_pubsub/middleware/stack.rb
-- lib/hanami/events/cloud_pubsub/mixin.rb
+- lib/hanami/events/cloud_pubsub/register.rb
 - lib/hanami/events/cloud_pubsub/runner.rb
 - lib/hanami/events/cloud_pubsub/safe_error_handler.rb
 - lib/hanami/events/cloud_pubsub/thread_inspector.rb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Google Cloud Pub/Sub adapter for the hanami-events gem

data/lib/hanami/events/cloud_pubsub/mixin.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  module Events
-    module CloudPubsub
-      # Mixin that extends class by `subscribe_to` method.
-      #
-      # @example
-      # $events = Hanami::Events.initialize(:memory)
-      #
-      # class WelcomeMailer
-      #   include Hanami::Events::Mixin
-      #
-      #   subscribe_to $events, 'user.created', id: 'welcome-mailer'
-      #
-      #   def call(payload)
-      #     # send email
-      #   end
-      # end
-      #
-      # @since 0.1.0
-      #
-      # @api public
-      module Mixin
-        def self.included(klass)
-          klass.extend(ClassMethods)
-        end
-
-        # Class interfaces
-        module ClassMethods
-          def subscribe_to(event_bus, event_name, id:)
-            klass = self
-            event_bus.subscribe(event_name, id: id) { |payload| klass.new.call(payload) }
-          end
-        end
-      end
-    end
-  end
-end