istox 0.1.112 → 0.1.113

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cbdf9678aebebaa528663485d031f2ac625080bd727e11da0a81321fe608391
-  data.tar.gz: 65f5626fb8199e82121d3e8a6d3da03462c815de316c4326a904c9d257841ea5
+  metadata.gz: 051bd3f64bac36e0344335c8d977aad2cbb7fc339bc0aa38bd6602718faaff74
+  data.tar.gz: 56f242af8d6fa59be8a800a977ede487cab6e511fbf7fada1a105096c8a996e6
 SHA512:
-  metadata.gz: d3e27bf821044a933dbd84e9b590cb9d6066926e8a1b8b9a92c9d3514a426147b4b79eae3f15f4671d9f834180a6b3da3e035de8ac1b68814bc3e16c09ef1236
-  data.tar.gz: d50d68a85ba7994b50887077aebbe9947bf8c68ffb51dd9be23e5ff4bd27a2896b77d640ebdff526174c857b509dfcc7c6ca0b3549ef4ef25b2373fe84d61486
+  metadata.gz: f0101e6728edd36b69ea6cdded9258feacc4f17fe79e0b7f5393c5210424b1925b8280a5a2289ba88a09020fb008a46477790171856ddfa046abc3d5a1a67af8
+  data.tar.gz: f49243acb52c4865c5541b10a1093ac88efc4bb9673ade9d7d56f198de6fea99d6f90db71992001f9b384228ae517534ab0a7c7caea49a5fcc14d2006a10e6cb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    istox (0.1.111)
+    istox (0.1.112)
       awesome_print
       binding_of_caller
       bunny (>= 2.12.0)
@@ -11,6 +11,8 @@ PATH
       listen (~> 3.0.5)
       ougai
       paranoia (~> 2.2)
+      redis (>= 2.0.0)
+      redis-namespace (>= 1.0.0)
       vault (~> 0.1)
 
 GEM
@@ -84,6 +86,8 @@ GEM
       railties (>= 3.0.0)
     faker (1.7.3)
       i18n (~> 0.5)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
     faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
@@ -91,7 +95,7 @@ GEM
     ffi (1.11.3)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    google-protobuf (3.11.2-universal-darwin)
+    google-protobuf (3.11.2)
     googleapis-common-protos-types (1.0.4)
       google-protobuf (~> 3.0)
     graphlient (0.3.7)
@@ -102,7 +106,7 @@ GEM
     graphql-client (0.16.0)
       activesupport (>= 3.0)
       graphql (~> 1.8)
-    grpc (1.26.0-universal-darwin)
+    grpc (1.26.0)
       google-protobuf (~> 3.8)
       googleapis-common-protos-types (~> 1.0)
     grpc-tools (1.26.0)
@@ -175,6 +179,9 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    redis (4.1.3)
+    redis-namespace (1.7.0)
+      redis (>= 3.0.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -207,6 +214,7 @@ GEM
     sqlite3 (1.3.13)
     thor (0.20.3)
     thread_safe (0.3.6)
+    timecop (0.9.1)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     uniform_notifier (1.11.0)
@@ -225,12 +233,14 @@ DEPENDENCIES
   database_cleaner (~> 1.6.0)
   factory_bot_rails (~> 4.8.2)
   faker (~> 1.7.3)
+  fakeredis
   istox!
   rails (~> 5.2.1)
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-rails (~> 3.8.0)
   sqlite3 (~> 1.3.6)
+  timecop
 
 BUNDLED WITH
    1.17.3

data/istox.gemspec

@@ -1,17 +1,16 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "istox/version"
+require 'istox/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "istox"
+  spec.name          = 'istox'
   spec.version       = Istox::VERSION
-  spec.authors       = ["Siong Leng"]
-  spec.email         = ["siongleng@ich-group.com"]
+  spec.authors       = ['Siong Leng']
+  spec.email         = ['siongleng@ich-group.com']
 
-  spec.summary       = "istox backend shared gem"
-  spec.description   = "istox backend shared gem"
-  spec.homepage      = "http://www.abc.com"
+  spec.summary       = 'istox backend shared gem'
+  spec.description   = 'istox backend shared gem'
+  spec.homepage      = 'http://www.abc.com'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -24,31 +23,35 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "bunny", ">= 2.12.0"
-  spec.add_dependency "istox_gruf"
-  spec.add_dependency "gruf"
-  spec.add_dependency 'vault', '~> 0.1'
-  spec.add_dependency "paranoia", "~> 2.2"
-  spec.add_dependency "graphlient"
+  spec.add_dependency 'awesome_print'
+  spec.add_dependency 'binding_of_caller'
+  spec.add_dependency 'bunny', '>= 2.12.0'
+  spec.add_dependency 'graphlient'
+  spec.add_dependency 'gruf'
+  spec.add_dependency 'istox_gruf'
   spec.add_dependency 'listen', '~> 3.0.5'
-  spec.add_dependency "binding_of_caller"
-  spec.add_dependency "ougai"
-  spec.add_dependency "awesome_print"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.8.0"
-  spec.add_development_dependency "factory_bot_rails", "~> 4.8.2"
-  spec.add_development_dependency "faker", "~> 1.7.3"
-  spec.add_development_dependency "bullet", "~> 5.7.5"
-  spec.add_development_dependency "rails", "~> 5.2.1"
-  spec.add_development_dependency "sqlite3", "~> 1.3.6"
-  spec.add_development_dependency "database_cleaner", "~> 1.6.0"
+  spec.add_dependency 'ougai'
+  spec.add_dependency 'paranoia', '~> 2.2'
+  spec.add_dependency 'redis', '>= 2.0.0'
+  spec.add_dependency 'redis-namespace', '>= 1.0.0'
+  spec.add_dependency 'vault', '~> 0.1'
+  spec.add_development_dependency 'bullet', '~> 5.7.5'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'database_cleaner', '~> 1.6.0'
+  spec.add_development_dependency 'factory_bot_rails', '~> 4.8.2'
+  spec.add_development_dependency 'faker', '~> 1.7.3'
+  spec.add_development_dependency 'fakeredis'
+  spec.add_development_dependency 'rails', '~> 5.2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.8.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
+  spec.add_development_dependency 'timecop'
 end

data/lib/istox.rb

@@ -16,6 +16,7 @@ module Istox
   require 'istox/interfaces/chainhub/transaction'
   require 'istox/helpers/publisher'
   require 'istox/helpers/bunny_boot'
+  require 'istox/helpers/rate_limit'
   require 'istox/helpers/vault'
   require 'istox/helpers/order_book_price_time'
   require 'istox/helpers/order_book_prorate'

data/lib/istox/helpers/rate_limit.rb

@@ -0,0 +1,119 @@
+require 'redis'
+require 'redis-namespace'
+
+# Documentation: https://github.com/ejfinneran/ratelimit
+
+module Istox
+  class RateLimit
+    # Create a Ratelimit object.
+    #
+    # @param [String] key A name to uniquely identify this rate limit. For example, 'emails'
+    # @param [Hash] options Options hash
+    # @option options [Integer] :bucket_span (600) Time span to track in seconds
+    # @option options [Integer] :bucket_interval (5) How many seconds each bucket represents
+    # @option options [Integer] :bucket_expiry (@bucket_span) How long we keep data in each bucket before it is auto expired.
+    # Cannot be larger than the bucket_span.
+    # @option options [Redis]   :redis (nil) Redis client if you need to customize connection options
+    #
+    # @return [Ratelimit] Ratelimit instance
+    #
+    def initialize(key, options = {})
+      @key = key
+      raise ArgumentError, 'Redis object is now passed in via the options hash - options[:redis]' unless options.is_a?(Hash)
+
+      @bucket_span = options[:bucket_span] || 600
+      @bucket_interval = options[:bucket_interval] || 5
+      @bucket_expiry = options[:bucket_expiry] || @bucket_span
+      raise ArgumentError, 'Bucket expiry cannot be larger than the bucket span' if @bucket_expiry > @bucket_span
+
+      @bucket_count = (@bucket_span / @bucket_interval).round
+      raise ArgumentError, 'Cannot have less than 3 buckets' if @bucket_count < 3
+
+      @raw_redis = options[:redis]
+    end
+
+    # Add to the counter for a given subject.
+    #
+    # @param [String]   subject A unique key to identify the subject. For example, 'user@foo.com'
+    # @param [Integer]  count   The number by which to increase the counter
+    #
+    # @return [Integer] The counter value
+    def add(subject, count = 1)
+      bucket = get_bucket
+      subject = "#{@key}:#{subject}"
+      redis.multi do
+        redis.hincrby(subject, bucket, count)
+        redis.hdel(subject, (bucket + 1) % @bucket_count)
+        redis.hdel(subject, (bucket + 2) % @bucket_count)
+        redis.expire(subject, @bucket_expiry)
+      end.first
+    end
+
+    # Returns the count for a given subject and interval
+    #
+    # @param [String] subject Subject for the count
+    # @param [Integer] interval How far back (in seconds) to retrieve activity.
+    def count(subject, interval)
+      bucket = get_bucket
+      interval = [[interval, @bucket_interval].max, @bucket_span].min
+      count = (interval / @bucket_interval).floor
+      subject = "#{@key}:#{subject}"
+
+      keys = (0..count - 1).map do |i|
+        (bucket - i) % @bucket_count
+      end
+      redis.hmget(subject, *keys).inject(0) { |a, i| a + i.to_i }
+    end
+
+    # Check if the rate limit has been exceeded.
+    #
+    # @param [String] subject Subject to check
+    # @param [Hash] options Options hash
+    # @option options [Integer] :interval How far back to retrieve activity.
+    # @option options [Integer] :threshold Maximum number of actions
+    def exceeded?(subject, options = {})
+      count(subject, options[:interval]) >= options[:threshold]
+    end
+
+    # Check if the rate limit is within bounds
+    #
+    # @param [String] subject Subject to check
+    # @param [Hash] options Options hash
+    # @option options [Integer] :interval How far back to retrieve activity.
+    # @option options [Integer] :threshold Maximum number of actions
+    def within_bounds?(subject, options = {})
+      !exceeded?(subject, options)
+    end
+
+    # Execute a block once the rate limit is within bounds
+    # *WARNING* This will block the current thread until the rate limit is within bounds.
+    #
+    # @param [String] subject Subject for this rate limit
+    # @param [Hash] options Options hash
+    # @option options [Integer] :interval How far back to retrieve activity.
+    # @option options [Integer] :threshold Maximum number of actions
+    # @yield The block to be run
+    #
+    # @example Send an email as long as we haven't send 5 in the last 10 minutes
+    #   ratelimit.exec_with_threshold(email, [:threshold => 5, :interval => 600]) do
+    #     send_another_email
+    #     ratelimit.add(email)
+    #   end
+    def exec_within_threshold(subject, options = {})
+      options[:threshold] ||= 30
+      options[:interval] ||= 30
+      sleep @bucket_interval while exceeded?(subject, options)
+      yield(self)
+    end
+
+    private
+
+    def get_bucket(time = Time.now.to_i)
+      ((time % @bucket_span) / @bucket_interval).floor
+    end
+
+    def redis
+      @redis ||= Redis::Namespace.new(:ratelimit, redis: @raw_redis || Redis.new)
+    end
+  end
+end

data/lib/istox/version.rb

@@ -1,3 +1,3 @@
 module Istox
-  VERSION = '0.1.112'.freeze
+  VERSION = '0.1.113'.freeze
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: istox
 version: !ruby/object:Gem::Version
-  version: 0.1.112
+  version: 0.1.113
 platform: ruby
 authors:
 - Siong Leng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: istox_gruf
+  name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,49 +39,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gruf
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
-  name: vault
+  name: graphlient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: paranoia
+  name: gruf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: graphlient
+  name: istox_gruf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.5
 - !ruby/object:Gem::Dependency
-  name: binding_of_caller
+  name: ougai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,89 +123,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ougai
+  name: paranoia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: vault
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bullet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.7.5
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -235,19 +249,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.3
 - !ruby/object:Gem::Dependency
-  name: bullet
+  name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.7.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.7.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +276,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.2.1
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -277,19 +333,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.6
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0'
 description: istox backend shared gem
 email:
 - siongleng@ich-group.com
@@ -331,6 +387,7 @@ files:
 - lib/istox/helpers/order_book_price_time.rb
 - lib/istox/helpers/order_book_prorate.rb
 - lib/istox/helpers/publisher.rb
+- lib/istox/helpers/rate_limit.rb
 - lib/istox/helpers/regex_helper.rb
 - lib/istox/helpers/result_handler.rb
 - lib/istox/helpers/vault.rb