ratelimit-ruby 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2f01c9e04b032a5ee94fb987336b241be8973cf
-  data.tar.gz: b1cc45bcbff577fd1f3a57a375dfe36cd3c245b8
+  metadata.gz: e2ff9d738826e547d7d64b087858282fe5b9a4d3
+  data.tar.gz: 39bbd78258a2805bec76eb852077f36e6ad3081b
 SHA512:
-  metadata.gz: 490f788a9c1619dc26a7625f53989888a8201287592098065e84838be56b6f5ac90afa1e408ebd24ee728edebeff261bcfce3c86b0f2affa6c5eb81f3b22d083
-  data.tar.gz: 229bad14f83c45f9130b3e2794c85ac8131be2ed646fb0a066bbde66c7dd0b979279049e7985f2caab4d4aa62d2cb85d3c7b9e88dc8878a18580ae68203f750d
+  metadata.gz: 6e2a19885fcd3952411fc44a80efbef3ffb888d013530c7dfd23e245a69f8a1dcfeb27d8259dfe8f4a0fd48e965594b49efc0a403d3d9530c8497607a872de5c
+  data.tar.gz: 4da6feb04c65f31a6ae53fb3f14ebc8f12c7bf0ea57b7b15fe972c39c4afaa0184b429c2df7264909d75525dc0feec9d634ecfe14a4c4a52ad2f0fd2ec8cb46c

data/Gemfile

@@ -1,10 +1,5 @@
 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'
 

data/README.md

@@ -18,24 +18,56 @@ See full documentation http://www.ratelim.it/documentation
 
 ## Supports
 
-* RateLimits
+* [RateLimits](http://www.ratelim.it/documentation/basic_rate_limits)
 * Millions of individual limits sharing the same policies
-* WebUI for tweaking limits
-* Logging
-* Semaphores
-* Infinite retention fo deduplication workflows
+* WebUI for tweaking limits & feature flags
+* Logging to help you debug
+* [Concurrency](http://www.ratelim.it/documentation/concurrency) & Semaphores
+* Infinite retention for [deduplication workflows](http://www.ratelim.it/documentation/once_and_only_once)
+* [FeatureFlags](http://www.ratelim.it/documentation/feature_flags) as a Service
 
 ## Options and Defaults
 ```ruby
-limiter =  RateLimit::Limiter.new(apikey: "ACCT_ID|APIKEY",
+limiter =  RateLimit::Limiter.new(
+  apikey: "ACCT_ID|APIKEY",
   on_error: :log_and_pass, # :log_and_pass, :log_and_hit, :throw
-  logger: nil, # pass in your own logger here
-  debug: false  #Faraday debugging
+  logger: nil, # pass in your own logger here. ie Rails.logger
+  debug: false,  #Faraday debugging
+  stats: nil, # receives increment("it.ratelim.limitcheck", {:tags=>["policy_group:page_view", "pass:true"]})
+  shared_cache: nil, # Something that quacks like Rails.cache ideally memcached
+                     # used to avoid hitting feature flag endpoint too much
+  in_process_cache: nil # Something like ActiveSupport::Cache::MemoryStore.new(size: 2.megabytes)
+                        # used to memoize featureflags if used in tight loops
+)
+```
+
+## Full Example with Feature Flags
+```ruby
+@limiter = RateLimit::Limiter.new(apikey: "",
+    shared_cache = Rails.cache,
+    logger = Rails.logger,
+    in_process_cahe = ActiveSupport::Cache::MemoryStore.new(size: 1.megabytes)
 )
 
+@limiter.create_limit("event:pageload", 1, RateLimIt::HOURLY_ROLLING)
+@limiter.create_limit("event:activation", 1, RateLimIt::INFINITE)
 
-```
 
+def track_event(event, user_id)
+  if @limiter.feature_is_on_for?("Services::RateLimit", user_id)       
+    return unless @limiter.pass?("event:#{event}:#{user_id}") 
+  end
+  actually_track_event(event, user_id)
+end
+
+
+track_event("pageload:home_page", 1) # will track
+track_event("pageload:home_page", 1) # will skip for the next hour
+track_event("activation", 1) # will track
+track_event("activation", 1) # will skip forever
+
+
+```
 
 ## Contributing to ratelimit-ruby
  

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/lib/ratelimit/murmur3.rb

@@ -0,0 +1,50 @@
+class Murmur3
+  ## MurmurHash3 was written by Austin Appleby, and is placed in the public
+  ## domain. The author hereby disclaims copyright to this source code.
+
+  MASK32 = 0xffffffff
+
+  def self.murmur3_32_rotl(x, r)
+    ((x << r) | (x >> (32 - r))) & MASK32
+  end
+
+
+  def self.murmur3_32_fmix(h)
+    h &= MASK32
+    h ^= h >> 16
+    h = (h * 0x85ebca6b) & MASK32
+    h ^= h >> 13
+    h = (h * 0xc2b2ae35) & MASK32
+    h ^ (h >> 16)
+  end
+
+  def self.murmur3_32__mmix(k1)
+    k1 = (k1 * 0xcc9e2d51) & MASK32
+    k1 = murmur3_32_rotl(k1, 15)
+    (k1 * 0x1b873593) & MASK32
+  end
+
+  def self.murmur3_32(str, seed=0)
+    h1 = seed
+    numbers = str.unpack('V*C*')
+    tailn = str.length % 4
+    tail = numbers.slice!(numbers.size - tailn, tailn)
+    for k1 in numbers
+      h1 ^= murmur3_32__mmix(k1)
+      h1 = murmur3_32_rotl(h1, 13)
+      h1 = (h1*5 + 0xe6546b64) & MASK32
+    end
+
+    unless tail.empty?
+      k1 = 0
+      tail.reverse_each do |c1|
+        k1 = (k1 << 8) | c1
+      end
+      h1 ^= murmur3_32__mmix(k1)
+    end
+
+    h1 ^= str.length
+    murmur3_32_fmix(h1)
+  end
+
+end

data/lib/ratelimit/noop_cache.rb

@@ -0,0 +1,13 @@
+module RateLimit
+  class NoopCache
+    def fetch(name, opts, &method)
+      yield
+    end
+
+    def write(name, value, opts=nil)
+    end
+
+    def read(name)
+    end
+  end
+end

data/lib/ratelimit/toy_cache.rb

@@ -0,0 +1,26 @@
+# Don't use me in prod
+# Just a toy for testing
+module RateLimit
+  class ToyCache
+    @@cache = {}
+
+    def fetch(name, opts, &block)
+      result = read(name)
+
+      return result unless result.nil?
+
+      r = yield
+
+      write(name, r)
+      read(name)
+    end
+
+    def write(name, value, opts=nil)
+      @@cache[name] = value
+    end
+
+    def read(name)
+      @@cache[name]
+    end
+  end
+end

data/lib/ratelimit-ruby.rb

@@ -6,16 +6,25 @@ module RateLimit
   end
 
   class Limiter
-    def base_url(local)
-      local ? 'http://localhost:8080' : 'http://www.ratelim.it'
-    end
 
-    def initialize(apikey:, on_error: :log_and_pass, logger: nil, debug: false, local: false, stats: nil)
+    def initialize(apikey:,
+                   on_error: :log_and_pass,
+                   logger: nil,
+                   debug: false,
+                   stats: nil, # receives increment("it.ratelim.limitcheck", {:tags=>["policy_group:page_view", "pass:true"]})
+                   shared_cache: nil, # Something that quacks like Rails.cache ideally memcached
+                   in_process_cache: nil, # ideally ActiveSupport::Cache::MemoryStore.new(size: 2.megabytes)
+                   use_expiry_cache: true, # must have shared_cache defined
+                   local: false # local development
+    )
+      @on_error = on_error
       @logger = (logger || Logger.new($stdout)).tap do |log|
         log.progname = "RateLimit"
       end
       @stats = (stats || NoopStats.new)
-      @on_error = on_error
+      @shared_cache = (shared_cache || NoopCache.new)
+      @in_process_cache = (in_process_cache || NoopCache.new)
+      @use_expiry_cache = use_expiry_cache
       @conn = Faraday.new(:url => self.base_url(local)) do |faraday|
         faraday.request :json # form-encode POST params
         faraday.response :logger if debug
@@ -23,8 +32,8 @@ module RateLimit
         faraday.options[:timeout] = 5
         faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
       end
-      (username, pass) = apikey.split("|")
-      @conn.basic_auth(username, pass)
+      (@account_id, pass) = apikey.split("|")
+      @conn.basic_auth(@account_id, pass)
     end
 
 
@@ -54,14 +63,29 @@ module RateLimit
     end
 
     def acquire(group, acquire_amount, allow_partial_response: false)
+
+      expiry_cache_key = "it.ratelim.expiry.#{group}"
+      if @use_expiry_cache
+        expiry = @shared_cache.read(expiry_cache_key)
+        if !expiry.nil? && Integer(expiry) > Time.now.utc.to_f * 1000
+          @stats.increment("it.ratelim.limitcheck.expirycache.hit", tags: [])
+          return OpenStruct.new(passed: false, amount: 0)
+        end
+      end
+
       result = @conn.post '/api/v1/limitcheck', { acquireAmount: acquire_amount,
                                                   groups: [group],
                                                   allowPartialResponse: allow_partial_response }.to_json
       handle_failure(result) unless result.success?
       res =JSON.parse(result.body, object_class: OpenStruct)
       res.amount ||= 0
+
       @stats.increment("it.ratelim.limitcheck", tags: ["policy_group:#{res.policyGroup}", "pass:#{res.passed}"])
-      res
+      if @use_expiry_cache
+        reset = result.headers['X-Rate-Limit-Reset']
+        @shared_cache.write(expiry_cache_key, reset) unless reset.nil?
+      end
+      return res
     rescue => e
       handle_error(e)
     end
@@ -80,7 +104,6 @@ module RateLimit
       raise RateLimit::WaitExceeded
     end
 
-
     def return(limit_result)
       result = @conn.post '/api/v1/limitreturn',
                           { enforcedGroup: limit_result.enforcedGroup,
@@ -95,8 +118,42 @@ module RateLimit
     end
 
     def feature_is_on_for?(feature, lookup_key, attributes: [])
-      to_send = { lookupKey: lookup_key, attributes: attributes }
+      @stats.increment("it.ratelim.featureflag.on", tags: ["feature:#{feature}"])
+
+      cache_key = "it.ratelim.ff.#{feature}.#{lookup_key}.#{attributes}"
+      @in_process_cache.fetch(cache_key, expires_in: 60) do
+        next uncached_feature_is_on_for?(feature, lookup_key, attributes) if @shared_cache.class == NoopCache
+
+        feature_obj = get_feature(feature)
+        if feature_obj.nil?
+          next false
+        end
+
+        attributes << lookup_key if lookup_key
+        if (attributes & feature_obj.whitelisted).size > 0
+          next true
+        end
+
+        if lookup_key
+          next get_user_pct(feature, lookup_key) < feature_obj.pct
+        end
+
+        next feature_obj.pct > 0.999
+      end
+    end
+
+    def base_url(local)
+      local ? 'http://localhost:8080' : 'http://www.ratelim.it'
+    end
+
+    private
+
+    def uncached_feature_is_on_for?(feature, lookup_key, attributes)
+      to_send = {}
+      to_send[:lookupKey] = lookup_key unless lookup_key.nil?
+      to_send[:attributes] = attributes if attributes.any?
       result = @conn.get "/api/v1/featureflags/#{feature}/on", to_send
+      @stats.increment("it.ratelim.featureflag.on.req", tags: ["success:#{result.success?}"])
       if result.success?
         result.body == "true"
       else
@@ -104,7 +161,28 @@ module RateLimit
       end
     end
 
-    private
+    def get_feature(feature)
+      get_all_features[feature]
+    end
+
+    def get_all_features
+      @shared_cache.fetch("it.ratelim.get_all_features", expires_in: 60) do
+        result = @conn.get "/api/v1/featureflags"
+        @stats.increment("it.ratelim.featureflag.getall.req", tags: ["success:#{result.success?}"])
+        if result.success?
+          res =JSON.parse(result.body, object_class: OpenStruct)
+          Hash[res.map { |r| [r.feature, r] }]
+        else
+          @logger.error("failed to fetch feature flags #{result.status}")
+          {}
+        end
+      end
+    end
+
+    def get_user_pct(feature, lookup_key)
+      int_value = Murmur3.murmur3_32("#{@account_id}#{feature}#{lookup_key}")
+      int_value / 4294967294.0
+    end
 
     def upsert(limit_definition, method)
       to_send = { limit: limit_definition.limit,
@@ -128,10 +206,10 @@ module RateLimit
       case @on_error
       when :log_and_pass
         @logger.warn("returned #{result.status}")
-        OpenStruct.new(passed: true)
+        OpenStruct.new(passed: true, amount: 0)
       when :log_and_hit
         @logger.warn("returned #{result.status}")
-        OpenStruct.new(passed: false)
+        OpenStruct.new(passed: false, amount: 0)
       when :throw
         raise "#{result.status} calling RateLim.it"
       end
@@ -141,10 +219,10 @@ module RateLimit
       case @on_error
       when :log_and_pass
         @logger.warn(e)
-        OpenStruct.new(passed: true)
+        OpenStruct.new(passed: true, amount: 0)
       when :log_and_hit
         @logger.warn(e)
-        OpenStruct.new(passed: false)
+        OpenStruct.new(passed: false, amount: 0)
       when :throw
         raise e
       end
@@ -163,6 +241,7 @@ module RateLimit
         raise "#{result.status} calling feature flag RateLim.it"
       end
     end
+
   end
 
 end
@@ -171,4 +250,6 @@ require 'faraday'
 require 'faraday_middleware'
 require 'logger'
 require 'ratelimit/noop_stats'
+require 'ratelimit/noop_cache'
+require 'ratelimit/murmur3'
 require 'ratelimit/limit_definition'

data/ratelimit-ruby.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ratelimit-ruby 0.1.6 ruby lib
+# stub: ratelimit-ruby 0.1.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ratelimit-ruby"
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   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 = "2017-01-23"
+  s.date = "2017-01-26"
   s.description = "rate limit your ruby"
   s.email = "jdwyah@gmail.com"
   s.extra_rdoc_files = [
@@ -30,7 +30,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/ratelimit-ruby.rb",
     "lib/ratelimit/limit_definition.rb",
+    "lib/ratelimit/murmur3.rb",
+    "lib/ratelimit/noop_cache.rb",
     "lib/ratelimit/noop_stats.rb",
+    "lib/ratelimit/toy_cache.rb",
     "ratelimit-ruby.gemspec"
   ]
   s.homepage = "http://github.com/jdwyah/ratelimit-ruby"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratelimit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,7 +127,10 @@ files:
 - VERSION
 - lib/ratelimit-ruby.rb
 - lib/ratelimit/limit_definition.rb
+- lib/ratelimit/murmur3.rb
+- lib/ratelimit/noop_cache.rb
 - lib/ratelimit/noop_stats.rb
+- lib/ratelimit/toy_cache.rb
 - ratelimit-ruby.gemspec
 homepage: http://github.com/jdwyah/ratelimit-ruby
 licenses: