conrad 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dca0b05c54f60645fece80d8226d43d6130afb47aac653d8bb92090b619c7812
-  data.tar.gz: 26a24ce8ec5288ab2847fda11442c13dbba14addd883dd2931d32ef1da240222
+  metadata.gz: e96b6146bf06c4a7e186558757e061af57b5dc1b8ac7d2129a78cf6ca9ccae14
+  data.tar.gz: e1f8ded64e5f68c115722e266615e3cd13c0c430cdfcd75ba59c6ffa2f70ecba
 SHA512:
-  metadata.gz: 3f9023ef66bb257ad4d9ceaa25b4ce63e646128c67e11de7fda8a765622235eefebfc83019a6ff4f0349ce0134b19793c689c0319f07e9e4e2af9e3f5982442d
-  data.tar.gz: fa8f34c73693be7666ee7ccadd9ba54f69d716c197ced407d5788a2a0205dea7755771fd4d359e2362befff766caae9173e89fb183fb757ec0e230c0b335a7c2
+  metadata.gz: 7278ae58a8a6616d3a81b86be52c544214dfec99673a6af824e6265db0ce6a49e202b88068905c4982f6fb3e5c563d87609c66f5c9772d4404ef236d5f8638eb
+  data.tar.gz: 820d004eec75ca4870c80fda14137fb670fb6549aa543f545459404b17ae3e40d4ebf5be4aae6a570971b06c10bf262a8d3dfa578a4374d1e32310b8a7d21583

data/lib/conrad/emitters/sqs.rb

@@ -1,27 +1,81 @@
+require 'conrad/errors'
+
 module Conrad
-  # A module containing all of conrad's built in event emitters for outputting events
+  # A module containing all of conrad's built in event emitters for outputting
+  # events
   module Emitters
-    # Basic emitter for sending events to AWS's sqs.
+    # Basic emitter for sending events to AWS's sqs. If all access information
+    # is given, the given credentials will be used. Otherwise, the emitter will
+    # attempt to use values configured in the running environment according to
+    # the AWS SDK documentation (such as from ~/.aws/credentials).
     class Sqs
-      attr_reader :queue_url, :region, :access_key_id, :secret_access_key
+      # Error for responding with issues around SQS credential creation
+      class InvalidAwsCredentials < ::Conrad::Error
+        # :nodoc:
+        def to_s
+          'Must provide secret_access_key, access_key_id, and region OR rely ' \
+          'on configured values in the running environment.'
+        end
+      end
+
+      # @return [String] the configured SQS queue URL
+      attr_reader :queue_url
+
+      # @deprecated Will be removed in 3.0.0, no migration path
+      # @return [String, nil] the configured region
+      attr_reader :region
+
+      # @deprecated Will be removed in 3.0.0, no migration path
+      # @return [String, nil] the configured AWS Access key ID
+      attr_reader :access_key_id
+
+      # @deprecated Will be removed in 3.0.0, no migration path
+      # @return [String, nil] the configured AWS secret access key
+      attr_reader :secret_access_key
+
+      # @return [Aws::SQS::Client] the created client
+      attr_reader :client
 
-      # Takes in and stores SQS region, url and creds for accessing a queue.
-      def initialize(queue_url:, region:, access_key_id:, secret_access_key:)
+      # @param queue_url [String] the queue to send messages to
+      # @param region [String] region the queue lives in
+      # @param access_key_id [String] AWS Acesss Key ID
+      # @param secret_access_key [String] AWS Secret Access Key
+      #
+      # @raise [InvalidAwsCredentials] if any of region, access_key_id, or
+      #   secret_access_key are not provided AND the running environment does
+      #   not have valid AWS credentials
+      def initialize(queue_url:, region: nil, access_key_id: nil, secret_access_key: nil)
         @queue_url = queue_url
         @region = region
         @access_key_id = access_key_id
         @secret_access_key = secret_access_key
 
-        @client ||= Aws::SQS::Client.new(
-          region: region,
-          access_key_id: access_key_id,
-          secret_access_key: secret_access_key
-        )
+        create_client(region: region, access_key_id: access_key_id, secret_access_key: secret_access_key)
       end
 
       # Sends an event up to SQS
       def call(event)
-        @client.send_message(queue_url: queue_url, message_body: event)
+        client.send_message(queue_url: queue_url, message_body: event)
+      end
+
+      private
+
+      def create_client(region:, access_key_id:, secret_access_key:)
+        if secret_access_key.nil? || access_key_id.nil? || region.nil?
+          validate_implicit_credentials
+
+          @client = Aws::SQS::Client.new
+        else
+          @client = Aws::SQS::Client.new(
+            region: region,
+            access_key_id: access_key_id,
+            secret_access_key: secret_access_key
+          )
+        end
+      end
+
+      def validate_implicit_credentials
+        raise InvalidAwsCredentials unless Aws::CredentialProviderChain.new.resolve.set?
       end
     end
   end

data/lib/conrad/version.rb

@@ -1,5 +1,5 @@
 # :nodoc:
 module Conrad
   # :nodoc:
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conrad
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jonathon Anderson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  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: rake
   requirement: !ruby/object:Gem::Requirement