base on Simple Ruby rate limiting mechanism. # Limiter [](https://github.com/Shopify/limiter/actions/workflows/ci.yml) This gem implements a simple mechanism to throttle or rate-limit operations in Ruby. ## Installation Add this line to your application's Gemfile: ```ruby gem 'ruby-limiter' ``` And then execute: $ bundle Or install it yourself as: $ gem install ruby-limiter ## Usage ### Basic Usage To rate limit calling an instance method, a mixin is provided. Simply specify the method to be limited, and the maximum rate that the method can be called. This rate is (by default) a number of requests per minute. ``` ruby class Widget extend Limiter::Mixin # limit the rate we can call tick to 300 times per minute # when the rate has been exceeded, a call to tick will block until the rate limit would not be exceeded limit_method :tick, rate: 300 ... end ``` To specify the rate in terms of an interval shorter (or longer) than 1 minute, an optional `interval` parameter can be provided to specify the throttling period in seconds. ``` ruby class Widget extend Limiter::Mixin # limit the rate we can call tick to 5 times per second # when the rate has been exceeded, a call to tick will block until the rate limit would not be exceeded # and the provided block will be executed limit_method(:tick, rate: 5, interval: 1) do puts 'Limit reached' end ... end ``` #### Load balancing By default all calls to the `limit_method` will be bursted, e.g. as quick as possible, until the rate is exceeded. Then we wait for the remainder of the interval to continue. To even out the burst, an optional `balanced` parameter can be provided to enable interleaving between the method calls, e.g: `interleave = interval / size`. ``` ruby ... limit_method :tick, rate: 60, balanced: true ... ``` For example: with an interval of 60 seconds and a rate of 60: `balanced: false` : As quickly as possible we call the method 60 times, then we wait for the remainder of the time. `balanced: true` : We interleave each call with 1 second so we call this method every second. #### Resetting a rate-limited method There are times when it may be necessary to reset the rate limiter for a method, for example during testing. This can be done by calling `reset_method_limit!` on the class, where "method" is replaced with the name of the method being limited. Given the example above, the following would reset the rate limit for the `tick` method during test setup: ``` ruby class WidgetTest < Minitest::Test def setup Widget.reset_tick_limit! end ... end ``` ### Advanced Usage In cases where the mixin is not appropriate the `RateQueue` class can be used directly. As in the mixin examples above, the `interval` parameter is optional (and defaults to 1 minute). It is also possible to provide the block to `RateQueue`, which will be executed on each limit hit (useful for metrics). ``` ruby class Widget def initialize # create a rate-limited queue which allows 10000 operations per hour @queue = Limiter::RateQueue.new(10000, interval: 3600) do puts "Hit the limit, waiting" end end def tick # this operation will block until less than 10000 shift calls have been made within the last hour @queue.shift # do something end end ``` #### Resetting a RateQueue In some circumstances it may be desirable to reset a rate queue, for example after invoking an API that resets an external rate limit. This can be done by calling `reset` on the queue. ``` ruby ... @queue.reset ... ``` ## 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/Shopify/limiter. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). ", Assign "at most 3 tags" to the expected json: {"id":"4583","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"