galago-rate_limiter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6af298c6a194e5e8d7939e3e18890698efc6c4ef
+  data.tar.gz: 16a8dd9c1a13dfdf993c7b1f42ac0377ab65f1a9
+SHA512:
+  metadata.gz: 2e046b041e5376884f6d79b693c92277b4b34ccc8836d98645badf33754f2a4879b5c84ba4d0240d7ef3166da2e71255fb2846d6621bb6c2d88260fd438532a2
+  data.tar.gz: 69563efbb8f7b0dfae163918c642a1d321e85d280d226666f090380e4f2e46617988239a7d3764224f0361853682b336f291179e1f03753f422f628c1f791f71

data/lib/galago/rate_limiter/configuration.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module Galago
+  class RateLimiter
+    class Configuration
+      include Singleton
+
+      DEFAULT_LIMIT = 5_000
+      DEFAULT_API_KEY_HEADER = 'HTTP_X_API_KEY'.freeze
+
+      attr_reader :api_key_header, :limit, :counter
+
+      def initialize
+        @limit = DEFAULT_LIMIT
+        @api_key_header = DEFAULT_API_KEY_HEADER
+      end
+
+      def limit=(limit)
+        raise ArgumentError.new("Limit must be a positive number") if limit < 1
+        @limit = limit
+      end
+
+      def api_key_header=(api_key_header)
+        header = api_key_header.dup
+        header.gsub!('-', '_')
+        header.upcase!
+
+        @api_key_header = "HTTP_#{header}".freeze
+      end
+
+      def counter=(counter)
+        @counter = case counter
+                   when Dalli::Client then MemcachedCounter.new(counter)
+                   when Redis then RedisCounter.new(counter)
+                   else counter
+                   end
+      end
+
+      def reset!
+        @limit = DEFAULT_LIMIT
+        @api_key_header = DEFAULT_API_KEY_HEADER
+      end
+
+    end
+  end
+end
+

data/lib/galago/rate_limiter/memcached_counter.rb

@@ -0,0 +1,18 @@
+module Galago
+  class RateLimiter
+    class MemcachedCounter
+      def initialize(client)
+        @memcached = client
+      end
+
+      def increment(key, amount, options = {})
+        @memcached.incr(key, amount, options[:expires_in], 1)
+      end
+
+      def reset!
+        @memcached.flush
+      end
+    end
+  end
+end
+

data/lib/galago/rate_limiter/railtie.rb

@@ -0,0 +1,12 @@
+module Galago
+  class RateLimiter::Railtie < ::Rails::Railtie
+    initializer "galago.rate_limiter.configure_counter" do |app|
+      app.config.middleware.use "Galago::RateLimiter"
+
+      RateLimiter.configure do |config|
+        config.counter = Rails.cache
+      end
+    end
+  end
+end
+

data/lib/galago/rate_limiter/redis_counter.rb

@@ -0,0 +1,22 @@
+module Galago
+  class RateLimiter
+    class RedisCounter
+      def initialize(client)
+        @redis = client
+      end
+
+      def increment(key, amount, options = {})
+        count, _ = @redis.multi do |multi|
+          multi.incrby(key, amount)
+          multi.expire(key, options[:expires_in])
+        end
+        count
+      end
+
+      def reset!
+        @redis.flushdb
+      end
+    end
+  end
+end
+

data/lib/galago/rate_limiter.rb

@@ -0,0 +1,67 @@
+require "json"
+require_relative "./rate_limiter/configuration"
+require_relative "./rate_limiter/memcached_counter"
+require_relative "./rate_limiter/redis_counter"
+require_relative "./rate_limiter/railtie" if defined?(Rails)
+
+module Galago
+  class RateLimiter
+    X_LIMIT_HEADER = 'X-RateLimit-Limit'.freeze
+    X_RESET_HEADER = 'X-RateLimit-Reset'.freeze
+    X_REMAINING_HEADER = 'X-RateLimit-Remaining'.freeze
+
+    def self.configure
+      yield Configuration.instance
+    end
+
+    def initialize(app)
+      @app = app
+      @config = Configuration.instance
+      @counter = @config.counter
+    end
+
+    def call(env)
+      api_key = env[@config.api_key_header]
+      return @app.call(env) if api_key.nil?
+      throughput = @counter.increment(api_key, 1, expires_in: expires_in)
+
+      if limit_exceeded?(throughput)
+        status = 403
+        headers = {
+          X_LIMIT_HEADER => @config.limit.to_s,
+          X_REMAINING_HEADER => "0",
+          X_RESET_HEADER => limit_resets_at.to_s
+        }
+        body = [JSON(message: "API rate limit exceeded for #{api_key}")]
+      else
+        status, headers, body = @app.call(env)
+        headers[X_LIMIT_HEADER] = @config.limit.to_s
+        headers[X_REMAINING_HEADER] = (@config.limit - throughput).to_s
+        headers[X_RESET_HEADER] = limit_resets_at.to_s
+      end
+
+      [status, headers, body]
+    end
+
+    private
+
+    def limit_exceeded?(throughput)
+      throughput > @config.limit
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.utc.to_i
+    end
+
+    def expires_in
+      timestamp % 3600
+    end
+
+    # Reset at the beginning of every hour.
+    def limit_resets_at
+      timestamp - (timestamp % 3600) + 3600
+    end
+
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: galago-rate_limiter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Karayusuf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: dalli
+  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:
+- jkarayusuf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/galago/rate_limiter.rb
+- lib/galago/rate_limiter/configuration.rb
+- lib/galago/rate_limiter/memcached_counter.rb
+- lib/galago/rate_limiter/railtie.rb
+- lib/galago/rate_limiter/redis_counter.rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: GitHub style API Rate limiter
+test_files: []