rb-cola 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61104e2a46792defb913daa94a0bf640070bc25926d37b6364a605ccbd955a86
-  data.tar.gz: 60d3ef544779d8da974ac807821ce937a67a0044e5c3c55a852b0ee85c2ab914
+  metadata.gz: be38dd0666f61a38c22ff64385ead51795d51e13297e3a010b55ba4a9542afdb
+  data.tar.gz: ddd118952cd6cda2f11f11e2f50d3a035a707e3dd6c4b1ac5478c1b11dff0ec1
 SHA512:
-  metadata.gz: f780b9d8fb8d691162c28e489149ddd13d2d754b46998a4105345a3749a3af1332289d3a618ab284ba8d18f46c32124e77a2fb166175f85dff26404b2eadb073
-  data.tar.gz: 1b8ebf49d6f3e3cfa99b7688dbe7879bb2e25d8577e1eaa71cf0036f154eeac19e6bc81ad595eb091645372ad1f9ccdc071ac8adca222d1dd6cc4527ddf0aae6
+  metadata.gz: 876274c2edd5cba870c289c2b1ca9ea5000b9aa2e715b9accbf61d19d19eed9c782068c82afb5a43e54f6a69bebed7ab4f50591419ab5719b0c7a13e7317f4f2
+  data.tar.gz: d7a03ffbd1fbb3e91ae409ad91c725ab783f738375cea10d817610a81c00f2332de6d70eb3582c5ecf540bb3ae04f3a506e0fdda83551babb3cd315dda87ce4b

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    rb-cola (0.0.1)
-      redis (>= 3.3.5, < 5)
+    rb-cola (0.0.3)
+      redis (>= 3.3.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
     byebug (11.0.1)
+    connection_pool (2.3.0)
     diff-lcs (1.3)
-    redis (4.1.3)
+    redis (5.0.5)
+      redis-client (>= 0.9.0)
+    redis-client (0.11.2)
+      connection_pool
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)

data/README.md

@@ -1,6 +1,92 @@
-Cola
-==========
+<img src="http://cdn2-cloud66-com.s3.amazonaws.com/images/oss-sponsorship.png" width=150/>
+
+# Cola
+
+---
 
 Cola is a simple distributed, transactional queue gem for Ruby backed by Redis. It uses Redis lists to provide its functionality with minimal additions. Cola supports transactions, retries, deadletter queues and timeouts. This gem is based on https://github.com/taganaka/redis-queue
 
+## Install
+
+Run
+
+```bash
+gem install rb-cola
+```
+
+or add this to your `Gemfile`
+
+```ruby
+gem 'rb-cola'
+```
+
+## Usage
+
+Create a queue, push and pop messages to and from the queue:
+
+```ruby
+q = ::Cola::Queue.new
+q.push("message")
+message = q.pop
+q.commit
+```
+
+See the files under `examples` folder for more information.
+
+### Push
+
+You can push messages onto the queue using `push` or `<<`:
+
+```ruby
+queue << message
+queue.push(message)
+queue.push(another_message, ttl: 30) # this message will expire in 30 seconds
+```
+
+### Pop
+
+You can pull the messages from the queue with blocking or non-blocking actions. Blocking actions will wait until a message is available to pop. Non-blocking actions will return `nil` is no message is available.
+
+### Envelope
+
+Each message is stored in an envelope when put on the queue. `pop` and `process` return the message itself when called. However, you can use `pop_with_envelope` to get the entire envelope.
+
+Attribute | Description | Default
+---|---|---
+message | The message | `nil`
+timestamp | Message timestamp | Timestamp of the push
+retries | Number of times the message has been retried | 0
+last_reason | The reason for the last retry failure | `nil`
+version | Envelope version | `0`
+uuid | Unique ID of the message | Automatically generated
+ttl | Time to live | `0`
+
+### Retries
+
+By default, if a pop fails, the message is lost and an exception is raised. This can be changed so Cola retries the message more than once. See `options` for more info. This is most useful when used with the `process` function in case an exception is raised within the process block.
+
+### Deadletter Queue
+
+In case of multiple failures, the message can be pushed to a deadletter queue for further manual inspection. This is disabled by default.
+
+### Message Expiry
+
+When pushing messages onto the queue, you can assign them a Time to Live (ttl). Messages will expire after their ttl is passed and they are not picked up for processing.
+
+## Options
+
+When creating a queue, you can use the following options:
+
+Option | Description | Default
+---|---|---
+redis | Redis instance to use | Using the current redis instance
+deadletter | Support deadletter queue | `false`
+queue_name | Set the queue name | Random queue name
+timeout | Message timeout | `0` (No timeout)
+retries | Number of retries | `0` (No retries)
+
+Example:
 
+```ruby
+q = ::Cola::Queue.new(timeout: 10, redis: @some_redis_instance)
+```

data/cola.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'redis', '>= 3.3.5', '< 5'
+  spec.add_runtime_dependency 'redis', '>= 3.3.5'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rspec", "~> 3.8"

data/lib/cola/queue.rb

@@ -24,6 +24,8 @@ module Cola
 			@retries = options[:retries] ||= 0
 		end
 
+		# returns the count of the items on the queue. 
+		# note that this returns the total number which might include expired messages
 		def len
 			@redis.llen @queue_name
 		end
@@ -68,6 +70,7 @@ module Cola
 			end
 		
 			@redis.lpush(@queue_name, wrapped.to_json)
+			return wrapped
 		end
 
 		def pop(non_block = false, timeout: @timeout)

data/lib/cola/version.rb

@@ -1,4 +1,4 @@
 module Cola
-	VERSION = '0.0.1'
+	VERSION = '0.0.3'
 end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb-cola
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Khash Sajadi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.5
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
-description: 
+description:
 email:
 - khash@cloud66.com
 executables:
@@ -102,7 +96,7 @@ files:
 homepage: https://github.com/cloud66-oss/rb-cola
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.3.24
+signing_key:
 specification_version: 4
 summary: A distributed queue based on Redis
 test_files: []