sidekiq-aws-sqs 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45920481b9e63b1c63ba93afbdda2ccea64f7d5e74af75bb876889e4007abc86
-  data.tar.gz: 8be08f891e92119526a33c4b254d24534604f9b190b1fdc8da5c8ee24c8693f7
+  metadata.gz: 2c672a08fbea53c439915d089a38d1a9d8a6cd6159fe8cf809dd66a3bbc946f2
+  data.tar.gz: '08e8905bdf9b926ef4485a110193b7ed553950f052b5cd4ca177212ac22b7766'
 SHA512:
-  metadata.gz: 8220afbb9c6c2cd1fb2cc59ff837a9101fd9a87587b4bc6d7766fb0a3e5e24a2779410e4354608457f80c74bbc4b3319c084aeae15aab0fecb5165abd9c163c4
-  data.tar.gz: fee3a4e6521c45d06a9bde31bf376cc89c4f67d6bccbf27254f0d5827aae76401dc1db8438f5df9b671c332e167b005a2a8a78330a36ae05c2b235ecc8af7738
+  metadata.gz: e0d38d03c38eca397b52367c7a134f0455e5335e2ef81ef2beab84379696f5abcbc73c423c305da2c1fb5f336cebe2b48a21fbc96e4566c8eee9eef65e105fc9
+  data.tar.gz: 42990522018f2b536fc4e558f2b191d9d967281a54fdaea1f3da2f167a0a6759fcd5dfa9cc26fdbdf575dbef998f3b154bacd012925eb386f87920ef78f8ca1f

data/Gemfile.lock

@@ -1,25 +1,179 @@
 PATH
   remote: .
   specs:
-    sidekiq-aws-sqs (0.0.0)
+    sidekiq-aws-sqs (0.0.1)
+      aws-sdk-sqs (~> 1.53)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      rails (>= 6.0.0)
+      safe_poller (~> 0.0.1)
+      sidekiq (>= 7.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     awesome_print (1.9.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.749.0)
+    aws-sdk-core (3.171.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-sqs (1.53.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    builder (3.2.4)
     coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.0)
+    crass (1.0.6)
+    date (3.3.3)
     diff-lcs (1.5.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.6.2)
     json (2.6.3)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
     method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    redis-client (0.14.1)
+      connection_pool
     regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -48,7 +202,21 @@ GEM
     rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    safe_poller (0.0.1)
+    sidekiq (7.0.9)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.11.0)
+    thor (1.2.1)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/sidekiq-aws-sqs.svg)](https://badge.fury.io/rb/sidekiq-aws-sqs)
+![test](https://github.com/nejdetkadir/sidekiq-aws-sqs/actions/workflows/test.yml/badge.svg?branch=main)
+![rubocop](https://github.com/nejdetkadir/sidekiq-aws-sqs/actions/workflows/rubocop.yml/badge.svg?branch=main)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+![Ruby Version](https://img.shields.io/badge/ruby_version->=_2.7.0-blue.svg)
+
 # Sidekiq::AWS::SQS
 
 `sidekiq-aws-sqs` is a Sidekiq extension that simplifies the integration of AWS SQS queues with Sidekiq workers, by abstracting away the details of polling, processing and error handling of SQS messages. It aims to provide a reliable and flexible way to consume messages from SQS, while allowing the user to customize the polling behavior and SQS client options as needed.
@@ -33,14 +39,46 @@ class MyWorker
   include Sidekiq::Worker
   include Sidekiq::AWS::SQS::Worker
 
-  sqs_options queue_url: 'https://sqs.foo.amazonaws.com/123/bar', wait_time_seconds: 20, destroy_on_received: true
+  sqs_options queue_url: 'https://sqs.foo.amazonaws.com/123/bar',
+              wait_time_seconds: 20, # optional, default: 20
+              destroy_on_received: true, # optional, default: false
+              max_number_of_messages: 10, # optional, default: 10
+              client: Aws::SQS::Client.new # optional if global config is set to Sidekiq::AWS::SQS.config.sqs_client
 
   def perform(message)
-    puts "Received message: #{message}"
+    body = JSON.parse(message, object_class: OpenStruct).body
+
+    puts "Received message: #{JSON.parse(body)}"
   end
 end
 ```
 
+### Configuration
+You can configure the global options for all sqs workers by creating an initializer file in `config/initializers/sidekiq_aws_sqs.rb` and setting the options as shown below.
+
+
+```ruby
+# config/initializers/sidekiq_aws_sqs.rb
+
+require 'sidekiq/aws/sqs'
+require 'aws-sdk-sqs'
+
+Sidekiq::AWS::SQS.configure do |config|
+  config.sqs_client = Aws::SQS::Client.new # global SQS client for all sqs workers
+
+  # you must set the your sqs workers here for registering them to sidekiq aws sqs
+  config.sqs_workers = [
+    MyWorker
+  ]
+
+  # global polling options for all sqs workers
+  config.wait_time_seconds = 20 # optional, default: 20
+  config.destroy_on_received = true # optional, default: false
+  config.max_number_of_messages = 10 # optional, default: 10
+  config.logger = Sidekiq.logger # optional, default: Sidekiq.logger
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nejdetkadir/sidekiq-aws-sqs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nejdetkadir/sidekiq-aws-sqs/blob/main/CODE_OF_CONDUCT.md).

data/lib/sidekiq/aws/sqs/helpers.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module AWS
+    module SQS
+      module Helpers
+        def validate_sqs_options!
+          raise ArgumentError, 'You must use the `sqs_options` method on your worker' if @sqs_options.blank?
+
+          if need_to_raise_for_queue_url?
+            raise ArgumentError,
+                  'You must provide a SQS queue URL like `sqs_options queue_url: "url"'
+          end
+
+          raise ArgumentError, 'You must provide a SQS client' if need_to_raise_for_client?
+
+          if need_to_raise_for_wait_time_seconds?
+            raise ArgumentError,
+                  'You must provide a valid wait time like `sqs_options wait_time_seconds: 20`'
+          end
+          if need_to_raise_for_max_number_of_messages?
+            raise ArgumentError,
+                  'You must provide a valid max number of messages like `sqs_options max_number_of_messages: 10`'
+          end
+
+          return unless need_to_raise_for_destroy_on_received?
+
+          raise ArgumentError,
+                'You must provide a valid destroy on received like `sqs_options destroy_on_received: true`'
+        end
+
+        def sqs_options_struct
+          if @sqs_options[:wait_time_seconds].blank?
+            @sqs_options[:wait_time_seconds] =
+              Sidekiq::AWS::SQS.config.wait_time_seconds
+          end
+
+          if @sqs_options[:max_number_of_messages].blank?
+            @sqs_options[:max_number_of_messages] =
+              Sidekiq::AWS::SQS.config.max_number_of_messages
+          end
+
+          if @sqs_options[:destroy_on_received].blank?
+            @sqs_options[:destroy_on_received] =
+              Sidekiq::AWS::SQS.config.destroy_on_received
+          end
+
+          @sqs_options[:client] = Sidekiq::AWS::SQS.config.sqs_client if @sqs_options[:client].blank?
+
+          OpenStruct.new(@sqs_options)
+        end
+
+        private
+
+        def need_to_raise_for_max_number_of_messages?
+          @sqs_options[:max_number_of_messages].present? && @sqs_options[:max_number_of_messages] > 10
+        end
+
+        def need_to_raise_for_wait_time_seconds?
+          @sqs_options[:wait_time_seconds].present? && @sqs_options[:wait_time_seconds] > 20
+        end
+
+        def need_to_raise_for_client?
+          Sidekiq::AWS::SQS.config.sqs_client.blank? && @sqs_options[:client].blank?
+        end
+
+        def need_to_raise_for_queue_url?
+          @sqs_options[:queue_url].blank?
+        end
+
+        def need_to_raise_for_destroy_on_received?
+          @sqs_options[:destroy_on_received].present? && !@sqs_options[:destroy_on_received].in?([true, false])
+        end
+
+        def need_to_destroy_on_received?
+          @sqs_options[:destroy_on_received] == true
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/aws/sqs/rails/engine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module AWS
+    module SQS
+      module Rails
+        class Engine < ::Rails::Engine
+          isolate_namespace Sidekiq::AWS::SQS
+
+          config.after_initialize do
+            ::Sidekiq.configure_server do |config|
+              config.on(:shutdown) do
+                ::Sidekiq::AWS::SQS.config.sqs_workers.each(&:stop_polling)
+              end
+
+              config.on(:startup) do
+                ::Sidekiq::AWS::SQS.config.sqs_workers.each(&:start_polling)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/aws/sqs/version.rb

@@ -3,7 +3,7 @@
 module Sidekiq
   module AWS
     module SQS
-      VERSION = '0.0.0'
+      VERSION = '0.0.1'
     end
   end
 end

data/lib/sidekiq/aws/sqs/worker.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'sidekiq/aws/sqs/helpers'
+
+# rubocop:disable Layout/LineLength, Metrics/AbcSize
+module Sidekiq
+  module AWS
+    module SQS
+      module Worker
+        include Sidekiq::AWS::SQS::Helpers
+
+        def poller
+          validate_sqs_options!
+
+          @poller ||= SafePoller.poll do
+            sqs_options_struct
+              .client
+              .receive_message(queue_url: sqs_options_struct.queue_url,
+                               wait_time_seconds: sqs_options_struct.wait_time_seconds)
+              .messages
+              .each do |message|
+              Sidekiq::AWS::SQS.logger.debug("Received message #{message.message_id} from #{sqs_options_struct.queue_url} for #{self}")
+
+              perform_async(message.to_json)
+
+              Sidekiq::AWS::SQS.logger.debug("Enqueued message #{message.message_id} from #{sqs_options_struct.queue_url} for #{self}")
+
+              next unless need_to_destroy_on_received?
+
+              sqs_options_struct.client.delete_message(queue_url: sqs_options_struct.queue_url,
+                                                       receipt_handle: message.receipt_handle)
+
+              Sidekiq::AWS::SQS.logger.debug("Deleted message #{message.message_id} from #{sqs_options_struct.queue_url} for #{self}")
+            end
+          end
+        end
+
+        def start_polling
+          Sidekiq::AWS::SQS.logger.debug("Starting polling for #{self}")
+
+          @poller&.start || poller
+        end
+
+        def stop_polling
+          Sidekiq::AWS::SQS.logger.debug("Stopping polling for #{self}")
+
+          @poller&.stop
+        end
+
+        def pause_polling
+          Sidekiq::AWS::SQS.logger.debug("Pausing polling for #{self}")
+
+          @poller&.pause
+        end
+
+        def resume_polling
+          Sidekiq::AWS::SQS.logger.debug("Resuming polling for #{self}")
+
+          @poller&.resume
+        end
+
+        def running?
+          @poller&.running? || false
+        end
+
+        def paused?
+          @poller&.paused? || false
+        end
+
+        def sqs_options(**options)
+          @sqs_options = options || {}
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Layout/LineLength, Metrics/AbcSize

data/lib/sidekiq/aws/sqs.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
 require_relative 'sqs/version'
+require 'rails'
+require 'aws-sdk-sqs'
+require 'sidekiq'
+require 'dry-configurable'
 
 module Sidekiq
   module AWS
     module SQS
-      class Error < StandardError; end
-      # Your code goes here...
+      extend Dry::Configurable
+
+      setting :sqs_client, default: nil, reader: true
+      setting :sqs_workers, default: [], reader: true
+      setting :wait_time_seconds, default: 20, reader: true
+      setting :max_number_of_messages, default: 10, reader: true
+      setting :destroy_on_received, default: false, reader: true
+      setting :logger, default: ::Sidekiq.logger, reader: true
     end
   end
 end
+
+require_relative 'sqs/rails/engine'
+require_relative 'sqs/worker'

metadata

@@ -1,15 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-aws-sqs
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - nejdetkadir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
-dependencies: []
+date: 2023-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.53'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.53'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: safe_poller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 description: sidekiq-aws-sqs is a Sidekiq extension that provides an easy way to poll
   and process messages from AWS SQS (Simple Queue Service) queues within a Sidekiq
   worker. It uses the SafePoller gem under the hood to safely poll messages at a specified
@@ -32,7 +108,10 @@ files:
 - README.md
 - Rakefile
 - lib/sidekiq/aws/sqs.rb
+- lib/sidekiq/aws/sqs/helpers.rb
+- lib/sidekiq/aws/sqs/rails/engine.rb
 - lib/sidekiq/aws/sqs/version.rb
+- lib/sidekiq/aws/sqs/worker.rb
 - sig/sidekiq/aws/sqs.rbs
 homepage: https://github.com/nejdetkadir/sidekiq-aws-sqs
 licenses: