raterr 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17ba66bcb168f7edde054062b22e260a53655635
-  data.tar.gz: e74e650451a183e4ff1e051807e5c69e29c1af9a
+  metadata.gz: 4d5f9e1d3c31745498e3887068c22635036e518b
+  data.tar.gz: 2942ba9149a80c66c3eac4ed1de69ebc7a920205
 SHA512:
-  metadata.gz: f16f4bb8cafbc3f99fc2c5356842276244e53c3780561d1df0a2e38e27565bb11671bb34aa7711c30125bfedb96717f8860519e5be893b3645f36332e61caea0
-  data.tar.gz: 8c7cc518d9bc683211cce1aae4bc7865b854da9b4b81360b7f561fb98f28f20d0074448214c5c32bea7078323e5e07f21bf056fbcccbda99fb39c5be19f47759
+  metadata.gz: 16af8babc16f23a439a014af9b2246b3eb25da816c1898ef35ae7a8b3c6bc175e8939d1c4ccae7d2abdd5f87f41d5d5928b9a561a132db4f5cbf181d7333dac9
+  data.tar.gz: 2eff125149940a708537a9dfb0027cdb2154a77c5084fb356960062509d59adcc923a00be1479b2f0c18466f351ff8d00ede717b2c5aaa4165152488ca557d6c

data/.travis.yml

@@ -3,3 +3,6 @@ language: ruby
 rvm:
   - 2.4.0
 before_install: gem install bundler -v 1.14.3
+services:
+  - redis-server
+script: RATERR_TEST_HASH=1 rake && RATERR_TEST_REDIS=1 rake

data/Gemfile

@@ -2,5 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in raterr.gemspec
 gemspec
+gem 'redis', '~> 4.0.0'
 gem 'byebug', require: false
 gem 'codecov', require: false, group: :test

data/README.md

@@ -23,14 +23,14 @@ Or install it yourself as:
 
 ## Usage
 For Ruby based application you need to tell `Raterr` what store to use.
-Currently it supports a simple hash or a `ActiveSupport::Cache::MemoryStore`
+Currently it supports a simple hash, or `Redis`
 It is best to load the store in an initializer of any other kind of file
 that is loaded initially.
 ```ruby
 # Use either
-Raterr::Cache.store = ActiveSupport::Cache::MemoryStore.new
-# Or
 Raterr::Cache.store = Hash.new
+# Or
+Raterr::Cache.store = Redis.new
 ```
 To enforce rate limiting use:
 ```ruby

data/lib/raterr.rb

@@ -1,10 +1,11 @@
-require 'active_support'
 require 'raterr/version'
+require 'raterr/store_container'
 require 'raterr/period_builder'
 require 'raterr/mixin'
 require 'raterr/hour'
 require 'raterr/day'
 require 'raterr/minute'
+require 'redis'
 
 module Raterr
 
@@ -23,7 +24,7 @@ module Raterr
     attr_accessor :store
 
     def enforce(request, **options)
-      unless store.is_a?(Hash) || store.is_a?(::ActiveSupport::Cache::MemoryStore)
+      unless store.is_a?(Hash) || store.is_a?(::Redis)
         raise InvalidStore.new('Store is not valid, please refer to the documentation')
       end
 

data/lib/raterr/mixin.rb

@@ -17,11 +17,11 @@ module Raterr
 
     def allowed?
       reset_cache if Time.now > rate_period
-      fetch_cache[:attempts] <= max_per_period
+      fetch_cache['attempts'] <= max_per_period
     end
 
     def proceed
-      attempts = fetch_cache[:attempts] + 1
+      attempts = fetch_cache['attempts'] + 1
       set_cache(attempts)
 
       {
@@ -38,28 +38,32 @@ module Raterr
     end
 
     def fetch_cache
-      cache.fetch(identifier) { { attempts: 1, start_time: Time.now } }
+      container.resolve(:get)
     end
 
     def set_cache(value)
       cache_attributes = {}.tap do |cache|
-        cache[:attempts] = value
-        cache[:start_time] = start_time
+        cache['attempts'] = value
+        cache['start_time'] = start_time
       end
-      cache.is_a?(Hash) ? cache[identifier] = cache_attributes :
-                          cache.write(identifier, cache_attributes)
+
+      container.resolve(:set, cache_attributes)
     end
 
     def reset_cache
-      cache.delete(identifier)
+      container.resolve(:delete, identifier)
     end
 
-    def cache
-      Raterr.store
+    def container
+      @container ||= StoreContainer.new(store: Raterr.store, identifier: identifier)
     end
 
     def start_time
-      fetch_cache[:start_time]
+      start_time = fetch_cache['start_time']
+      # Depending on the storage option start_time can be
+      # either a Time object or a string
+      return Time.parse(start_time) if start_time.is_a?(String)
+      start_time
     end
   end
 end

data/lib/raterr/store_container.rb

@@ -0,0 +1,33 @@
+module Raterr
+  class StoreContainer
+
+    attr_reader :store, :store_type, :identifier
+
+    def initialize(store:, identifier:)
+      @store = store
+      @identifier = identifier
+    end
+
+    def resolve(method, attrs = nil)
+      store_type = store.class.to_s.downcase.to_sym
+      resolvers[method][store_type].call(attrs)
+    end
+
+    def resolvers
+      {
+        get: {
+          hash: -> (attributes) { store.fetch(identifier) { { 'attempts' => 1, 'start_time' => Time.now } } },
+          redis: -> (attributes) { JSON.parse(store.get(identifier) || { 'attempts' => 1, 'start_time' => Time.now }.to_json) }
+        },
+        set: {
+          hash: -> (attributes) { store[identifier] = attributes },
+          redis: -> (attributes) { store.set(identifier, attributes.to_json) }
+        },
+        delete: {
+          hash: -> (identifier) { store.delete(identifier) },
+          redis: -> (identifier) { store.del(identifier) }
+        }
+      }
+    end
+  end
+end

data/lib/raterr/version.rb

@@ -1,3 +1,3 @@
 module Raterr
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/raterr.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "activesupport", "~> 5.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raterr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stefan Slaveykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.9.1
 description: A gem allowing you to set rate limiting on your application
 email:
 - wizard.oneandonly@gmail.com
@@ -89,6 +89,7 @@ files:
 - lib/raterr/minute.rb
 - lib/raterr/mixin.rb
 - lib/raterr/period_builder.rb
+- lib/raterr/store_container.rb
 - lib/raterr/version.rb
 - raterr.gemspec
 homepage: https://github.com/wizardone/raterr