qprocessor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e127381632515acbf030a9eca5338928a298187b155950102a33bff338af4fc
+  data.tar.gz: 767a5e859b1de2fcc61463b2b0c2d350a4ca7dbffc7ede0d352005fab68707cd
+SHA512:
+  metadata.gz: de8a0421e4fd44bb25badc482f8aa1a6b160f0d73594e3d3a689f9e538e57bcd37b0191d168206546776cc7a55a6e054e495db3a0bbeb0f90561c9087e4fe19f
+  data.tar.gz: fbbbd2241b98d85028964409991fcf87ddde61cfecaddc4ca99677717c828a2a1d6604e4bb3232f438aebc3ee742f0dbcb41520c3a7afe55e4ef18f38333d8fb

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# CHANGE LOG
+

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qprocessor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    qprocessor (0.1.0)
+      beaneater (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    beaneater (1.1.1)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  qprocessor!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# QProcessor
+
+A simple library that wraps the processing of elements pulled from a queue. Initial
+implementation will work with Beanstalkd, though I might expand it to cover other
+types of queue later. The idea behind this gem is to allow for the easy creation
+of an application as a service, where the services job is to pull items from a
+queue and process them. The library code is intended to wrap the parts of the code
+that would be common and repeated if you made individual service applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qprocessor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install qprocessor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/free-beer/qprocessor.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "qprocessor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qprocessor/json_parser.rb

@@ -0,0 +1,14 @@
+require "json"
+
+module QProcessor
+  # A parser class that treats the job contents as YAML.
+  class JSONParser
+    def initialize(settings={})
+      @settings = {}.merge(settings)
+    end
+
+    def parse(job)
+      JSON.parse(job.body)
+    end
+  end
+end

data/lib/qprocessor/processor.rb

@@ -0,0 +1,106 @@
+require "beaneater"
+require "logger"
+
+module QProcessor
+  # This class encapsulates a lot of the functionality around creating a queue
+  # processor that pulls work from a queue and passes it to an instance of a
+  # specified class for 'handling'.
+  class Processor
+    # A constant for a regular expression to match Beanstalk URLs
+    BEANSTALK_URL_PATTERN = /^beanstalk:\/\/([^:\/]+)[:]?([\d]*)[\/]?(.*)$/
+
+    # A constant with the name of the default job parser class.
+    DEFAULT_PARSER_CLASS = "QProcessor::YAMLParser"
+
+    # The default Beanstalk tube name.
+    DEFAULT_TUBE_NAME = "default"
+
+    # A constant containing the maximum permitted setting for the inter-error sleep interval.
+    MAX_ERROR_RESTART_INTERVAL = 32
+
+    # Constructor for the Processor class.
+    #
+    # @param [String] The name assigned to the processor, primarily used for logging.
+    # @param [String] The URL to be used when connecting to the queue system.
+    # @param [Hash] A Hash of the class names used by the processor. There are two
+    #               keys recognised in this Hash - :parser and :processor. The
+    #               :parser class should be the fully qualified name of the class
+    #               class that can be used to parse job content. The :processor
+    #               class should be the fully qualified name of the class that will
+    #               process jobs.
+    # @param [Hash] A Hash of additional settings that will be used by the processor.
+    #               Valid keys include :logger and :reuse_processor.
+    def initialize(name, url, class_names, settings={})
+      @instance        = nil
+      @name            = name
+      @parser_class    = get_class!(class_names.fetch(:parser, DEFAULT_PARSER_CLASS))
+      @processor_class = get_class!(class_names[:processor])
+      @queue_url       = url
+      @settings        = {}.merge(settings)
+      @terminate       = false
+    end
+    attr_reader :class_name, :name,  :queue_url, :settings
+
+    # Starts processing of the queue. This method will not return to the caller
+    # as it will run a loop processing the queue jobs as they become available.
+    def start
+      queue    = connect
+      interval = 0
+      while !@terminate
+        begin
+          logger.debug("The '#{name}' queue processor is listening for jobs.")
+          queue.reserve do|job|
+            logger.debug "The '#{name}' queue processor received job id #{job.id}."
+            handle(job)
+            interval = 0
+          end
+        rescue => error
+          logger.error "The '#{name}' queue processor caught an exception.\nType: #{error.class.name}\n"\
+                       "Message: #{error}\nStack Trace:\n#{error.backtrace.join("\n")}"
+          sleep(interval) if interval > 0
+          interval = interval > 0 ? interval * 2 : 1
+          interval = MAX_ERROR_RESTART_INTERVAL if interval > MAX_ERROR_RESTART_INTERVAL
+        end
+      end
+    end
+
+  private
+
+    def beanstalk_connect
+      match = BEANSTALK_URL_PATTERN.match(queue_url)
+      raise QProcessor::Error("Invalid Beanstalk queue URL '#{queue_url}' specified.") if !match
+      beanstalk = Beaneater.new("#{match[1]}#{match[2] == "" ? "" : ":#{match[2]}"}")
+      beanstalk.tubes[match[3] != "" ? match[3] : DEFAULT_TUBE_NAME]
+    end
+
+    def connect
+      if queue_url[0, 9] == "beanstalk"
+        beanstalk_connect
+      else
+        raise QProcessor::Error.new("Unrecognised queue URL '#{queue_url}' encountered")
+      end
+    end
+
+    def get_class(name)
+      name.split("::").reduce(Object) {|t, e| (!t.nil? ? t.const_get(e) : nil)}
+    end
+
+    def get_class!(name)
+      result = get_class(name)
+      raise QProcessor::Error.new("Unable to locate the '#{class_name}' class.") if result.nil?
+      result
+    end
+
+    def handle(job)
+      @instance = @processor_class.new(parser: @parser_class.new(logger: logger),
+                                       logger: logger) if @instance.nil?
+      @instance.process(job)
+      @instance = nil if !settings.fetch(:reuse_processor, true)
+    end
+
+    def logger
+      settings[:logger] = Logger.new(STDOUT) if !settings.include?(:logger) || !settings[:logger]
+      settings[:logger]
+    end
+  end
+end

data/lib/qprocessor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QProcessor
+  VERSION = "0.1.0"
+end

data/lib/qprocessor/yaml_parser.rb

@@ -0,0 +1,14 @@
+require "yaml"
+
+module QProcessor
+  # A parser class that treats the job contents as YAML.
+  class YAMLParser
+    def initialize(settings={})
+      @settings = {}.merge(settings)
+    end
+
+    def parse(job)
+      YAML.load(job.body)
+    end
+  end
+end

data/lib/qprocessor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "qprocessor/json_parser"
+require_relative "qprocessor/yaml_parser"
+require_relative "qprocessor/processor"
+require_relative "qprocessor/version"
+
+module QProcessor
+  class Error < StandardError; end
+end

data/qprocessor.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/qprocessor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qprocessor"
+  spec.version       = QProcessor::VERSION
+  spec.authors       = ["Peter Wood"]
+  spec.email         = ["pw0470@gmail.com"]
+
+  spec.summary       = "A library for generating queue processing applications."
+  spec.description   = "A library to assist in the creation of queue processing 'application as a service' entities."
+  spec.homepage      = "https://github.com/free-beer/qprocessor"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/free-beer/qprocessor.git"
+  spec.metadata["changelog_uri"] = "https://github.com/free-beer/qprocessor/blob/master/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "beaneater", "~> 1.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: qprocessor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Wood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A library to assist in the creation of queue processing 'application
+  as a service' entities.
+email:
+- pw0470@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qprocessor.rb
+- lib/qprocessor/json_parser.rb
+- lib/qprocessor/processor.rb
+- lib/qprocessor/version.rb
+- lib/qprocessor/yaml_parser.rb
+- qprocessor.gemspec
+homepage: https://github.com/free-beer/qprocessor
+licenses: []
+metadata:
+  homepage_uri: https://github.com/free-beer/qprocessor
+  source_code_uri: https://github.com/free-beer/qprocessor.git
+  changelog_uri: https://github.com/free-beer/qprocessor/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A library for generating queue processing applications.
+test_files: []