bottleneck 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3649703aee00044bc91147c7489cf0c80e458a21
-  data.tar.gz: 12a5b811e2562ca04f2abc265d5aa0c499729101
+  metadata.gz: 42281ac9ac20f1a15452c335a67fa510bc4cf4a1
+  data.tar.gz: 21f2ebab21d35f82ed6a67a5406ae376e71d1ffa
 SHA512:
-  metadata.gz: db0db32c604752d3c68183fadc2ab74592eeeecd40607708596a9ce9593005fa3b21132ac0384b8603b86ee16091bc5a4fe475d688aa09c40ac5ec9fc827e100
-  data.tar.gz: 24632e961b71137446477527fef6a1a013766e241191e9ae609b99077ef2b2745bedabbe65c96b701a0e2dbf2c0548eb57aada8eced21f3c39f0a1ff827ca164
+  metadata.gz: 895fc354c07a4d1f775c087ed100ff4e257a6a51d544560fe81b8522ec06242897ad9a29df5257ac4768b6b2a13a969df3007032b7f6ad5861739adaf3d993a6
+  data.tar.gz: eae36948a25b82c5f1b3a2f5b86e39bb163a0866c10629de0c78959f7902b7a2d7b486abd04fd3b222281ea9da65130fafcf0f22e102b56b5e3701a5b20e4088

data/.rubocop.yml

@@ -10,4 +10,6 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
   SupportedStyles:
     - single_quotes
-    - double_quotes      
+    - double_quotes      
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    bottleneck (0.4.0)
-      redis
+    bottleneck (0.4.1)
+      redis (~> 4.0)
+      redis-namespace (~> 1.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +17,8 @@ GEM
     rainbow (3.0.0)
     rake (10.5.0)
     redis (4.0.1)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -47,7 +50,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
+  rubocop (~> 0.52.1)
 
 BUNDLED WITH
    1.16.0

data/README.md

@@ -1,8 +1,9 @@
 # Bottleneck
 
-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/bottleneck`. To experiment with that code, run `bin/console` for an interactive prompt.
+Bottleneck - simple Redis based requests limiter with two params:
 
-TODO: Delete this and the text above, and describe your gem
+*  time_period_seconds: 3600
+*  max_requests_count: 100
 
 ## Installation
 
@@ -22,22 +23,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create two yaml files in config dir:
 
-## Development
+**bottleneck.yml**
 
-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.
+limits:
+  time_period_seconds: 3600
+  max_requests_count: 100
 
-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).
+**redis.yml**
+host: 'localhost'
+port: 6379
+
+Add before action:
+class ApplicationController < ActionController::API
+  before_action :check_limit
+
+  private
+
+  def check_limit
+    result = Bottleneck.check(request)
+    render status: result[:status], json: { message: result[:message] }
+  end
+end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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. 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.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Bottleneck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bottleneck/blob/master/CODE_OF_CONDUCT.md).

data/bottleneck.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.52.1"
   spec.add_dependency "redis", "~> 4.0"
+  spec.add_dependency "redis-namespace", "~> 1.6.0"
 end

data/config/bottleneck.yml

@@ -0,0 +1,3 @@
+limits:
+  time_period_seconds: 3
+  max_requests_count: 3

data/config/redis.yml

@@ -0,0 +1,2 @@
+host: '127.0.0.1'
+port: 6379

data/lib/bottleneck/core.rb

@@ -2,8 +2,8 @@ require "bottleneck/constants"
 
 module Bottleneck
   class Core
-    def initialize(request)
-      @ip = request.remote_ip.to_s
+    def initialize(ip)
+      @ip = ip.to_s
       @storage = Bottleneck.storage
       @limits = Bottleneck.config["limits"]
     end

data/lib/bottleneck/version.rb

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

data/lib/bottleneck.rb

@@ -2,23 +2,28 @@ require "bottleneck/version"
 require "bottleneck/core"
 require "yaml"
 require "redis"
+require "redis-namespace"
 
 module Bottleneck
   class << self
-    def check(request)
-      Core.new(request).run
+    def check(ip)
+      Core.new(ip).run
     end
 
     def storage
       init_storage
     end
 
-    # Init redis client from config
-    def init_storage
+    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
+    def init_storage
+      Redis::Namespace.new(:bottleneck, redis: redis_conn)
+    end
+
     # Get limits from config
     def config
       load_config("bottleneck.yml")
@@ -27,7 +32,9 @@ module Bottleneck
     private
 
     def load_config(file)
-      path = File.join(Rails.root, "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)
       YAML.load_file(path)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bottleneck
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Marat Galiev
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 description: Simple Redis based Rate Limiter for Rails applications
 email:
 - kazanlug@gmail.com
@@ -99,6 +113,8 @@ files:
 - bin/console
 - bin/setup
 - bottleneck.gemspec
+- config/bottleneck.yml
+- config/redis.yml
 - lib/bottleneck.rb
 - lib/bottleneck/constants.rb
 - lib/bottleneck/core.rb