excess_flow 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 8a3d126c802897da085efe1c25b0ed072fdd04c68e60dd0ed84a6f5500305bc5
4
+ data.tar.gz: 51819fceea85eebbc32bfc473a591af5adbbb1fc4a1515f6e3891792c76f3b7d
5
+ SHA512:
6
+ metadata.gz: 7b77fa015d8730b165a0afc446406a6b3af7eaffb9ebd35614bf71b291a59e29cb57b5535a01eec2fd4c1a49f712951f9965774b944da9ba3b6725997f876b3d
7
+ data.tar.gz: 8d86f5d753f6394ee2418baf98ce1f45f8d6bec79bb65edbdeec549240b795c8e639fa7bc31e5a1f503a694a857c58ab19277ea3faac949e0e8e1b630d2e728a
@@ -0,0 +1,35 @@
1
+ version: 2
2
+ jobs:
3
+ build:
4
+ docker:
5
+ - image: circleci/ruby:2.6.4
6
+ - image: circleci/redis
7
+
8
+ working_directory: ~/repo
9
+
10
+ steps:
11
+ - checkout
12
+
13
+ - restore_cache:
14
+ keys:
15
+ - bundle-{{ checksum "Gemfile.lock" }}
16
+
17
+ - run:
18
+ name: install dependencies
19
+ command: |
20
+ gem update --system
21
+ gem install bundler
22
+ bundle install --jobs=4 --retry=3 --path vendor/bundle
23
+
24
+ - save_cache:
25
+ key: bundle-{{ checksum "Gemfile.lock" }}
26
+ paths:
27
+ - ./vendor/bundle
28
+
29
+ - run:
30
+ name: rubocop
31
+ command: bundle exec rubocop
32
+
33
+ - run:
34
+ name: rspec
35
+ command: bundle exec rspec
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,4 @@
1
+ --color
2
+ --require spec_helper
3
+ --format progress
4
+ --profile
data/.rubocop.yml ADDED
@@ -0,0 +1,6 @@
1
+ Metrics/LineLength:
2
+ Max: 120
3
+
4
+ Metrics/BlockLength:
5
+ Exclude:
6
+ - 'spec/**/*.rb'
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 2.0.2
data/CHANGELOG.md ADDED
@@ -0,0 +1,4 @@
1
+ # Changelog
2
+
3
+ ## 1.0.0
4
+ - Initial commit!
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at ruslan@ruslan.io. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ gemspec
6
+
7
+ group :development, :test do
8
+ gem 'rubocop', '~> 0.74.0'
9
+ end
10
+
11
+ group :test do
12
+ gem 'rspec', '~> 3.8.0'
13
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,54 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ excess_flow (1.0.0)
5
+ connection_pool
6
+ rake
7
+ redis
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ ast (2.4.0)
13
+ connection_pool (2.2.2)
14
+ diff-lcs (1.3)
15
+ jaro_winkler (1.5.3)
16
+ parallel (1.17.0)
17
+ parser (2.6.5.0)
18
+ ast (~> 2.4.0)
19
+ rainbow (3.0.0)
20
+ rake (13.0.0)
21
+ redis (4.1.3)
22
+ rspec (3.8.0)
23
+ rspec-core (~> 3.8.0)
24
+ rspec-expectations (~> 3.8.0)
25
+ rspec-mocks (~> 3.8.0)
26
+ rspec-core (3.8.2)
27
+ rspec-support (~> 3.8.0)
28
+ rspec-expectations (3.8.5)
29
+ diff-lcs (>= 1.2.0, < 2.0)
30
+ rspec-support (~> 3.8.0)
31
+ rspec-mocks (3.8.2)
32
+ diff-lcs (>= 1.2.0, < 2.0)
33
+ rspec-support (~> 3.8.0)
34
+ rspec-support (3.8.3)
35
+ rubocop (0.74.0)
36
+ jaro_winkler (~> 1.5.1)
37
+ parallel (~> 1.10)
38
+ parser (>= 2.6)
39
+ rainbow (>= 2.2.2, < 4.0)
40
+ ruby-progressbar (~> 1.7)
41
+ unicode-display_width (>= 1.4.0, < 1.7)
42
+ ruby-progressbar (1.10.1)
43
+ unicode-display_width (1.6.0)
44
+
45
+ PLATFORMS
46
+ ruby
47
+
48
+ DEPENDENCIES
49
+ excess_flow!
50
+ rspec (~> 3.8.0)
51
+ rubocop (~> 0.74.0)
52
+
53
+ BUNDLED WITH
54
+ 2.0.2
data/LICENSE.txt ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,174 @@
1
+ # ExcessFlow [![Build Status][ci-image]][ci] [![Code Climate][codeclimate-image]][codeclimate] [![Gem Version][version-image]][version]
2
+ ExcessFlow is a high precision Redis based rate limiter; it means that even with
3
+ hundreds and even thousands requests coming in all at once it will not allow an
4
+ occasional request slip over limit (causing potential race conditions or
5
+ unwanted extra invocations of your code).
6
+
7
+ Can be used with any Ruby or Ruby on Rails project. Can be used in any
8
+ distributed environment without any additional setup.
9
+
10
+ ## How it works
11
+ Once a request comes in ExcessFlow will setup a global mutex using Redis. Once
12
+ mutex is set up it will sort out your request's limits and see if it can be
13
+ fulfilled or you are over your quota. In either case mutex will be released and
14
+ ExcessFlow will continue either with execution of your code or return an
15
+ `ExcessFlow::FailedExecution` as a result.
16
+
17
+ This global mutex ensures that only one check for a limit can be active at a
18
+ time thus eliminating race conditions.
19
+
20
+ # Installation
21
+ Add the following line to your Gemfile:
22
+
23
+ ```
24
+ gem 'excess_flow'
25
+ ```
26
+ And run `bundle` from your shell.
27
+
28
+ To install gem manually run from your shell:
29
+
30
+ ```
31
+ gem install excess_flow
32
+ ```
33
+
34
+ ## Requirements
35
+ Only requirement to run this gem is [Redis](https://redis.io/). Other than that
36
+ it is not dependant on any other framework or system.
37
+
38
+ ## Configration
39
+ The only thing you need to set up is URL of your Redis server. You can do this
40
+ by either setting `EXCESS_FLOW_REDIS_URL` environment variable or by executing
41
+ following code during runtime. For Ruby on Rails create
42
+ `config/initializers/excess_flow.rb` file and put the following code in there:
43
+
44
+ ```
45
+ ExcessFlow.configure do |configuration|
46
+ configuration.redis_url = <REDIS_URL>
47
+ end
48
+ ```
49
+
50
+ There are two ways to configure ExcessFlow: using environment variables or
51
+ invoking configuration block during runtime.
52
+
53
+ Following settings are supported:
54
+
55
+ | Variable | Method | Settings |
56
+ | ------------- | ------------- | ------------- |
57
+ | `EXCESS_FLOW_CONNECTION_POOL` | `connection_pool` | Redis connection pool size to share amongst the fibers or threads in your Ruby. Defaults to `100`. |
58
+ | `EXCESS_FLOW_CONNECTION_TIMEOUT` | `connection_timeout` | How long to wait for a connection from connection pool to become available (in seconds). Defaults to `3`. |
59
+ | `EXCESS_FLOW_REDIS_URL` | `redis_url` | URL of your Redis server that will be used for caching. Defaults to `redis://localhost:6379/1`. |
60
+ | `EXCESS_FLOW_REDIS_SENTINELS` | `sentinels` | (optional) Comma separated list of Sentinels IPs for Redis. Defaults to `nil`. Example value: `8.8.8.8:42,8.8.4.4:42`. |
61
+
62
+ ## Usage
63
+ To rate limit your request simply wrap your code into `throttle` block:
64
+
65
+ ```
66
+ ExcessFlow.throttle(key: 'meaning_of_life', limit: 42, ttl: 42) do
67
+ 21 + 21
68
+ end
69
+ ```
70
+
71
+ This returns a `ExcessFlow::RateLimitedExecutionResult` class that wraps result
72
+ of execution of your code. If you need to know if request was within limit call
73
+ `success?` method on it. If you need to get access to result call `result`
74
+ method.
75
+
76
+ ```
77
+ execution = ExcessFlow.throttle(key: 'meaning_of_life', limit: 42, ttl: 42) do
78
+ 21 + 21
79
+ end
80
+ => #<ExcessFlow::RateLimitedExecutionResult:0x00005588c4c084e0 @result="42">
81
+
82
+ execution.success?
83
+ => true
84
+
85
+ execution.result
86
+ => 42
87
+ ```
88
+
89
+ If execution of your code was rate limited then `ExcessFlow::RateLimitedExecutionResult`
90
+ will hold `ExcessFlow::FailedExecution` as a result and `success?` method will
91
+ return false.
92
+
93
+ ```
94
+ execution = ExcessFlow.throttle(key: 'meaning_of_life', limit: 0, ttl: 42) do
95
+ 21 + 21
96
+ end
97
+ => #<ExcessFlow::RateLimitedExecutionResult:0x00005588c4c084e0
98
+ @result="#<ExcessFlow::FailedExecution:0x00005588c4c30350>">
99
+
100
+ execution.success?
101
+ => false
102
+
103
+ execution.result
104
+ => #<ExcessFlow::FailedExecution:0x00005588c4c30350>
105
+
106
+ ```
107
+
108
+ `throttle` method accepts 4 named arguments:
109
+
110
+ | Argument | Meaning |
111
+ | ------------- | ------------- |
112
+ | `key` | Name of window in which to keep requests that should be limited. |
113
+ | `ttl` | Time in seconds for which to keep a window open. |
114
+ | `limit` | Number of requests allowed to be done within single unique window. |
115
+ | `strategy` | (optional) Rate limiting strategy to use. Defaults to `:fixed_window`. Available options are `:fixed_window` and `:sliding_window`. |
116
+
117
+ ### Rate limiting strategies
118
+ Currently there are two strategies available: `:fixed_window` and
119
+ `:sliding_window`. If in doubt and don't know which one to use start with
120
+ `:fixed_window` as it is more lightweight and will guarantee you better
121
+ performance.
122
+
123
+ #### :fixed_window
124
+ Fixed window strategy allows you to make N requests in a O period of time. After
125
+ O time passes counter is re-set allowing you to make another N requests.
126
+
127
+ Think about a bucket that you can fill with pebbles. Once full you can no longer
128
+ add pebbles to it and has to wait for someone to come and empty it for you so
129
+ you can start filling it with pebbles again. Catch is that that someone comes
130
+ every O minutes to empty it.
131
+
132
+ #### :sliding_window
133
+ Sliding window strategy allows you to make N requests in a O period of time
134
+ where O is tracked for each request individually.
135
+
136
+ Think about bucket with pebbles again. This time someone is sitting right next
137
+ to you as you fill it and tracks time at which you put each individual pebble
138
+ in. Once O minutes is passed they remove the pebble out of bucket.
139
+
140
+ ## Development
141
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run
142
+ `rspec` to run the tests. You can also run `bin/console` for an interactive
143
+ prompt that will allow you to experiment.
144
+
145
+ To install this gem onto your local machine, run `bundle exec rake install`. To
146
+ release a new version, update the version number in `version.rb`, and then run
147
+ `bundle exec rake release`, which will create a git tag for the version, push
148
+ git commits and tags, and push the `.gem` file to
149
+ [rubygems.org](https://rubygems.org).
150
+
151
+ ## Contributing
152
+ Bug reports and pull requests are welcome on GitHub at
153
+ https://github.com/ConvertKit/excess_flow. This project is intended to be a
154
+ safe, welcoming space for collaboration, and contributors are expected to adhere
155
+ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
156
+
157
+ ## License
158
+ The gem is available as open source under the terms of the
159
+ [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
160
+
161
+ ## Code of Conduct
162
+ Everyone interacting in the ExcessFlow project’s codebases, issue
163
+ trackers, chat rooms and mailing lists is expected to follow the [code of
164
+ conduct](https://github.com/ConvertKit/excess_flow/blob/master/CODE_OF_CONDUCT.md).
165
+
166
+ [ci]: https://circleci.com/gh/ConvertKit/excess_flow
167
+ [ci-image]: https://circleci.com/gh/ConvertKit/excess_flow.svg?style=svg
168
+ [codeclimate]:
169
+ https://codeclimate.com/github/ConvertKit/excess_flow/maintainability
170
+ [codeclimate-image]:
171
+ https://api.codeclimate.com/v1/badges/f9ca3b6dda3b492b125e/maintainability
172
+ [version]: https://badge.fury.io/rb/excess_flow
173
+ [version-image]: https://badge.fury.io/rb/excess_flow.svg
174
+
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,12 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # frozen_string_literal: true
4
+
5
+ lib = File.expand_path('../lib', __dir__)
6
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
7
+
8
+ require 'bundler/setup'
9
+ require 'excess_flow'
10
+
11
+ require 'irb'
12
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ lib = File.expand_path('lib', __dir__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+
6
+ require 'excess_flow/constants'
7
+
8
+ Gem::Specification.new do |spec|
9
+ spec.name = 'excess_flow'
10
+ spec.version = ExcessFlow::VERSION
11
+ spec.authors = ['ConvertKit, LLC']
12
+ spec.email = ['engineering@convertkit.com']
13
+
14
+ spec.summary = 'Redis based rate limiter'
15
+ spec.description = 'Hihg precision simple redis based rate limiter.'
16
+ spec.license = 'Apache License Version 2.0'
17
+
18
+ spec.metadata['source_code_uri'] = 'https://github.com/ConvertKit/excess_flow'
19
+
20
+ spec.files = `git ls-files | grep -Ev '^(spec)'`.split("\n")
21
+
22
+ spec.executables = ['console']
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_dependency 'connection_pool'
26
+ spec.add_dependency 'rake'
27
+ spec.add_dependency 'redis'
28
+ end