propono 1.7.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 013ba7a6dc0e9ffb8fa06aefbec64ee0c398f933
-  data.tar.gz: 1fd1f5e5b5cca50704e67bc874e33c79360c846a
+  metadata.gz: d42471617c3c3d8f3b41074c4088e86a812c7c7d
+  data.tar.gz: 7403c09c886c595f642460307b0636e651a5cea1
 SHA512:
-  metadata.gz: b5a91dcbc2c42611e718affa73fd7be0a16f8d59d7585384dff86c272bece9d47d2d46dcf45466b8acb515778b181059e63d60cffd40e250643d8e6e2052b334
-  data.tar.gz: 44ff1b11418f68dca4f5886a66f8c709251310f362f1ec24bf1c450a76e3d42b0e628a6ee93546c7841b56e431b17f9030b7e2a292aa7ec7655a1d1acd589173
+  metadata.gz: f21cda9adb199d017845d6155c3721c9f9d4697cee57daa20b7ba90748594c3380f1eddc78f0f1af43b4b61a8778a0810f0792a3bfe770b29e84ac9ed618af42
+  data.tar.gz: b6dedfd0fc6645cd8400251a3dadba0f62ef28d685ec3eef47ab55b461e9129c20cfa07f77120c2c37d0d20e2b61d5619d9266c764ff90a279311a835e9f7aeb

data/.gitignore

@@ -15,5 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 test/config.yml
+manual_test.rb
 tmp
 *.swp

data/.travis.yml

@@ -1,14 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - rbx-2.1.1
+  - 2.2.8
+  - 2.4.2
 script:
   - bundle exec rake test:local
-addons:
-    code_climate:
-        repo_token: 88dd239bc2e0010742a42a4e0234b4decd19b46d0e9d3408d8b1fe0f96dd8fc1
-matrix:
-  allow_failures:
-    - rvm: rbx-2.1.1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.0.0 / 2017-03-14
+* [FEATURE] Remove UDP and TCP support
+* [FEATURE] Change default publish behaviour from async to sync
+* [FEATURE] Propono.subscripe_by_post has been removed
+* [FEATURE] Propono.subscripe_by_queue has been renamed to subscribe
+* [FEATURE] Change to Propono::Client interface
+* [FEATURE] Switch fog out for aws gems
+* [FEATURE] Use long polling
+
 # 1.7.0 / 2017-01-17
 * [FEATURE] Added num_messages_per_poll config option to allow you to change how many messages you pull from AWS per poll cycle.
 

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in propono.gemspec
 gemspec
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,8 +1,8 @@
 # Propono
 
-[![Build Status](https://travis-ci.org/meducation/propono.png)](https://travis-ci.org/meducation/propono)
-[![Dependencies](https://gemnasium.com/meducation/propono.png?travis)](https://gemnasium.com/meducation/propono)
-[![Code Climate](https://codeclimate.com/github/meducation/propono.png)](https://codeclimate.com/github/meducation/propono)
+[![Build Status](https://travis-ci.org/iHiD/propono.png)](https://travis-ci.org/iHiD/propono)
+[![Dependencies](https://gemnasium.com/iHiD/propono.png?travis)](https://gemnasium.com/iHiD/propono)
+[![Code Climate](https://codeclimate.com/github/iHiD/propono.png)](https://codeclimate.com/github/iHiD/propono)
 
 Propono is a [pub/sub](http://en.wikipedia.org/wiki/Publish-subscribe_pattern) gem built on top of Amazon Web Services (AWS). It uses Simple Notification Service (SNS) and Simple Queue Service (SQS) to seamlessly pass messages throughout your infrastructure.
 
@@ -10,17 +10,25 @@ It's beautifully simple to use. [Watch an introduction](https://www.youtube.com/
 
 ```ruby
 # On Machine A
-Propono.listen_to_queue('some-topic') do |message|
+Propono::Client.new.listen_to_queue('some-topic') do |message|
   puts "I just received: #{message}"
 end
 
 # On Machine B
-Propono.publish('some-topic', "The Best Message Ever")
+Propono::Client.new.publish('some-topic', "The Best Message Ever")
 
 # Output on Machine A a second later.
 # - "I just received The Best Message Ever"
 ```
 
+## Changes from v1 to v2
+
+Version 2 of Propono changed a few things: 
+- We moved from a global interface to a client interface. Rather than calling `publish` and equivalent on `Propono`, you should now initialize a `Propono::Client` and then call everything on that client. This fixes issues with thread safety and global config.
+- We have also removed the dependancy on Fog and instead switch to the `sns` and `sqs` mini-gems of `aws-sdk`.
+- UDP and TCP support have been removed, an subscribe_by_post has been removed.
+- We are now using long-polling. This makes Propono **significantly** faster (10-100x).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,28 +44,31 @@ And then execute:
 The first thing to do is setup some configuration keys for Propono. It's best to do this in an initializer, or at the start of your application.
 
 ```ruby
-Propono.config.access_key       = "access-key"       # From AWS
-Propono.config.secret_key       = "secret-key"       # From AWS
-Propono.config.queue_region     = "queue-region"     # From AWS
+client = Propono::Client.new
+client.config.access_key       = "access-key"       # From AWS
+client.config.secret_key       = "secret-key"       # From AWS
+client.config.queue_region     = "queue-region"     # From AWS
 
 # Or use the IAM profile of the machine
-Propono.config.use_iam_profile  = true
-Propono.config.queue_region     = "queue-region"     # From AWS
+client.config.use_iam_profile  = true
+client.config.queue_region     = "queue-region"     # From AWS
 
 ```
 
 You can then start publishing messages easily from anywhere in your codebase.
 
 ```ruby
-Propono.publish('some-topic', "Some string")
-Propono.publish('some-topic', {some: ['hash', 'or', 'array']})
+client = Propono::Client.new
+client.publish('some-topic', "Some string")
+client.publish('some-topic', {some: ['hash', 'or', 'array']})
 ```
 
 Listening for messages is easy too. Just tell Propono what your application is called and start listening. You'll get a block yielded for each message.
 
 ```ruby
-Propono.config.application_name = "application-name" # Something unique to this app.
-Propono.listen_to_queue('some-topic') do |message|
+client = Propono::Client.new
+client.config.application_name = "application-name" # Something unique to this app.
+client.listen_to_queue('some-topic') do |message|
   # ... Do something interesting with the message
 end
 ```
@@ -70,75 +81,12 @@ This is because a queue is established for each application_name/topic combinati
 * subscribers that share the same `application_name` will act as multiple workers on the same queue. Only one will get to process each message.
 * subscribers that have a different `application_name` will each get a copy of a message to process independently i.e. acts as a one-to-many broadcast.
 
-
-**Note for using in Rake tasks and similar:** Propono spawns new threads for messages sent via SNS. If your application ends before the final thread is executed, then the last message might not send. There are two options to help you here:
-* Pass the `{async: false}` option to Propono.publish. (This was introduced in 1.3.0)
-* Do a `Thread#join` on each thread that is returned from calls to `publish`.
-
-### Using TCP for messages
-
-Publishing directly to SNS takes about 15x longer than publishing over a simple TCP connection. It is therefore sometimes favourable to publish to a separate machine listening for TCP messages, which will then proxy them on.
-
-To send messages this way, you need to set up a little extra config:
-
-```ruby
-Propono.config.tcp_host = "some.host.running.a.propono.listener"
-Propono.config.tcp_port = 12543
-```
-
-You then simply pass the `:tcp` protocol into `publish`
-
-```ruby
-Propono.publish('some-topic', message, protocol: :tcp)
-```
-
-You'll now need another application running Propono to listen to the TCP feed. You can use the same machine or a different one, just make sure the port config is the same in both applications, and you're good to go.
-
-```ruby
-Propono.listen_to_tcp do |topic, message|
-  Propono.publish(topic, message) # Proxy the message to SNS
-end
-```
-
-This proxying of TCP to SQS is used so often that there's a simple shortcut. Just run this on the machine receiving the TCP packets.
-
-```ruby
-Propono.proxy_tcp()
-```
-
-### Using UDP for messages
-
-If you want almost-zero performance impact, and don't mind the occasional message getting lost, you can use UDP. We use this for things like our live dashboard where we don't mind losing a piece of activity here and there, but any performance impact on our Meducation itself is bad news.
-
-Sending messages in this way is very similar to using TCP. First add some config:
-
-```ruby
-Propono.config.udp_host = "some.host.running.a.propono.listener"
-Propono.config.udp_port = 12543
-```
-
-You then simply pass the `:udp` protocol into `publish`:
-
-```ruby
-Propono.publish('some-topic', message, protocol: :udp)
-```
-
-As per the `listen_to_tcp` method explained above, you now listen to UDP or use the proxy method:
-
-```ruby
-Propono.listen_to_udp do |topic, message|
-  Propono.publish(topic, message) # Proxy the message to SNS
-end
-
-Propono.proxy_udp()
-```
-
 ### Configuration
 
 The following configuration settings are available:
 
 ```
-Propono.config do |config|
+Propono::Client.new do |config|
   # Use AWS access and secret keys
   config.access_key = "An AWS access key"
   config.secret_key = "A AWS secret key"
@@ -147,10 +95,6 @@ Propono.config do |config|
 
   config.queue_region = "An AWS queue region"
   config.application_name = "A name unique in your network"
-  config.udp_host = "The host of a machine used for UDP proxying"
-  config.udp_port = "The port of a machine used for UDP proxying"
-  config.tcp_host = "The host of a machine used for TCP proxying"
-  config.tcp_port = "The port of a machine used for TCP proxying"
   config.logger = "A logger such as Log4r or Rails.logger"
 
   config.max_retries = "The number of retries if a message raises an exception before being placed on the failed queue"
@@ -158,7 +102,7 @@ Propono.config do |config|
 end
 ```
 
-These can all also be set using the `Propono.config.access_key = "..."` syntax.
+These can all also be set using the `client.config.access_key = "..."` syntax.
 
 ### Is it any good?
 
@@ -168,22 +112,22 @@ These can all also be set using the `Propono.config.access_key = "..."` syntax.
 
 Firstly, thank you!! :heart::sparkling_heart::heart:
 
-We'd love to have you involved. Please read our [contributing guide](https://github.com/meducation/propono/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
+We'd love to have you involved. Please read our [contributing guide](https://github.com/iHiD/propono/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
 
 ### Contributors
 
-This project is managed by the [Meducation team](http://company.meducation.net/about#team).
+This project is managed by the [Jeremy Walker](http://ihid.co.uk).
 
 These individuals have come up with the ideas and written the code that made this possible:
 
-- [Jeremy Walker](http://github.com/iHiD)
-- [Malcolm Landon](http://github.com/malcyL)
-- [Charles Care](http://github.com/ccare)
-- [Rob Styles](http://github.com/mmmmmrob)
+- [Jeremy Walker](https://github.com/iHiD)
+- [Malcolm Landon](https://github.com/malcyL)
+- [Charles Care](https://github.com/ccare)
+- [Rob Styles](https://github.com/mmmmmrob)
 
 ## Licence
 
-Copyright (C) 2015 New Media Education Ltd
+Copyright (C) 2017 Jeremy Walker
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the MIT License.
@@ -193,5 +137,5 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 MIT License for more details.
 
-A copy of the MIT License is available in [Licence.md](https://github.com/meducation/propono/blob/master/LICENCE.md)
+A copy of the MIT License is available in [LICENCE.md](https://github.com/iHiD/propono/blob/master/LICENCE.md)
 along with this program.

data/lib/propono.rb

@@ -7,161 +7,21 @@ require 'propono/logger'
 require 'propono/configuration'
 require "propono/utils"
 
+require 'propono/components/client'
+
 require 'propono/components/aws_config'
-require 'propono/components/sns'
-require 'propono/components/sqs'
+require 'propono/components/aws_client'
+
 require "propono/components/queue"
 require "propono/components/topic"
-require "propono/components/post_subscription"
 require "propono/components/queue_subscription"
 require "propono/components/sqs_message"
 
 require "propono/services/publisher"
-require "propono/services/queue_creator"
 require "propono/services/queue_listener"
-require "propono/services/subscriber"
-require "propono/services/topic_creator"
-require "propono/services/udp_listener"
-require "propono/services/tcp_listener"
 
 # Propono is a pub/sub gem built on top of Amazon Web Services (AWS).
 # It uses Simple Notification Service (SNS) and Simple Queue Service (SQS)
 # to seamlessly pass messages throughout your infrastructure.
 module Propono
-
-  # Propono configuration settings.
-  #
-  # Settings should be set in an initializer or using some
-  # other method that insures they are set before any
-  # Propono code is used. They can be set as followed:
-  #
-  #   Propono.config.access_key = "my-access-key"
-  #
-  # The following settings are allowed:
-  #
-  # * <tt>:access_key</tt> - The AWS access key
-  # * <tt>:secret_key</tt> - The AWS secret key
-  # * <tt>:queue_region</tt> - The AWS region
-  # * <tt>:application_name</tt> - The name of the application Propono
-  #   is included in.
-  # * <tt>:queue_suffix</tt> - Optional string to append to topic and queue names.
-  # * <tt>:udp_host</tt> - If using UDP, the host to send to.
-  # * <tt>:udp_port</tt> - If using UDP, the port to send to.
-  # * <tt>:logger</tt> - A logger object that responds to puts.
-  def self.config
-    @config ||= Configuration.new
-    if block_given?
-      yield @config
-    else
-      @config
-    end
-  end
-
-  # Publishes a new message into the Propono pub/sub network.
-  #
-  # This requires a topic and a message. By default this pushes
-  # out AWS SNS. The method optionally takes a :protocol key in
-  # options, which can be set to :udp for non-guaranteed but very
-  # fast delivery.
-  #
-  # @param [String] topic The name of the topic to publish to.
-  # @param [String] message The message to post.
-  # @param [Hash] options
-  #   * protocol: :udp
-  def self.publish(topic, message, options = {})
-    suffixed_topic = "#{topic}#{Propono.config.queue_suffix}"
-    Publisher.publish(suffixed_topic, message, options)
-  end
-
-  # Creates a new SNS-SQS subscription on the specified topic.
-  #
-  # This is implicitly called by {#listen_to_queue}.
-  #
-  # @param [String] topic The name of the topic to subscribe to.
-  def self.subscribe_by_queue(topic)
-    Subscriber.subscribe_by_queue(topic)
-  end
-
-  # Creates a new SNS-POST subscription on the specified topic.
-  #
-  # The POST currently needs confirming before the subscription
-  # can be published to.
-  #
-  # @param [String] topic The name of the topic to subscribe to.
-  def self.subscribe_by_post(topic, endpoint)
-    Subscriber.subscribe_by_post(topic, endpoint)
-  end
-
-  # Listens on a queue and yields for each message
-  #
-  # Calling this will enter a queue-listening loop that
-  # yields the message_processor for each messages.
-  #
-  # This method will automatically create a subscription if
-  # one does not exist, so there is no need to call
-  # <tt>subscribe_by_queue</tt> in addition.
-  #
-  # @param [String] topic The topic to subscribe to.
-  # @param &message_processor The block to yield for each message.
-  def self.listen_to_queue(topic, &message_processor)
-    QueueListener.listen(topic, &message_processor)
-  end
-
-  # Listens on a queue and yields for each message
-  #
-  # Calling this will enter a queue-listening loop that
-  # yields the message_processor for each messages.  The
-  # loop will end when all messages have been processed.
-  #
-  # This method will automatically create a subscription if
-  # one does not exist, so there is no need to call
-  # <tt>subscribe_by_queue</tt> in addition.
-  #
-  # @param [String] topic The topic to subscribe to.
-  # @param &message_processor The block to yield for each message.
-  def self.drain_queue(topic, &message_processor)
-    QueueListener.drain(topic, &message_processor)
-  end
-
-  # Listens for UDP messages and yields for each.
-  #
-  # Calling this will enter a queue-listening loop that
-  # yields the message_processor for each UDP message received.
-  #
-  # @param &message_processor The block to yield for each message.
-  #   Is called with <tt>|topic, message|</tt>.
-  def self.listen_to_udp(&message_processor)
-    UdpListener.listen(&message_processor)
-  end
-
-  # Listens for TCP messages and yields for each.
-  #
-  # Calling this will enter a queue-listening loop that
-  # yields the message_processor for each UDP message received.
-  #
-  # @param &message_processor The block to yield for each message.
-  #   Is called with <tt>|topic, message|</tt>.
-  def self.listen_to_tcp(&message_processor)
-    TcpListener.listen(&message_processor)
-  end
-
-  # Listens for UDP messages and passes them onto the queue.
-  #
-  # This method uses #listen_to_udp and #publish to proxy
-  # messages from UDP onto the queue.
-  def self.proxy_udp
-    Propono.listen_to_udp do |topic, message, options = {}|
-      Propono.publish(topic, message, options)
-    end
-  end
-
-  # Listens for TCP messages and passes them onto the queue.
-  #
-  # This method uses #listen_to_tcp and #publish to proxy
-  # messages from TCP onto the queue.
-  def self.proxy_tcp
-    Propono.listen_to_tcp do |topic, message, options = {}|
-      Propono.publish(topic, message, options)
-    end
-  end
 end

data/lib/propono/components/aws_client.rb

@@ -0,0 +1,78 @@
+#require 'aws/sns'
+#require 'aws/sqs'
+require 'aws-sdk-sns'
+require 'aws-sdk-sqs'
+
+module Propono
+  class AwsClient
+    attr_reader :aws_config
+    def initialize(aws_config)
+      @aws_config = aws_config
+    end
+
+    def publish_to_sns(topic, message)
+      sns_client.publish(
+        topic_arn: topic.arn,
+        message: message.to_json
+      )
+    end
+
+    def send_to_sqs(queue, message)
+      sqs_client.send_message(
+        queue_url: queue,
+        message_body: message
+      )
+    end
+
+    def create_topic(name)
+      Topic.new(sns_client.create_topic(name: name))
+    end
+
+    def create_queue(name)
+      url = sqs_client.create_queue(queue_name: name).queue_url
+      attributes = sqs_client.get_queue_attributes(queue_url: url, attribute_names: ["QueueArn"]).attributes
+      Queue.new(url, attributes)
+    end
+
+    def subscribe_sqs_to_sns(queue, topic)
+      sns_client.subscribe(
+        topic_arn: topic.arn,
+        protocol: 'sqs',
+        endpoint: queue.arn
+      )
+    end
+
+    def set_sqs_policy(queue, policy)
+      sqs_client.set_queue_attributes(
+        queue_url: queue.url,
+        attributes: { "Policy": policy }
+      )
+    end
+
+    def read_from_sqs(queue, num_messages, long_poll: true)
+      wait_time_seconds = long_poll ? 20 : 0
+      sqs_client.receive_message(
+        queue_url: queue.url,
+        wait_time_seconds: wait_time_seconds,
+        max_number_of_messages: num_messages
+      ).messages
+    end
+
+    def delete_from_sqs(queue, receipt_handle)
+      sqs_client.delete_message(
+        queue_url: queue.url,
+        receipt_handle: receipt_handle
+      )
+    end
+
+    private
+
+    def sns_client
+      @sns_client ||= Aws::SNS::Client.new(aws_config.aws_options)
+    end
+
+    def sqs_client
+      @sqs_client ||= Aws::SQS::Client.new(aws_config.aws_options)
+    end
+  end
+end