sqs_buffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67e3a29c2cf4c0bf644d388fef3c67c55435be20
+  data.tar.gz: ac1d17611aa8d095b175af1baf8747ceb4007ae8
+SHA512:
+  metadata.gz: e9371ad563ff830c44e1e6963d250d5010116da3438d6fa2d406310aafce466391afac6dcdda6c16e51e0abd2c4343f06fd1839d7ecd51f06069b80f25147bc5
+  data.tar.gz: 18d1580ff5a425b4db944cb68cc8db138bb97c9281006de39a739225c33dc4337f91145ca6adb5c2a683a024ba11d181b30ef572c406030e802c61744ccaf6d9

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.19

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Thomas
+
+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,39 @@
+# SqsBuffer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sqs_buffer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sqs_buffer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqs_buffer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/sqs_buffer/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 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,157 @@
+require 'thread'
+require 'aws-sdk'
+require 'concurrent'
+
+module SqsBuffer
+  class Client
+    def initialize(opts)
+      @queue_url = opts.fetch(:queue_url) { |k| missing_key!(k) }
+      client = opts.fetch(:client) { |k| missing_key!(k) }
+
+      @poller = Aws::SQS::QueuePoller.new(@queue_url, client: client)
+      @skip_delete = opts.fetch(:skip_delete, true)
+      @max_number_of_messages = opts.fetch(:max_number_of_messages, 10)
+      @logger = opts.fetch(:logger, Logger.new(STDOUT))
+      @process_block = Concurrent::MutexAtomicReference.new
+      @before_request_block = Concurrent::MutexAtomicReference.new
+      @process_block = Concurrent::MutexAtomicReference.new
+      @message_queue = Concurrent::Array.new
+      @last_process_time = Concurrent::AtomicFixnum.new(Time.now.to_i)
+      @running = Concurrent::AtomicBoolean.new(false)
+      @max_wait_time = Concurrent::AtomicFixnum.new(
+        opts.fetch(:max_wait_time, 300)
+      )
+      @max_queue_threshold = Concurrent::AtomicFixnum.new(
+        opts.fetch(:max_queue_threshold, 100)
+      )
+      configure_before_request_block
+    end
+
+    def start_polling
+      @running.make_true
+
+      @worker_thread = Thread.new do
+        opts = {
+          skip_delete: @skip_delete,
+          max_number_of_messages: @max_number_of_messages
+        }
+        @poller.poll(opts) do |messages|
+          store_messages(messages)
+        end
+      end # End worker thread
+
+      @running.value
+    end
+
+    def queue_url
+      @queue_url
+    end
+
+    def stop_polling
+      @running.make_false
+    end
+
+    def queue_full?
+      @message_queue.length >= @max_queue_threshold.value
+    end
+
+    def queue_empty?
+      @message_queue.empty?
+    end
+
+    def queue_length
+      @message_queue.length
+    end
+
+    def shutting_down?
+      @running.false? && worker_thread_alive?
+    end
+
+    def running?
+      @running.true? && worker_thread_alive?
+    end
+
+    def worker_thread_alive?
+      !@worker_thread.nil? && @worker.alive?
+    end
+
+    def last_process_time_stale?
+      @last_process_time.value < Time.now.to_i - @max_wait_time.value
+    end
+
+    def process_all_messages
+      # This will be a collection of SQS messages
+      # I am pretty sure this exposes the @message_queue to mutability
+      # Maybe I should deep dup this?
+      @process_block.value.call(@message_queue)
+      delete_all_messages
+      touch_process_time
+    rescue StandardError => e
+      @logger.error "An exception(#{e.message}) occurred while process the message queue: #{@message_queue.join("\n")} | Backtrace: #{e.backtrace}"
+    end
+
+    def process_block(&block)
+      @process_block.value = block
+    end
+
+    def before_request_block(&block)
+      @before_request_block.value = block
+    end
+
+    private
+
+    def need_to_process?
+      if !queue_empty? && (queue_full? || last_process_time_stale?)
+        true
+      else
+        false
+      end
+    end
+
+    def missing_key!(k)
+      raise ":#{k} is a required key!"
+    end
+
+    def configure_before_request_block
+      @poller.before_request do |stats|
+        if @running.false?
+          @logger.info "Shutting down. Processing all messages first..."
+          process_all_messages
+          @logger.info "All messages have been processed. Throwing :stop_polling"
+          throw :stop_polling
+        end
+        if @before_request_block.value
+          @before_request_block.value.call(stats)
+        end
+        if need_to_process?
+          process_all_messages
+        end
+      end # End Poller loop
+    end
+
+    def store_messages(messages)
+      messages.each do |msg|
+        store_message(msg)
+      end
+    end
+
+    def store_message(msg)
+      @message_queue << msg
+    rescue StandardError => e
+      @logger.error "Exception: #{e.message} while storing message: #{msg} | Backtrace: #{e.backtrace}"
+    end
+
+    def touch_process_time
+      @last_process_time.value = Time.now.to_i
+    end
+
+    def delete_all_messages
+      while @message_queue.length > 0 do
+        messages = @message_queue.shift(10)
+        @poller.delete_messages(messages)
+      end
+    end
+
+  end
+end
+

data/lib/sqs_buffer/version.rb

@@ -0,0 +1,3 @@
+module SqsBuffer
+  VERSION = "0.1.0"
+end

data/lib/sqs_buffer.rb

@@ -0,0 +1,6 @@
+require "sqs_buffer/version"
+require "sqs_buffer/client"
+
+module SqsBuffer
+end
+

data/sqs_buffer.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqs_buffer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sqs_buffer"
+  spec.version       = SqsBuffer::VERSION
+  spec.authors       = ["John Thomas"]
+  spec.email         = ["thomas07@vt.edu"]
+
+  spec.summary       = %q{Buffer SQS messages to process more than 10 events}
+  spec.description   = %q{SQS only allows you to pull and delete 10 events
+at a time. This gem is greedy and will buffer events so you can process
+more than 10 at at time.}
+  spec.homepage      = "https://github.com/thomas07vt/sqs_buffer.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  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", "~> 2.2"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sqs_buffer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Thomas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  name: aws-sdk
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: concurrent-ruby
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  SQS only allows you to pull and delete 10 events
+  at a time. This gem is greedy and will buffer events so you can process
+  more than 10 at at time.
+email:
+- thomas07@vt.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sqs_buffer.rb
+- lib/sqs_buffer/client.rb
+- lib/sqs_buffer/version.rb
+- sqs_buffer.gemspec
+homepage: https://github.com/thomas07vt/sqs_buffer.git
+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.4.5
+signing_key:
+specification_version: 4
+summary: Buffer SQS messages to process more than 10 events
+test_files: []