aws-broker 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47445eb1fe64609e924b638fba632b0d59808374
-  data.tar.gz: ffaa55778697fe1c9fa6dd4e59d79e07dbd23f6a
+  metadata.gz: 15d27e2ba58c931cc347494c6420b762666dcc60
+  data.tar.gz: 873896f0dd399e8e41f232cbcf23c3d757223ddb
 SHA512:
-  metadata.gz: 00cbd98f3230911e14f541a5f917e6009ed6c83673f8298d73cebe9f0a1a522c9eb903d38cbcafae28e933b5c702639cbdf7ab9b7c4b6c130261ca5c43b01787
-  data.tar.gz: b627d025fe2558cfdd629ff289bc5a18602a25f2e70e6a164aeedb081954b6db930e02f462001b70fd58cf3d52208fe1972c00c3e826511b0fd9c2467753b349
+  metadata.gz: df5fb8fcf7e36951e8d3b8737c66f2fa1672f292c699eda096e88edc7aff1e57acae9fa7c89ab9057f9e129737e81b28e2924025bde0b6e55b3c0b046235b915
+  data.tar.gz: 7513b2f5159cf72adff7a05de25a502f7f0255ee1c17c35e143ea17b4ba45cf31061e7bb8d73cf0e25f5d8ef8cd513684b3d0c2921fc94fd50b8005f4de1dae6

data/README.md

@@ -16,7 +16,7 @@ Message processing is not part of this gem - we recommend using
 
     gem 'aws-broker'
 
-### Usage
+### Basic Usage
 
     Broker = Aws::Broker
     topic = 'topic'
@@ -33,37 +33,52 @@ Message processing is not part of this gem - we recommend using
     # publish message to topic
     Broker.publish(topic, message)
 
-### Configuration
+### Rails Usage
 
-#### Broker Options
+Though AWS Broker does not require Rails, an ActiveRecord extension and
+accompanying RSpec matcher is provided if the project is Rails. This simplifies
+the process of publishing events for ActiveRecord create, update, and destroy
+callbacks.
 
-Aws::Broker can be configured via the following:
+    ## Publishing
 
-    Aws::Broker.configure do |config|
-      config.enabled      = false
-      config.queue_prefix = 'prefix'
+    # app/models/user.rb
+    class User < ActiveRecord::Base
+      publish_event :create, :update, :destroy
     end
 
-The following options are available:
+    ## Subscribing
 
-| Option         | Default | Description                                      |
-|----------------|---------|--------------------------------------------------|
-| `enabled`      | true    | if false, don't trigger API calls to AWS         |
-| `queue_prefix` | nil     | prefix for default queue name (prefix-topic)     |
+    # app/subscribers/user_subscriber.rb
+    class UserSubscriber < Shoryuken::Subscriber
+      self.resource_class = 'User'
 
-#### AWS Client
+      def create;  ... end
 
-AWS Broker wraps the AWS SQS and SNS clients. All configuration is the same as
-the AWS SDK. See
-[Configuring the AWS SDK for Ruby](http://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html)
-for details.
+      def update;  ... end
 
-Some supported options:
+      def destroy; ... end
+    end
+
+    ## Testing
+
+    # spec/rails_helper.rb
+    require 'aws/broker/matchers'
+
+    # spec/models/user_spec.rb
+    describe User do
+      context 'publish' do
+        subject { User }
+        it { should publish_event(:create) }
+        it { should publish_event(:update) }
+        it { should publish_event(:destroy) }
+      end
+    end
+
+### Usage Details
 
-* `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` env variables
-* shared `~/.aws/credentials` file
-* IAM
-* `Aws.config[:credentials]`
+See the [wiki](https://github.com/Thanx/aws-broker/wiki) for an in-depth
+overview of usage and configuration options.
 
 ### Inspiration
 

data/lib/aws-broker.rb

@@ -1,7 +1,10 @@
 require 'aws-sdk-sqs'
 require 'aws-sdk-sns'
 require 'aws/broker'
+require 'aws/broker/railtie' if defined?(Rails)
 
-module Aws
-
+begin
+  require 'shoryuken'
+  require 'shoryuken/subscriber'
+rescue LoadError
 end

data/lib/aws/broker/matchers.rb

@@ -0,0 +1,27 @@
+RSpec::Matchers.define :publish_event do |event|
+  match do |klass|
+    filter = :"publish_event_#{event}"
+    # find callback
+    callback = klass._commit_callbacks.detect { |c| c.filter == filter }
+    # assert existence
+    expect(callback).to be
+    # assert after_commit
+    expect(callback.kind).to eq(:after)
+    # assert after commit event type
+    expect(callback.instance_variable_get(:@if)[0]).to include("[:#{event}]")
+    # assert broker call is triggered
+    object = klass.new
+    allow(object).to receive(:id) { 0 }
+    expect(Broker).to receive(:publish).with(
+      klass.to_s.underscore.tr('/','_'),
+      event: event,
+      id:    0
+    )
+    object.send(filter)
+    true
+  end
+
+  failure_message do |klass|
+    "expected #{klass.to_s} to publish_event #{event}"
+  end
+end

data/lib/aws/broker/publishing.rb

@@ -0,0 +1,26 @@
+module Aws
+  class Broker
+    module Publishing
+
+      # only :create, :update, :destroy
+      def publish_event(*events)
+        events.each do |event|
+          event = event.to_sym
+          unless [:create, :update, :destroy].include?(event)
+            raise "Invalid publish event #{event}"
+          end
+          method_name = :"publish_event_#{event}"
+          define_method method_name do
+            Broker.publish(
+              self.class.to_s.underscore.tr('/', '_'),
+              event: event,
+              id:    id
+            )
+          end
+          after_commit method_name, on: event
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/broker/railtie.rb

@@ -0,0 +1,15 @@
+require 'aws/broker/publishing'
+
+module Aws
+  class Broker
+    class Railtie < Rails::Railtie
+
+      initializer 'aws-broker.extend_active_record' do
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::Base.send(:extend, Aws::Broker::Publishing)
+        end
+      end
+
+    end
+  end
+end

data/lib/shoryuken/subscriber.rb

@@ -0,0 +1,43 @@
+module Shoryuken
+  class Subscriber
+    include Shoryuken::Worker
+
+    class << self
+      attr_reader :resource_class
+
+      def queue=(queue)
+        shoryuken_options(
+          queue:       queue,
+          auto_delete: true,
+          body_parser: :json
+        )
+      end
+
+      def resource_class=(klass)
+        @resource_class = klass
+      end
+    end
+
+    def perform(_, body)
+      @body = body
+      send(event)
+    end
+
+  private
+
+    def resource
+      @resource ||= self.class.resource_class.constantize.find(message[:id])
+    end
+
+    def event
+      message[:event]
+    end
+
+    def message
+      @message ||= JSON.parse(@body['Message']).symbolize_keys
+    rescue JSON::ParserError
+      {}
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-broker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Eng @ Thanx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Lightweight Ruby pub-sub abstraction on AWS
+description: Ruby pub-sub on AWS
 email: eng@thanx.com
 executables: []
 extensions: []
@@ -49,9 +49,12 @@ files:
 - lib/aws/broker.rb
 - lib/aws/broker/base.rb
 - lib/aws/broker/config.rb
-- lib/aws/broker/constants.rb
+- lib/aws/broker/matchers.rb
 - lib/aws/broker/publisher.rb
+- lib/aws/broker/publishing.rb
+- lib/aws/broker/railtie.rb
 - lib/aws/broker/subscriber.rb
+- lib/shoryuken/subscriber.rb
 homepage: https://github.com/thanx/aws-broker
 licenses:
 - MIT
@@ -72,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: AWS Broker

data/lib/aws/broker/constants.rb

@@ -1,7 +0,0 @@
-module Aws
-  class Broker
-
-    VERSION = '0.0.3'.freeze
-
-  end
-end