ratelimit-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cf58e13eb3d3e2371dc2dd10833cf597d2ab108
+  data.tar.gz: 24eb31d4a576763298d489bfe6d11454f7c5eb8e
+SHA512:
+  metadata.gz: df86c38c7dd3b1c57f7ed345e245aac1b9962df2f831e2daab790b3c34bae842e9e75bd0e85d08c435e61c516a3f7ff94aba56283d5370cf380c8b464ae83e50
+  data.tar.gz: fcd2f9261d6c38bfc779055baac475b26e3a8fa5fe9d88f7a68aa7e28690f850286137ef0cd28c96fd32e9ad08c1ab711727971aec5ba5377ee115fe41fb5a0a

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.ruby-gemset

@@ -0,0 +1 @@
+ratelimit-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem 'faraday'
+gem 'faraday_middleware'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,87 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    concurrent-ruby (1.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    git (1.3.0)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashie (3.4.6)
+    highline (1.7.8)
+    i18n (0.7.0)
+    json (1.8.3)
+    juwelier (2.1.3)
+      builder
+      bundler (>= 1.13)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.6)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.1)
+    rake (11.3.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    semver (1.0.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  faraday
+  faraday_middleware
+  juwelier (~> 2.1.0)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Jeff Dwyer
+
+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,42 @@
+# ratelimit-ruby
+
+Rate Limit your Ruby app using http://www.ratelim.it
+
+```ruby
+limiter =  RateLimit::Limiter.new(apikey: "APIKEY", account_id: ACCT_ID)
+
+# only need to do this on startup
+# limit to 1 per hour
+limiter.upsert_limit(Limit.new("pageload", 1, RateLimIt::HOURLY_ROLLING))
+
+if limiter.check?("pageload")
+  do_hourly_thing()
+end
+```
+See full documentation http://www.ratelim.it/documentation
+
+## Supports
+
+* RateLimits
+* Millions of individual limits sharing the same policies
+* WebUI for tweaking limits
+* Logging
+* Semaphores
+* Infinite retention fo deduplication workflows
+
+
+## Contributing to ratelimit-ruby
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 Jeff Dwyer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "ratelimit-ruby"
+  gem.homepage = "http://github.com/jdwyah/ratelimit-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{rate limit your ruby}
+  gem.description = %Q{rate limit your ruby}
+  gem.email = "jdwyah@gmail.com"
+  gem.authors = ["Jeff Dwyer"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ratelimit-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ratelimit/limit_definition.rb

@@ -0,0 +1,24 @@
+module RateLimit
+  SECONDLY="SECONDLY".freeze
+  MINUTELY="MINUTELY".freeze
+  MINUTELY_ROLLING="MINUTELY_ROLLING".freeze
+  HOURLY="HOURLY".freeze
+  HOURLY_ROLLING="HOURLY_ROLLING".freeze
+  DAILY="DAILY".freeze
+  DAILY_ROLLING="DAILY_ROLLING".freeze
+  MONTHLY="MONTHLY".freeze
+  INFINITE="INFINITE".freeze
+  POLICIES = [SECONDLY, MINUTELY, MINUTELY_ROLLING, HOURLY, HOURLY_ROLLING, DAILY, DAILY_ROLLING, MINUTELY, INFINITE]
+
+  class LimitDefinition
+    attr_reader :limit, :group, :policy, :returnable
+
+    def initialize(group, limit, policy, returnable)
+      raise "Invalid Policy" unless POLICIES.include? policy
+      @limit = limit
+      @group = group
+      @policy = policy
+      @returnable= returnable
+    end
+  end
+end

data/lib/ratelimit-ruby.rb

@@ -0,0 +1,78 @@
+module RateLimit
+  class WaitExceeded < StandardError
+  end
+
+  class Limiter
+    def base_url(local)
+      local ? 'http://localhost:8080' : 'http://www.ratelim.it'
+    end
+
+    def initialize(apikey:, account_id:, local: false, debug: false)
+      @conn = Faraday.new(:url => self.base_url(local)) do |faraday|
+        faraday.request :json # form-encode POST params
+        faraday.response :logger if debug
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+      @conn.basic_auth(account_id, apikey)
+    end
+
+    def upsert_semaphore(group, limit, policy)
+      upsert(LimitDefinition.new(group, limit, policy, true))
+    end
+
+    def upsert_limit(group, limit, policy)
+      upsert(LimitDefinition.new(group, limit, policy, false))
+    end
+
+    def check?(group)
+      result = acquire(group, 1)
+      return result.passed
+    end
+
+    def acquire(group, acquire_amount, allow_partial_response: false)
+      result = @conn.post '/api/v1/limitcheck', { acquireAmount: acquire_amount,
+                                                  groups: [group],
+                                                  allowPartialResponse: allow_partial_response }.to_json
+      res =JSON.parse(result.body, object_class: OpenStruct)
+      res.amount ||= 0
+      res
+    end
+
+    def acquire_or_wait(key:, acquire_amount:, max_wait_secs:, init_backoff: 0)
+      start = Time.now
+      sleep = init_backoff
+      while Time.now - start < max_wait_secs
+        sleep(sleep)
+        res = acquire(key, acquire_amount)
+        if res.passed
+          return res
+        end
+        sleep += rand
+      end
+      raise RateLimit::WaitExceeded
+    end
+
+
+    def return(limit_result)
+      @conn.post '/api/v1/limitreturn',
+                 { enforcedGroup: limit_result.enforcedGroup,
+                   amount: limit_result.amount }.to_json
+      puts result.body
+    end
+
+    private
+
+    def upsert(limit_definition)
+      to_send = { limit: limit_definition.limit,
+                  group: limit_definition.group,
+                  policyName: limit_definition.policy,
+                  returnable: limit_definition.returnable }.to_json
+      result= @conn.post '/api/v1/limits', to_send
+    end
+  end
+
+end
+
+require 'faraday'
+require 'faraday_middleware'
+require 'ratelimit/limit_definition'

data/ratelimit-ruby.gemspec

@@ -0,0 +1,70 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: ratelimit-ruby 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "ratelimit-ruby"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jeff Dwyer"]
+  s.date = "2016-11-18"
+  s.description = "rate limit your ruby"
+  s.email = "jdwyah@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/ratelimit-ruby.rb",
+    "lib/ratelimit/limit_definition.rb",
+    "ratelimit-ruby.gemspec"
+  ]
+  s.homepage = "http://github.com/jdwyah/ratelimit-ruby"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "rate limit your ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<faraday_middleware>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: ratelimit-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Dwyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: shoulda
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: rate limit your ruby
+email: jdwyah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/ratelimit-ruby.rb
+- lib/ratelimit/limit_definition.rb
+- ratelimit-ruby.gemspec
+homepage: http://github.com/jdwyah/ratelimit-ruby
+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: rate limit your ruby
+test_files: []