rails_throttle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ac0a027c97f8d22db38bedc1700b9f0834475000d44dd23819296f32bfc8a1e
+  data.tar.gz: a6280ac0701ce08f4bb085608b9e834f509aedc414e9079d076c297fc99fb865
+SHA512:
+  metadata.gz: b2c92b80a09e7176a2e8d0179987484ce45f22eeb64e7b49d3943d15cfa735aed7836e1b4487574ce59423d5fead2ade6eb8711a169c4a0ac5cdd79a2ef00526
+  data.tar.gz: cdc44864b318e5c91655e4befc1b3bcecc8ae4d1ee9cd6cef638bea22099e22191bbd367ace6314b2993596d91176b39cda57ea7d15a5a3c8b7bbfae98e2c52f

data/.circleci/config.yml

@@ -0,0 +1,42 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.1-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            - v1-dependencies-
+
+      - run:
+          name: Install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Run tests
+          command: |
+            bundle exec rake test
+      
+      - run:
+          name: Rubocop
+          command:
+            bundle install rubocop
+            bundle exec rubocop
+ 
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,47 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/BlockLength:
+  Exclude:
+    - db/schema.rb
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - test/**/*.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Exclude:
+    - 'db/schema.rb'
+
+Lint/PercentStringArray:
+  Exclude:
+    - 'config/initializers/csp.rb'
+    
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_throttle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    rails_throttle (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    declarative_minitest (0.1.1)
+      minitest (>= 5.0)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  bundler (~> 1.17)
+  declarative_minitest (~> 0.1.1)
+  minitest (~> 5.0)
+  rails_throttle!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Peter Zhu
+
+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,57 @@
+# RailsThrottle
+
+RailsThrottle is a simple library used to throttle code in your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_throttle", "~> 0.1.0"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_throttle
+
+## Usage
+
+- See full documentation here: 
+- Example configuration (for production, you can configure other environments in a similar way):
+    ```ruby
+    # In config/environments/production.rb
+    RailsThrottle.backend = ActiveSupport::Cache::RedisStore.new "localhost:6379/0"
+
+    # Alternatively, also supports any of the other caching strategies of ActiveSupport::Cache.
+    # For details, see https://api.rubyonrails.org/classes/ActiveSupport/Cache.html.
+    ```
+- Example usage:
+    ```ruby
+    RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => 1
+    RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => 2
+    RailsThrottle::Throttle.decrement("foo", limit: 4, period: 2.seconds) # => 1
+    RailsThrottle::Throttle.reset("foo")
+    RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds, increment: 4) # => 4
+    RailsThrottle::Throttle.increment("foo", limit: 4, period: 2.seconds) # => RailsThrottle::ThrottleError
+    RailsThrottle::Throttle.throttled?("foo", limit: 5) # => true
+
+    # ... wait 2 seconds ...
+
+    RailsThrottle::Throttle.throttled?("foo", limit: 5) # => false
+    ```
+
+## Development
+
+Just the usual clone and `bundle` to install dependencies. Run `rake test` to run tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/peterzhu2118/rails_throttle.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_throttle"
+
+# 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/lib/rails_throttle/throttle.rb

@@ -0,0 +1,92 @@
+module RailsThrottle
+  class Throttle
+    # Increments the counter for a given key.
+    #
+    # @param [String] key The key that uniquely identifies this throttle operation.
+    # @param [Hash] options The options to this increment.
+    # @option options [Integer] :increment The amount to increment the counter by, defaults to 1 if not provided.
+    # @option options [Integer] :limit The maximum value the key can take before it is throttled (i.e. this key will
+    #   be throttled once exceeded this limit).
+    # @option options [Integer] :period The period of time (in seconds) which this throttle applies, the throttle will
+    #   expire after this number of seconds.
+    # @yield [key, value] Yields up to two parameters (you can choose whether you want zero, one, or two of these
+    #   parameters).
+    # @yieldparam [String] key The key that was passed in.
+    # @yieldparam [Integer] value The current value of the throttle counter.
+    # @return [Integer] The current value of the throttle counter.
+    def self.increment(key, options = {}, &block)
+      raise "Key cannot be blank" if key.blank?
+
+      increment = options[:increment] || 1
+      limit = options[:limit]
+      period = options[:period]
+
+      raise "Must specify :limit in the parameters" if limit.nil?
+      raise "Must specify :period in the parameters" if period.nil?
+
+      value = RailsThrottle.backend.increment(key, increment)
+
+      if value.nil?
+        RailsThrottle.backend.write(key, increment, expires_in: period)
+
+        value = increment
+      elsif value > limit
+        raise RailsThrottle::ThrottleError, "Limit exceeded for key `#{key}` with limit of #{limit}"
+      end
+
+      unless block.nil?
+        if block.arity.zero?
+          block.call
+        elsif block.arity == 1
+          block.call(key)
+        else
+          block.call(key, value)
+        end
+      end
+
+      value
+    end
+
+    # Decrements the counter for a given key.
+    #
+    # @param [String] key The key that uniquely identifies this throttle operation.
+    # @param [Hash] options The options to this increment.
+    # @option options [Integer] :decrement The amount to decrement the counter by, defaults to 1 if not provided.
+    # @return [Integer] The current value of the throttle counter.
+    def self.decrement(key, options = {})
+      raise "Key cannot be blank." if key.blank?
+
+      decrement = options[:decrement] || 1
+
+      RailsThrottle.backend.decrement(key, decrement)
+    end
+
+    # Returns true if the key is throttled, false otherwise.
+    #
+    # @param [String] key The key that uniquely identifies this throttle operation.
+    # @param [Hash] options The options to this increment.
+    # @option options [Integer] :limit The maximum value the key can take before it is throttled (i.e. this key will
+    #   be throttled once exceeded this limit).
+    # @return [Boolean] True if the key is throttled, false otherwise.
+    def self.throttled?(key, options = {})
+      raise "Key cannot be blank." if key.blank?
+
+      limit = options[:limit]
+
+      raise "Must specify :limit in the parameters" if limit.nil?
+
+      value = RailsThrottle.backend.read(key) || 0
+
+      value >= limit
+    end
+
+    # Resets a key so that it is no longer throttled.
+    #
+    # @param [String] key The key that uniquely identifies this throttle operation.
+    def self.reset(key)
+      raise "Key cannot be blank." if key.blank?
+
+      RailsThrottle.backend.delete(key)
+    end
+  end
+end

data/lib/rails_throttle/version.rb

@@ -0,0 +1,3 @@
+module RailsThrottle
+  VERSION = "0.1.0".freeze
+end

data/lib/rails_throttle.rb

@@ -0,0 +1,16 @@
+require "active_support/cache"
+
+require "rails_throttle/version"
+require "rails_throttle/throttle"
+
+module RailsThrottle
+  mattr_accessor :backend
+
+  class ThrottleError < StandardError
+    def initialize(message = nil)
+      super(message)
+    end
+  end
+end
+
+RailsThrottle.backend ||= ActiveSupport::Cache::MemoryStore.new

data/rails_throttle.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_throttle/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_throttle"
+  spec.version       = RailsThrottle::VERSION
+  spec.authors       = ["Peter Zhu"]
+  spec.email         = ["peter@peterzhu.ca"]
+
+  spec.summary       = "Throttle code in your Rails application."
+  spec.homepage      = "https://github.com/peterzhu2118/rails_throttle"
+  spec.license       = "MIT"
+
+  # 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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "declarative_minitest", "~> 0.1.1"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rails_throttle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Zhu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: declarative_minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- peter@peterzhu.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_throttle.rb
+- lib/rails_throttle/throttle.rb
+- lib/rails_throttle/version.rb
+- rails_throttle.gemspec
+homepage: https://github.com/peterzhu2118/rails_throttle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Throttle code in your Rails application.
+test_files: []