ahoy_matey 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40222ba157a73c4362b78a26fe1796a9bbc9fb50
-  data.tar.gz: 58a88b0ed382c126ceb141c902855f5c1492ee77
+  metadata.gz: 9e5a105f360566e591e93df058b2ef3f2b014d2b
+  data.tar.gz: 75b530f1d2ac5db181fce79e5e28772fee413e44
 SHA512:
-  metadata.gz: e04afdc9015e4456e2062c718c38ef043777b3e7442435926420db88bbeecb5226b60d899d45b24d69faa9cadb4041f735a7460f6f8f0062180763c90fdadc8d
-  data.tar.gz: 08de05c386b58857803d8867f92512293f68d41146d1c96d3e0c7082596ab4db0f0b920284ae28a9ffa946877440abe96279d2765b2cc030d68a65b6da62f9b6
+  metadata.gz: 04728f524b58d1b923072dbf88f2f3e028bd9e7c09b40b7e26dcf24b1311255fcf851401c1890d473d1ef43f6b35abac94be4ec71d889211d09f6ebd573f7934
+  data.tar.gz: 40cd9292793a8a9df4f91c474deb5fe787b483d9cf7f9b76d00ef9ebe36a0d82511fdc12dcf506acd71849b5443f072110af1faf4983596006c7a96543ac3c1b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.5.1
+
+- Restored throttling after removing side effects
+
 ## 1.5.0
 
 - Removed throttling due to unintended side effects with its implementation

data/README.md

@@ -530,18 +530,6 @@ Send a `POST` request as `Content-Type: application/json` to `/ahoy/events` with
 
 Use an array to pass multiple events at once.
 
-## Throttling
-
-To throttle requests to Ahoy endpoints, check out [Rack::Attack](https://github.com/kickstarter/ack-attack). Here’s a sample config:
-
-```ruby
-Rack::Attack.throttle("ahoy/ip", limit: 20, period: 1.minute) do |req|
-  if req.path.start_with?("/ahoy/")
-    req.ip
-  end
-end
-```
-
 ## Reference
 
 By default, Ahoy create endpoints at `/ahoy/visits` and `/ahoy/events`. To disable, use:
@@ -552,10 +540,6 @@ Ahoy.mount = false
 
 ## Upgrading
 
-### 1.5.0
-
-There’s nothing to do, but it’s worth noting that simple throttling, which was added in `1.3.0`, was removed due to unintended side effects with its implementation. See the [Throttling](#throttling) section for how to properly add it by hand if needed.
-
 ### 1.4.0
 
 There’s nothing to do, but it’s worth noting the default store was changed from `ActiveRecordStore` to `ActiveRecordTokenStore` for new installations.

data/ahoy_matey.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "request_store"
   spec.add_dependency "uuidtools"
   spec.add_dependency "safely_block", ">= 0.1.1"
+  spec.add_dependency "rack-attack", "< 6"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/ahoy.rb

@@ -72,6 +72,15 @@ module Ahoy
   mattr_accessor :mount
   self.mount = true
 
+  mattr_accessor :throttle
+  self.throttle = true
+
+  mattr_accessor :throttle_limit
+  self.throttle_limit = 20
+
+  mattr_accessor :throttle_period
+  self.throttle_period = 1.minute
+
   mattr_accessor :job_queue
   self.job_queue = :ahoy
 

data/lib/ahoy/engine.rb

@@ -1,6 +1,11 @@
 module Ahoy
   class Engine < ::Rails::Engine
     initializer "ahoy.middleware", after: "sprockets.environment" do |app|
+      if Ahoy.throttle
+        require "ahoy/throttle"
+        app.middleware.use Ahoy::Throttle
+      end
+
       next unless Ahoy.quiet
 
       # Parse PATH_INFO by assets prefix

data/lib/ahoy/throttle.rb

@@ -0,0 +1,25 @@
+require "rack/attack"
+
+module Ahoy
+  class Throttle < Rack::Attack
+    throttle("ahoy/ip", limit: Ahoy.throttle_limit, period: Ahoy.throttle_period) do |req|
+      if req.path.start_with?("/ahoy/")
+        req.ip
+      end
+    end
+
+    def_delegators self, :whitelisted?, :blacklisted?, :throttled?, :tracked?, :blocklisted?, :safelisted?
+
+    def self.throttled_response
+      Rack::Attack.throttled_response
+    end
+
+    def self.blacklisted_response
+      Rack::Attack.blacklisted_response
+    end
+
+    def self.blocklisted_response
+      Rack::Attack.blocklisted_response
+    end
+  end
+end

data/lib/ahoy/version.rb

@@ -1,3 +1,3 @@
 module Ahoy
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_matey
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Andrew Kane
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rack-attack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -260,6 +274,7 @@ files:
 - lib/ahoy/stores/log_store.rb
 - lib/ahoy/stores/mongoid_store.rb
 - lib/ahoy/subscribers/active_record.rb
+- lib/ahoy/throttle.rb
 - lib/ahoy/tracker.rb
 - lib/ahoy/version.rb
 - lib/ahoy/visit_properties.rb