shoryuken 5.0.4 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9793af33c7faa6fed94f9ba3c4d195de11fbb2bac9147740cec68f3f0a9b60b0
-  data.tar.gz: ba16095e67066c94e72fb9472d1f34d238bfbde6c1a77797f36c683426abb41e
+  metadata.gz: c2a0f01f40da91819e9e8e0b127a2504fccdd927365866f7971a7df207cea287
+  data.tar.gz: 3da85303fc49af5b0ad06888d667bde14ef12b79c595c98cdc3232d085d08350
 SHA512:
-  metadata.gz: 80108514d02ec16533f76b172df6f5d350dcd1b3d4253bda633ebbc4fc84398e3d5073e8d47f155a2b9f42da69b008b1650f48c612759314807bc9e9d0488c2c
-  data.tar.gz: de622970e9b943f26933934de1784d99c0f788607f7b9ae8d183601a55dba61b514d0d9b0813b09590de35bb74a985d62a5b891834a18f4319e6b740e62c9517
+  metadata.gz: 8a94cf02d3c7c25bf8282097449b83f1f4f3b4816b0e7be396048585ccc5667e9dcbdfe839f593c0ed04b2304fc1c0ca2d5d9564c86b854de63de6dafddc5de9
+  data.tar.gz: 20844e414f26d4a6a4e9d3db14bd4ea89bad4550486b91a1a1b8ba6eff2145e89fdf63007e356c707e54dbe8e0d1bb608844ec81db02516e84c4971633fd621d

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   Exclude:
     - '**/Gemfile'
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/PerceivedComplexity:
   Enabled: false

data/.travis.yml

@@ -1,10 +1,6 @@
 language: ruby
 
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
   - 2.4.4
   - 2.5.1
   - 2.6.3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [v5.0.5] - 2020-06-07
+
+- Add ability to configure queue by ARN
+  - [#603](https://github.com/phstc/shoryuken/pull/603)
+
 ## [v5.0.4] - 2020-02-20
 
 - Add endpoint option to SQS CLI

data/README.md

@@ -21,7 +21,7 @@ Shoryuken _sho-ryu-ken_ is a super-efficient [Amazon SQS](https://aws.amazon.com
 
 ## Requirements
 
-Ruby 2.0 or greater.
+Ruby 2.4 or greater.
 
 ## Installation
 

data/lib/shoryuken/queue.rb

@@ -8,9 +8,9 @@ module Shoryuken
 
     attr_accessor :name, :client, :url
 
-    def initialize(client, name_or_url)
+    def initialize(client, name_or_url_or_arn)
       self.client = client
-      set_name_and_url(name_or_url)
+      set_name_and_url(name_or_url_or_arn)
     end
 
     def visibility_timeout
@@ -50,32 +50,60 @@ module Shoryuken
       # Make sure the memoization work with boolean to avoid multiple calls to SQS
       # see https://github.com/phstc/shoryuken/pull/529
       return @_fifo if defined?(@_fifo)
+
       @_fifo = queue_attributes.attributes[FIFO_ATTR] == 'true'
+      @_fifo
     end
 
     private
 
-    def set_by_name(name)
+    def initialize_fifo_attribute
+      # calling fifo? will also initialize it
+      fifo?
+    end
+
+    def set_by_name(name) # rubocop:disable Naming/AccessorMethodName
       self.name = name
       self.url  = client.get_queue_url(queue_name: name).queue_url
     end
 
-    def set_by_url(url)
+    def set_by_url(url) # rubocop:disable Naming/AccessorMethodName
       self.name = url.split('/').last
       self.url  = url
     end
 
-    def set_name_and_url(name_or_url)
-      if name_or_url.include?('://')
-        set_by_url(name_or_url)
+    def arn_to_url(arn_str)
+      *, region, account_id, resource = arn_str.split(':')
+
+      required = [region, account_id, resource].map(&:to_s)
+      valid = required.none?(&:empty?)
+
+      abort "Invalid ARN: #{arn_str}. A valid ARN must include: region, account_id and resource." unless valid
+
+      "https://sqs.#{region}.amazonaws.com/#{account_id}/#{resource}"
+    end
+
+    def set_name_and_url(name_or_url_or_arn) # rubocop:disable Naming/AccessorMethodName
+      if name_or_url_or_arn.include?('://')
+        set_by_url(name_or_url_or_arn)
+
+        # anticipate the fifo? checker for validating the queue URL
+        initialize_fifo_attribute
+        return
+      end
+
+      if name_or_url_or_arn.start_with?('arn:')
+        url = arn_to_url(name_or_url_or_arn)
+        set_by_url(url)
 
         # anticipate the fifo? checker for validating the queue URL
-        return fifo?
+        initialize_fifo_attribute
+        return
       end
 
-      set_by_name(name_or_url)
-    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue => ex
-      raise ex, "The specified queue #{name_or_url} does not exist."
+      set_by_name(name_or_url_or_arn)
+    rescue Aws::Errors::NoSuchEndpointError, Aws::SQS::Errors::NonExistentQueue => e
+      raise e, "The specified queue #{name_or_url_or_arn} does not exist."
     end
 
     def queue_attributes

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '5.0.4'.freeze
+  VERSION = '5.0.5'.freeze
 end

data/shoryuken.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-byebug', '3.9.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 

data/spec/shoryuken/queue_spec.rb

@@ -39,6 +39,29 @@ RSpec.describe Shoryuken::Queue do
       end
     end
 
+    context 'when queue ARN supplied' do
+      let(:queue_arn) { 'arn:aws:sqs:ap-southeast-2:000000000000:queue-name' }
+
+      it 'initializes by URL and validate the URL' do
+        subject = described_class.new(sqs, queue_arn)
+
+        expect(subject.name).to eq('queue-name')
+        expect(subject.url).to eq('https://sqs.ap-southeast-2.amazonaws.com/000000000000/queue-name')
+      end
+    end
+
+    context 'when invalid queue ARN supplied' do
+      let(:queue_arn) { 'arn:aws:sqs::000000000000:queue-name' }
+
+      it 'raises an error' do
+        expect do
+          described_class.new(sqs, queue_arn)
+        end.to raise_error(
+          'Invalid ARN: arn:aws:sqs::000000000000:queue-name. A valid ARN must include: region, account_id and resource.'
+        )
+      end
+    end
+
     context 'when queue name supplied' do
       subject { described_class.new(sqs, queue_name) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.0.5
 platform: ruby
 authors:
 - Pablo Cantero
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -28,16 +28,16 @@ dependencies:
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +202,7 @@ homepage: https://github.com/phstc/shoryuken
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,8 +217,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Shoryuken is a super efficient AWS SQS thread based message processor
 test_files: