simple_sqs 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84e064a9ba95888b963a578cf6ebefb366ec55b055542c183173a97457198959
+  data.tar.gz: 3b6413aacbde1e5a9b2663319b6fab79ca93813e40db69f32a293d342dca1498
+SHA512:
+  metadata.gz: 30724a11c2b10164b39eb11e221aea930fa9f561a5a1583187c12691942543350e7136da08749499e8e6f095bcb44685b2d183db12c59931ff9dc0c18ebfa6eb
+  data.tar.gz: c34bf64d4f225428105e7083ac20fcf266614dfc9e4b60a5cb1629f02e20aef7b32edda6f2676b6d612cad3db0b9fff74ca70eda0f57365ace517d55f831f389

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Local todo list for this project :)
+TODO.md

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.3.1@simple_sqs --create

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_sqs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jean-Philippe Boily
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# SimpleSqs
+
+[![Build Status](https://travis-ci.org/rainforestapp/simple_sqs.svg)](https://travis-ci.org/rainforestapp/simple_sqs)
+
+SimpleSqs is a super simple abstraction of SQS. You can have a daemon polling and running jobs for messages, and enqueue some messages too. It was developed by Rainforest QA, a [web app testing](https://www.rainforestqa.com/product/web-app-testing/) platform.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_sqs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_sqs
+
+### Configuration
+
+The way that SimpleSqs works is that you will enqueue messages with an `event_name`, this should be the name of a class in your app consuming the messages. You need to setup the namespace for it, just like this:
+
+```ruby
+# config/initializers/simple_sqs.rb <- if you are using Rails, as an example
+SIMPLE_SQS_EVENTS_NAMESPACE = MyApp::Sqs::Events
+```
+
+Some more configuration needed:
+
+```
+export SIMPLE_SQS_PUBLIC_KEY=...
+export SIMPLE_SQS_SECRET_KEY=...
+export SIMPLE_SQS_REGION=...
+```
+
+### ActiveRecord
+
+If your project uses ActiveRecord, the processing of messages will take place in a transaction. Stop this behaviour by setting the environment variable `SIMPLE_SQS_NO_AR_TRANSACTION` with any value:
+
+```
+export SIMPLE_SQS_NO_AR_TRANSACTION=true
+```
+
+### Librato prefix
+
+If you have multiple apps using SimpleSqs that all logs to the same Librato account, it is higly suggested to configure each app with a [custom prefix](https://github.com/librato/librato-rails#custom-prefixes).
+
+### Rake task
+
+To be able to use the polling included in SimpleSqs, you can just add this to your Rakefile:
+
+```ruby
+spec = Gem::Specification.find_by_name 'simple_sqs'
+load "#{spec.gem_dir}/lib/tasks/simple_sqs.rake"
+```
+
+And then start this rake task to start polling: `bundle exec rake simple_sqs:daemon`
+
+## Usage
+
+You can have a daemon on Heroku, as an example, by puttin a line like this in your `Procfile`:
+
+```
+sqs: env SIMPLE_SQS_QUEUE_URL=http://.... bundle exec rake simple_sqs:daemon
+```
+
+To enqueue new messages:
+
+```ruby
+q = SimpleSqs::Queue.new(queue_url: "https://sqs.us-east-1.amazonaws.com...../my-queue-name")
+q.send_message(event_name: 'MyEvent', arguments: ['ok', 1])
+```
+
+### Sample job
+
+```ruby
+class MyApp::Sqs::Events::MyEvent < SimpleSqs::Events::Base
+  def process
+    arguments = event['Arguments']
+    # do whatever you want here my friend!
+  end
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_sqs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_sqs"
+
+# 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

data/bin/setup

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

data/dummy_app/sqs/events/some_event.rb

@@ -0,0 +1,11 @@
+module DummyApp
+  module Sqs
+    module Events
+      class SomeEvent < SimpleSqs::Events::Base
+        def process
+          #
+        end
+      end
+    end
+  end
+end

data/lib/simple_sqs.rb

@@ -0,0 +1,14 @@
+require "simple_sqs/version"
+require "simple_sqs/events"
+require "simple_sqs/events/base"
+require "simple_sqs/worker"
+require "simple_sqs/processor"
+require "simple_sqs/queue"
+require "sentry-raven"
+require "librato-rails"
+require "aws-sdk"
+require 'multi_json'
+
+module SimpleSqs
+  # Your code goes here...
+end

data/lib/simple_sqs/events.rb

@@ -0,0 +1,2 @@
+module SimpleSqs::Events
+end

data/lib/simple_sqs/events/base.rb

@@ -0,0 +1,16 @@
+class SimpleSqs::Events::Base
+  attr_reader :event, :sqs_message
+
+  def initialize(event, sqs_message = nil)
+    @event = event
+    @sqs_message = sqs_message
+  end
+
+  def process
+    raise NotImplementedError.new
+  end
+
+  def timestamp
+    Time.parse event['EventTimestamp']
+  end
+end

data/lib/simple_sqs/processor.rb

@@ -0,0 +1,44 @@
+#
+# Simple SQS
+#
+# This is used to process SQS notifications
+#
+require 'logger'
+
+class SimpleSqs::Processor
+  def process_sqs_message(json_message_body, sqs_message = nil, transaction_safe = true)
+    if Object.const_defined?("ActiveRecord") && transaction_safe
+      ActiveRecord::Base.transaction do
+        json_message_body['Events'].each do |event|
+          process event, sqs_message
+        end
+      end
+    else
+      json_message_body['Events'].each do |event|
+        process event, sqs_message
+      end
+    end
+  end
+
+  private
+  def process event, sqs_message
+    logger.debug "Processing SQS event #{event.inspect}, raw message: #{sqs_message.inspect}"
+    Librato.timing("sqs.process", source: event['EventType']) do
+      klass = SIMPLE_SQS_EVENTS_NAMESPACE.const_get(event['EventType'])
+      sqs_event = klass.new(event.freeze, sqs_message)
+
+      lag = ((Time.now - sqs_event.timestamp) * 1000).ceil
+      Librato.measure("sqs.lag", lag, source: event['EventType'])
+      Librato.increment("sqs.events", source: event['EventType'])
+
+      sqs_event.process
+    end
+  rescue NameError => e
+    Raven.capture_exception(e, extra: {parameters: event, cgi_data: ENV})
+    logger.error e
+  end
+
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/simple_sqs/queue.rb

@@ -0,0 +1,39 @@
+class SimpleSqs::Queue
+  attr_reader :client
+
+  def initialize queue_url:
+    @queue_url = queue_url
+    @client = Aws::SQS::Client.new(
+      access_key_id: ENV.fetch('SIMPLE_SQS_PUBLIC_KEY'),
+      secret_access_key: ENV.fetch('SIMPLE_SQS_SECRET_KEY'),
+      region: ENV.fetch('SIMPLE_SQS_REGION')
+    )
+  end
+
+  def send_message event_name:, arguments: []
+    body = {'Events' => [
+      {'EventType' => event_name,
+       'EventTimestamp' => Time.now.to_s,
+       'Arguments' => arguments
+      }
+    ]}
+
+    resp = client.send_message(
+      queue_url: @queue_url,
+      message_body: body.to_json,
+    )
+  end
+
+  def approximate_number_of_messages
+    get_attribute('ApproximateNumberOfMessages')
+  end
+
+  private
+  def get_attribute attribute
+    resp = client.get_queue_attributes(
+      attribute_names: [attribute],
+      queue_url: @queue_url
+    )
+    resp.attributes[attribute]
+  end
+end

data/lib/simple_sqs/version.rb

@@ -0,0 +1,3 @@
+module SimpleSqs
+  VERSION = "0.1.2"
+end

data/lib/simple_sqs/worker.rb

@@ -0,0 +1,82 @@
+class SimpleSqs::Worker
+  attr_reader :client, :processor
+
+  # Allow another worker to get the message after this long. Suggest 25%-50% more
+  # than your average job
+  VISIBILITY_TIMEOUT = ENV.fetch('SIMPLE_SQS_VISABILITY_TIMEOUT', 15).to_i.freeze
+
+  # Set to false if you're using a redrive policy on your queue.
+  DELETE_AFTER_MAX_RETRY = (ENV.fetch('DELETE_AFTER_MAX_RETRY', 'true').downcase == 'true').freeze
+
+  # If DELETE_AFTER_MAX_RETRY enabled, delete after this many retrys
+  MAX_RETRY = ENV.fetch('MAX_SQS_MESSAGE_RETRY', 5).to_i.freeze
+
+  def initialize queue_url:
+    @queue_url = queue_url
+    @client = Aws::SQS::Client.new(
+      access_key_id: ENV.fetch('SIMPLE_SQS_PUBLIC_KEY'),
+      secret_access_key: ENV.fetch('SIMPLE_SQS_SECRET_KEY'),
+      region: ENV.fetch('SIMPLE_SQS_REGION')
+    )
+    @processor = SimpleSqs::Processor.new
+    @poller = Aws::SQS::QueuePoller.new(@queue_url, {client: @client})
+    @transaction = !ENV.key?('SIMPLE_SQS_NO_AR_TRANSACTION')
+  end
+
+  def transaction?
+    @transaction
+  end
+
+  def start
+    logger.info 'Starting SQS polling'
+    receive_and_process
+  end
+
+  def receive_and_process
+    @poller.before_request do |stats|
+      trap "INT", -> (*args) { stop_polling }
+      trap "TERM", -> (*args) { stop_polling }
+    end
+
+    @poller.poll(visibility_timeout: VISIBILITY_TIMEOUT) do |message|
+      process(message)
+    end
+  end
+
+  private
+  def stop_polling
+    logger.info "Stopping SQS polling"
+    throw :stop_polling
+  end
+
+  def process(message)
+    json_message_body = MultiJson.decode(message.body)
+    begin
+      processor.process_sqs_message(json_message_body, message, transaction?)
+    rescue Exception => e
+      logger.error "SQS: #{message.message_id}\t#{e.message}\t#{e.backtrace}"
+      Librato.increment('sqs.error')
+      handle_message_error(message, exception: e)
+    end
+  end
+
+  def handle_message_error(message, exception: nil)
+    if exception
+      Raven.capture_exception(exception, extra: {parameters: message, cgi_data: ENV})
+    end
+
+    if DELETE_AFTER_MAX_RETRY && message.attributes['ApproximateReceiveCount'].to_i > MAX_RETRY
+      logger.error "Deleting SQS message after multiple failures. #{message.body} #{exception}"
+      Librato.increment('sqs.fatal_error')
+      client.delete_message(queue_url: @queue_url, receipt_handle: message.receipt_handle)
+    else
+      # The `poll` loop usually deletes the messages in SQS by default, but we want to
+      # retry to run those as they errored out.
+      throw :skip_delete
+    end
+  end
+
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/tasks/simple_sqs.rake

@@ -0,0 +1,11 @@
+namespace :simple_sqs do
+  desc "Daemon that polls SQS"
+  task :daemon => :environment do
+    queue_url = ENV.fetch('SIMPLE_SQS_QUEUE_URL')
+
+    Rails.logger.info "Simple SQS: started polling"
+
+    worker = SimpleSqs::Worker.new(queue_url: queue_url)
+    worker.start
+  end
+end

data/simple_sqs.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_sqs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_sqs"
+  spec.version       = SimpleSqs::VERSION
+  spec.authors       = ["Jean-Philippe Boily"]
+  spec.email         = ["j@jipi.ca"]
+
+  spec.summary       = 'Opinionated but Simple SQS wrapper.'
+  spec.homepage      = 'https://github.com/rainforestapp/simple_sqs'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "librato-rails"
+  spec.add_dependency "sentry-raven"
+  spec.add_dependency "multi_json"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: simple_sqs
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jean-Philippe Boily
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: librato-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    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: rspec
+  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: byebug
+  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'
+description: 
+email:
+- j@jipi.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dummy_app/sqs/events/some_event.rb
+- lib/simple_sqs.rb
+- lib/simple_sqs/events.rb
+- lib/simple_sqs/events/base.rb
+- lib/simple_sqs/processor.rb
+- lib/simple_sqs/queue.rb
+- lib/simple_sqs/version.rb
+- lib/simple_sqs/worker.rb
+- lib/tasks/simple_sqs.rake
+- simple_sqs.gemspec
+homepage: https://github.com/rainforestapp/simple_sqs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Opinionated but Simple SQS wrapper.
+test_files: []