grape-throttler 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff44f961112b47773a75e7c195b909e33938d0ada801d01ddd981f1f8ca8c854
-  data.tar.gz: e3422fd5c83dbec806d859f62c1bc5a6560fbe0da905b1fc4d6acbe13bb101b7
+  metadata.gz: c02d5c5ef081337c20539acf09bafd5c9ae35fedeeb16a92c38b16e5839fed04
+  data.tar.gz: b49635981a48db4d77ffb3ce56e539b1b33aa42727f931e20e5324dea0320645
 SHA512:
-  metadata.gz: 3ee5867e71b9de391fea4a5e37385b522abe52c724aa261f4f48510b30b076c417bd76eab1b1de27c1ee742096b3e493c7dcc92453242708574780873a8a216e
-  data.tar.gz: 47544b35bd03f981dd5c7dffa4f5c8cc8a9e155968507ded18c60e9971b9626f45e4f965382fc55b6af9e7c35be0d1c58e29eea0285df2f27a3c5bf932a6a054
+  metadata.gz: bbcca0e55d60925b0afb472459c88580e8dfe214c27059fa26e92a825b5f72ac3d6e5225d00ed8e38e3ca0f439f99d2334a0d2631907763453ee783d1c6f4fa3
+  data.tar.gz: 40644a93838ebe1e019bbfee16cf11606b4bbc375f569c554d5ed52ee99689c2e9da100ec69ad85799caf95180151c75d76ae96c9e0d1b25aef25065102eab35

data/README.md

@@ -1,40 +1,38 @@
-Grape Throttle
-==============
+# GrapeThrottler
 
-[![Gem Version](https://badge.fury.io/rb/grape-throttle.svg)](https://badge.fury.io/rb/grape-throttle)
-[![Build Status](https://travis-ci.org/xevix/grape-throttle.svg)](https://travis-ci.org/xevix/grape-throttle)
+[![Gem Version](https://badge.fury.io/rb/grape-throttler.svg)](http://badge.fury.io/rb/grape-throttler)
+[![Build Status](https://travis-ci.org/drexed/grape-throttler.svg?branch=master)](https://travis-ci.org/drexed/grape-throttler)
 
-**Deprecation Warning**
+GrapeThrottler provides a simple endpoint-specific throttling mechanism for Grape.
 
-This gem is no longer being actively maintained. For similar throttle functionality see [rack-attack](https://github.com/kickstarter/rack-attack). Integration of this gem with rack-attack is a future consideration.
+## Installation
 
-**Description**
+Add this line to your application's Gemfile:
 
-The grape-throttle gem provides a simple endpoint-specific throttling mechanism for Grape.
-
-## Requirements
+```ruby
+gem 'grape-throttler'
+```
 
-* Grape >= 0.10.0
-* Redis
+And then execute:
 
-## Usage
+    $ bundle
 
-### Build and Install
+Or install it yourself as:
 
-To use, just install the gem from RubyGems or via Bundler by requiring it in your Gemfile.
+    $ gem install grape-throttler
 
-```
-gem 'grape-throttle'
-```
+## Table of Contents
 
-### Middleware Setup
+* [Configuration](#configuration)
+* [Endpoint](#endpoint)
 
-Then in your Grape API, install the middleware which will do the throttling. At a minimum, it requires a Redis instance for caching as the `cache` parameter.
+## Configuration
+In your Grape API, install the middleware which will do the throttling. At a minimum, it requires a Redis instance for caching as the `cache` parameter.
 
 **Simple Case**
 
 ```ruby
-use Grape::Middleware::ThrottleMiddleware, cache: Redis.new
+use GrapeThrottler::Middleware::ThrottleMiddleware, cache: Redis.new
 ```
 
 In this simple case, you just set up the middleware, and pass it a Redis instance.
@@ -42,7 +40,7 @@ In this simple case, you just set up the middleware, and pass it a Redis instanc
 **Advanced Case**
 
 ```ruby
-use Grape::Middleware::ThrottleMiddleware, cache: $redis, user_key: ->(env) do
+use GrapeThrottler::Middleware::ThrottleMiddleware, cache: $redis, user_key: ->(env) do
   # Use the current_user's id as an identifier
   user = current_user
   user.nil? ? nil : user.id
@@ -58,10 +56,10 @@ The `user_key` parameter is a function that can be used to determine a custom id
 The gem will log errors to STDOUT by default. If you prefer a different logger you can use the `logger` option to pass in your own logger.
 
 ```ruby
-use Grape::Middleware::ThrottleMiddleware, cache: Redis.new, logger: Logger.new('my_custom_log.log')
+use GrapeThrottler::Middleware::ThrottleMiddleware, cache: Redis.new, logger: Logger.new('my_custom_log.log')
 ```
 
-### Endpoint Usage
+## Endpoint
 
 This gem adds a `throttle` DSL-like method that can be used to throttle different endpoints differently.
 
@@ -72,56 +70,57 @@ Supported predefined periods are: `:hourly`, `:daily`, `:monthly`.
 Example:
 
 ```ruby
-class API < Grape::API
+class API < GrapeThrottler::API
   resources :users do
 
     # Allow start of competition only every 10 minutes
-    desc "Start competition"
+    desc 'Start competition'
     throttle period: 10.minutes, limit: 1
     params do
-      requires :id, type: Integer, desc: "id"
+      requires :id, type: Integer, desc: 'id'
     end
-    post "/:id/competition" do
+    post '/:id/competition' do
       User.find(params[:id]).start_competition
     end
 
     # 3 times a day max
-    desc "Fetch a user"
+    desc 'Fetch a user'
     throttle daily: 3
     params do
-      requires :id, type: Integer, desc: "id"
+      requires :id, type: Integer, desc: 'id'
     end
-    get "/:id" do
+    get '/:id' do
       User.find(params[:id])
     end
 
     # Once a month or the user will go crazy
-    desc "Poke a user"
+    desc 'Poke a user'
     throttle monthly: 1
     params do
-      requires :id, type: Integer, desc: "id"
+      requires :id, type: Integer, desc: 'id'
     end
-    post "/:id/poke" do
+    post '/:id/poke' do
       User.find(params[:id]).poke
     end
 
     # No limit to the amount we can annoy users
-    desc "Annoy a user"
+    desc 'Annoy a user'
     params do
-      requires :id, type: Integer, desc: "id"
+      requires :id, type: Integer, desc: 'id'
     end
-    post "/:id/annoy" do
+    post '/:id/annoy' do
       User.find(params[:id]).annoy
     end
   end
 end
 ```
 
-## TODO
-
-* Custom error handling and error strings, status etc.
-* Allow use of something other than Redis for caching
+## Contributing
 
-## Thanks
+Your contribution is welcome.
 
-Thanks to the awesome Grape community, and to @dblock for all the help getting this thing going.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/grape-throttler/middleware/throttle_middleware.rb

@@ -29,7 +29,7 @@ module GrapeThrottler
           current = redis.get(rate_key).to_i
 
           if !current.nil? && current >= limit
-            endpoint.error!('too many requests, please try again later', 429)
+            endpoint.error!('Too Many Requests', 429)
           else
             redis.multi do
               redis.set(rate_key, COUNTER_START, { nx: true, ex: period.to_i })

data/lib/grape-throttler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeThrottler
-  VERSION ||= '1.0.0'
+  VERSION ||= '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-throttler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Juan Gomez