Unthrottle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07bba615b8615a79a3b6980846713a150cf42d93
+  data.tar.gz: 9b2a1940c67ff22e17b226e9751477af87990a68
+SHA512:
+  metadata.gz: 2fa655776bf9d8811ed294006632911ceb69ed27322f56f70e05f74e161490fd468752f601e9b0a7719fedce1e4777799f6dd37e51f7e1e6e0eeddc66cbf2cfb
+  data.tar.gz: 8e7644469c1d06378da77a14e73889da09d0909a665f2a52e6f571322d6dce795395abb2911298a20cd64c0e3a7834d5165b07dd6f52087cbb1b283392caf4fb

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shishir Sharma
+
+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,61 @@
+# Unthrottle
+
+Centralized rate limiting for ruby processes shareing a single API using Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unthrottle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unthrottle
+
+## Usage
+
+```ruby
+    require 'unthrottle'
+
+    Unthrottle.configure do |config|
+      config.host = "localhost"
+      config.port = "6379"
+      config.db = "test"
+
+      config.key = "google_geocoding_api"
+      config.rate_limit_time = 3 # Millisecs
+      config.limit = 3           # Number of api call during timeout
+
+      config.logger = Logger.new(STDOUT)
+    end
+
+    Unthrottle.api(:timeout => 10) {
+       #<Your method call>
+    }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, 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` to create a git
+tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/shishirsharma/Unthrottle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/Unthrottle.rb

@@ -0,0 +1,85 @@
+require 'unthrottle/version'
+require 'redis'
+require 'timeout'
+
+module Unthrottle
+  class Configuration
+    attr_accessor :redis, :host, :port, :db,
+                  :key, :rate_limit_time, :limit,
+                  :logger,
+                  :log_level
+
+    def initialize
+      @host = 'localhost'
+      @port = 6379
+      @db = 'test'
+
+      # Key name => time out in sec
+      @key = :global            # Api key name
+      @rate_limit_time = 60     # Expire time for this key
+      @limit = 10               # Api call limit in timeout periode
+      @log_level = Logger::INFO
+    end
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def configure
+    @config ||= Configuration.new
+    yield(config) if block_given?
+    # Create a redis connection if not provided with
+    @config.redis ||=
+      Redis.new(host: config.host, port: config.port,
+                db: config.db)
+    @config.logger ||= Logger.new(STDOUT)
+    @config.logger.level = @config.log_level
+  end
+
+  # Register an Api Call in redis
+  #
+  # @param key Api key name to register call with
+  # @return current count of this key
+  def register_api_call(key)
+    keyname = "Unthrottle:#{key}".to_sym # Puting key names in a namespace
+    rate_limit_time = @config.rate_limit_time
+    # This can possibly return nil and integer
+    count = @config.redis.get(keyname).to_i
+    # Run it as a redis transaction
+    @config.redis.multi do |redis|
+      redis.incr(keyname)
+      # Set expire if this is a first time we call api
+      if count == 0
+        redis.expire(keyname, rate_limit_time)
+      end
+    end
+
+    return count + 1
+  end
+
+  # Run an api with rate limit
+  #
+  # @param [Hash] opts input options
+  # @options opts [Integer] :timeout milli seconds to wait before you retry api
+  def api(timeout: 60)
+    sleep_time = 100/1000.0     # 100 millisecs
+    Timeout::timeout(timeout) do # secs
+      loop do
+        count = self.register_api_call(@config.key)
+        @config.logger.debug("Attempt api with #{count}")
+        if count <= @config.limit
+          @config.logger.debug("Going through with #{count}")
+          yield                 # Call the block provided
+          return
+        end
+        @config.logger.info("Rate limit hit! going to sleep with #{sleep_time}")
+        sleep(sleep_time)       # milli secs
+        # Geometric sleep progression for now
+        sleep_time += sleep_time
+      end
+    end
+  end
+
+  module_function :configure, :register_api_call, :api
+end

data/lib/unthrottle/version.rb

@@ -0,0 +1,3 @@
+module Unthrottle
+  VERSION = "0.1.0"
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: Unthrottle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shishir Sharma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: Centralized rate limiting for multiple web servies, using Redis.
+email:
+- shishirsharma.in@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/Unthrottle.rb
+- lib/unthrottle/version.rb
+- tasks/rspec.rake
+homepage: https://github.com/shishirsharma/Unthrottle
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Centralized rate limiting for things, using Redis.
+test_files: []