queuewrangler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 65fc3f9ddd1f707cc75164a43f1b8c800e612ab4
+  data.tar.gz: 471a3bcbe371bb22afcdc6a92d1488ddcd0856f2
+SHA512: 
+  metadata.gz: 86607eaf3630d851abe707abe70d4c5eb3c5d25b80a63f646c13b1381b255131045a26098c447f514b4f9ee68ed65963e0f14500a2c037ceb8ca2ed721148ac2
+  data.tar.gz: 942d78feba4d11b152a8b98c599056e657fff13f7526e241a3b209a62e9e9ba18f81d59ebe2951e6ae202c2341a4293a1e2622643e9c0f11e34c3b4f8d05d7e6

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in queuewrangler.gemspec
+gemspec
+
+group :development do
+  gem 'rspec', '~> 2.11'
+  gem 'debugger', :platform => :mri_19
+  gem 'debugger-pry', :platform => :mri_19
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lookout, Inc.
+
+MIT License
+
+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,57 @@
+# Queuewrangler
+
+A gem to simplify queueing long running actions for processing in a background
+thread.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'queuewrangler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queuewrangler
+
+## Usage
+``` ruby
+require 'queuewrangler'
+
+module RemoteLogger
+  class Logger
+    include Singleton
+    include QueueWrangler::Wrangler
+
+    def initialize
+      initialize_queuewrangler(true)
+    end
+
+    def log(msg)
+      enqueue(:send_data, msg)
+    end
+
+    def send_data(msg)
+       # perform long running action here
+    end
+  end
+end
+
+Thread.new do
+  RemoteLogger::Logger.instance.run!
+end
+
+RemoteLogger::Logger.instance.log('This will get enqueued and then sent to the send_data method')
+
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--fail-fast --color --order random'
+end
+
+task :test => :spec
+task :default => :test

data/lib/queuewrangler.rb

@@ -0,0 +1,5 @@
+require "queuewrangler/version"
+require "queuewrangler/wrangler"
+
+module QueueWrangler
+end

data/lib/queuewrangler/version.rb

@@ -0,0 +1,3 @@
+module QueueWrangler
+  VERSION = "1.0.0"
+end

data/lib/queuewrangler/wrangler.rb

@@ -0,0 +1,72 @@
+require 'logger'
+
+module QueueWrangler
+  module Wrangler
+    attr_reader :queue
+
+    #  Initializes the queue and performs other prepatory work required before
+    #  queue processing may begin.
+    #
+    #  @param [Boolean] enabled True if the queue should be processed
+    #  @param [Logger] logger Where to log or no logging if not specified
+    def initialize_queuewrangler(enabled, logger=nil)
+      @enabled = enabled
+      @queue = Queue.new
+      @should_die = false
+      @logger = logger || Logger.new(nil)
+    end
+
+    def log
+      @logger
+    end
+
+    # Determine whether the runloop is dead or not
+    def dead?
+      @should_die
+    end
+
+    # Instruct the runloop to die and flush our internal queue of events
+    def die!
+      @should_die = true
+      process_queue
+    end
+
+    # Flush the outstanding events in the events queue
+    def process_queue
+      until @queue.empty?
+        method, args = @queue.pop
+
+        unless method.nil?
+          log.info("process_queue - handling #{method} with #{args.inspect}")
+          if @enabled
+            processed = send(method, *args)
+
+            unless processed
+              log.info "Failed to process #{method}"
+              enqueue(method, *args)
+              # Arbitrary sleep to make sure we don't spin when we cannot
+              # process a message infinitly
+              sleep 1
+            end
+          end
+        end
+      end
+    end
+
+    def run!
+      id = self.class.name.split('::').last
+      log.info "#{id}#runloop - starting the runloop, processing: #{@enabled}"
+      until dead?
+        process_queue
+        # Arbitrary sleep just to make sure we don't spin on
+        # #process_queue when the queue is completely empty
+        sleep 0.5
+      end
+      log.info "#{id}#runloop - ending the runloop"
+    end
+
+    def enqueue(method, *args)
+      @queue << [method, [*args]]
+    end
+  end
+end

data/queuewrangler.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'queuewrangler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "queuewrangler"
+  spec.version       = QueueWrangler::VERSION
+  spec.authors       = ["R. Tyler Croy, Shaw Vrana"]
+  spec.email         = ["shaw@lookout.com"]
+  spec.description   = %q{Easily create long running background actions}
+  spec.summary       = %q{Make deffering action easy}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/queuewrangler_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'queuewrangler'
+
+describe QueueWrangler::Wrangler do
+  class DeferredAction
+    include QueueWrangler::Wrangler
+    def initialize
+      initialize_queuewrangler(true)
+    end
+  end
+
+  context 'instance methods' do
+    subject(:wrangler) { DeferredAction.new }
+
+    it { should respond_to :run! }
+    it { should respond_to :dead? }
+
+    it { should respond_to :die! }
+    describe '#die!' do
+      it 'should process the queue' do
+        wrangler.should_receive(:process_queue)
+        wrangler.die!
+      end
+    end
+
+    it { should respond_to :process_queue }
+    it { should respond_to :enqueue}
+
+    describe '#enqueue' do
+      let(:uuid) { rand }
+      let(:event) { 'rspec_wrangler' }
+
+      it 'should enqueue a proper message' do
+        wrangler.enqueue(:foo, uuid, event, :extra_info => 'bogus')
+        expect(wrangler.queue.size).to eql(1)
+      end
+    end
+
+    describe '#process_queue' do
+      let(:uuid) { rand }
+      let(:event) { 'rspec_wrangler' }
+
+      it 'should call class method with correct parameters' do
+        wrangler.enqueue(:foo, uuid, event, :extra_info => 'bogus')
+        wrangler.should_receive(:foo).with(uuid, event, :extra_info => 'bogus').and_return(true)
+        wrangler.process_queue
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+
+begin
+  require 'debugger'
+  require 'debugger-pry'
+rescue LoadError
+  # The two requires will fail on Ruby 1.8, but we don't particularly care
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: queuewrangler
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- R. Tyler Croy, Shaw Vrana
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-02-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: Easily create long running background actions
+email: 
+- shaw@lookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/queuewrangler.rb
+- lib/queuewrangler/version.rb
+- lib/queuewrangler/wrangler.rb
+- queuewrangler.gemspec
+- spec/queuewrangler_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Make deffering action easy
+test_files: 
+- spec/queuewrangler_spec.rb
+- spec/spec_helper.rb