sqs_simplify 0.2.0

data/lib/sqs_simplify/scheduler.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SqsSimplify
+  class Scheduler < SqsSimplify::Base
+    include SqsSimplify::ExecutionHook
+    private_class_method :new
+
+    def initialize(message:, delay_seconds:, queue_url:, group_id: nil)
+      @message = message
+      @delay_seconds = delay_seconds
+      @queue_url = queue_url
+      @group_id = group_id
+    end
+
+    private
+
+    def queue_url
+      self.class.queue_url
+    end
+
+    def build_message
+      Message.new queue_url: @queue_url, body: dump_message(@message), delay_seconds: @delay_seconds,
+                  group_id: @group_id
+    end
+
+    def send_message
+      sqs_message = build_message
+      self.class.call_hook :before_each, sqs_message
+      client.send_message(sqs_message.to_send).message_id
+    rescue Aws::SQS::Errors::NonExistentQueue => e
+      self.class.call_hook :resolver_exception, e, sqs_message
+      raise e
+    rescue StandardError => e
+      self.class.call_hook :resolver_exception, e, sqs_message
+    ensure
+      self.class.call_hook :after_each, sqs_message
+    end
+
+    class << self
+      def send_message(message:, after: nil, queue_url: nil, group_id: nil)
+        after = after.nil? ? 0 : after.to_i
+        raise 'parameter must be between 0 to 960 seconds' unless after >= 0 && after < 961
+
+        queue_url ||= self.queue_url
+        new(message: message, delay_seconds: after, queue_url: queue_url,
+            group_id: group_id).send :send_message
+      end
+
+      def map_queue(nickname, &block)
+        const_name = nickname.capitalize
+
+        class_eval <<~M, __FILE__, __LINE__ + 1
+          class #{const_name} < #{self}; end
+          private_constant '#{const_name}'
+
+          def self.#{nickname}
+            #{const_name}
+          end
+        M
+
+        block&.call send(nickname)
+        mapped_queues[nickname] = const_get(const_name).name
+      end
+
+      private
+
+      def mapped_queues
+        @mapped_queues ||= {}
+      end
+    end
+  end
+end

data/lib/sqs_simplify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SqsSimplify
+  VERSION = '0.2.0'
+end

data/lib/sqs_simplify/worker.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module SqsSimplify
+  class Worker
+    def initialize(**options, &callback)
+      self.queues = options[:queues]
+      self.priority = options[:priority]
+      self.worker_size = options[:worker_size]
+      self.parallel_type = options[:parallel_type]
+      self.callback = callback
+    end
+
+    def perform
+      valid_queues!
+
+      if priority?
+        consumer_with_priority
+      else
+        consumer
+      end
+    end
+
+    private
+
+    attr_accessor :queues, :priority, :worker_size, :parallel_type, :callback
+
+    def sqs_consumers
+      @sqs_consumers ||= build_sqs_consumers
+    end
+
+    def build_sqs_consumers
+      consumers = SqsSimplify.consumers
+
+      if queues
+        queues.map do |queue|
+          consumers.find { |consumer| consumer.queue_name == queue } || Struct.new(:queue_name).new
+        end
+      else
+        consumers
+      end
+    end
+
+    def valid_queues!
+      if queues
+        check_option_queues!
+      else
+        check_has_any_consumer!
+      end
+    end
+
+    def check_option_queues!
+      all_queue_names = sqs_consumers.map(&:queue_name)
+
+      invalid_queues = queues.reject do |queue|
+        all_queue_names.include? queue
+      end
+
+      raise "Option queue invalid: [#{invalid_queues.join(', ')}]" if invalid_queues.length.positive?
+    end
+
+    def check_has_any_consumer!
+      raise 'No queue consumers were found in this project' if sqs_consumers.empty?
+    end
+
+    def priority?
+      priority
+    end
+
+    def consumer_with_priority
+      accumulated = 0
+      index = 0
+
+      loop do
+        amount = execute(sqs_consumers[index])
+        if amount.positive?
+          accumulated += amount
+          index = 0
+        else
+          index += 1
+          return accumulated if index >= queues.count
+        end
+      end
+    end
+
+    def consumer
+      number_of_executions = sqs_consumers.map do |sqs_consumer|
+        execute(sqs_consumer)
+      end
+      number_of_executions.reduce(&:+)
+    end
+
+    def execute(sqs_consumer)
+      options = { worker_size: worker_size, parallel_type: parallel_type }
+      result = sqs_consumer.consume_messages(**options)
+      callback&.call(result, sqs_consumer)
+      result
+    end
+  end
+end

data/lib/sqs_simplify.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+require 'fileutils'
+require 'json'
+require 'logger'
+require 'ostruct'
+require 'parallel'
+require 'pathname'
+require 'timeout'
+
+require 'sqs_simplify/execution_hook'
+require 'sqs_simplify/client'
+require 'sqs_simplify/base'
+
+require 'sqs_simplify/command'
+require 'sqs_simplify/consumer'
+require 'sqs_simplify/faker_client'
+
+require 'sqs_simplify/message'
+require 'sqs_simplify/scheduler'
+require 'sqs_simplify/version'
+
+require 'sqs_simplify/worker'
+require 'sqs_simplify/job'
+require 'sqs_simplify/dead_queue'
+
+require 'sqs_simplify/errors/execution_expired'
+require 'sqs_simplify/errors/non_existent_queue'
+require 'sqs_simplify/errors/reserved_method_name'
+
+module SqsSimplify
+  include SqsSimplify::ExecutionHook
+
+  add_hook :message_not_deleted, :after_fork
+
+  class << self
+    def configure
+      block_given? ? yield(settings) : settings
+    end
+
+    def settings
+      @settings ||= OpenStruct.new(
+        hooks: self,
+        worker: self::Worker,
+        root: Pathname.new(Dir.pwd)
+      )
+    end
+
+    def consumers
+      @consumers ||= []
+    end
+
+    def schedulers
+      @schedulers ||= []
+    end
+
+    def logger
+      return @logger if @logger
+
+      path = settings.log_dir || "#{settings.root}/log"
+      FileUtils.mkdir_p(path) unless File.directory?(path)
+      @logger = Logger.new("#{path}/sqs_simplify.log")
+    end
+  end
+
+  class Error < StandardError; end
+end

data/rubocop.yml

@@ -0,0 +1,3 @@
+Lint/MissingSuper:
+  Exclude:
+    - 'app/services/**/*'

data/sqs_simplify.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sqs_simplify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sqs_simplify'
+  spec.version       = SqsSimplify::VERSION
+  spec.authors       = ['Ralph Baesso', 'Nathan Meira', 'Joathan Fontan']
+  spec.email         = ['ralphsbaesso@gmail.com', 'nathanmeira1@gmail.com', 'joathan.fontan@brobotbr.com.br']
+
+  spec.summary       = 'Simple producers, consumers and jobs on top of Amazon SQS'
+  spec.description   = 'Send, consume and schedule Amazon SQS messages with jobs, consumers, ' \
+                       'dead letter queues, FIFO group ids and a worker command.'
+  spec.homepage      = 'https://github.com/joathan-fontan/sqs_simplify'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aws-sdk-sqs', '~> 1.0'
+  spec.add_runtime_dependency 'parallel', '>= 1.20', '< 3'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sqs_simplify
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ralph Baesso
+- Nathan Meira
+- Joathan Fontan
+bindir: exe
+cert_chain: []
+date: 1980-01-02 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Send, consume and schedule Amazon SQS messages with jobs, consumers,
+  dead letter queues, FIFO group ids and a worker command.
+email:
+- ralphsbaesso@gmail.com
+- nathanmeira1@gmail.com
+- joathan.fontan@brobotbr.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.pt-br.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sqs_simplify.rb
+- lib/sqs_simplify/base.rb
+- lib/sqs_simplify/client.rb
+- lib/sqs_simplify/command.rb
+- lib/sqs_simplify/consumer.rb
+- lib/sqs_simplify/dead_queue.rb
+- lib/sqs_simplify/errors/execution_expired.rb
+- lib/sqs_simplify/errors/non_existent_queue.rb
+- lib/sqs_simplify/errors/reserved_method_name.rb
+- lib/sqs_simplify/execution_hook.rb
+- lib/sqs_simplify/faker_client.rb
+- lib/sqs_simplify/job.rb
+- lib/sqs_simplify/message.rb
+- lib/sqs_simplify/scheduler.rb
+- lib/sqs_simplify/version.rb
+- lib/sqs_simplify/worker.rb
+- rubocop.yml
+- sqs_simplify.gemspec
+homepage: https://github.com/joathan-fontan/sqs_simplify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joathan-fontan/sqs_simplify
+  source_code_uri: https://github.com/joathan-fontan/sqs_simplify
+  changelog_uri: https://github.com/joathan-fontan/sqs_simplify/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: Simple producers, consumers and jobs on top of Amazon SQS
+test_files: []