nimble_throttler 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0765993522990a60372512a6c8c7a17cef2ca2cb
-  data.tar.gz: 75c2ea0f82ed30ec40327bf01cf3a9aafe5e0eac
+  metadata.gz: eef8af63d28977c1fabe218bfb3ef8e8540d6077
+  data.tar.gz: f88fdf87edd68648fc19f89e4ff804aa112e3259
 SHA512:
-  metadata.gz: afffca9f47aba0c0da8c34de7aeeb19aacf5e8b82635cccdb6e533e1a7257b2f7740d6d8b3788d0bdcb50c010fad4a5d6fe364f2ef8f8831a19895b40e2f1f0d
-  data.tar.gz: 19368f26a8dd02ab07ea41e2f1727a01e9e22b5361da73e84ecf2d60c50f632721292cc6ff08d694b575f2ba4d40ea06f44744baae935531a49b4465102cbf89
+  metadata.gz: 4290b99ac2c6864ee2ed4ac73df1b894a3712a90d5482266274266e93832ab792ffc4cc451f14ac94029513086bf3e9a3e160ce2defe3c4855beb595167d143f
+  data.tar.gz: 069c804c85e28fc4007fd1a7bb4d7952deb1ad118f2eea204f54f8195e75b119d989e091f38ba1ad9bb599919245d3a8ae508aa14ea5d321a6817b48e7b27398

data/README.md

@@ -1,8 +1,10 @@
 # NimbleThrottler
 
-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/nimble_throttler`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Code Climate](https://codeclimate.com/github/kimquy/nimble_throttler/badges/gpa.svg)](https://codeclimate.com/github/kimquy/nimble_throttler)
 
-TODO: Delete this and the text above, and describe your gem
+[![Build Status](https://travis-ci.org/kimquy/nimble_throttler.svg?branch=master)](https://travis-ci.org/kimquy/nimble_throttler)
+
+NimbleThrottler is very simple ruby gem which allow throttling an certain endpoints.
 
 ## Installation
 
@@ -22,13 +24,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add the following code into `application.rb` of your Rails app.
+
+```ruby
+require "nimble_throttler"
 
-## Development
+module YourRailsApp
+  class Application < Rails::Application
+    config.middleware.use Rack::NimbleThrottling
+  end
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Now you're ready to throttle the endpoints by adding this file `nimble_throttling.rb` into `initializers` folder. Example:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+NimbleThrottler.configure do
+  throttle '/testing', limit: 5, period: 1.hours
+  throttle '/awesome', limit: 100, period: 2.hours
+  throttle '/home/page', limit: 100, period: 3.hours
+end
+```
 
 ## Contributing
 

data/nimble_throttler.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "nimble_throttler"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Long Nguyen"]
   spec.email         = ["long.polyglot@gmail.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nimble_throttler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Long Nguyen