heroic-sns 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGJmMTYxNjFmNmJlZGFkM2E4ZDMzN2I0ODY1ODJmYzc5ZWMxNTAxZA==
-  data.tar.gz: !binary |-
-    ODU4NTFjMTM2MTBjZTY0MWMzNDNjZGZhYTQ1YjdhZTE0OWEwODAzOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTkxZjczZTVjODdjMjBlMTM0OWU2YjFmYzI4NzM1YzZmMWYzZWFlZjQ2YzMx
-    ODM1ODk3ZmNlMDRmYjE4NmI3MWE4ZTVmM2RmNTgwZTc2YjMwMjEzZjRhNjEy
-    NTVhMDZkZjlmN2IwYjkxNTdjM2M1Mzc2ODFjMzU3ZjhhZGRjZTg=
-  data.tar.gz: !binary |-
-    ZTY3YzJmZWRkZTE3OGE4ODRkNjgxNjMwMmYwYzRmZGQ4ODQ1MzE1YjMzZTcw
-    ZmYzMTJkYzhhM2Y5MmQ2YTQ5ZGRlYmUwMWMwYTc5YWUwM2RhMGFiOGJkZmVh
-    OWUyODNjYWE3Njg3Y2MyMzQ1ODI2N2Q0MGE4MmU5MTU0ODIzMDU=
+SHA1:
+  metadata.gz: 11d6f41c3874ec698df32ac516c3d103f74bfd7b
+  data.tar.gz: 9dbf1f1690e3ec3888a52c661c4755c6d5c1a05e
+SHA512:
+  metadata.gz: b0e8fe315fd65c499060616c8780586c427b1ed3ff3a829df29437fe17128d764cdc502f1eed9f450c7e09c068b80e65bf9fddce08253ab2ba1d6b4dc3d1062f
+  data.tar.gz: 20d5a1e66117f7c30e15d4107d93d6f84d8439dad5fd58919f46eb2e7bf0209067e47c048e3e7c040dbe365dfe8e18ddb4e33f16e6eb1898bb211b20b9028eac

data/.gitignore

@@ -1,4 +1,5 @@
 /capture
+/html
 /pkg
 /tmp
 /Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+### 1.1.1 (August 9, 2013)
+
+* Ease up json gem dependency - [@speedmanly]
+* Documentation cleaned up and tests improved.
+
+### 1.1.0 (June 20, 2013)
+
+* Rework Cert logic - [@sbeckeriv]
+
+### 1.0.1 (May 17, 2013)
+
+* Gem housekeeping, based on [advice by @dblock](http://code.dblock.org/your-first-ruby-gem)
+
+### 1.0.0 (May 5, 2013)
+
+* Initial public release - [@benzado]
+
+[@benzado]: http://github.com/benzado
+[@sbeckeriv]: http://github.com/sbeckeriv
+[@dblock]: http://github.com/dblock
+[@speedmanly]: http://github.com/speedmanly

data/README.md

@@ -3,21 +3,26 @@
 Heroic::SNS provides secure, lightweight Rack middleware for AWS Simple
 Notification Service (SNS) endpoints.
 
-Any SNS messages POSTed by Amazon to your web application are intercepted,
-parsed, verified, and then passed along via the `sns.message` environment key.
+Any SNS messages POSTed by Amazon to your web application are
+intercepted, parsed, verified, and then passed along via the
+`sns.message` environment key.
 
-If something goes wrong, the error will be passed along via the `sns.error`
-environment key. `Heroic::SNS::Endpoint` does not log any messages itself.
+If something goes wrong, the error will be passed along via the
+`sns.error` environment key. `Heroic::SNS::Endpoint` does not log any
+messages itself.
 
-**Heroic::SNS aims to be secure.** All message signatures are verified (to avoid
-forgeries) and stale messages are rejected (to avoid replay attacks).
+**Heroic::SNS aims to be secure.** All message signatures are verified
+(to avoid forgeries) and stale messages are rejected (to avoid replay
+attacks).
 
-**Heroic::SNS aims to be lightweight.** Beside Ruby standard libraries there are
-no dependencies beside [rack][]. Specifically, Heroic::SNS *does not* depend on [aws-sdk][]. They will be friendly to each other, however, if you include both
-in a project.
+**Heroic::SNS aims to be lightweight.** Beside Ruby standard libraries
+there are no dependencies besides [json][] and [rack][]. Specifically,
+Heroic::SNS *does not* depend on [aws-sdk][]. They will be friendly to
+each other, however, if you include both in a project.
 
-[aws-sdk]: https://github.com/aws/aws-sdk-ruby
+[json]: https://rubygems.org/gems/json
 [rack]: http://rack.github.io/
+[aws-sdk]: https://github.com/aws/aws-sdk-ruby
 
 ## Overview
 
@@ -29,8 +34,8 @@ in a project.
 
 ## How to use it
 
-Once you have installed the gem, simply add the following to your `config.ru`
-file:
+Once you have installed the gem, simply add the following to your
+`config.ru` file:
 
     use Heroic::SNS::Endpoint, :topics => /:aws-ses-bounces$/
 
@@ -38,52 +43,64 @@ On Rails, you could also install it in `/config/initializers/sns_endpoint.rb`:
 
     Rails.application.config.middleware.use Heroic::SNS::Endpoint, :topic => ...
 
-The Endpoint class takes an options hash as an argument, and understands these
-options:
+The Endpoint class takes an options hash as an argument, and understands
+these options:
+
+### :topic
 
-`:topic` is required, and provides a filter that defines what SNS topics are
-handled by this endpoint. **A message is considered either "on-topic" or
-"off-topic".** You can supply any of the following:
+`:topic` is required, and provides a filter that defines what SNS topics
+are handled by this endpoint. **A message is considered either
+"on-topic" or "off-topic".** You can supply any of the following:
 
 - a `String` containing a single topic ARN
+
 - an `Array` of `String` representing a list of topic ARNs
+
 - a `RegExp` which matches on-topic ARNs
-- a `Proc` which accepts an ARN as an argument and returns `true` or `false` for
-  on-topic and off-topic ARNs, respectively.
+
+- a `Proc` which accepts an ARN as an argument and returns `true` or
+  `false` for on-topic and off-topic ARNs, respectively.
 
 The key `:topics` is also supported.
 
+### :auto_confirm
+
 `:auto_confirm` affects how on-topic subscription confirmations are handled.
 
-- If `true`, they are confirmed by retrieving the URL in the `SubscribeURL`
-  field of the SNS message, and your app is not notified.
-- If `false`, they are ignored; your app is also not notified.
-- If `nil`, there is no special handling and the message is passed along to your
-  app.
-  
-The default is `true`.
+- If `true`, they are confirmed by retrieving the URL in the
+  `SubscribeURL` field of the SNS message, and your app is NOT notified.
+  This is the default.
+
+- If `false`, they are ignored; your app is NOT notified.
+
+- If `nil`, there is no special handling and the message is passed along
+  to your app.
+
+### :auto_resubscribe
 
 `:auto_resubscribe` affects how on-topic unsubscribe confirmations are handled.
 
-- If `true`, they topic is automatically re-subscribed by retrieving the URL in
-  the `SubscribeURL` field of the SNS message, and your app is not notified.
-- If `false`, they are ignored and your app is also not notified.
-- If `nil`, there is no special handling and the message is passed along to your
-  app.
+- If `false`, they are ignored and your app is NOT notified. This is the
+  default.
+
+- If `true`, they topic is automatically re-subscribed by retrieving the
+  URL in the `SubscribeURL` field of the SNS message, and your app is
+  NOT notified.
 
-The default is `false`.
+- If `nil`, there is no special handling and the message is passed along
+  to your app.
 
-If you are a control-freak and want no special handling whatsoever, use these
-options:
+If you are a control-freak and want no special handling whatsoever, use
+these options:
 
     use Heroic::SNS::Endpoint, :topics => Proc.new { true }, :auto_confirm => nil, :auto_resubscribe => nil
 
-Then the object will simply parse and verify SNS messages it finds and pass them
-along to your app, taking no action.
+Then the object will simply parse and verify SNS messages it finds and
+pass them along to your app, taking no action.
 
-Once the middleware is set up, any notifications will be made available in your
-Rack environment under the `sns.message` key. If you are using Rails, your
-controller would have a method like this:
+Once the middleware is set up, any notifications will be made available
+in your Rack environment under the `sns.message` key. If you are using
+Rails, your controller would have a method like this:
 
     skip_before_filter :verify_authenticity_token, :only => [:handle_notification]
 
@@ -98,43 +115,45 @@ controller would have a method like this:
       head :ok
     end
 
-You must skip the authenticity token verification to allow Amazon to POST to the
-controller action. Be careful not to disable it for more actions than you need.
-Be sure to disable any authentication checks for that action, too.
+You must skip the authenticity token verification to allow Amazon to
+POST to the controller action. Be careful not to disable it for more
+actions than you need. Be sure to disable any authentication checks for
+that action, too.
 
 ## Multiple endpoint URLs
 
-If you are receiving multiple notifications at multiple endpoint URLs, you
-should only include one instance of the Endpoint in your middleware stack, and
-ensure that its topic filter allows all the notifications you are interested in
-to pass through.
+If you are receiving multiple notifications at multiple endpoint URLs,
+you should only include one instance of the Endpoint in your middleware
+stack, and ensure that its topic filter allows all the notifications you
+are interested in to pass through.
 
 `Endpoint` does not interact with the URL path at all; if you want your
 subscriptions to go to different URLs, simply set them up that way.
 
 ## Off-topic notifications
 
-As a security measure, `Endpoint` requires you to set up a topic filter. Any
-notifications that do not match this filter are not passed along to your
-application.
+As a security measure, `Endpoint` requires you to set up a topic filter.
+Any notifications that do not match this filter are not passed along to
+your application.
 
-All off-topic messages are ignored with one exception: if the message is a
-regular notification (meaning your app has an active subscription) *and* the
-message can be verified as authentic (by checking its signature), `Endpoint`
-will cancel the subscription by visiting the URL in the `UnsubscribeURL` field
-of the message.
+All off-topic messages are ignored with one exception: if the message is
+a regular notification (meaning your app has an active subscription)
+*and* the message can be verified as authentic (by checking its
+signature), `Endpoint` will cancel the subscription by visiting the URL
+in the `UnsubscribeURL` field of the message.
 
-If you would rather make decision about on-topic and off-topic notifications in
-your own code, simply pass `Proc.new { true }` as the topic filter, and all
-messages will be treated as on topic. Be aware that it is dangerous to leave
-`:auto_confirm` enabled with a permissive topic filter, as this will allow
-anyone to subscribe your web app to any SNS notification.
+If you would rather make decision about on-topic and off-topic
+notifications in your own code, simply pass `Proc.new { true }` as the
+topic filter, and all messages will be treated as on topic. Be aware
+that it is dangerous to leave `:auto_confirm` enabled with a permissive
+topic filter, as this will allow anyone to subscribe your web app to any
+SNS notification.
 
 ## Contributing
 
 * Fork the project.
 * Make your feature addition or bug fix and include tests.
-* Update `CHANGELOG`.
+* Update `CHANGELOG.md`.
 * Send a pull request.
 
 ## Copyright and License

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rdoc/task'
 
 Bundler.setup(:default, :development)
 
@@ -8,6 +9,11 @@ Rake::TestTask.new do |t|
   t.libs << 'test'
 end
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "CHANGELOG.md", "lib")
+end
+
 task :demo do
   sh 'rackup -Ilib demo/config.ru'
 end

data/heroic-sns.gemspec

@@ -26,6 +26,7 @@ EOD
 
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = '>= 1.8.7'
+  s.add_development_dependency 'rdoc', '~> 4.0'
   s.add_runtime_dependency 'rack', '~> 1.4'
-  s.add_runtime_dependency 'json', '~> 1.7.7'
+  s.add_runtime_dependency 'json', '~> 1.7'
 end

data/lib/heroic/lru_cache.rb

@@ -3,12 +3,12 @@ module Heroic
   # This LRU Cache is a generic key-value store that is designed to be safe for
   # concurrent access. It uses a doubly-linked-list to identify which item was
   # least recently retrieved, and a Hash for fast retrieval by key.
-
+  #
   # To support concurrent access, it uses two levels of locks: a cache-level lock
   # is used to locate or create the desired node and move it to the front of the
   # LRU list. A node-level lock is used to synchronize access to the node's
   # value.
-
+  #
   # If a thread is busy generating a value to be stored in the cache, other
   # threads will still be able to read and write to other keys with no conflict.
   # However, if a second thread tries to read the value that the first thread is
@@ -16,24 +16,6 @@ module Heroic
 
   class LRUCache
 
-    class Node
-      attr_reader :key
-      attr_accessor :left, :right
-      def initialize(key)
-        @key = key
-        @lock = Mutex.new
-      end
-      def read
-        @lock.synchronize { @value ||= yield(@key) }
-      end
-      def write(value)
-        @lock.synchronize { @value = value }
-      end
-      def to_s
-        sprintf '<Node:%x(%s)>', self.object_id, @key.inspect
-      end
-    end
-
     # If you yield a block to the constructor, it will be called on every cache
     # miss to generate the needed value. This is optional but recommended, as
     # the block will run while holding a lock on the cache node associated with
@@ -53,25 +35,34 @@ module Heroic
       @rightmost = nil
     end
 
+    # Retrieve a value from the cache for a given key. If the value is in the
+    # cache, the method will return immediately. If the value is not in the
+    # cache and a block was provided to the constructor, it will be invoked to
+    # generate the value and insert it into the cache. If another thread is in
+    # the process of generating the same value, the current thread will wait for
+    # it to complete.
+    #
+    # If the cache is full, this method may cause the least recently used item
+    # to be evicted from the cache.
+
     def get(key)
       node = node_for_key(key)
       node.read(&@block)
     end
 
+    # Inserts a value into the cache, assigning it to the given key. (Instead of
+    # directly inserting values into the cache, it is recommended that you supply
+    # a block to the constructor to generate values on demand.)
+
     def put(key, value)
       node = node_for_key(key)
       node.write(value)
     end
 
-    def empty!
-      @lock.synchronize do
-        @store.empty!
-        @leftmost = nil
-        @rightmost = nil
-      end
-    end
+    # Verify the data structures used to maintain the cache. If a problem is
+    # detected, an exception is raised. This method is intended for testing and
+    # debugging only.
 
-    # Verify the list structure. Intended for testing and debugging only.
     def verify!
       @lock.synchronize do
         left_to_right = Array.new
@@ -111,6 +102,24 @@ module Heroic
 
     private
 
+    class Node # :nodoc:
+      attr_reader :key
+      attr_accessor :left, :right
+      def initialize(key)
+        @key = key
+        @lock = Mutex.new
+      end
+      def read
+        @lock.synchronize { @value ||= yield(@key) }
+      end
+      def write(value)
+        @lock.synchronize { @value = value }
+      end
+      def to_s
+        sprintf '<Node:%x(%s)>', self.object_id, @key.inspect
+      end
+    end
+
     def node_for_key(key)
       @lock.synchronize do
         node = @store[key]

data/lib/heroic/sns/endpoint.rb

@@ -1,38 +1,54 @@
 require 'openssl'
 require 'open-uri'
 
-# Heroic::SNS::Endpoint is Rack middleware which intercepts messages from
-# Amazon's Simple Notification Service (SNS). It makes the parsed and verified
-# message available to your application in the Rack environment under the
-# 'sns.message' key. If an error occurred during message handling, the error
-# is available in the Rack environment in the 'sns.error' key.
-
-# Endpoint is to be initialized with a hash of options. It understands three
-# different options:
-# - :topic (or :topics) specifies a filter that defines what SNS topics are
-#   handled by this endpoint ("on-topic"). You can supply any of the following:
-#   - a topic ARN as a String
-#   - a list of topic ARNs as an Array of Strings
-#   - a regular expression matching on-topic ARNs
-#   - a Proc which takes a topic ARN as a String and returns true or false.
-#   You must specify a topic filter. Use Proc.new { true } if you insist on
-#   indiscriminately accepting all notifications.
-# - :auto_confirm determines how SubscriptionConfirmation messages are handled.
-#   If true, the subscription is confirmed and your app is not notified.
-#   If false, the subscription is ignored and your app is not notified.
-#   If nil, the message is passed along to your app.
-
-# You can install this in your config.ru:
-#   use Heroic::SNS::Endpoint, :topics => /whatever/
-
-# For Rails, you can also install it in /config/initializers/sns_endpoint.rb:
-#   Rails.application.config.middleware.use Heroic::SNS::Endpoint, :topic => ...
-
 module Heroic
   module SNS
 
     SUBSCRIPTION_ARN_HTTP_HEADER = 'HTTP_X_AMZ_SNS_SUBSCRIPTION_ARN'
 
+=begin rdoc
+
+  Heroic::SNS::Endpoint is Rack middleware which intercepts messages from
+  Amazon's Simple Notification Service (SNS). It makes the parsed and
+  verified message available to your application in the Rack environment
+  under the 'sns.message' key. If an error occurred during message handling,
+  the error is available in the Rack environment in the 'sns.error' key.
+
+  Endpoint is to be initialized with a hash of options. It understands three
+  different options:
+
+  +:topic+ (or +:topics+) specifies a filter that defines what SNS topics
+  are handled by this endpoint ("on-topic"). You can supply any of the
+  following:
+  - a topic ARN as a String
+  - a list of topic ARNs as an Array of Strings
+  - a regular expression matching on-topic ARNs
+  - a Proc which takes a topic ARN as a String and returns true or false.
+  You *must* specify a topic filter. Use <code>Proc.new{true}</code> if
+  you insist on indiscriminately accepting all notifications.
+
+  +:auto_confirm+ determines how SubscriptionConfirmation messages are handled.
+  - If true, the subscription is confirmed and your app is not notified.
+    This is the default.
+  - If false, the subscription is ignored and your app is not notified.
+  - If nil, the message is passed along to your app.
+
+  +:auto_resubscribe+ affects how on-topic UnsubscribeConfirmation messages are handled.
+  - If false, they are ignored and your app is also not notified.
+    This is the default.
+  - If true, they topic is automatically re-subscribed by retrieving the URL in
+    the `SubscribeURL` field of the SNS message, and your app is not notified.
+  - If nil, there is no special handling and the message is passed along to your
+    app.
+
+  You can install this in your config.ru:
+    use Heroic::SNS::Endpoint, :topics => /whatever/
+
+  For Rails, you can also install it in /config/initializers/sns_endpoint.rb:
+    Rails.application.config.middleware.use Heroic::SNS::Endpoint, :topic => ...
+
+=end
+
     class Endpoint
 
       DEFAULT_OPTIONS = { :auto_confirm => true, :auto_resubscribe => false }

data/lib/heroic/sns/message.rb

@@ -19,7 +19,10 @@ module Heroic
       end
     end
 
-    # Encapsulates an SNS message.
+    # Encapsulates an SNS message. Since Endpoint takes care of authenticating
+    # the message, most of the time you will simply be interested in retrieving
+    # the +subject+ and +body+ from the message and acting on it.
+    #
     # See: http://docs.aws.amazon.com/sns/latest/gsg/json-formats.html
     class Message
 
@@ -29,6 +32,8 @@ module Heroic
         raise Error.new("failed to parse message as JSON: #{e.message}")
       end
 
+      # The message type will be one of +SubscriptionConfirmation+,
+      # +UnsubscribeConfirmation+, and +Notification+.
       def type
         @msg['Type']
       end
@@ -37,11 +42,14 @@ module Heroic
         @msg['TopicArn']
       end
 
+      # A Universally Unique Identifier, unique for each message published. For
+      # a notification that Amazon SNS resends during a retry, the message ID of
+      # the original message is used.
       def id
         @msg['MessageId']
       end
 
-      # The timestamp as a Time object.
+      # The timestamp when the message was published, as a Time object.
       def timestamp
         Time.xmlschema(@msg['Timestamp'])
       end
@@ -64,6 +72,9 @@ module Heroic
         @msg['Subject']
       end
 
+      # The message payload. As far as Amazon and this class are concerned, the
+      # message payload is just a string of bytes. If you are expecting, for
+      # example, a JSON object, you will need to pass this to a JSON parser.
       def body
         @msg['Message']
       end
@@ -77,13 +88,13 @@ module Heroic
       end
 
       # The token is used to confirm subscriptions via the SNS API. If you visit
-      # the :subscribe_url, you can ignore this field.
+      # the +subscribe_url+, you can ignore this field.
       def token
         @msg['Token']
       end
 
-      def ==(other_message)
-        @msg == other_message.instance_variable_get(:@msg)
+      def ==(other)
+        other.is_a?(Message) && @msg == other.instance_variable_get(:@msg)
       end
 
       def hash
@@ -98,11 +109,14 @@ module Heroic
         string << ">"
       end
 
+      # Returns a JSON serialization of the message. Note that it may not be
+      # identical to the serialization that was retrieved from the network.
       def to_json
         @msg.to_json
       end
 
-      # Verifies the message signature. Raises an exception if it is not valid.
+      # Verifies the message signature. Raises Error if it is not valid.
+      #
       # See: http://docs.aws.amazon.com/sns/latest/gsg/SendMessageToHttp.verify.signature.html
       def verify!
         age = Time.now - timestamp

data/lib/heroic/sns/version.rb

@@ -1,5 +1,5 @@
 module Heroic
   module SNS
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/test/test_lru_cache.rb

@@ -14,12 +14,12 @@ class LRUCacheTest < Test::Unit::TestCase
 
   def test_get_put
     cache = Heroic::LRUCache.new(1)
-    assert_nil cache.get(:foo)
-    cache.put(:foo, :bar)
-    assert_equal :bar, cache.get(:foo)
-    cache.put(:answer, 42)
-    assert_equal 42, cache.get(:answer)
-    assert_nil cache.get(:foo)
+    assert_nil cache.get(:casey)
+    cache.put(:casey, :jones)
+    assert_equal :jones, cache.get(:casey)
+    cache.put(:april, :oneil)
+    assert_equal :oneil, cache.get(:april)
+    assert_nil cache.get(:casey)
   end
 
   def test_exceptions
@@ -32,41 +32,41 @@ class LRUCacheTest < Test::Unit::TestCase
       end
     end
     assert_raises RuntimeError do
-      cache.get(:foo)
+      cache.get(:ooze)
     end
     @should_throw = false
-    assert_equal 4, cache.get(:foo)
+    assert_equal 4, cache.get(:ooze)
   end
 
   def test_dynamic
     @counter = 0
-    cache = Heroic::LRUCache.new(3) { |k| @counter += 1; "hello, #{k}." }
+    cache = Heroic::LRUCache.new(3) { |k| @counter += 1; k.to_s.length }
     assert_equal 0, @counter
     cache.verify!
-    assert_equal "hello, leo.", cache.get(:leo); assert_equal 1, @counter
+    assert_equal 3, cache.get(:leo); assert_equal 1, @counter
     cache.verify!
-    assert_equal "hello, leo.", cache.get(:leo); assert_equal 1, @counter
+    assert_equal 3, cache.get(:leo); assert_equal 1, @counter
     cache.verify!
-    assert_equal "hello, donnie.", cache.get(:donnie); assert_equal 2, @counter
+    assert_equal 6, cache.get(:donnie); assert_equal 2, @counter
     cache.verify!
-    assert_equal "hello, donnie.", cache.get(:donnie); assert_equal 2, @counter
+    assert_equal 6, cache.get(:donnie); assert_equal 2, @counter
     cache.verify!
-    assert_equal "hello, mikey.", cache.get(:mikey); assert_equal 3, @counter
+    assert_equal 5, cache.get(:mikey); assert_equal 3, @counter
     cache.verify!
-    assert_equal "hello, mikey.", cache.get(:mikey); assert_equal 3, @counter
+    assert_equal 5, cache.get(:mikey); assert_equal 3, @counter
     cache.verify!
     # raph will push leo out of cache
-    assert_equal "hello, raph.", cache.get(:raph); assert_equal 4, @counter
+    assert_equal 4, cache.get(:raph); assert_equal 4, @counter
     cache.verify!
-    assert_equal "hello, raph.", cache.get(:raph); assert_equal 4, @counter
+    assert_equal 4, cache.get(:raph); assert_equal 4, @counter
     cache.verify!
     # mikey and donnie remain in cache
-    assert_equal "hello, mikey.", cache.get(:mikey); assert_equal 4, @counter
+    assert_equal 5, cache.get(:mikey); assert_equal 4, @counter
     cache.verify!
-    assert_equal "hello, donnie.", cache.get(:donnie); assert_equal 4, @counter
+    assert_equal 6, cache.get(:donnie); assert_equal 4, @counter
     cache.verify!
     # leo will have to be refetched
-    assert_equal "hello, leo.", cache.get(:leo); assert_equal 5, @counter
+    assert_equal 3, cache.get(:leo); assert_equal 5, @counter
     cache.verify!
   end
 
@@ -76,35 +76,34 @@ class LRUCacheTest < Test::Unit::TestCase
     cache = Heroic::LRUCache.new(100) do |k|
       sleep 1 # simulate slow generation, such as network I/O
       @lock.synchronize { @counter += 1 }
-      k.to_s
+      k.to_s.length
     end
     # load the cache with things to read
-    cache.put(:a, 'a')
-    cache.put(:b, 'b')
-    cache.put(:c, 'c')
+    cache.put(:leo, 0)
+    cache.put(:donnie, 0)
     start_time = Time.now
-    # start fetch in background
-    td = Thread.new do
-      cache.get(:d)
+    # Start threads to fetch in background. :leo and :donnie should return
+    # immediately, because the values are in the cache; :mikey and :raph should
+    # run concurrently; the second :raph should wait on the first :raph to
+    # complete.
+    threads = [:leo, :donnie, :mikey, :raph, :raph].map do |k|
+      Thread.new { cache.get(k) }
     end
-    te = Thread.new do
-      cache.get(:e)
-    end
-    # while background threads fetch, reading other keys should not be blocked
-    assert_equal 'a', cache.get(:a)
-    assert_equal 'b', cache.get(:b)
-    assert_equal 'c', cache.get(:c)
+    # Fetching values already in the cache should not block.
+    assert_equal 0, cache.get(:leo)
+    assert_equal 0, cache.get(:donnie)
     assert_equal 0, @lock.synchronize { @counter }
-    # now main thread should block until background items are fetched
-    assert_equal "d", cache.get(:d)
-    assert_equal "e", cache.get(:e)
+    # Fetching values being computed now will block until somebody computes them.
+    assert_equal 5, cache.get(:mikey)
+    assert_equal 4, cache.get(:raph)
     assert_equal 2, @lock.synchronize { @counter }
-    # reading the same values should be fast (they are cached)
-    assert_equal "d", cache.get(:d)
-    assert_equal "e", cache.get(:e)
+    # Fetching those same values should not trigger a recompute.
+    assert_equal 5, cache.get(:mikey)
+    assert_equal 4, cache.get(:raph)
     assert_equal 2, @lock.synchronize { @counter }
-    # look at time elapsed to make sure we didn't sleep more than once
-    [td, te].each { |t| t.join }
+    # Let's wait for all threads to finish, then check the clock to make sure we
+    # only slept for a second.
+    threads.each { |t| t.join }
     time_elapsed = (Time.now - start_time)
     assert_in_delta time_elapsed, 1.0, 0.01
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: heroic-sns
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Benjamin Ragheb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -30,29 +44,21 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
-description: ! 'Secure, lightweight Rack middleware for Amazon Simple Notification
-  Service (SNS)
-
+        version: '1.7'
+description: |
+  Secure, lightweight Rack middleware for Amazon Simple Notification Service (SNS)
   endpoints. SNS messages are intercepted, parsed, verified, and then passed along
-
-  to the web application via the ''sns.message'' environment key. Heroic::SNS has
-  no
-
+  to the web application via the 'sns.message' environment key. Heroic::SNS has no
   dependencies besides Rack (specifically, the aws-sdk gem is not needed).
-
   SNS message signatures are verified in order to reject forgeries and replay
-
   attacks.
-
-'
 email: ben@benzado.com
 executables: []
 extensions: []
@@ -60,7 +66,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -93,12 +99,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/CHANGELOG

@@ -1,13 +0,0 @@
-### 1.1.0 (June 20, 2013)
-
-* Rework Cert logic - [@sbeckeriv]
-
-### 1.0.1 (May 17, 2013)
-
-* Gem housekeeping, based on [advice by dblock](http://code.dblock.org/your-first-ruby-gem)
-
-### 1.0.0 (May 5, 2013)
-
-* Initial public release - [@benzado]
-
-[@benzado]: http://github.com/benzado