laboristo 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af62fb6474cb5a857ef672cb6ee2ba49c33f0339
-  data.tar.gz: 158385fd74e9146eb4a864d777739541e92cb85d
+  metadata.gz: a984e5e708ac9e7852e539987cf0b68bb9e04cdc
+  data.tar.gz: 8238919ff0403e16c718d2551c6014f382100957
 SHA512:
-  metadata.gz: ce57368d6948b2cef3bb48520fb197e443d987dc951c204723d74b9949184fff3e1669eaca0fe5e7a314f3cfcc6ad8bff31200b57131eaa160b9007252a3e84c
-  data.tar.gz: 85064e5306f486f9f095da20231c3d8514c63bb84aa8f3361eb201f3ba10c8b4c82d16dee05c1a3010ce8240b52f5eb1cb133a4db1888d3d3cec2a9e2773cae0
+  metadata.gz: b0085a639eec84750f0df83f60a35d0803c9d3a43217cd938efe727109e1db5947314dd23119d3dc69cbab90b01ef936444b53545a4d856f464e2ce1a6e245e6
+  data.tar.gz: 6f3e20625c09b0901775db9620e2d17dbcadbfd57c6da2588c348a73bdb599d3b4543e9ffc228a61b6a446253fbbcdc2c83964f6f33ce3df7e1c883afc0c22b8

data/README.md

@@ -38,8 +38,6 @@ And then execute:
 
 Before using Laboristo, you will need to set some environment variables:
 
-	AWS_REGION=<your_aws_region>
-	AWS_ACCOUNT_ID=<your_aws_account_id>
 	AWS_ACCESS_KEY_ID=<your_aws_access_key>
 	AWS_SECRET_ACCESS_KEY=<your_aws_secret_key>
 
@@ -57,18 +55,24 @@ Here are some considerations that you need to know when using Laboristo and SQS:
 
 ## Usage
 
+To refer to a particular queue, you will need the corresponding queue url, an attribute defined by AWS SQS when you create a queue. You can check the queue url in the AWS SQS Console. In the following examples, we will assume a queue having an url like this:
+
+```
+  https://sqs.us-east-1.amazonaws.com/123456789/my_queue
+```
+
 To push a message to the queue:
 
 ```ruby
 require 'laboristo'
 
-Laboristo['my_queue'] << 'some message'
+Laboristo['https://sqs.us-east-1.amazonaws.com/123456789/my_queue'] << 'some message'
 ```
 
 And get messages from a queue:
 ```ruby
 require 'laboristo'
-Laboristo['my_queue'].each do |msg|
+Laboristo['https://sqs.us-east-1.amazonaws.com/123456789/my_queue'].each do |msg|
   # Do something with msg...
 end
 ```
@@ -80,24 +84,30 @@ Workers can be as simple as this:
 ```ruby
   require 'my_app'
 
-  Laboristo['my_queue'].each do |message|
+  Laboristo['https://sqs.us-east-1.amazonaws.com/123456789/my_queue'].each do |message|
     # Do some magic stuff with the message
   end
 ```
 
-Place worker at ```./workers/my_worker.rb``` and run this code to run worker in foreground:
+For instance, you can place your worker at ```./workers/my_worker.rb``` and run this code to run worker in foreground:
 
 ```
-  $ laboristo my_worker
+  $ laboristo workers/my_worker
 ```
 
 To run it in background you can use ```-d``` flag to daemonize the process:
 
 ```
-  $ laboristo my_worker -d
+  $ laboristo workers/my_worker -d
+```
+
+And, to stop a worker running in background, you can confidently kill the process:
+
+```
+  $ kill $$(cat /tmp/my_worker.pid)
 ```
 
-You can stop the workers by killing the process. Keep in mind that, because of how SQS works, unprocessed messages will go back to the queue.
+Keep in mind that, because of how SQS works, unprocessed messages will go back to the queue. So, if you kill the worker process, unprocessed messages will go back to queue.
 
 ### Purging
 
@@ -107,6 +117,8 @@ Delete all messages from a queue:
   Laboristo['my_queue'].purge
 ```
 
+Because of AWS SQS restrictions, you can purge a queue only once every 60 seconds.
+
 ## Development
 
 After cloning repository install dependencies using [dep](https://github.com/cyx/dep):
@@ -123,9 +135,7 @@ Set environment variables as explained before in this document, and run the test
 
 ### TO-DO:
 
-First of all, add more tests! This gem stated as an experiment, so you can expect bugs.
-
-In future versions, I'd like to improve the worker bin so that it can be started/stopped in a more elegant fashion than simply killing the process ;-)
+First of all, help me adding more tests! This gem stated as an experiment, so you can expect bugs.
 
 Feel free to report bugs, open issues, comments and pull requests. Only keep in mind that I just want to keep this gem neat and simple.
 

data/bin/laboristo

@@ -1,20 +1,8 @@
 #! /usr/bin/env ruby
 
-stop = proc do
-  if defined?(Laboristo)
-    Laboristo.stop
-  else
-    exit 0
-  end
-end
-
-trap(:INT,  &stop)
-trap(:TERM, &stop)
-
 usage = <<-EOS
 Usage:
-  laboristo start <worker> [-d|--daemonize]
-  laboristo stop <worker>
+  laboristo <worker> [-d|--daemonize]
 EOS
 
 require 'clap'
@@ -31,10 +19,9 @@ args = Clap.run ARGV,
     exit 0
   }
 
-command = args.shift
 worker = args.shift
-worker_path = File.expand_path("workers/#{worker}")
-pid_path = File.expand_path("tmp/#{worker}.pid")
+worker_path = File.expand_path(worker)
+pid_path = File.expand_path("/tmp/#{worker}.pid")
 
 $stdout.sync = true
 

data/laboristo.gemspec

@@ -1,7 +1,8 @@
 Gem::Specification.new do |s|
   s.name          = 'laboristo'
-  s.version       = '0.3.2'
+  s.version       = '0.4.0'
   s.summary       = 'Simple messages and workers for AWS SQS'
+  s.description   = 'A very simple way to handle messages and workers using AWS SQS'
   s.authors       = ['matiasow']
   s.email         = ['matiasow@gmail.com']
   s.homepage      = 'https://github.com/matiasow/laboristo'

data/lib/laboristo.rb

@@ -3,15 +3,12 @@ require 'base64'
 
 module Laboristo
   class Queue
-    attr_accessor :name
     attr_accessor :url
     attr_accessor :sqs
 
-    def initialize(name)
-      @name = name
+    def initialize(url)
       @sqs = Aws::SQS::Client.new
-      @url = "https://sqs.#{ENV['AWS_REGION']}.amazonaws.com/#{ENV['AWS_ACCOUNT_ID']}/#{@name}"
-      @stopping = false
+      @url = url
     end
 
     def push(message)
@@ -34,18 +31,12 @@ module Laboristo
             $stdout.puts "ERROR: Can't process message #{msg[:message_id]}.\n#{e}"
           end
         end
-
-        break if @stopping
       end
     end
 
     alias << push
     alias pop each
 
-    def stop
-      @stopping = true
-    end
-
     def purge
       @sqs.purge_queue(queue_url: @url)
     end

data/test/queue_test.rb

@@ -1,21 +1,19 @@
 require_relative 'helper'
 
 test 'initialize' do
-  q = Laboristo::Queue.new(@queue_name)
-  assert q.name == @queue_name
+  q = Laboristo::Queue.new(@url)
   assert q.sqs.is_a? Aws::SQS::Client
   assert q.url == @url
 end
 
 test 'initialize through []' do
-  q = Laboristo[@queue_name]
-  assert q.name == @queue_name
+  q = Laboristo[@url]
   assert q.sqs.is_a? Aws::SQS::Client
   assert q.url == @url
 end
 
 test 'push message to queue' do
-  q = Laboristo[@queue_name]
+  q = Laboristo[@url]
   msg = SecureRandom.uuid
 
   q.push(msg)
@@ -27,7 +25,7 @@ test 'push message to queue' do
 end
 
 test 'push message to queue using <<' do
-  q = Laboristo[@queue_name]
+  q = Laboristo[@url]
   msg = SecureRandom.uuid
 
   q << msg
@@ -39,7 +37,7 @@ test 'push message to queue using <<' do
 end
 
 test 'fetch messages using pop' do
-  q = Laboristo[@queue_name]
+  q = Laboristo[@url]
   msg = SecureRandom.uuid
 
   send_message(msg)
@@ -51,7 +49,7 @@ test 'fetch messages using pop' do
 end
 
 test 'fetch messages using each' do
-  q = Laboristo[@queue_name]
+  q = Laboristo[@url]
   msg = SecureRandom.uuid
 
   send_message(msg)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: laboristo
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - matiasow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: 
+description: A very simple way to handle messages and workers using AWS SQS
 email:
 - matiasow@gmail.com
 executables: