clock-limiter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5721871b91f6bb4cfb4c8210ccbb86ce2629891da8b306a7d7432a851a59d6c9
+  data.tar.gz: 8f896c8d5d655f2cdd5316dd6e5f94524ffff3aaa74dabe53b7e9e34225fb4dd
+SHA512:
+  metadata.gz: 0d4151bdde7cfb130e6476355466ce364725d9a992d1c8c8e452e4ec3f652c83efeebd61c1c0d7490b04ec2abae1723137ae2223ced2a069e09e96f5b9cb509d
+  data.tar.gz: 84d0701c8e1ade8f8fa4b4ff81a2f091e4b2a769e3c73cc1ede63505d6a1b06a799d79b31d198408924108e6b3481c9723ae7f7dcb25bbe61a1cc8aa4e9a4b22

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.1", "3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test

data/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish gem
+
+on:
+  # Manually publish
+  workflow_dispatch:
+  # Alternatively, publish whenever a tag occurs.
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: 2.7
+      - run: bundle install
+
+      - name: Publish to GPR
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/rubocop.yml

@@ -0,0 +1,15 @@
+name: Rubocop
+
+on: [push]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: 2.7
+      - run: gem install rubocop
+      - name: Rubocop
+        run: rubocop

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# General config to enable every `Pendent` cop
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [v1.0.0](https://github.com/leadsimple/clock-limiter/tree/v1.0.0) (2023-07-21)
+
+First Release :tada:!

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 rafaeelaudibert@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,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'fakeredis', '~> 0.9'
+  gem 'minitest', '~> 5.0'
+  gem 'rake', '~> 12.0'
+end
+
+# Specify your gem's dependencies in clock-limiter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Rafael Baldasso Audibert
+
+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,128 @@
+# Clock::Limiter
+
+Clock-based rate limiter which resets when the clock second/minute/etc. changes.
+
+This is useful when you are having to deal with a third-party who implemented rate limits which reset when the minute or hour changes instead of having implemented it as a floating 60-second or 60-minute, respectively, window.
+
+## How it works
+
+By setting keys in Redis keeping track of the current second/minute/etc in a carefully crafted key, we can guarantee we are using the current bucket (second, minute, etc.) at any time.
+
+These keys are set to automatically expire in the future. They will stick around for at most the amount of time of the category they belong too, i.e. if it's a minute period, then the key will last for at most one minute in Redis. See [Periods](#periods)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clock-limiter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install clock-limiter
+
+This gem requires Ruby >= 2.5.
+
+## Usage
+
+First, you should configure this in a initializer such as `initializers/clock_limiter.rb`
+
+```ruby
+Clock::Limiter.configure do |config|
+  config.redis = Redis.new               # Must be something that implements `#get` and `#expire`
+  config.time_provider = -> { Time.now } # Must return a Time instance
+end
+```
+
+Then, you can include it in a class like so
+
+```ruby
+class Limited
+  include Clock::Limiter
+
+  add_clock_limit(period: Clock::Limiter::Period::MINUTE, limit: 10)
+  add_clock_limit(period: Clock::Limiter::Period::SECOND, limit: 2)
+
+  on_clock_limit_failure do |limit|
+    puts "Limit #{limit} reached!"
+  end
+
+  def call
+    with_clock_limiter do
+      puts 'CALLED'
+    end
+  end
+end
+```
+
+You can then try it by calling the `#call` instance method repeatedly in less than a second.
+
+```ruby
+limited = Limited.new
+
+limited.call # CALLED
+limited.call # CALLED
+limited.call # Limit Clock::Limiter::Period::SECOND reached!
+```
+
+The limit will be global across the `Limited` class.
+
+### Periods
+
+The available periods are
+
+- `Clock::Limiter::Period::SECOND`, where the key lasts for at most 1 second
+- `Clock::Limiter::Period::MINUTE`, where the key lasts for at most 1 minute
+- `Clock::Limiter::Period::HOUR`, where the key lasts for at most 1 hour
+- `Clock::Limiter::Period::DAY`, where the key lasts for at most 24 hours
+- `Clock::Limiter::Period::MONTH`, where the key lasts for at most 31 days
+- `Clock::Limiter::Period::YEAR`, where the key lasts for at most 366 days
+
+### Advanced Usage
+
+`with_clock_limiter` accepts an optional argument called `custom_key` which can be used if you don't want the rate limit to be global across the class, but want it to be based on a specific key instead - if you have different rate limits, for different accounts, this might be what you need.
+
+```ruby
+class Limited
+  include Clock::Limiter
+
+  add_clock_limit(period: Clock::Limiter::Period::MINUTE, limit: 10)
+
+  on_clock_limit_failure do |limit, key|
+    puts "Limit #{limit} for key #{key} reached!"
+  end
+
+  def call
+    with_clock_limiter("KEY_1") do
+      puts 'CALLED'
+    end
+
+    with_clock_limiter("KEY_2") do
+      puts 'CALLED 2'
+    end
+  end
+end
+```
+
+## 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/[USERNAME]/clock-limiter. 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/[USERNAME]/clock-limiter/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 Clock::Limiter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clock-limiter/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 'clock/limiter'
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/clock-limiter.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/clock/limiter/version'
+
+Gem::Specification.new do |spec| # rubocop:disable Gemspec/RequireMFA because we want to deploy this through the GitHub Actions workflow
+  spec.name          = 'clock-limiter'
+  spec.version       = Clock::Limiter::VERSION
+  spec.authors       = ['Rafael Baldasso Audibert']
+  spec.email         = ['engineering+clock-limiter@leadsimple.com']
+
+  spec.summary       = 'Clock-based rate limiter which resets when the clock second/minute/etc. changes.'
+  spec.homepage      = 'https://github.com/leadsimple/clock-limiter'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/leadsimple/clock-limiter'
+  spec.metadata['changelog_uri'] = 'https://github.com/leadsimple/clock-limiter/blob/master/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']
+end

data/lib/clock/limiter/configuration.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module Clock
+  module Limiter
+    class Configuration
+      class ConfigurationError < StandardError; end
+
+      # We want to guarantee we are only using valid Redis instances.
+      # We could restrict to a `::Redis` instance, but that's not always
+      # worth it, because we might need to use a Redis client that is not
+      # a `::Redis` instance - such as `MockRedis` for example
+      def self.valid_redis?(redis)
+        redis.respond_to?(:incr) && redis.respond_to?(:expire)
+      end
+
+      # @param redis [::Redis-like]
+      def redis=(redis)
+        raise ConfigurationError, '`redis` must implement `#incr` and `#expire`' unless self.class.valid_redis?(redis)
+
+        @redis = redis
+      end
+
+      # @return [::Redis-like]
+      def redis
+        raise ConfigurationError, 'Redis not configured' if @redis.nil?
+
+        @redis
+      end
+
+      # @param time_provider [Proc]
+      def time_provider=(time_provider)
+        raise ConfigurationError, '`time_provider` must be a Proc' unless time_provider.is_a?(Proc)
+
+        @time_provider = time_provider
+      end
+
+      # @return [Proc]
+      def time_provider
+        raise ConfigurationError, 'Time provider not configured' if @time_provider.nil?
+
+        @time_provider
+      end
+
+      # @param fail_with_empty_limits [Boolean]
+      def fail_with_empty_limits=(fail_with_empty_limits)
+        unless [true, false].include?(fail_with_empty_limits)
+          raise ConfigurationError, '`fail_with_empty_limits` must be a boolean'
+        end
+
+        @fail_with_empty_limits = fail_with_empty_limits
+      end
+
+      # @return [Boolean] - true by default
+      def fail_with_empty_limits?
+        return @fail_with_empty_limits unless @fail_with_empty_limits.nil?
+
+        true
+      end
+    end
+  end
+end

data/lib/clock/limiter/limit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Clock
+  module Limiter
+    Limit = Struct.new(:period, :limit, keyword_init: true) do
+      def initialize(period:, limit:)
+        raise Clock::Limiter::Period::InvalidError, period unless Period::VALID_PERIODS.include?(period)
+
+        super
+      end
+    end
+  end
+end

data/lib/clock/limiter/limiter.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Clock
+  module Limiter
+    class NoLimitsError < StandardError
+      def initialize
+        super('At least one limit must be set')
+      end
+    end
+
+    # Configure the singleton instance of this class.
+    class << self
+      # Instantiate the Configuration singleton or return it.
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # This is the configure block definition.
+      # The configuration method will return the
+      # Configuration singleton, which is then yielded
+      # to the configure block.
+      def configure
+        yield(configuration)
+      end
+
+      def included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        attr_reader :clock_limits, :on_clock_limit_failure_block
+
+        # Adds a new value to the `clock_limits` array which will be used to check if
+        # the limit has been reached or not.
+        #
+        # @param [Clock::Limiter::Period] period
+        # @param [Integer] limit
+        def add_clock_limit(period:, limit:)
+          @clock_limits ||= []
+          @clock_limits << Limit.new(period: period, limit: limit)
+        end
+
+        # Sets the block that will be called when the limit has been reached.
+        #
+        # @param [Proc] block
+        def on_clock_limit_failure(&block)
+          @on_clock_limit_failure_block = block
+        end
+      end
+    end
+
+    # Runs the block if the limit has not been reached. If the limit has been
+    # reached, the block set with `on_clock_limit_failure` will be called.
+    # If no limits have been set, a `NoLimitsError` will be raised.
+    # If the limit has been reached, the block set with `on_clock_limit_failure` will
+    # be called.
+    # If the limit has not been reached, the block passed to this method will
+    # be called.
+    #
+    # @param [String] custom_key Custom key if this limit is not global to the class
+    # @yield
+    # @return [Object] The return value of the block passed to this method
+    # @raise [NoLimitsError] If no limits have been set
+    # @raise [Clock::Limiter::Period::InvalidError] If an invalid period has been set
+    def with_clock_limiter(custom_key = self.class.name)
+      raise NoLimitsError if fail_with_empty_limits?
+
+      self.class.clock_limits&.each do |limit|
+        next if within_limit?(limit, custom_key)
+
+        return self.class.on_clock_limit_failure_block&.call(limit, custom_key)
+      end
+
+      yield
+    end
+
+    private
+
+    def fail_with_empty_limits?
+      Clock::Limiter.configuration.fail_with_empty_limits? &&
+        (self.class.clock_limits.nil? || self.class.clock_limits.empty?)
+    end
+
+    # Increments the value of the key and returns true if the limit has not
+    # been reached. If the limit has been reached, false will be returned.
+    #
+    # @param [Clock::Limiter::Limit] limit
+    # @param [String] custom_key
+    def within_limit?(limit, custom_key)
+      key, ttl = key_and_ttl(limit, custom_key)
+
+      value = Clock::Limiter.configuration.redis.incr(key)
+      return false if value > limit.limit
+
+      # If value was first set, then set expiration
+      Clock::Limiter.configuration.redis.expire(key, ttl) if value == 1
+
+      true
+    end
+
+    # Returns the key and ttl for the given limit and group key.
+    #
+    # @param [Clock::Limiter::Limit] limit
+    # @param [String] custom_key
+    def key_and_ttl(limit, custom_key) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      case limit.period
+      when Period::SECOND
+        [key(limit.period, custom_key), 1]
+      when Period::MINUTE
+        [key(limit.period, custom_key), 60] # 1 * 60
+      when Period::HOUR
+        [key(limit.period, custom_key), 3_600] # 1 * 60 * 60
+      when Period::DAY
+        [key(limit.period, custom_key), 86_400] # 1 * 60 * 60 * 24
+      when Period::MONTH
+        [key(limit.period, custom_key), 2_678_400] # 1 * 60 * 60 * 24 * 31 (worst case, 31 days)
+      when Period::YEAR
+        [key(limit.period, custom_key), 31_622_400] # 1 * 60 * 60 * 24 * 366 (worst case, 366 days)
+      else
+        raise Period::InvalidError(limit.period)
+      end
+    end
+
+    # Returns the key for the given period and group key.
+    #
+    # @param [Clock::Limiter::Period] period
+    # @param [String] custom_key
+    def key(period, custom_key)
+      "clock-limiter:#{custom_key}:#{period}:#{current_period(period)}"
+    end
+
+    # Returns the current period for the given period.
+    # i.e. if the period is Period::SECOND, then we'll return the current second
+    # according to the [Clock::Limiter::Configuration#time_provider]
+    #
+    # @param [Clock::Limiter::Period] period
+    def current_period(period) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      case period
+      when Period::SECOND
+        Clock::Limiter.configuration.time_provider.call.sec
+      when Period::MINUTE
+        Clock::Limiter.configuration.time_provider.call.min
+      when Period::HOUR
+        Clock::Limiter.configuration.time_provider.call.hour
+      when Period::DAY
+        Clock::Limiter.configuration.time_provider.call.day
+      when Period::MONTH
+        Clock::Limiter.configuration.time_provider.call.month
+      when Period::YEAR
+        Clock::Limiter.configuration.time_provider.call.year
+      else
+        raise Period::InvalidError(period)
+      end
+    end
+  end
+end

data/lib/clock/limiter/period.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Clock
+  module Limiter
+    module Period
+      SECOND = :second
+      MINUTE = :minute
+      HOUR = :hour
+      DAY = :day
+      MONTH = :month
+      YEAR = :year
+
+      VALID_PERIODS = [SECOND, MINUTE, HOUR, DAY, MONTH, YEAR].freeze
+
+      class InvalidError < StandardError
+        attr_reader :period
+
+        def initialize(period)
+          @period = period
+          super("Invalid period #{period}. Valid periods: #{VALID_PERIODS}")
+        end
+      end
+    end
+  end
+end

data/lib/clock/limiter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Clock
+  module Limiter
+    VERSION = '1.0.0'
+  end
+end

data/lib/clock/limiter.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'clock/limiter/version'
+require 'clock/limiter/configuration'
+require 'clock/limiter/period'
+require 'clock/limiter/limit'
+require 'clock/limiter/limiter'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: clock-limiter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafael Baldasso Audibert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-24 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- engineering+clock-limiter@leadsimple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/rubocop.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clock-limiter.gemspec
+- lib/clock/limiter.rb
+- lib/clock/limiter/configuration.rb
+- lib/clock/limiter/limit.rb
+- lib/clock/limiter/limiter.rb
+- lib/clock/limiter/period.rb
+- lib/clock/limiter/version.rb
+homepage: https://github.com/leadsimple/clock-limiter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leadsimple/clock-limiter
+  source_code_uri: https://github.com/leadsimple/clock-limiter
+  changelog_uri: https://github.com/leadsimple/clock-limiter/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Clock-based rate limiter which resets when the clock second/minute/etc. changes.
+test_files: []