activejob-traffic_control 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2906ae48cd5953f18837860c3685e3ebf8a2dd84
-  data.tar.gz: 5bb69b07b5439da6c1f56d5674fbfec37bd111d8
+  metadata.gz: 511ad5f30c21f83e11d8f6918f145c4fb0d73d9e
+  data.tar.gz: c39128c8888ce24cc9d0b0341763a259ae40d54c
 SHA512:
-  metadata.gz: 5887b615c100a481113967f5541c4e4d86621a4ce9a4ae604dcac4c524c53d0a097ec30ce9a5d88d6bd30d18fdcce4646d8731d660a190532fc496a31b19a39a
-  data.tar.gz: d5ccb7e7fa1c4782bcc1650a62d6f1ca17117aace77a130e2c6561714d97619faec95f86b5526516772f3ca429361ce4701e727c212585d8f896528b0de2170c
+  metadata.gz: 6db8cce696dfeb0b984b7bc8abf9dd1f591c9d8fa3f1ce83536c5d05a91517b03fb35ae32f8e64a8f5427bd47b1f4689c182775d6cc54ea765c9305f278667ba
+  data.tar.gz: 55b4efb468ba9771612992816b615a5bc93f70b9adf2233c1fe12d6875548917f1300cbad99a9cbeff0fda40c30b731e36ef0ce1b0d77a5004f1ef7014b51fbd

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.2
+
+- Use #class_attribute instead of #attr_accessor for various configuration (thanks avokhmin!)
+
+## 0.1.1
+
+- Improve documentation and comments.
+
+## 0.1.0
+
+- First release.

data/README.md

@@ -35,11 +35,27 @@ ActiveJob::TrafficControl.client = ConnectionPool.new(size: 5, timeout: 5) { Red
 class CanThrottleJob < ActiveJob::Base
   include ActiveJob::TrafficControl::Throttle
 
+  throttle threshold: 2, period: 1.second
+
+  def perform
+    # no more than two of `CanThrottleJob` will run every second
+    # if more than that attempt to run, they will be re-enqueued to run in a random time
+    # ranging from 1 - 5x the period (so, 1-5 seconds in this case)
+  end
+end
+```
+
+If you do not care about the job being re-enqueued (if it's scheduled to run otherwise, or dropping will have no ill effect), you can specify `drop: true` instead. The `drop: true` flag also applies to `Concurrency`, below.
+
+```ruby
+class CanThrottleAndDropJob < ActiveJob::Base
+  include ActiveJob::TrafficControl::Throttle
+
   throttle threshold: 2, period: 1.second, drop: true
 
   def perform
     # no more than two of `CanThrottleJob` will run every second
-    # if more than that attempt to run, they will be dropped (you can set `drop: false` to have the re-enqueued instead)
+    # if more than that attempt to run, they will be dropped
   end
 end
 ```

data/lib/active_job/traffic_control/concurrency.rb

@@ -8,12 +8,10 @@ module ActiveJob
       CONCURRENCY_REENQUEUE_DELAY = ENV["RACK_ENV"] == "test" ? 1...5 : 30...(60 * 5)
 
       class_methods do
-        attr_accessor :job_concurrency
-
         def concurrency(threshold, drop: true, key: nil, wait_timeout: 0.1, stale_timeout: 60 * 10)
           raise ArgumentError, "Concurrent jobs needs to be an integer > 0" if threshold.to_i < 1
 
-          @job_concurrency = {
+          self.job_concurrency = {
             threshold: threshold.to_i,
             drop: drop,
             wait_timeout: wait_timeout.to_f,
@@ -30,6 +28,8 @@ module ActiveJob
       included do
         include ActiveJob::TrafficControl::Base
 
+        class_attribute :job_concurrency, instance_accessor: false
+
         around_perform do |job, block|
           if self.class.job_concurrency.present?
             lock_options = {

data/lib/active_job/traffic_control/throttle.rb

@@ -6,12 +6,10 @@ module ActiveJob
       extend ::ActiveSupport::Concern
 
       class_methods do
-        attr_accessor :job_throttling
-
         def throttle(threshold:, period:, drop: false, key: nil)
           raise ArgumentError, "Threshold needs to be an integer > 0" if threshold.to_i < 1
 
-          @job_throttling = {
+          self.job_throttling = {
             threshold: threshold,
             period: period,
             drop: drop,
@@ -27,6 +25,8 @@ module ActiveJob
       included do
         include ActiveJob::TrafficControl::Base
 
+        class_attribute :job_throttling, instance_accessor: false
+
         around_perform do |job, block|
           if self.class.job_throttling.present?
             lock_options = {

data/lib/active_job/traffic_control/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module TrafficControl
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-traffic_control
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -133,6 +133,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -169,4 +170,3 @@ signing_key:
 specification_version: 4
 summary: Traffic control for ActiveJob
 test_files: []
-has_rdoc: