aws-broker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c78e1a8326e34ac698ddf33e647d8d263c101256
-  data.tar.gz: 8d4a5395d3a052901010f33758b112c54f46d478
+  metadata.gz: 47445eb1fe64609e924b638fba632b0d59808374
+  data.tar.gz: ffaa55778697fe1c9fa6dd4e59d79e07dbd23f6a
 SHA512:
-  metadata.gz: 8dd6ecdeeeed53fa28f319acd16a3cbdbfcd471807869868db89e6a8156a7a09c03208f2fa094101e7f081f08359700591e0a72186aa5296d6d9d5b7afb736aa
-  data.tar.gz: 21f4532b4ec60c021ae997e197d0e343a719cc6e8188538fee0f0e1d8a7f2beef07c9b4aee2214787bfc84b6ceb13f88da5a47ca8663386361fb5a95584c5bda
+  metadata.gz: 00cbd98f3230911e14f541a5f917e6009ed6c83673f8298d73cebe9f0a1a522c9eb903d38cbcafae28e933b5c702639cbdf7ab9b7c4b6c130261ca5c43b01787
+  data.tar.gz: b627d025fe2558cfdd629ff289bc5a18602a25f2e70e6a164aeedb081954b6db930e02f462001b70fd58cf3d52208fe1972c00c3e826511b0fd9c2467753b349

data/README.md

@@ -1,22 +1,72 @@
-# AWS Broker
+# AWS Broker [![Gem Version](https://badge.fury.io/rb/aws-broker.svg)](https://badge.fury.io/rb/aws-broker)
 
 :incoming_envelope: Ruby pub-sub on AWS
 
 * * *
 
+[![CircleCI](https://circleci.com/gh/Thanx/aws-broker.svg?style=svg)](https://circleci.com/gh/Thanx/aws-broker)
+
 ### Background
 
 This lightweight abstraction simplifies pub-sub on AWS's SNS and SQS services.
 Message processing is not part of this gem - we recommend using
 [Shoryuken](https://github.com/phstc/shoryuken) in addition to this gem.
 
-### Usage
+### Installation
 
-Usage:
+    gem 'aws-broker'
+
+### Usage
 
     Broker = Aws::Broker
     topic = 'topic'
     queue = 'queue'
     message = { id: 0 }
+
+    # subscribe topic to specified queue
     Broker.subscribe(topic, queue)
+
+    # subscribe topic to default queue
+    #   "topic" or "prefix-topic" (see options)
+    Broker.subscribe(topic)
+
+    # publish message to topic
     Broker.publish(topic, message)
+
+### Configuration
+
+#### Broker Options
+
+Aws::Broker can be configured via the following:
+
+    Aws::Broker.configure do |config|
+      config.enabled      = false
+      config.queue_prefix = 'prefix'
+    end
+
+The following options are available:
+
+| Option         | Default | Description                                      |
+|----------------|---------|--------------------------------------------------|
+| `enabled`      | true    | if false, don't trigger API calls to AWS         |
+| `queue_prefix` | nil     | prefix for default queue name (prefix-topic)     |
+
+#### AWS Client
+
+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.
+
+Some supported options:
+
+* `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` env variables
+* shared `~/.aws/credentials` file
+* IAM
+* `Aws.config[:credentials]`
+
+### Inspiration
+
+* [propono](https://github.com/iHiD/propono)
+* [shoryuken](https://github.com/phstc/shoryuken)
+* [bunny](https://github.com/ruby-amqp/bunny)

data/lib/aws/broker/base.rb

@@ -5,7 +5,7 @@ module Aws
     private
 
       def enabled?
-        Broker.config.enabled?
+        config.enabled?
       end
 
       def create_topic
@@ -13,15 +13,11 @@ module Aws
       end
 
       def sns
-        @sns ||= Aws::SNS::Client.new(credentials)
+        @sns ||= Aws::SNS::Client.new
       end
 
-      def credentials
-        {
-          access_key_id:     ENV['AWS_ACCESS_KEY'],
-          secret_access_key: ENV['AWS_SECRET_KEY'],
-          region:            ENV['AWS_REGION']
-        }
+      def config
+        Broker.config
       end
 
     end

data/lib/aws/broker/config.rb

@@ -2,14 +2,12 @@ module Aws
   class Broker
     class Config
 
-      attr_accessor :enabled
+      attr_accessor :enabled, :queue_prefix
       alias_method :enabled?, :enabled
 
-      attr_accessor :queue_prefix
-
       def initialize
-        self.enabled = true
-        self.queue_prefix = nil
+        self.enabled        = true
+        self.queue_prefix   = nil
       end
 
     end

data/lib/aws/broker/constants.rb

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

data/lib/aws/broker/subscriber.rb

@@ -12,6 +12,7 @@ module Aws
       def subscribe
         return unless enabled?
         create_queue
+        find_queue_arn
         create_topic
         sns.subscribe(
           topic_arn: @topic_arn,
@@ -24,8 +25,8 @@ module Aws
     private
 
       def queue_name
-        if Broker.config.queue_prefix
-          "#{Broker.config.queue_prefix}-#{@topic}"
+        if config.queue_prefix
+          "#{config.queue_prefix}-#{@topic}"
         else
           @topic
         end
@@ -35,6 +36,9 @@ module Aws
         @queue_url = sqs.create_queue(
           queue_name: @queue
         ).queue_url
+      end
+
+      def find_queue_arn
         @queue_arn = sqs.get_queue_attributes(
           queue_url:       @queue_url,
           attribute_names: ['QueueArn']
@@ -50,31 +54,31 @@ module Aws
 
       def policy
         <<-POLICY
-{
-  "Version": "2008-10-17",
-  "Id": "#{@queue_arn}/SQSDefaultPolicy",
-  "Statement": [
-    {
-      "Sid": "#{@queue_arn}-Sid",
-      "Effect": "Allow",
-      "Principal": {
-        "AWS": "*"
-      },
-      "Action": "SQS:*",
-      "Resource": "#{@queue_arn}",
-      "Condition": {
-        "StringEquals": {
-          "aws:SourceArn": "#{@topic_arn}"
-        }
-      }
-    }
-  ]
-}
+          {
+            "Version": "2008-10-17",
+            "Id": "#{@queue_arn}/SQSDefaultPolicy",
+            "Statement": [
+              {
+                "Sid": "#{@queue_arn}-Sid",
+                "Effect": "Allow",
+                "Principal": {
+                  "AWS": "*"
+                },
+                "Action": "SQS:*",
+                "Resource": "#{@queue_arn}",
+                "Condition": {
+                  "StringEquals": {
+                    "aws:SourceArn": "#{@topic_arn}"
+                  }
+                }
+              }
+            ]
+          }
         POLICY
       end
 
       def sqs
-        @sqs ||= Aws::SQS::Client.new(credentials)
+        @sqs ||= Aws::SQS::Client.new
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-broker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eng @ Thanx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns