grape-throttling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af60e3bd619a2608ab8ab0ad68b3040b03bb14c26a84467e996e23ffb96db0bf
+  data.tar.gz: 1eadd65155a233b585f7c547f500760703dcc1d773cf45cc33b6eed76264bf83
+SHA512:
+  metadata.gz: 32e1eb6a1d13978bbcd11e1f2fcad756ad91ad333e3c86d9617ff00c13006eb911e319a8097d04495c6c18fdccb7c9958fa4cccc1f3be3d7f150981fcc5ff48c
+  data.tar.gz: '09ef4bd9a04b3a6a1f054aff1dfb77e054a6c84995e0ba8ee76d92138bc1082278b44840e8c8412e48c4026de4257008145e1bdfd0f4d778f1e087f4f5c6797d'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  # - rubocop-packaging
+  - rubocop-performance
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+services:
+  - redis
+language: ruby
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+before_install: gem install bundler
+after_success: bundle install
+gemfile:
+  - gemfiles/grape-0-16
+  - gemfiles/grape-1-0
+  - gemfiles/grape-1-5
+script: bundle exec rake test && bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 2729877005qq@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-throttling.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 OuYangJinTing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Grape::Throttling
+
+[![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)
+
+If your api through [`grape`](https://github.com/ruby-grape/grape) build, you can use `grape-throttling` limit api rate.
+
+- **Simple**. The you only need to call `use_throttle` in your api internal.
+- **Throttle remind**. The response header include `X-RateLimit-Limit`, `X-Ratelimit-Used`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-throttling'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+gem install grape-throttling
+```
+
+## Usage
+
+```ruby
+class Api < Grape::API
+  use_throttle(max: 60, expire: 1.day, condition: proc { !current_user.is_admin? }, identity: proc { request.ip })
+end
+```
+
+| Argument Key | Default               | Description                    |
+| ------------ | --------------------- | ------------------------------ |
+| `max`        | `60`                  | Maximum rate that can be used. |
+| `expire`     | `1.day`               | Waiting time for reset rate.   |
+| `condition`  | `proc { true }`       | Condition of enabled throttle. |
+| `identity`   | `proc { request.ip }` | Used for throttle identity.    |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/OuYangJinTing/grape-throttling>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/OuYangJinTing/grape-throttling/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Grape::Throttling project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OuYangJinTing/grape-throttling/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'grape/throttling'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/grape-0-16

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+gem 'grape', '~> 0.16.1'

data/gemfiles/grape-1-0

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+gem 'grape', '~> 1.0.0'

data/gemfiles/grape-1-5

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+gem 'grape', '~> 1.5.0'

data/grape-throttling.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/grape/throttling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-throttling'
+  spec.version       = Grape::Throttling::VERSION
+  spec.authors       = ['OuYangJinTing']
+  spec.email         = ['2729877005qq@gmail.com']
+
+  spec.summary       = 'Grape rate limit exceeded.'
+  spec.description   = 'Grape rate limit exceeded.'
+  spec.homepage      = 'https://github.com/OuYangJinTing/grape-throttling'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/OuYangJinTing/grape-throttling.git'
+  spec.metadata['changelog_uri'] = 'https://github.com/OuYangJinTing/grape-throttling/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'grape', '>= 0.16.1'
+  spec.add_runtime_dependency 'redis-namespace', '>= 0.8.0'
+  spec.add_runtime_dependency 'hiredis'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'rubocop'
+  # spec.add_development_dependency 'rubocop-packaging'
+  spec.add_development_dependency 'rubocop-performance'
+end

data/lib/grape/throttling.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'grape'
+require 'redis-namespace'
+
+require 'grape/throttling/counter'
+require 'grape/throttling/extension/api'
+require 'grape/throttling/extension/request'
+require 'grape/throttling/configurable'
+require 'grape/throttling/configuration'
+require 'grape/throttling/error'
+require 'grape/throttling/version'
+
+module Grape
+  module Throttling # :nodoc:
+    extend Configurable
+  end
+end

data/lib/grape/throttling/configurable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    module Configurable # :nodoc:
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        config.tap { yield(config) if block_given? }
+      end
+    end
+  end
+end

data/lib/grape/throttling/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    class Configuration # :nodoc:
+      attr_reader :redis
+
+      def initialize
+        @redis = ::Redis.new(url: 'redis://localhost:6379/0', driver: :hiredis)
+      end
+
+      def redis=(redis)
+        raise ArgumentError, 'must be provide redis instance' unless redis.is_a?(::Redis)
+
+        @redis = redis
+      end
+    end
+  end
+end

data/lib/grape/throttling/counter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    class Counter # :nodoc:
+      delegate :set, :del, :expire, :ttl, to: :@redis
+
+      def initialize(expire)
+        @expire = expire.try(:to_i).to_i
+        env = ENV['RACK_ENV'].presence || 'unknow'
+        @redis = Redis::Namespace.new(
+          "grape-throttling:#{env}:counter",
+          redis: Throttling.config.redis
+        )
+      end
+
+      def get(key)
+        @redis.get(key).to_i
+      end
+
+      def incr(key)
+        response = begin
+          @redis.incr(key)
+        rescue Redis::CommandError => e
+          del(key) == 1 ? @redis.incr(key) : (raise e)
+        end
+
+        response.tap { expire(key, @expire) if response == 1 && @expire.positive? }
+      end
+    end
+  end
+end

data/lib/grape/throttling/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    class Error < StandardError; end
+    class ArgumentError < Error; end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    module Extension
+      module Api # :nodoc:
+        extend ActiveSupport::Concern
+
+        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
+            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)
+            raise ArgumentError, 'identity must be Proc' unless identity.is_a?(Proc)
+
+            @@throttle = Counter.new(expire)
+            @@throttle.define_singleton_method(:max) { max }
+            @@throttle.define_singleton_method(:condition) { condition }
+            @@throttle.define_singleton_method(:identity) { identity }
+
+            helpers do
+              def mixin_throttle_headers(count)
+                header('X-RateLimit-Limit', @@throttle.max.to_s)
+                header('X-Ratelimit-Used', count.to_s)
+                header('X-RateLimit-Remaining', (@@throttle.max - count).to_s)
+                header('X-RateLimit-Reset', (Time.now.utc + @@throttle.ttl(request.id_throttle)).to_s)
+
+                header
+              end
+            end
+
+            before do
+              if instance_eval(&@@throttle.condition)
+                request.enabled_throttle = true
+                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
+              end
+            end
+
+            after { mixin_throttle_headers(@@throttle.incr(request.id_throttle)) if request.throttle? }
+
+            @@throttle
+          end
+          # rubocop:enable Style/ClassVars
+        end
+
+        Grape::API.include(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    module Extension
+      module Request # :nodoc:
+        extend ActiveSupport::Concern
+
+        included do
+          attr_accessor :enabled_throttle, :id_throttle
+
+          def throttle?
+            !!enabled_throttle
+          end
+        end
+
+        Grape::Request.include self
+      end
+    end
+  end
+end

data/lib/grape/throttling/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Grape
+  module Throttling
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: grape-throttling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OuYangJinTing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Grape rate limit exceeded.
+email:
+- 2729877005qq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/grape-0-16
+- gemfiles/grape-1-0
+- gemfiles/grape-1-5
+- grape-throttling.gemspec
+- lib/grape/throttling.rb
+- lib/grape/throttling/configurable.rb
+- lib/grape/throttling/configuration.rb
+- lib/grape/throttling/counter.rb
+- lib/grape/throttling/error.rb
+- lib/grape/throttling/extension/api.rb
+- lib/grape/throttling/extension/request.rb
+- lib/grape/throttling/version.rb
+homepage: https://github.com/OuYangJinTing/grape-throttling
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OuYangJinTing/grape-throttling
+  source_code_uri: https://github.com/OuYangJinTing/grape-throttling.git
+  changelog_uri: https://github.com/OuYangJinTing/grape-throttling/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Grape rate limit exceeded.
+test_files: []