propono 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cbff5dcb118c99e3f7ff39f3cfc172e478edb5e
-  data.tar.gz: 619b6da2339dd1a0c9feea52b4851e0735f6a826
+  metadata.gz: f1ff92b911ef9f4ae48012a57710e6dc36f4afa7
+  data.tar.gz: da17719ba6d0d5b9914892e36156af76888df5e0
 SHA512:
-  metadata.gz: bf7e492a492a3a31dd40fede408e1b084f996aff7b057f1747617a10f8d217028d2dca4541d381dd0da70612e89ca2b91b4d3a91696036e057a3504940760b47
-  data.tar.gz: f9fec93fc0c85902123a9b6d5c608ef711a89853e01502fd70d3c563797889707b14687522bd302abe5eeb039951d1a43a1bf94add6286955c6675533796dacb
+  metadata.gz: 4188aeee17c98854395491b0453b5f51161209473f9ccc9a2692e499f529ba19d5eaa777ecb874ad1b8b5b61057110b0e8cfc940c0cd9c8ec9f9da67a42f7eeb
+  data.tar.gz: 01ab6936c889bf091dac35b44a3bee9351a597f4ddc1fd5cb378b752027c926e86461dc66bf0a434022e4e86f9a0b4f7938635d0d56027e32ca09ccd5f522db0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.4.0 / 2014-07-12
+* [FEATURE] Move symbolize_keys to Propono namespace to avoid ActiveSupport conflict (:blue_heart: @tardate)
+* [BUGFIX] Drain integration tests drain queues before starting (:blue_heart: @tardate)
+* [BUGFIX] Fix typos in log messages (:blue_heart: @tardate)
+* [BUGFIX] Fix issue with tests failing when ran in a certain order
+
 # 1.3.0 / 2014-07-12
 * [FEATURE] Add {async: false} option to publisher
 

data/README.md

@@ -6,7 +6,7 @@
 
 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.
 
-It's beautifully simple to use.
+It's beautifully simple to use. [Watch an introduction](https://www.youtube.com/watch?v=ZM3-Gl5DVgM)
 
 ```ruby
 # On Machine A
@@ -18,7 +18,7 @@ end
 Propono.publish('some-topic', "The Best Message Ever")
 
 # Output on Machine A a second later.
-# - "I just recieved The Best Message Ever"
+# - "I just received The Best Message Ever"
 ```
 
 ## Installation
@@ -39,6 +39,11 @@ The first thing to do is setup some configuration keys for Propono. It's best to
 Propono.config.access_key       = "access-key"       # From AWS
 Propono.config.secret_key       = "secret-key"       # From AWS
 Propono.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
+
 ```
 
 You can then start publishing messages easily from anywhere in your codebase.
@@ -58,7 +63,17 @@ end
 ```
 In the background, Propono is automatically setting up a queue using SQS, a notification system using SNS, and gluing them all together for you. But you don't have to worry about any of that.
 
-**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. It's therefore advisable to do a `Thread.join` on the thread that is returned from the final call to `publish`.
+**Does it matter what I set my `application_name` to?**
+For a simple publisher and subscriber deployment, no.
+However, the `application_name` has a direct impact on subscriber behaviour when more than one is in play.
+This is because a queue is established for each application_name/topic combination. In practice:
+* 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
 
@@ -124,8 +139,12 @@ The following configuration settings are available:
 
 ```
 Propono.config do |config|
+  # Use AWS access and secret keys
   config.access_key = "An AWS access key"
   config.secret_key = "A AWS secret key"
+  # Or use AWS IAM profile of the machine
+  config.use_iam_profile = true
+  
   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"

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 namespace :test do
   Rake::TestTask.new(:local) do |t|
-    t.pattern = "test/{components/,services/,helpers/,}*_test.rb"
+    t.pattern = "test/{components/,services/,utils/,}*_test.rb"
   end
 end
 

data/lib/propono.rb

@@ -5,8 +5,7 @@ require "propono/version"
 require 'propono/propono_error'
 require 'propono/logger'
 require 'propono/configuration'
-
-require "propono/helpers/hash"
+require "propono/utils"
 
 require 'propono/components/aws_config'
 require 'propono/components/sns'
@@ -45,6 +44,7 @@ module Propono
   # * <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.

data/lib/propono/components/sqs_message.rb

@@ -9,7 +9,7 @@ module Propono
       body = JSON.parse(@raw_body_json["Message"])
 
       @raw_message    = raw_message
-      @context        = body.symbolize_keys
+      @context        = Propono::Utils.symbolize_keys body
       @failure_count  = context[:num_failures] || 0
       @message        = context.delete(:message)
       @receipt_handle = raw_message["receipt_handle"]

data/lib/propono/services/publisher.rb

@@ -17,7 +17,7 @@ module Propono
       raise PublisherError.new("Topic is nil") if topic_id.nil?
       raise PublisherError.new("Message is nil") if message.nil?
 
-      options = options.symbolize_keys
+      options = Propono::Utils.symbolize_keys options
 
       @topic_id = topic_id
       @message = message

data/lib/propono/services/tcp_listener.rb

@@ -29,14 +29,14 @@ module Propono
     end
 
     def process_tcp_data(tcp_data)
-      json = JSON.parse(tcp_data).symbolize_keys
+      json = Propono::Utils.symbolize_keys JSON.parse(tcp_data)
 
       # Legacy syntax is covered in the else statement
       # This conditional and the else block will be removed in v1.
       if json[:id]
         @processor.call(json[:topic], json[:message], id: json[:id])
       else
-        Propono.config.logger.info("Sending and recieving messags without ids is deprecated")
+        Propono.config.logger.info("Sending and receiving messages without ids is deprecated")
         @processor.call(json[:topic], json[:message])
       end
     end

data/lib/propono/services/udp_listener.rb

@@ -27,14 +27,14 @@ module Propono
     end
 
     def process_udp_data(udp_data)
-      json = JSON.parse(udp_data).symbolize_keys
+      json = Propono::Utils.symbolize_keys JSON.parse(udp_data)
 
       # Legacy syntax is covered in the else statement
       # This conditional and the else block will be removed in v1.
       if json[:id]
         @processor.call(json[:topic], json[:message], id: json[:id])
       else
-        Propono.config.logger.info("Sending and recieving messags without ids is deprecated")
+        Propono.config.logger.info("Sending and receiving messages without ids is deprecated")
         @processor.call(json[:topic], json[:message])
       end
     end

data/lib/propono/utils.rb

@@ -0,0 +1,17 @@
+module Propono
+  module Utils
+
+    # Returns +hash+ with all primary and nested keys to string values symbolised
+    # To avoid conflicts with ActiveSupport and other libraries that provide Hash symbolisation,
+    # this method is kept within the Propono namespace and not mixed into Hash
+    def self.symbolize_keys(hash)
+      hash.inject({}) do |result, (key, value)|
+        new_key = key.is_a?(String) ? key.to_sym : key
+        new_value = value.is_a?(Hash) ? symbolize_keys(value) : value
+        result[new_key] = new_value
+        result
+      end
+    end
+
+  end
+end

data/lib/propono/version.rb

@@ -1,3 +1,3 @@
 module Propono
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/test/components/aws_config_test.rb

@@ -4,23 +4,24 @@ module Propono
   class AwsConfigTest < Minitest::Test
 
     def setup
+      super
       @config = Propono::Configuration.new
-      
+
       @config.access_key = "test-access-key"
       @config.secret_key = "test-secret-key"
       @config.queue_region = "test-queue-region"
-      
+
       @aws_config = Propono::AwsConfig.new(@config)
     end
 
     def test_access_key
       assert_equal "test-access-key", @aws_config.aws_options[:aws_access_key_id]
     end
-    
+
     def test_secret_key
       assert_equal "test-secret-key", @aws_config.aws_options[:aws_secret_access_key]
     end
-    
+
     def test_region
       assert_equal "test-queue-region", @aws_config.aws_options[:region]
     end
@@ -28,22 +29,22 @@ module Propono
     def test_no_iam_profile_selected
       assert ! @aws_config.aws_options.has_key?(:use_iam_profile)
     end
-    
+
     def test_use_iam_profile
       @config.use_iam_profile = true
       assert @aws_config.aws_options[:use_iam_profile]
     end
-    
+
     def test_selecting_use_iam_profile_results_in_no_access_key
       @config.use_iam_profile = true
       assert ! @aws_config.aws_options.has_key?(:aws_access_key_id)
     end
-    
+
     def test_selecting_use_iam_profile_results_in_no_secret_key
       @config.use_iam_profile = true
       assert ! @aws_config.aws_options.has_key?(:aws_secret_access_key)
     end
-    
+
     def test_region_when_using_iam_profile
       @config.use_iam_profile = true
       assert_equal "test-queue-region", @aws_config.aws_options[:region]

data/test/components/sns_test.rb

@@ -7,6 +7,7 @@ module Propono
     end
 
     def setup
+      super
       Propono.config.access_key = "test-access-key"
       Propono.config.secret_key = "test-secret-key"
       Propono.config.queue_region = "test-queue-region"

data/test/components/sqs_test.rb

@@ -7,6 +7,7 @@ module Propono
     end
 
     def setup
+      super
       Propono.config.access_key = "test-access-key"
       Propono.config.secret_key = "test-secret-key"
       Propono.config.queue_region = "us-east-1"

data/test/configuration_test.rb

@@ -4,6 +4,7 @@ module Propono
   class ConfigurationTest < Minitest::Test
 
     def setup
+      super
       Propono.instance_variable_set("@config", nil)
     end
 

data/test/integration/slow_queue_test.rb

@@ -11,6 +11,8 @@ module Propono
       message_received = false
       slow_message_received = false
 
+      Propono.drain_queue(slow_topic)
+      Propono.drain_queue(topic)
       Propono.subscribe_by_queue(topic)
 
       thread = Thread.new do

data/test/integration/sns_to_sqs_test.rb

@@ -8,6 +8,7 @@ module Propono
       flunks = []
       message_received = false
 
+      Propono.drain_queue(topic)
       Propono.subscribe_by_queue(topic)
 
       thread = Thread.new do

data/test/integration/tcp_to_sqs_test.rb

@@ -11,6 +11,7 @@ module Propono
       Propono.config.tcp_host = "localhost"
       Propono.config.tcp_port = 20009
 
+      Propono.drain_queue(topic)
       Propono.subscribe_by_queue(topic)
 
       sqs_thread = Thread.new do

data/test/integration/udp_proxy_test.rb

@@ -10,6 +10,7 @@ module Propono
 
       Propono.config.udp_port = 20001
 
+      Propono.drain_queue(topic)
       Propono.subscribe_by_queue(topic)
 
       sqs_thread = Thread.new do

data/test/integration/udp_to_sqs_test.rb

@@ -10,6 +10,7 @@ module Propono
 
       Propono.config.udp_port = 20002
 
+      Propono.drain_queue(topic)
       Propono.subscribe_by_queue(topic)
 
       sqs_thread = Thread.new do

data/test/services/publisher_test.rb

@@ -39,7 +39,8 @@ module Propono
     def test_publish_logs
       publisher = Publisher.new("foo", "bar")
       publisher.instance_variable_set(:@id, 'abc')
-      Propono.config.logger.expects(:info).with() {|x| x =~ /^Propono \[abc\]: Publishing bar to foo via sns.*/}
+      publisher.stubs(:publish_via_sns)
+      Propono.config.logger.expects(:info).with {|x| x =~ /^Propono \[abc\]: Publishing bar to foo via sns.*/}
       publisher.send(:publish)
     end
 

data/test/test_helper.rb

@@ -20,6 +20,7 @@ class Minitest::Test
       config.secret_key = "test-secret-key"
       config.queue_region = "us-east-1"
       config.application_name = "MyApp"
+      config.queue_suffix = ""
 
       config.logger.stubs(:debug)
       config.logger.stubs(:info)

data/test/{helpers → utils}/hash_test.rb

@@ -22,7 +22,7 @@ module Propono
         }
       }
 
-      assert_equal expected, input.symbolize_keys
+      assert_equal expected, Propono::Utils.symbolize_keys(input)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: propono
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - MalcyL
@@ -9,90 +9,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.8
 description: Pub / Sub Library using Amazon Web Services
@@ -103,8 +103,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -121,7 +121,6 @@ files:
 - lib/propono/components/sqs_message.rb
 - lib/propono/components/topic.rb
 - lib/propono/configuration.rb
-- lib/propono/helpers/hash.rb
 - lib/propono/logger.rb
 - lib/propono/propono_error.rb
 - lib/propono/services/publisher.rb
@@ -131,6 +130,7 @@ files:
 - lib/propono/services/tcp_listener.rb
 - lib/propono/services/topic_creator.rb
 - lib/propono/services/udp_listener.rb
+- lib/propono/utils.rb
 - lib/propono/version.rb
 - propono.gemspec
 - test/components/aws_config_test.rb
@@ -142,7 +142,6 @@ files:
 - test/components/topic_test.rb
 - test/config.yml.example
 - test/configuration_test.rb
-- test/helpers/hash_test.rb
 - test/integration/integration_test.rb
 - test/integration/slow_queue_test.rb
 - test/integration/sns_to_sqs_test.rb
@@ -159,6 +158,7 @@ files:
 - test/services/topic_creator_test.rb
 - test/services/udp_listener_test.rb
 - test/test_helper.rb
+- test/utils/hash_test.rb
 homepage: ''
 licenses:
 - AGPL3
@@ -169,17 +169,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: General purpose pub/sub library built on top of AWS SNS and SQS
@@ -193,7 +193,6 @@ test_files:
 - test/components/topic_test.rb
 - test/config.yml.example
 - test/configuration_test.rb
-- test/helpers/hash_test.rb
 - test/integration/integration_test.rb
 - test/integration/slow_queue_test.rb
 - test/integration/sns_to_sqs_test.rb
@@ -210,4 +209,5 @@ test_files:
 - test/services/topic_creator_test.rb
 - test/services/udp_listener_test.rb
 - test/test_helper.rb
+- test/utils/hash_test.rb
 has_rdoc: 

data/lib/propono/helpers/hash.rb

@@ -1,10 +0,0 @@
-class Hash
-  def symbolize_keys
-    inject({}) do |result, (key, value)|
-      new_key = key.is_a?(String) ? key.to_sym : key
-      new_value = value.is_a?(Hash) ? value.symbolize_keys : value
-      result[new_key] = new_value
-      result
-    end
-  end
-end