run_no_mo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25ea1d8b1acba1a0d62306275ea7cdc268f19b93
+  data.tar.gz: 0e3e346d46ac9f00eea24cb02d7da60589967de1
+SHA512:
+  metadata.gz: 82867323afaf5efb93c651d1a655016d6b631181f51cf48df9f88b378143cae38759cf36ae6f54ac8a289a680a47c257175b9cee71e0d60ed90f829886b3e3cc
+  data.tar.gz: 3b323d6363bdf3b0c9e287bf66b3b595ee8e9773e6519c9a146584eefeafea25b9de5e8791918011c18a97d0fefd9b49cca4a0331d59525f313fc63b84d3c6fe

data/.gitignore

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

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 run_no_mo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    run_no_mo (1.0.0)
+      activesupport (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (13.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  run_no_mo!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joel Bandi
+
+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,93 @@
+# RunNoMo
+
+Helps you rate limit the execution of code!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'run_no_mo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install run_no_mo
+
+## Usage (look at the test files for usage)
+
+```ruby
+require "test_helper"
+
+class RunNoMoTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::RunNoMo::VERSION
+  end
+
+  def test_limiter_limits__count
+    #  create a limiter using factory
+    limiter = RunNoMo.limit times: 5, raises: true
+    
+    # run 4 times
+    4.times do
+      limiter.run { noop }
+    end
+
+    # run 1 more time
+    limiter.run { noop }
+    
+    # run once again NO-MO
+    assert_raises RunNoMo::LimitExceeded do
+      # does not get executed
+      limiter.run { noop }
+    end
+  end
+
+  def test_limiter__limiters__count__within
+    limiter = RunNoMo::limit times: 2, within: 3.seconds, raises: true
+
+    assert_raises RunNoMo::LimitExceeded do
+      3.times do
+        limiter.run { noop }
+      end
+    end
+
+    limiter = RunNoMo::limit times: 2, within: 1.second, raises: true
+
+    3.times do
+      limiter.run { sleep 1 }
+    end
+  end
+
+  def test_limiter_no_throw
+    limiter = RunNoMo::limit times: 3
+
+    count = 0
+
+    5.times do
+      limiter.run { count += 1 }
+    end
+
+    assert_equal 3, count
+  end
+
+  private
+
+  def noop; 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).
+
+## 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 "run_no_mo"
+
+# 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/run_no_mo.rb

@@ -0,0 +1,9 @@
+require "run_no_mo/version"
+require "run_no_mo/limiter"
+require "active_support/all"
+
+module RunNoMo
+  def self.limit(times:, within: nil, raises: false)
+    Limiter.new(times: times, within: within, raises: raises)
+  end
+end

data/lib/run_no_mo/limiter.rb

@@ -0,0 +1,45 @@
+module RunNoMo
+  class LimitExceeded < StandardError; end
+
+  class Limiter
+    def initialize(times:, within:, raises:)
+      @times = times
+      @count = 0
+
+      @within = within
+      @last_run = nil
+
+      @raises = raises
+    end
+
+    def run(&block)
+      if reset_counter?
+        @count = 0
+      else
+        @count+= 1
+      end
+
+      @last_run = Time.now
+
+      return limit_exceeded! if @count > @times
+      
+      block.call
+    end
+
+    private
+
+    def limit_exceeded!
+      raise LimitExceeded.new if @raises
+    end
+
+    def reset_counter?
+      return false if @within.nil?
+
+      return false if @last_run.nil?
+
+      return false if (Time.now - @last_run) < @within
+
+      true
+    end
+  end
+end

data/lib/run_no_mo/version.rb

@@ -0,0 +1,3 @@
+module RunNoMo
+  VERSION = "1.0.0"
+end

data/run_no_mo.gemspec

@@ -0,0 +1,24 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "run_no_mo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "run_no_mo"
+  spec.version       = RunNoMo::VERSION
+  spec.authors       = ["Joel Bandi"]
+  spec.email         = ["joelvivekbandi@gmail.com"]
+  spec.license       = "MIT"
+  spec.summary       = "Rate limit execution of code."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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', '~> 5.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: run_no_mo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joel Bandi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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'
+description: 
+email:
+- joelvivekbandi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/run_no_mo.rb
+- lib/run_no_mo/limiter.rb
+- lib/run_no_mo/version.rb
+- run_no_mo.gemspec
+homepage: 
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Rate limit execution of code.
+test_files: []