grape-throttling 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aab77fdedb6a77b7a4de1583352c11f8eb73d797fe3bc67f8075436257100ac
-  data.tar.gz: 67fabd18bd8324a7d2a1f8df795b5a9507d6a3ff6f7ea164c14d582d91f99051
+  metadata.gz: 4d7af84a0a0c54a3c7fdf73b4af2be49ee97f1360b0de6d5ce3c2871ecc2f45c
+  data.tar.gz: 505fd42572b665a149c7b15c8801fea4f12337fac7326578977183528ae6e8cf
 SHA512:
-  metadata.gz: 20ba672eca5e35767111fc8c042cfb870a3677df47ffcc87dba8dc82885d135a8bf1165a92cf966249f38ed7b33152b2733668347e7143be0f8c19b81f013563
-  data.tar.gz: 7e4fc918914fe7e9d6b1a2aef41a8440cdae79fe405a2012fb34318ae01e4e3c4bf7339b994af0b7c72ebd9fe88d7a64e363889467818629db0cb899366493c0
+  metadata.gz: 046b944e3d314770bfd3b467b052871f8b3d3294f3d04a7474cb500b42bf4a612ad0c2433b9d6c17e728886f54999928563c22968ba0e2e362a2f08917e63317
+  data.tar.gz: df97788c0d8f9253995035b1ca916a92a60d4a0a9b3ffd19f6def85d77dad98d7aa1791d8d504a8d7513ba9c255a861996787e8be5095dea51cb06b636804a84

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+### 0.1.2 (2020-12-24)
+
+- Allow custom overspeed message ([#1](https://github.com/OuYangJinTing/grape-throttling/pull/1/files))
+
 ### 0.1.1 (2020-11-05)
 
-- Dimension reduction support ruby >= 2.3.0
+- Down grade support ruby >= 2.3.0

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/OuYangJinTing/grape-throttling.svg)](https://travis-ci.org/OuYangJinTing/grape-throttling)
 [![Gem Version](https://badge.fury.io/rb/grape-throttling.svg)](https://badge.fury.io/rb/grape-throttling)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f200c46569aa627315f6/maintainability)](https://codeclimate.com/github/OuYangJinTing/grape-throttling/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f200c46569aa627315f6/test_coverage)](https://codeclimate.com/github/OuYangJinTing/grape-throttling/test_coverage)
 
 If your api through [`grape`](https://github.com/ruby-grape/grape) build, you can use `grape-throttling` limit api rate.
 
@@ -48,9 +50,12 @@ end
 ## Configure
 
 ```ruby
-# default configuration
+# Default configuration
 Grape::Throttling.configure do |config|
   config.redis = ::Redis.new(url: 'redis://localhost:6379/0', driver: :hiredis)
+  # Api overspeed access message custom method.
+  # If doesn't respond，default message is "API rate limit exceeded."
+  config.overspeed_message_method = :overspeed_message
 end
 ```
 

data/grape-throttling.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'grape', '>= 0.16.1'
   spec.add_runtime_dependency 'redis-namespace', '>= 0.8.0'
   spec.add_runtime_dependency 'hiredis'
+  spec.add_runtime_dependency 'activesupport', '>= 3'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rack-test'

data/lib/grape/throttling.rb

@@ -2,6 +2,7 @@
 
 require 'grape'
 require 'redis-namespace'
+require 'active_support/all'
 
 require 'grape/throttling/counter'
 require 'grape/throttling/extension/api'

data/lib/grape/throttling/configuration.rb

@@ -3,10 +3,12 @@
 module Grape
   module Throttling
     class Configuration # :nodoc:
-      attr_reader :redis
+      attr_reader :redis, :overspeed_message_method
+      attr_writer :overspeed_message_method
 
       def initialize
         @redis = ::Redis.new(url: 'redis://localhost:6379/0', driver: :hiredis)
+        @overspeed_message_method = :overspeed_message
       end
 
       def redis=(redis)

data/lib/grape/throttling/extension/api.rb

@@ -8,7 +8,7 @@ module Grape
 
         module ClassMethods # :nodoc:
           # rubocop:disable Style/ClassVars
-          def use_throttle(max: 60, expire: 1.day, condition: proc { true }, identity: proc { request.ip }) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+          def use_throttle(max: 60, expire: 1.day, condition: proc { true }, identity: proc { request.ip }) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
             max = max.try(:to_i).to_i
             raise ArgumentError, 'max must be positive number' unless max.positive?
             raise ArgumentError, 'condition must be Proc' unless condition.is_a?(Proc)
@@ -36,7 +36,13 @@ module Grape
                 request.id_throttle = instance_eval(&@@throttle.identity)
                 count = @@throttle.get(request.id_throttle)
 
-                error!('API rate limit exceeded.', 403, mixin_throttle_headers(count)) if count >= @@throttle.max
+                message = if respond_to?(Throttling.config.overspeed_message_method)
+                            send(Throttling.config.overspeed_message_method)
+                          else
+                            'API rate limit exceeded.'
+                          end
+
+                error!(message, 403, mixin_throttle_headers(count)) if count >= @@throttle.max
               end
             end
 

data/lib/grape/throttling/version.rb

@@ -2,6 +2,6 @@
 
 module Grape
   module Throttling
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-throttling
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - OuYangJinTing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement