circuitry 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cf97d3815318439ecc8eff261947cb4360bc0d48
-  data.tar.gz: d4e82e38d4bf9cfddc0dbd410eb1414dd7cf8af5
+SHA256:
+  metadata.gz: d200bb856db00d87237c6425d03a31ab5953ac4962f7af81e9797b85f94ee921
+  data.tar.gz: 1bc9b5eac4c058f5f30ad035ae8f10dabf4921d0f3b35781a528856ba75459c0
 SHA512:
-  metadata.gz: a42bd8ed1ce577f498aad1b674304042248a9e9892a3dbb0b955c5452288e852ca6510c460ac3994cf8f17bb1bee10dcb83e59a3845b00238c2c344614b9f704
-  data.tar.gz: aa1e4eff88e74a1cee7d1e27e1f404dc3efdf565337191faf4b605ad1bcf574fd25044d2781c4e95c6e9b19aa85341b98006849e97e013691a18b1eb6616c826
+  metadata.gz: be4a3411b0e5a4535049dda1343e901a4abcb2ec81d2b76762dfe75460b1b5941031c0e50d5d3c1bca0b23700350497dfd40e5243b90e449b93ef36b76ab14d2
+  data.tar.gz: 245564d9b1d16e53b9086acc44446967705dcef54062f0747ae6b8cb50a601fb8822c3ef7444c09bb2e7355519667bb8c1cbfd45e16da29ea018f11d04cc7602

data/.circleci/config.yml

@@ -0,0 +1,12 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/circuitry
+    docker:
+      - image: kapost/ruby:2.4.3-node-6.11.5
+    steps:
+      - checkout
+      - run: bundle install
+      - run:
+          name: Rspec
+          command: bundle exec rspec --format documentation --color spec

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Circuitry 3.3.0 (June 23, 2020)
+
+* Update AWS SDK to version 3 and use module sdk gems. *thogg4*
+  See https://github.com/aws/aws-sdk-ruby 
+  Version 3 is backwards compatible with version 2.
+* Catch `Aws::SNS::Errors::InvalidParameter` and rethrow with the topic
+  and message that caused the problem for improved debugging.
+
 ## Circuitry 3.2.0 (May 6, 2017)
 
 * Fixed processing for `batch_size` of 1. *Xi Zhang*

data/README.md

@@ -116,9 +116,15 @@ production:
 Available configuration options for *both* subscriber and publisher applications include:
 
 * `access_key`: The AWS access key ID that has access to SNS publishing and/or
-  SQS subscribing. *(required)*
+  SQS subscribing. *(required unless using iam profile)*
 * `secret_key`: The AWS secret access key that has access to SNS publishing
-  and/or SQS subscribing. *(required)*
+  and/or SQS subscribing. *(required unless using iam profile)*
+* `use_iam_profile`: Whether or not to use an iam profile for authenticating to AWS.
+  This will only work when running your application inside of an AWS instance.
+  Accepts `true` or `false`
+  Please refer to the [AWS Docs](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-credentials-iam)
+  for more details about using iam profiles for authentication.
+  *(required unless using access and secret keys, default: `false`)*
 * `region`: The AWS region that your SNS and/or SQS account lives in.
   *(optional, default: "us-east-1")*
 * `logger`: The logger to use for informational output, warnings, and error

data/circuitry.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'aws-sdk-sqs'
+  spec.add_dependency 'aws-sdk-sns'
+
   spec.add_dependency 'retries', '~> 0.0.5'
   spec.add_dependency 'virtus', '~> 1.0'
   spec.add_dependency 'thor'

data/lib/circuitry/config/shared_settings.rb

@@ -9,6 +9,7 @@ module Circuitry
         base.attribute :access_key, String
         base.attribute :secret_key, String
         base.attribute :region, String, default: 'us-east-1'
+        base.attribute :use_iam_profile, Virtus::Attribute::Boolean, default: false
         base.attribute :logger, Logger, default: Logger.new(STDERR)
         base.attribute :error_handler
         base.attribute :topic_names, Array[String], default: []

data/lib/circuitry/config/subscriber_settings.rb

@@ -26,6 +26,7 @@ module Circuitry
         unless value.is_a?(Circuitry::Locks::Base)
           raise ConfigError, "invalid lock strategy \"#{value.inspect}\""
         end
+        super
       end
     end
   end

data/lib/circuitry/publisher.rb

@@ -6,6 +6,17 @@ require 'circuitry/services/sns'
 module Circuitry
   class PublishError < StandardError; end
 
+  class SnsPublishError < StandardError
+    def initialize(topic:, message:, exception:)
+      msg = {
+        error: "#{exception.class}: #{exception.message}",
+        topic_arn: topic.arn,
+        message: message
+      }
+      super msg.to_json
+    end
+  end
+
   class Publisher
     include Concerns::Async
     include Services::SNS
@@ -54,7 +65,7 @@ module Circuitry
         # TODO: Don't use ruby timeout.
         # http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/
         Timeout.timeout(timeout) do
-          logger.info("Publishing message to #{topic_name}")
+          logger.debug("Publishing message to #{topic_name}")
 
           handler = ->(error, attempt_number, _total_delay) do
             logger.warn("Error publishing attempt ##{attempt_number}: #{error.class} (#{error.message}); retrying...")
@@ -62,7 +73,7 @@ module Circuitry
 
           with_retries(max_tries: 3, handler: handler, rescue: CONNECTION_ERRORS, base_sleep_seconds: 0.05, max_sleep_seconds: 0.25) do
             topic = Topic.find(topic_name)
-            sns.publish(topic_arn: topic.arn, message: message)
+            sns_publish(topic: topic, message: message)
           end
         end
       end
@@ -72,11 +83,20 @@ module Circuitry
 
     private
 
+    def sns_publish(topic:, message:)
+      sns.publish(topic_arn: topic.arn, message: message)
+
+    rescue Aws::SNS::Errors::InvalidParameter => ex
+      raise SnsPublishError.new(topic: topic, message:  message, exception: ex)
+    end
+
     def logger
       Circuitry.publisher_config.logger
     end
 
     def can_publish?
+      return true if Circuitry.publisher_config.use_iam_profile
+
       Circuitry.publisher_config.aws_options.values.all? do |value|
         !value.nil? && !value.empty?
       end

data/lib/circuitry/services/sns.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-sns'
 
 module Circuitry
   module Services

data/lib/circuitry/services/sqs.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-sqs'
 
 module Circuitry
   module Services

data/lib/circuitry/subscriber.rb

@@ -132,7 +132,7 @@ module Circuitry
     def process_message(message, &block)
       message = Message.new(message)
 
-      logger.info("Processing message #{message.id}")
+      logger.debug("Processing message #{message.id}")
 
       handled = try_with_lock(message.id) do
         handle_message_with_middleware(message, &block)
@@ -179,7 +179,7 @@ module Circuitry
     end
 
     def delete_message(message)
-      logger.info("Removing message #{message.id} from queue")
+      logger.debug("Removing message #{message.id} from queue")
       sqs.delete_message(queue_url: queue, receipt_handle: message.receipt_handle)
     end
 
@@ -192,6 +192,8 @@ module Circuitry
     end
 
     def can_subscribe?
+      return true if Circuitry.subscriber_config.use_iam_profile
+
       Circuitry.subscriber_config.aws_options.values.all? do |value|
         !value.nil? && !value.empty?
       end

data/lib/circuitry/version.rb

@@ -1,3 +1,3 @@
 module Circuitry
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuitry
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Matt Huggins
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: retries
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +245,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -241,7 +256,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
 - circuitry.gemspec
 - exe/circuitry
 - lib/circuitry.rb
@@ -297,8 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Decouple ruby applications using Amazon SNS fanout with SQS processing.

data/circle.yml

@@ -1,7 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.0
-
-dependencies:
-  pre:
-    - gem install bundler -v 1.8.9