bottleneck 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42281ac9ac20f1a15452c335a67fa510bc4cf4a1
-  data.tar.gz: 21f2ebab21d35f82ed6a67a5406ae376e71d1ffa
+  metadata.gz: 22d916e42ef02a5ad281db4499e3d3e35855b34b
+  data.tar.gz: f61fe13668ac348fc40040df8f90f0f5eed1c2f0
 SHA512:
-  metadata.gz: 895fc354c07a4d1f775c087ed100ff4e257a6a51d544560fe81b8522ec06242897ad9a29df5257ac4768b6b2a13a969df3007032b7f6ad5861739adaf3d993a6
-  data.tar.gz: eae36948a25b82c5f1b3a2f5b86e39bb163a0866c10629de0c78959f7902b7a2d7b486abd04fd3b222281ea9da65130fafcf0f22e102b56b5e3701a5b20e4088
+  metadata.gz: 29f95a6863d82b3d7b4a34c5ed3c8683858592b517c39a42c0d85503c4027c7189d7a80d2c980f3624de4d931b01b31e82fe04d5f80dbbbf7d24c168b2ae4647
+  data.tar.gz: d75e87c21de2d47e6bfe429a9805d7f98cbb352bee9a1f5fee89c0cb05a4c11525524bfe08e7545240e8440afb0de46e37b84c8a7acb775c5bd7a7b54551e5e1

data/.travis.yml

@@ -1,5 +1,9 @@
 sudo: false
 language: ruby
+services:
+  - redis-server
 rvm:
   - 2.4.2
 before_install: gem install bundler -v 1.16.0
+script:
+  - bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bottleneck (0.4.1)
+    bottleneck (0.4.2)
       redis (~> 4.0)
       redis-namespace (~> 1.6.0)
 
@@ -10,12 +10,15 @@ GEM
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
     parallel (1.12.1)
     parser (2.5.0.2)
       ast (~> 2.4.0)
     powerpack (0.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
+    rdoc (6.0.1)
     redis (4.0.1)
     redis-namespace (1.6.0)
       redis (>= 3.0.4)
@@ -48,7 +51,9 @@ PLATFORMS
 DEPENDENCIES
   bottleneck!
   bundler (~> 1.16)
+  fakeredis (~> 0.6)
   rake (~> 10.0)
+  rdoc (~> 6.0.1)
   rspec (~> 3.0)
   rubocop (~> 0.52.1)
 

data/README.md

@@ -1,9 +1,8 @@
-# Bottleneck
+[![Build Status](https://travis-ci.org/maratgaliev/bottleneck.svg?branch=master)](https://travis-ci.org/maratgaliev/bottleneck)
 
-Bottleneck - simple Redis based requests limiter with two params:
+# Bottleneck
 
-*  time_period_seconds: 3600
-*  max_requests_count: 100
+Bottleneck - simple Redis based requests limiter.
 
 ## Installation
 
@@ -27,29 +26,35 @@ Create two yaml files in config dir:
 
 **bottleneck.yml**
 
+```ruby
 limits:
   time_period_seconds: 3600
   max_requests_count: 100
-
+```
 **redis.yml**
+
+```ruby
 host: 'localhost'
 port: 6379
+```
 
-Add before action:
+Add before action to your controller:
+```ruby
 class ApplicationController < ActionController::API
   before_action :check_limit
 
   private
 
   def check_limit
-    result = Bottleneck.check(request)
+    result = Bottleneck.check(request.remote_ip)
     render status: result[:status], json: { message: result[:message] }
   end
 end
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/maratgaliev/bottleneck. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/maratgaliev/bottleneck](https://github.com/maratgaliev/bottleneck).
 
 ## License
 

data/bottleneck.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.52.1"
+  spec.add_development_dependency "rdoc", "~> 6.0"
+  spec.add_development_dependency "fakeredis", "~> 0.6"
   spec.add_dependency "redis", "~> 4.0"
-  spec.add_dependency "redis-namespace", "~> 1.6.0"
+  spec.add_dependency "redis-namespace", "~> 1.6"
 end

data/lib/bottleneck/core.rb

@@ -2,15 +2,22 @@ require "bottleneck/constants"
 
 module Bottleneck
   class Core
+    # Create a Core object.
+    #
+    # @param [String] ip A name to uniquely identify this rate limit. For example, '127.0.0.1'
+    #
+    # @return [Core] Core instance
     def initialize(ip)
       @ip = ip.to_s
       @storage = Bottleneck.storage
       @limits = Bottleneck.config["limits"]
     end
 
+    # Run main logic initialization, set and read Redis keys and validation requests count and time limit.
+    #
+    # @return [Hash] Hash with :status and :message keys
     def run
       client_ip = @ip
-      # create key in redis, based on client's IP
       key = "request_count:#{client_ip}"
       result = { status: Constants::SUCCESS_STATUS, message: Constants::OK_MESSAGE }
       requests_count = @storage.get(key)
@@ -29,11 +36,20 @@ module Bottleneck
 
     private
 
+    # Get remaining time in seconds for key.
+    #
+    # @param [String]   key A unique key in Redis store
+    #
+    # @return [Integer] Countdown in seconds
     def period(key)
-      # get remaining seconds with TTL from redis
       @storage.ttl(key)
     end
 
+    # Return string message for 429 status
+    #
+    # @param [Integer]   secs Remaining seconds
+    #
+    # @return [String] Rate limit message with seconds   
     def message(secs)
       "Rate limit exceeded. Try again in #{secs} seconds"
     end

data/lib/bottleneck/version.rb

@@ -1,3 +1,3 @@
 module Bottleneck
-  VERSION = "0.4.2".freeze
+  VERSION = "0.4.3".freeze
 end

data/lib/bottleneck.rb

@@ -6,33 +6,47 @@ require "redis-namespace"
 
 module Bottleneck
   class << self
+    # Run method call on Core object 
+    #
+    # @param [String] A name to uniquely identify this rate limit. For example, '127.0.0.1'
     def check(ip)
       Core.new(ip).run
     end
 
+    # Init Redis Namespace storage
+    #
+    # @return [Redis::Namespace] Redis::Namespace instance  
     def storage
       init_storage
     end
 
+    # Init Redis instance
+    #
+    # @return [Redis] Redis instance
     def redis_conn
       redis_conf = load_config("redis.yml")
       Redis.new(host: redis_conf["host"], port: redis_conf["port"])
     end
 
-    # Init redis client from config
+    # Init Redis Namespace storage
+    #
+    # @return [Redis::Namespace] Redis::Namespace instance  
     def init_storage
       Redis::Namespace.new(:bottleneck, redis: redis_conn)
     end
 
-    # Get limits from config
+    # Load limits config file
+    #
+    # @return [Hash] Hash for bottleneck.yml file  
     def config
       load_config("bottleneck.yml")
     end
 
     private
-
+    # Load config file
+    #
+    # @return [Hash] Hash with configuration
     def load_config(file)
-      # Check for Rails defined, or use current path
       root = (defined?(Rails) && Rails.respond_to?(:root) && Rails.root) || Dir.pwd
       path = "#{root}/config/#{file}"
       raise "No #{file} file found in your config directory!" unless File.exist?(path)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bottleneck
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Marat Galiev
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1.6'
 description: Simple Redis based Rate Limiter for Rails applications
 email:
 - kazanlug@gmail.com