simple-throttle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64857d974825a0acfc9ea727baa6677cb65bc259
+  data.tar.gz: 82873bafc96d5958a22240c2314eed21f7880368
+SHA512:
+  metadata.gz: ecee0e9ed26d1f6a21721b94651681cb4afc38315ac6ac03082fccc0c9a2d460c2ab74707bfacd2fbe1ac9fdec5461f1131c76be467f9f20f11d83d02f6ee8a2
+  data.tar.gz: be1e90d260664b00b8b84e69bb0907578b1ee3f8a09012f09f416e08c585998b3d85a3b25b324b42a360a6f4665f4b57a806c06550d715009e4a5dd93448ec87

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-throttle.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Throttle
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-throttle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-throttle
+
+## Usage
+
+```ruby
+@throttle = Throttle.per_hour(1) #allow one call per hour
+@throttle.run { puts 'Hello World!' } #executes immediately
+@throttle.run { puts 'Hello World!' } #sleeps for 1 hour before executing.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/simple-throttle.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple/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

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/throttle/time_window/runner.rb

@@ -0,0 +1,41 @@
+module Throttle
+  module TimeWindow
+    ##
+    # Executes at most a number of times within given time window.
+    #
+    class Runner
+      # Parameters:
+      # +wait_s+: minimum number os seconds between +count+ block invocations
+      # +count+: maximum number of times block may be called between +wait_s+ seconds
+      def initialize(wait_s, count, sleep = ->(seconds) { sleep seconds })
+        @max = count
+        @last = 0.0 #last invocation timestamp
+        @count = 0
+        @wait_s = wait_s.to_f
+        @sleep = sleep
+      end
+
+      # Run given +block+ either immediately (if allowed) or after sleep.
+      def run(&block)
+        #puts "count: #{@count}, delta: #{Time.now.to_f - @last}"
+        now = Time.now.to_f
+        delta = now - @last
+        if delta >= @wait_s
+          #puts "resetting"
+          @last = now
+          @count = 0
+        end
+
+        if @count >= @max
+          sleep_interval = @wait_s - delta
+          #puts "throttle forced sleep for #{sleep_interval}"
+          @sleep.call sleep_interval
+        end
+
+        @count += 1
+        #puts "running "
+        yield
+      end
+    end
+  end
+end

data/lib/throttle/version.rb

@@ -0,0 +1,3 @@
+module Throttle
+  VERSION = "0.0.1".freeze
+end

data/lib/throttle.rb

@@ -0,0 +1,17 @@
+require "throttle/version"
+require "throttle/time_window/runner"
+
+module Throttle
+
+  HOUR_SECONDS = 3600
+  DAYS_SECONDS = 24 * HOUR_SECONDS
+
+  def self.per_hour(count)
+    TimeWindow::Runner.new(HOUR_SECONDS, count)
+  end
+
+  def self.per_day(count)
+    TimeWindow::Runner.new(DAYS_SECONDS, count)
+  end
+end
+

data/simple-throttle.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'throttle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-throttle"
+  spec.version       = Throttle::VERSION
+  spec.authors       = ["Alexandre Maia"]
+  spec.email         = ["alexandre.maia@gmail.com"]
+  spec.summary       = %q{Limit amount of executions with time windows.}
+  spec.homepage      = "https://www.github.com/cxz/simple-throttle"
+  spec.license          = %q{MIT}
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: simple-throttle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandre Maia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alexandre.maia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/throttle.rb
+- lib/throttle/time_window/runner.rb
+- lib/throttle/version.rb
+- simple-throttle.gemspec
+homepage: https://www.github.com/cxz/simple-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.5.1
+signing_key: 
+specification_version: 4
+summary: Limit amount of executions with time windows.
+test_files: []