faraday-throttler-rx 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a90bfffb43e9cfb65219fe3325686b7c3d8e4cf410bcd91802e9a84222306de0
+  data.tar.gz: bfd4da59b12e9b86fdcc3706eb669817dab02b1054aba2c08749c6997eda8d95
+SHA512:
+  metadata.gz: 703f490b28de0dba22faa60e0de17aaf2a513b610272f8f939973950f01e2e95a5a21abafa9f9421c95e1555a3e2f18d3d74b1448790f9e67bae4ff324620946
+  data.tar.gz: 3b09c9b0fdaef98b68bf28451d626dd6903673cc863e327410067fbfa3702e8e4559f479af5b347092daa28f5be7550b469828e87b7423a9509cbf409eb88aca

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_throttler.gemspec
+gemspec
+
+group :test do
+  gem 'byebug'
+end

data/README.md

@@ -0,0 +1,122 @@
+[ ![Codeship Status for ismasan/faraday_throttler](https://codeship.com/projects/40d401a0-5c01-0133-561a-22b0ee77d2e6/status?branch=master)](https://codeship.com/projects/110895)
+
+# FaradayThrottler
+
+Configurable Faraday middleware for Ruby HTTP clients that:
+
+* limits request rate to backend services.
+* does its best to return cached or placeholder responses to clients while backend service is unavailable or slow.
+* optionally uses Redis to rate-limit outgoing requests across processes and servers.
+
+## Use case
+
+Use this gem if you want to help avoid request [stampedes](https://en.wikipedia.org/wiki/Cache_stampede) to your backend APIs. For example after front-end cache expiration. This middleware can help you limit the number and rate of concurrent requests to the backend, while serving useful cached or hard-coded responses back to the client when the backend is not inmediatly available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_throttler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_throttler
+
+## Usage
+
+### Defaults
+
+The defaul configuration uses an in-memory lock and in-memory cache. Not suitable for multi-server deployments.
+
+```ruby
+require 'faraday'
+require 'faraday_throttler'
+
+client = Faraday.new(:url => 'https://my.api.com') do |c|
+ c.use(
+    :throttler,
+    # Allow up to 1 request every 3 seconds, per path, to backend
+    rate: 3,
+    # Queued requests will wait for up to 2 seconds for current in-flight request
+    # to the same path.
+    # If in-flight request hasn't finished after that time, return a default placeholder response.
+    wait: 2
+ )
+ c.adapter Faraday.default_adapter
+end
+```
+
+Make some requests:
+
+```ruby
+resp = client.get('/foobar')
+resp.body
+```
+
+The configuration above will only issue 1 request every 3 seconds to `my.api.com/foobar`. Requests to the same path will wait for up to 2 seconds for current _in-flight_ request to finish.
+
+If an in-flight request finishes within the wait period, queued requests will respond with the same data, and the data will be cached as a fallback.
+
+If the in-flight request doesn't finish within 2 seconds (wait period), queued requests will attempt to serve a previous response from the same resource from cache.
+
+If no matching response found in cache, a default fallback response will be used (status 204 No Content). Fallback responses can be cofigured.
+
+Tweaking the `rate` and `wait` arguments allows you to control the rate of cached, fresh and fallback reponses.
+
+### Distributed Redis lock and cache
+
+The defaults use in-memory lock and cache store implementations. To make the most efficient use of this gem across processes and servers, you can use [Redis](http://redis.io/) as a distributed lock and cache store.
+
+```ruby
+require 'redis'
+require 'faraday_throttler/redis_lock'
+require 'faraday_throttler/redis_cache'
+
+redis = Redis.new(uri: 'redis://my-redis-server.com:1234')
+
+redis_lock = FaradayThrottler::RedisLock.new(redis)
+
+# Cache entries will be available for 1 hour
+redis_cache = FaradayThrottler::RedisCache.new(redis: redis, ttl: 3600)
+
+client = Faraday.new(:url => 'https://my.api.com') do |c|
+ c.use(
+    :throttler,
+    rate: 3,
+    wait: 2,
+    # Use Redis-backed lock
+    lock: redis_lock,
+    # Use Redis-backed cache with set expiration
+    cache: redis_cache
+ )
+ c.adapter Faraday.default_adapter
+end
+```
+
+## Advanced usage
+
+Most internal behaviours are split into delegate objects that you can pass as middleware arguments to override the defaults. See the details [in the code](https://github.com/ismasan/faraday_throttler/blob/master/lib/faraday_throttler/middleware.rb#L16).
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` 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/ismasan/faraday_throttler.
+
+To contribute with code:
+
+1. Fork it ( http://github.com/ismasan/faraday_throttler/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 new Pull Request

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 "faraday_throttler"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'redis'
+gem 'rack'
+gem 'faraday', '1.10.0'

data/examples/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    multipart-post (2.2.3)
+    rack (1.6.4)
+    redis (3.2.1)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (= 1.10.0)
+  rack
+  redis
+
+BUNDLED WITH
+   1.17.3

data/examples/README.md

@@ -0,0 +1,25 @@
+## Examples
+
+```
+bundle install
+```
+
+Run test rack server in one terminal window.
+
+```
+rackup config.ru
+```
+
+Run Redis in another:
+
+```
+redis-server
+```
+
+Run test client in another:
+
+```
+ruby client.rb
+```
+
+Tweak middleware option in `client.rb`

data/examples/client.rb

@@ -0,0 +1,32 @@
+require 'bundler/setup'
+require 'redis'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'faraday_throttler/middleware'
+require 'faraday_throttler/redis_cache'
+
+
+redis = Redis.new
+cache = FaradayThrottler::RedisCache.new(redis: redis, ttl: 60)
+
+conn = Faraday.new(:url => 'http://localhost:9800') do |faraday|
+  # faraday.response :logger                  # log requests to STDOUT
+  faraday.use :throttler, rate: 10, wait: 1, cache: cache
+  faraday.adapter  Faraday.default_adapter
+end
+
+start = Time.now
+success = 0
+tr = (1..100).map do |i|
+  Thread.new do
+    sleep (rand * 10)
+    n = Time.now
+    r = conn.get('/foo/bar')
+    success += 1 if r.status == 200
+    # puts %([#{n}] #{r.headers['X-Throttler']} took: #{r.headers['X-ThrottlerTime']} - #{r.body})
+  end
+end
+
+tr.map{|t| t.join }
+
+
+p "Success ------- #{success}  --- Time = #{Time.now - start}"

data/examples/config.ru

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+
+run ->(env) {
+  puts 'req'
+  sleep (rand * 5).ceil
+  [200, {'Content-Type' => 'application/json'}, [%({"date": "#{Time.now.to_s}"})]]
+}

data/faraday_throttler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_throttler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-throttler-rx"
+  spec.version       = FaradayThrottler::VERSION
+  spec.authors       = ["Boris Koumondji"]
+  spec.email         = ["brexis2009@yahoo.fr"]
+
+  spec.summary       = %q{Redis-backed request throttler requests to protect backend APIs against request stampedes}
+  spec.description   = %q{Configure how often you want to hit backend APIs, and fallback responses to keep clients happy}
+  spec.homepage      = "https://github.com/fedapay/faraday_throttler"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 0.9.1"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/faraday_throttler/cache.rb

@@ -0,0 +1,19 @@
+module FaradayThrottler
+  class Cache
+    def initialize(store = {})
+      @mutex = Mutex.new
+      @store = store
+    end
+
+    def set(key, resp)
+      mutex.synchronize { store[key] = resp }
+    end
+
+    def get(key)
+      mutex.synchronize { store[key] }
+    end
+
+    private
+    attr_reader :store, :mutex
+  end
+end

data/lib/faraday_throttler/errors.rb

@@ -0,0 +1,6 @@
+module FaradayThrottler
+  module Errors
+    class ThrottlerError < StandardError; end
+    class SerializerError < ThrottlerError; end
+  end
+end

data/lib/faraday_throttler/fallbacks.rb

@@ -0,0 +1,16 @@
+module FaradayThrottler
+  class Fallbacks
+    DEFAULT_CONTENT_TYPE = 'application/json'.freeze
+
+    def call(req)
+      {
+        url: req[:url],
+        status: 204,
+        body: '',
+        response_headers: {
+          'Content-Type' => req.fetch(:request_headers, {}).fetch('Content-Type', DEFAULT_CONTENT_TYPE)
+        }
+      }
+    end
+  end
+end

data/lib/faraday_throttler/key_resolver.rb

@@ -0,0 +1,14 @@
+require 'openssl/digest'
+
+module FaradayThrottler
+  class KeyResolver
+    def call(request_env)
+      hash request_env[:url].to_s
+    end
+
+    private
+    def hash(str)
+      OpenSSL::Digest::MD5.hexdigest(str)
+    end
+  end
+end

data/lib/faraday_throttler/middleware.rb

@@ -0,0 +1,155 @@
+require 'timeout'
+require 'faraday'
+require 'logger'
+require 'faraday_throttler/key_resolver'
+require 'faraday_throttler/cache'
+require 'faraday_throttler/rate_limit_response_checker'
+
+module FaradayThrottler
+  class Middleware < Faraday::Middleware
+    def initialize(
+        # The base Faraday adapter.
+        app,
+
+        # Sticks cache.
+        cache: Cache.new,
+
+        # Resolves response unique key to use as cache key
+        # Interface:
+        #   #call(response_env Hash) String
+        cache_key_resolver: KeyResolver.new,
+
+        # Maximum requests to sent to the backend api simultanous
+        rate: 10,
+
+        # Queued requests will wait for up to 1 seconds for current in-flight request
+        # to the same path.
+        # If in-flight request hasn't finished after that time, return a default placeholder response.
+        wait: 1,
+
+        # Wraps requests to backend service in a timeout block, in seconds.
+        # timeout: 0 disables this behaviour.
+        timeout: 0,
+
+        # Use to check if backend api response is a rate limit
+        rate_limit_response_checker: RateLimitResponseChecker.new,
+
+        # Pass your own Logger instance (for example Rails.logger in a Rails app).
+        # Defaults to STDOUT.
+        # http://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html
+        # Interface:
+        #   #debug(msg String, &block)
+        #   #warn(msg String, &block)
+        #   #error(msg String, &block)
+        #   #info(msg String, &block)
+        #   #fatal(msg String, &block)
+        logger: Logger.new(STDOUT)
+    )
+
+      validate_dep! cache, :cache, :get, :set
+      validate_dep! cache_key_resolver, :cache_key_resolver, :call
+      validate_dep! rate_limit_response_checker, :rate_limit_response_checker, :call
+      validate_dep! logger, :info, :error, :warn, :debug
+
+      @cache = cache
+      @cache_key_resolver = cache_key_resolver
+      @rate = rate.to_i
+      @wait = wait.to_i
+      @timeout = timeout.to_i
+      @rate_limit_response_checker = rate_limit_response_checker
+      @logger = logger
+
+      super app
+    end
+
+    def call(request_env)
+      return app.call(request_env) if request_env[:method] != :get
+
+      start = Time.now
+
+      cache_key = cache_key_resolver.call(request_env)
+
+      # Wait stick to be available
+      until request_stick?(cache_key)
+        logger.debug logline(cache_key, "A.1. No stick available. Wait for new one.")
+        sleep(wait)
+      end
+
+      logger.debug logline(cache_key, "A.2. start backend request.")
+      handle_request(request_env, cache_key, start)
+    end
+
+    private
+    attr_reader :app, :cache, :cache_key_resolver, :rate, :wait, :timeout,
+                :rate_limit_response_checker, :logger
+
+    def handle_request(request_env, cache_key, start)
+      logger.debug logline(cache_key, "B.1.1. handle sync. Timeout: #{timeout}")
+      with_timeout(timeout) {
+        fetch_and_check_rate_limit(request_env, cache_key, start)
+      }
+    rescue ::Timeout::Error => e
+      release_request_stick(cache_key)
+      logger.error logline(cache_key, "B.1.2. timeout error. Timeout: #{timeout}. Message: #{e.message}")
+      raise Faraday::TimeoutError
+    end
+
+    def fetch_and_check_rate_limit(request_env, cache_key, start)
+      app.call(request_env).on_complete do |response_env|
+        if rate_limit_response_checker.call(response_env)
+          sleep wait
+          logger.debug logline(cache_key, "C.1.1. Rate limited on backend. Took #{Time.now - start}")
+          fetch_and_check_rate_limit(request_env, cache_key, start)
+        else
+          # Everything alright
+          logger.debug logline(cache_key, "C.1.2. Everything alright, request finished. Took #{Time.now - start}")
+          debug_headers response_env, :fresh, start
+          release_request_stick(cache_key)
+        end
+      end
+    end
+
+    def validate_dep!(dep, dep_name, *methods)
+      methods.each do |m|
+        raise ArgumentError, %(#{dep_name} must implement :#{m}) unless dep.respond_to?(m)
+      end
+    end
+
+    def debug_headers(resp_env, status, start)
+      resp_env[:response_headers].merge!(
+        'X-Throttler' => status.to_s,
+        'X-ThrottlerTime' => (Time.now - start)
+      )
+    end
+
+    def with_timeout(seconds, &block)
+      if seconds == 0
+        yield
+      else
+        ::Timeout.timeout(seconds, &block)
+      end
+    end
+
+    def request_stick?(cache_key)
+      counter = cache.get(cache_key, 0).to_i
+      p "#{counter}, #{cache_key}"
+      if counter < rate
+        cache.set(cache_key, counter + 1)
+        true
+      else
+        false
+      end
+    end
+
+    def release_request_stick(cache_key)
+      counter = cache.get(cache_key, 0).to_i
+      cache.set(cache_key, counter - 1) if counter > 0
+    end
+
+    def logline(cache_key, line)
+      "[Throttler:#{cache_key}] #{line}"
+    end
+  end
+
+  Faraday::Middleware.register_middleware throttler: ->{ Middleware }
+end

data/lib/faraday_throttler/rate_limit_response_checker.rb

@@ -0,0 +1,7 @@
+module FaradayThrottler
+  class RateLimitResponseChecker
+    def call(response)
+      response.has_key?(:status) && response[:status] == 429
+    end
+  end
+end

data/lib/faraday_throttler/redis_cache.rb

@@ -0,0 +1,23 @@
+module FaradayThrottler
+  class RedisCache
+    NAMESPACE = 'throttler:cache:'.freeze
+
+    def initialize(redis: Redis.new, ttl: 0)
+      @redis = redis
+      @ttl = ttl
+    end
+
+    def set(key, value)
+      opts = {}
+      opts[:ex] = ttl if ttl > 0
+      redis.set [NAMESPACE, key].join, value, opts
+    end
+
+    def get(key, default = nil)
+      redis.get([NAMESPACE, key].join) || default
+    end
+
+    private
+    attr_reader :redis, :ttl
+  end
+end

data/lib/faraday_throttler/version.rb

@@ -0,0 +1,3 @@
+module FaradayThrottler
+  VERSION = "0.0.4"
+end

data/lib/faraday_throttler.rb

@@ -0,0 +1,7 @@
+require "faraday_throttler/version"
+
+module FaradayThrottler
+  # Your code goes here...
+end
+
+require 'faraday_throttler/middleware'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: faraday-throttler-rx
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Boris Koumondji
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Configure how often you want to hit backend APIs, and fallback responses
+  to keep clients happy
+email:
+- brexis2009@yahoo.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/README.md
+- examples/client.rb
+- examples/config.ru
+- faraday_throttler.gemspec
+- lib/faraday_throttler.rb
+- lib/faraday_throttler/cache.rb
+- lib/faraday_throttler/errors.rb
+- lib/faraday_throttler/fallbacks.rb
+- lib/faraday_throttler/key_resolver.rb
+- lib/faraday_throttler/middleware.rb
+- lib/faraday_throttler/rate_limit_response_checker.rb
+- lib/faraday_throttler/redis_cache.rb
+- lib/faraday_throttler/version.rb
+homepage: https://github.com/fedapay/faraday_throttler
+licenses: []
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Redis-backed request throttler requests to protect backend APIs against request
+  stampedes
+test_files: []