toiler 0.3.6 → 0.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ecb4ddc2f0165788a9bd382078331339bf47c99
-  data.tar.gz: 6368cf4989ef308ef4bd5192f10effd40e959b87
+  metadata.gz: a4ced1103b95b851ceefc678c709faf6ed6f458e
+  data.tar.gz: ca7069d2a1ac054ea3bb7e5bb78c2effb8c08cfd
 SHA512:
-  metadata.gz: de6ff36fe3a1794525ceeb374453aa311d1fc44861dd0cabf25e2d1a64822d0a869772fff47b48ebce867eee0835ffce5acbe700805740b9c15bec81900a0785
-  data.tar.gz: 49bd75691c9b2a2908ee677ddd062f4bc2a765937538b60bc00b6ab0f83c6a6e46a2c8d0e699b84ebd4149c60ea8a7eff19e98c15f7aea15072ed4404e8d8267
+  metadata.gz: f070535678f3af853ad2835c42a69bf95e60cff53f137f7dd34b232f393df8d89b6b8e0679cc6999e9a3d14cdeac063d3676a9ca865357c07976c33fb5261aa1
+  data.tar.gz: a89273d951335f6b7916f19ca7f620365d2654228bd261a3ad41c3397034e40b76e429fc38c47facc90073044843de9ce3be0f17f4a904aeddd09554c74b0701

data/.gitignore

@@ -1,35 +1,35 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.gitmodules

@@ -1,4 +1,4 @@
-[submodule "celluloid-task-pooledfiber"]
-	path = celluloid-task-pooledfiber
-	url = git@github.com:celluloid/celluloid-task-pooledfiber.git
-	branch = 0.2.0-prerelease
+[submodule "celluloid-task-pooledfiber"]
+	path = celluloid-task-pooledfiber
+	url = git@github.com:celluloid/celluloid-task-pooledfiber.git
+	branch = 0.2.0-prerelease

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.2.2

data/Gemfile

@@ -1,9 +1,9 @@
-source 'https://rubygems.org'
-
-gem 'concurrent-ruby', '~> 1.0.0'
-gem 'concurrent-ruby-edge', '~> 0.2.0'
-gem 'aws-sdk', '~> 2.2'
-
-group :development do
-  gem 'rubocop'
-end
+source 'https://rubygems.org'
+
+gem 'concurrent-ruby', '~> 1.0.0'
+gem 'concurrent-ruby-edge', '~> 0.2.0'
+gem 'aws-sdk', '~> 2.2'
+
+group :development do
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -1,41 +1,41 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.2.0)
-    aws-sdk (2.3.7)
-      aws-sdk-resources (= 2.3.7)
-    aws-sdk-core (2.3.7)
-      jmespath (~> 1.0)
-    aws-sdk-resources (2.3.7)
-      aws-sdk-core (= 2.3.7)
-    concurrent-ruby (1.0.2)
-    concurrent-ruby-edge (0.2.2)
-      concurrent-ruby (~> 1.0.2)
-    jmespath (1.2.4)
-      json_pure (>= 1.8.1)
-    json_pure (1.8.3)
-    parser (2.3.1.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    rainbow (2.1.0)
-    rubocop (0.40.0)
-      parser (>= 2.3.1.0, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    unicode-display_width (1.0.5)
-
-PLATFORMS
-  ruby
-  x64-mingw32
-
-DEPENDENCIES
-  aws-sdk (~> 2.2)
-  concurrent-ruby (~> 1.0.0)
-  concurrent-ruby-edge (~> 0.2.0)
-  rubocop
-
-BUNDLED WITH
-   1.11.2
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.2.0)
+    aws-sdk (2.3.7)
+      aws-sdk-resources (= 2.3.7)
+    aws-sdk-core (2.3.7)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.3.7)
+      aws-sdk-core (= 2.3.7)
+    concurrent-ruby (1.0.2)
+    concurrent-ruby-edge (0.2.2)
+      concurrent-ruby (~> 1.0.2)
+    jmespath (1.2.4)
+      json_pure (>= 1.8.1)
+    json_pure (1.8.3)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.0.5)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  aws-sdk (~> 2.2)
+  concurrent-ruby (~> 1.0.0)
+  concurrent-ruby-edge (~> 0.2.0)
+  rubocop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -1,6 +1,6 @@
-Copyright (c) Sebastian Schepens
-
-Toiler is an Open Source project licensed under the terms of
-the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
-for license text.
-
+Copyright (c) Sebastian Schepens
+
+Toiler is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.
+

data/README.md

@@ -1,125 +1,125 @@
-##Toiler
-Toiler is a AWS SQS long-polling thread-based message processor.
-It's based on [shoryuken](https://github.com/phstc/shoryuken) but takes
-a different approach at loadbalancing and uses long-polling.
-
-##Features
-###Concurrency
-Toiler allows to specify the amount of processors (threads) that should be spawned for each queue.
-Instead of [shoryuken's](https://github.com/phstc/shoryuken) loadbalancing  approach, Toiler delegates this work to the kernel scheduling threads.
-
-Because Toiler uses threads to provide concurrency, **each thread instatiates a new worker**, as it should be expected, so please **use class variables to store shared variables like clients**.
-
-###Long-Polling
-A Fetcher thread is spawned for each queue.
-Fetchers are resposible for polling SQS and retreiving messages.
-They are optimised to not bring more messages than the amount of processors avaiable for such queue.
-By long-polling fetchers wait for a configurable amount of time for messages to become available on a single request, this prevents unneccesarilly requesting messages when there are none.
-
-###Message Parsing
-Workers can configure a parser Class or Proc to parse an SQS message body before being processed.
-
-###Batches
-Toiler allows a Worker to be able to receive a batch of messages instead of a single one.
-
-###Auto Visibility Extension
-Toiler has the ability to automatically extend the visibility timeout of and SQS message to prevent the message from re-entering the queue if processing of such message is taking longer than the queue's visibility timeout.
-
-##Instalation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'toiler'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install toiler
-
-## Usage
-
-### Worker class
-
-```ruby
-class MyWorker
-  include Toiler::Worker
-
-  toiler_options queue: 'default', concurrency: 5, auto_delete: true
-  toiler_options parser: :json
-
-  # toiler_options parser: ->(sqs_msg){ REXML::Document.new(sqs_msg.body) }
-  # toiler_options parser: MultiJson
-  # toiler_options auto_visibility_timeout: true
-  # toiler_options batch: true
-
-  #Example connection client that should be shared across all instances of MyWorker
-  @@client = ConnectionClient.new
-    
-  def initialize
-    @last_message = nil
-  end
-
-  def perform(sqs_msg, body)
-    #Workers are thread safe, yay!
-    #Each worker instance is assured to be processing only one message at a time
-    @last_message = sqs_msg 
-    puts body
-  end
-end
-```
-
-### Configuration
-
-```yaml
-aws:
-  access_key_id:      ...       # or <%= ENV['AWS_ACCESS_KEY_ID'] %>
-  secret_access_key:  ...       # or <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
-  region:             us-east-1 # or <%= ENV['AWS_REGION'] %>
-wait: 20                        # The time in seconds to wait for messages during long-polling
-```
-
-### Rails Integration
-
-You can tell Toiler to load your Rails application by passing the `-R` or `--rails` flag to the "toiler" command.
-
-If you load Rails, and assuming your workers are located in the `app/workers` directory, they will be auto-loaded. This means you don't need to require them explicitly with `-r`.
-
-
-### Start Toiler
-
-```shell
-bundle exec toiler -r worker.rb -C toiler.yml
-```
-
-Other options:
-
-```bash
-toiler --help
-
-    -d, --daemon                     Daemonize process
-    -r, --require [PATH|DIR]         Location of the worker
-    -C, --config PATH                Path to YAML config file
-    -R, --rails                      Load Rails
-    -L, --logfile PATH               Path to writable logfile
-    -P, --pidfile PATH               Path to pidfile
-    -v, --verbose                    Print more verbose output
-    -h, --help                       Show help
-```
-
-
-## Credits
-
-Much of the credit goes to [Pablo Cantero](https://github.com/phstc), creator of [Shoryuken](https://github.com/phstc/shoryuken), and [everybody who contributed to it](https://github.com/phstc/shoryuken/graphs/contributors).
-
-## Contributing
-
-1. Fork it ( https://github.com/sschepens/toiler/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
+##Toiler
+Toiler is a AWS SQS long-polling thread-based message processor.
+It's based on [shoryuken](https://github.com/phstc/shoryuken) but takes
+a different approach at loadbalancing and uses long-polling.
+
+##Features
+###Concurrency
+Toiler allows to specify the amount of processors (threads) that should be spawned for each queue.
+Instead of [shoryuken's](https://github.com/phstc/shoryuken) loadbalancing  approach, Toiler delegates this work to the kernel scheduling threads.
+
+Because Toiler uses threads to provide concurrency, **each thread instatiates a new worker**, as it should be expected, so please **use class variables to store shared variables like clients**.
+
+###Long-Polling
+A Fetcher thread is spawned for each queue.
+Fetchers are resposible for polling SQS and retreiving messages.
+They are optimised to not bring more messages than the amount of processors avaiable for such queue.
+By long-polling fetchers wait for a configurable amount of time for messages to become available on a single request, this prevents unneccesarilly requesting messages when there are none.
+
+###Message Parsing
+Workers can configure a parser Class or Proc to parse an SQS message body before being processed.
+
+###Batches
+Toiler allows a Worker to be able to receive a batch of messages instead of a single one.
+
+###Auto Visibility Extension
+Toiler has the ability to automatically extend the visibility timeout of and SQS message to prevent the message from re-entering the queue if processing of such message is taking longer than the queue's visibility timeout.
+
+##Instalation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toiler
+
+## Usage
+
+### Worker class
+
+```ruby
+class MyWorker
+  include Toiler::Worker
+
+  toiler_options queue: 'default', concurrency: 5, auto_delete: true
+  toiler_options parser: :json
+
+  # toiler_options parser: ->(sqs_msg){ REXML::Document.new(sqs_msg.body) }
+  # toiler_options parser: MultiJson
+  # toiler_options auto_visibility_timeout: true
+  # toiler_options batch: true
+
+  #Example connection client that should be shared across all instances of MyWorker
+  @@client = ConnectionClient.new
+    
+  def initialize
+    @last_message = nil
+  end
+
+  def perform(sqs_msg, body)
+    #Workers are thread safe, yay!
+    #Each worker instance is assured to be processing only one message at a time
+    @last_message = sqs_msg 
+    puts body
+  end
+end
+```
+
+### Configuration
+
+```yaml
+aws:
+  access_key_id:      ...       # or <%= ENV['AWS_ACCESS_KEY_ID'] %>
+  secret_access_key:  ...       # or <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+  region:             us-east-1 # or <%= ENV['AWS_REGION'] %>
+wait: 20                        # The time in seconds to wait for messages during long-polling
+```
+
+### Rails Integration
+
+You can tell Toiler to load your Rails application by passing the `-R` or `--rails` flag to the "toiler" command.
+
+If you load Rails, and assuming your workers are located in the `app/workers` directory, they will be auto-loaded. This means you don't need to require them explicitly with `-r`.
+
+
+### Start Toiler
+
+```shell
+bundle exec toiler -r worker.rb -C toiler.yml
+```
+
+Other options:
+
+```bash
+toiler --help
+
+    -d, --daemon                     Daemonize process
+    -r, --require [PATH|DIR]         Location of the worker
+    -C, --config PATH                Path to YAML config file
+    -R, --rails                      Load Rails
+    -L, --logfile PATH               Path to writable logfile
+    -P, --pidfile PATH               Path to pidfile
+    -v, --verbose                    Print more verbose output
+    -h, --help                       Show help
+```
+
+
+## Credits
+
+Much of the credit goes to [Pablo Cantero](https://github.com/phstc), creator of [Shoryuken](https://github.com/phstc/shoryuken), and [everybody who contributed to it](https://github.com/phstc/shoryuken/graphs/contributors).
+
+## Contributing
+
+1. Fork it ( https://github.com/sschepens/toiler/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