propono 2.0.0.rc2 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdafed27b21eb9c0036e0dfcddb71d4fba5942ab
-  data.tar.gz: 76aeeaf6298fa889277144044ceb6cdf5b735fa7
+  metadata.gz: 97673d01a5c39db6689660e59a8667a342c759ab
+  data.tar.gz: 3e221dff98ec598ee9bd3144bca3dbae9a286de2
 SHA512:
-  metadata.gz: c10ed26f455590cc1f0087e7f3123c252028592e8fdcb736e8b06bf48bb3e0d81ea7b0808ac9c127c24673276512a8d3695f75800f98bc41886c3d3a00d50805
-  data.tar.gz: 19adb710ff52cef5489ffc7bb5a0c4dddd46b467c1bbe93de7e562d5462b9c11124240ceec6fd69c1c5328f969ebf0edcee292a79ac7b7412de60a7d1805fd91
+  metadata.gz: 94bbdc2ef73278a7258ef1d404c225e26e40db5f62cd5f5f3d1b7a35380b6867e256fc39dbda5755291bca3c5333444190a516a86ffcacaac98a21559cc0371c
+  data.tar.gz: cac7956743dbf2c7eab5237966471ccdc86cc460756d9f0d113284637d360746af27abbb1dc4eea65a962cca18a0a6696a4a74d279e819ad7a152ec8af215af8

data/README.md

@@ -10,7 +10,7 @@ It's beautifully simple to use. [Watch an introduction](https://www.youtube.com/
 
 ```ruby
 # On Machine A
-Propono::Client.new.listen_to_queue('some-topic') do |message|
+Propono::Client.new.listen('some-topic') do |message|
   puts "I just received: #{message}"
 end
 
@@ -26,7 +26,7 @@ Propono::Client.new.publish('some-topic', "The Best Message Ever")
 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.
+- UDP and TCP support have been removed, and `subscribe_by_post` has been removed.
 - We are now using long-polling. This makes Propono **significantly** faster (10-100x).
 
 ## Installation
@@ -68,7 +68,7 @@ Listening for messages is easy too. Just tell Propono what your application is c
 ```ruby
 client = Propono::Client.new
 client.config.application_name = "application-name" # Something unique to this app.
-client.listen_to_queue('some-topic') do |message|
+client.listen('some-topic') do |message|
   # ... Do something interesting with the message
 end
 ```

data/lib/propono/components/client.rb

@@ -51,7 +51,7 @@ module Propono
 
     # Creates a new SNS-SQS subscription on the specified topic.
     #
-    # This is implicitly called by {#listen_to_queue}.
+    # This is implicitly called by {#listen}.
     #
     # @param [String] topic The name of the topic to subscribe to.
     def subscribe(topic)

data/lib/propono/configuration.rb

@@ -5,36 +5,41 @@ module Propono
 
   class Configuration
 
-    SETTINGS = [
-      :use_iam_profile, :access_key, :secret_key, :queue_region, :queue_suffix,
-      :application_name,
-      :logger,
-      :max_retries, :num_messages_per_poll
-    ]
-    attr_writer *SETTINGS
-
-    def initialize
-      self.logger = Propono::Logger.new
-      self.queue_suffix = ""
-      self.use_iam_profile = false
-      self.max_retries = 0
-      self.num_messages_per_poll = 10
-    end
+    def self.add_setting(sym, required: true)
+      define_method(sym) do
+        required ? get_or_raise(sym) : @settings[sym]
+      end
 
-    SETTINGS.each do |setting|
-      define_method setting do
-        get_or_raise(setting)
+      define_method("#{sym}=") do |new_value|
+        @settings[sym] = new_value
       end
     end
 
-    attr_reader :use_iam_profile, :queue_suffix
+    add_setting :access_key
+    add_setting :secret_key
+    add_setting :queue_region
+    add_setting :application_name
+    add_setting :logger
+    add_setting :max_retries
+    add_setting :num_messages_per_poll
+
+    add_setting :use_iam_profile, required: false
+    add_setting :queue_suffix,    required: false
+
+    def initialize
+      @settings = {
+        logger:                Propono::Logger.new,
+        queue_suffix:          "",
+        use_iam_profile:       false,
+        max_retries:           0,
+        num_messages_per_poll: 10
+      }
+    end
 
     private
 
     def get_or_raise(setting)
-      val = instance_variable_get("@#{setting.to_s}")
-      val.nil?? raise(ProponoConfigurationError.new("Configuration for #{setting} is not set")) : val
+      @settings[setting] || raise(ProponoConfigurationError.new("Configuration for #{setting} is not set"))
     end
   end
 end
-

data/lib/propono/logger.rb

@@ -6,13 +6,13 @@ module Propono
 
     StdLevels.each do |level|
       define_method level do |*args|
-        $stdout.puts *args
+        $stdout.puts(*args)
       end
     end
 
     ErrorLevels.each do |level|
       define_method level do |*args|
-        $stderr.puts *args 
+        $stderr.puts(*args)
       end
     end
   end

data/lib/propono/services/queue_listener.rb

@@ -93,7 +93,7 @@ module Propono
 
     def requeue_message_on_failure(sqs_message, exception)
       next_queue = (sqs_message.failure_count < propono_config.max_retries) ? main_queue : failed_queue
-      propono_config.logger.error "Error proessing message, moving to queue: #{next_queue}"
+      propono_config.logger.error "Error processing message, moving to queue: #{next_queue}"
       aws_client.send_to_sqs(next_queue, sqs_message.to_json_with_exception(exception))
     end
 

data/lib/propono/version.rb

@@ -1,3 +1,3 @@
 module Propono
-  VERSION = "2.0.0.rc2"
+  VERSION = "2.0.0.rc3"
 end

data/test/components/aws_client_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Propono
+  class AwsClientTest < Minitest::Test
+
+    def test_publish_to_sns_proxies
+      client = AwsClient.new(nil)
+      sns_client = mock
+      message = {foo: 'bar'}
+      topic_arn = "asd"
+      topic = mock(arn: topic_arn)
+      sns_client.expects(:publish).with(
+        topic_arn: topic_arn,
+        message: message.to_json
+      )
+      client.stubs(sns_client: sns_client)
+      client.publish_to_sns(topic, message)
+    end
+  end
+end

data/test/configuration_test.rb

@@ -45,12 +45,29 @@ module Propono
       assert_equal application_name, propono_config.application_name
     end
 
+    def test_default_logger
+      assert propono_config.logger.is_a?(Propono::Logger)
+    end
+
+    def test_logger
+      propono_config.logger = :my_logger
+      assert_equal :my_logger, propono_config.logger
+    end
+
+    def test_default_queue_suffix
+      assert_equal "", propono_config.queue_suffix
+    end
+
     def test_queue_suffix
       queue_suffix = "test-application-name"
       propono_config.queue_suffix = queue_suffix
       assert_equal queue_suffix, propono_config.queue_suffix
     end
 
+    def test_default_num_messages_per_poll
+      assert_equal 10, propono_config.num_messages_per_poll
+    end
+
     def test_num_messages_per_poll
       val = 3
       propono_config.num_messages_per_poll = val
@@ -81,6 +98,27 @@ module Propono
       end
     end
 
+    def test_missing_logger_throws_exception
+      propono_config.logger = nil
+      assert_raises(ProponoConfigurationError) do
+        propono_config.logger
+      end
+    end
+
+    def test_missing_max_retries_throws_exception
+      propono_config.max_retries = nil
+      assert_raises(ProponoConfigurationError) do
+        propono_config.max_retries
+      end
+    end
+
+    def test_missing_num_messages_per_poll_throws_exception
+      propono_config.num_messages_per_poll = nil
+      assert_raises(ProponoConfigurationError) do
+        propono_config.num_messages_per_poll
+      end
+    end
+
     def test_default_max_retries
       assert_equal 0, propono_config.max_retries
     end

data/test/services/publisher_test.rb

@@ -115,12 +115,6 @@ module Propono
       end
     end
 
-    def test_publish_should_raise_exception_if_topic_is_nil
-      assert_raises(PublisherError, "Topic is nil") do
-        Publisher.publish(aws_client, propono_config, nil, "foobar")
-      end
-    end
-
     def test_publish_should_raise_exception_if_message_is_nil
       assert_raises(PublisherError, "Message is nil") do
         Publisher.publish(aws_client, propono_config, "foobar", nil)

data/test/test_helper.rb

@@ -14,28 +14,23 @@ class Minitest::Test
   end
 
   def propono_config
-    return @propono_config if @propono_config
-
-    @propono_config = Propono::Configuration.new
-    @propono_config.access_key = "test-access-key"
-    @propono_config.secret_key = "test-secret-key"
-    @propono_config.queue_region = "us-east-1"
-    @propono_config.application_name = "MyApp"
-    @propono_config.queue_suffix = ""
-
-    @propono_config.logger.stubs(:debug)
-    @propono_config.logger.stubs(:info)
-    @propono_config.logger.stubs(:error)
-
-    @propono_config
+    @propono_config ||= Propono::Configuration.new.tap do |c|
+      c.access_key = "test-access-key"
+      c.secret_key = "test-secret-key"
+      c.queue_region = "us-east-1"
+      c.application_name = "MyApp"
+      c.queue_suffix = ""
+
+      c.logger.stubs(:debug)
+      c.logger.stubs(:info)
+      c.logger.stubs(:error)
+    end
   end
 
   def aws_client
-    return @aws_client if @aws_client
-
-    @aws_client = Propono::AwsClient.new(mock)
-    @aws_client.stubs(:sns_client)
-    @aws_client.stubs(:sqs_client)
-    @aws_client
+    @aws_client ||= Propono::AwsClient.new(mock).tap do |c|
+      c.stubs(:sns_client)
+      c.stubs(:sqs_client)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: propono
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0.rc3
 platform: ruby
 authors:
 - MalcyL
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
@@ -142,6 +142,7 @@ files:
 - lib/propono/utils.rb
 - lib/propono/version.rb
 - propono.gemspec
+- test/components/aws_client_test.rb
 - test/components/aws_config_test.rb
 - test/components/client_test.rb
 - test/components/queue_subscription_test.rb
@@ -182,6 +183,7 @@ signing_key:
 specification_version: 4
 summary: General purpose pub/sub library built on top of AWS SNS and SQS
 test_files:
+- test/components/aws_client_test.rb
 - test/components/aws_config_test.rb
 - test/components/client_test.rb
 - test/components/queue_subscription_test.rb