batch_queue 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b95fc0b74f01e311f6054edca52d5e914caeb0e
-  data.tar.gz: 4698c96901a2a66c2b8f7a61b960fc3b87097da5
+  metadata.gz: df6a825858badbbd444159c27bc643efb4ba2f7d
+  data.tar.gz: 11d1abe1d25b45733767e0f884bcb23a353607f4
 SHA512:
-  metadata.gz: def8c8a4612de2b9bc4d4e484a20ab0e500391b5c98a33056001710019c86cfe2c55159248b44873cccd8e370e762b21fc9796c75f3020d65e28e239d4a1ae0f
-  data.tar.gz: b00f65b31ef402135eb2f0630878e80cd66a1d2e4eab4cc5d36efbbee6e71d0d6aafe55402c7f49b1f8f6ab900283341bd7dad66adde2febc86ed556dacd98ca
+  metadata.gz: 2f48dca2b314320eb441901bbc7264575fab419dc381c6bce1711f7bc04696919fb0dd98f582413dcedbaa63a0b37224b9ea4253aaf576c989503eee360133ba
+  data.tar.gz: a4c4d1ca28b61019d1242a0c8b3b0c58134692cac09ed53e67ee8c3b8a9ba48e923fb34cf036b46456e955fcc645fbc1fbe9faa1326f8a4e96464f28284cf686

data/README.md

@@ -1,8 +1,24 @@
 # BatchQueue
 
-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/batch_queue`. To experiment with that code, run `bin/console` for an interactive prompt.
+BatchQueue is queue that takes jobs and runs them, in aggregate, via a callback on a background thread.  You can process a “batch” of N jobs at a time or after T seconds whichever comes sooner.
 
-TODO: Delete this and the text above, and describe your gem
+Example: You want to send metrics to Amazon’s AWS CloudWatch service every 60 seconds or when the batch size reaches 20, whichever comes first. You might write code like this:
+
+```
+# Create the AWS CloudWatch Client
+cw_client = Aws::CloudWatch::Client.new(...)
+
+# Set up the BatchQueue
+BatchQueue.new(max_batch_size: 20, max_interval_seconds: 60) do |batch_metric_data|
+    cw_client.put_metric_data(:metric_data => batch_metric_data)
+end
+
+# Add to the BatchQueue
+@bq << {
+    metric_name: 'Widgets',
+    value: 1
+}
+```
 
 ## Installation
 
@@ -22,7 +38,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 1. Set up the BatchQueue
+Each BatchQueue gets its own background thread that executes jobs.
+```
+bq = BatchQueue.new(max_batch_size: 20, max_interval_seconds: 60) do |batch_metric_data|
+    # Put your code that you want to execute here.
+end
+```
+
+### 2. Add a job to the queue
+You can add any object to the queue.
+```
+bq << {
+    # your object here.
+}
+
+```
+or
+```
+bq << MyJob.new(...)
+
+```
+
 
 ## Development
 
@@ -32,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/batch_queue.
+Bug reports and pull requests are welcome on GitHub at https://github.com/flivni/batch_queue.
 
 ## License
 

data/lib/batch_queue/batch_queue.rb

@@ -19,11 +19,6 @@ class BatchQueue
     end
   end
 
-  # a block taking taking an exception as a parameter
-  def on_error(&block)
-    @on_error = block
-  end
-
   def push(object)
     @mutex.synchronize do
       raise 'BatchQueue is stopped' unless @is_running
@@ -87,7 +82,7 @@ class BatchQueue
     begin
       @block.call(arr)
     rescue StandardError => exc
-      @on_error.call(exc) if @on_error
+      puts "BatchQueue: Unhandled exception #{exc.inspect}"
     ensure
       @mutex.lock
     end

data/lib/batch_queue/version.rb

@@ -1,3 +1,3 @@
 class BatchQueue
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch_queue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Felix Livni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler