cable_x 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76917008d7ce08585ee10c4920f94f7fea9e52fcd04f031617cc94689f7034f1
-  data.tar.gz: ea77fe44decf6ce838664e1af8a4c71680274b31fb6119c8af8c2592c1692f59
+  metadata.gz: 0ae31a8435e6fcf9142eb27dbd761a8ee99525efe91f5c439ecffa0b6429b090
+  data.tar.gz: 474f402b907b5288b4a41d2217421805bb7746a08389c86e4c8df2a898e88c90
 SHA512:
-  metadata.gz: 6bcec2f189429bc13d423c35b67cc496f4d40894439a1c81ac5fe437ea1c94909d9665f811ddc6298e4e4fb316985bce15494fe96fe9cc340f5e4208cb7d490e
-  data.tar.gz: 1ed2df1944dc39fadee3ded7de04f489574e54e7d82d8c252a883065aae964dbaa37dec34b7c1a6d7792d7e44ad9c2c9fbd5113f54d7b5059b7d0bc0efaa499c
+  metadata.gz: 716524bc5935eefbe1df7c52806ff5eb91584c45d301cc4d28913a04903791d58f974e6419089ad0224ba1c98a31368e282297fdacd8e178b78b889e9eb116a1
+  data.tar.gz: 9c058b68e43f8ef0d519b6299ed3be6e1adb53271741c90b24521b12871316ab5e02862e857fee99af101206bf1339eff495c5cb1648a149dacf9a73d6ee459e

data/README.md

@@ -1,8 +1,14 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/58f79a904f11911be561/maintainability)](https://codeclimate.com/github/Code-Vedas/rails-cable-x/maintainability)
+![](https://ruby-gem-downloads-badge.herokuapp.com/cable_x?type=total&color=brightgreen)
+[![Gem Version](https://badge.fury.io/rb/cable_x.svg)](https://badge.fury.io/rb/cable_x)
+[![Coverage Status](https://coveralls.io/repos/github/Code-Vedas/rails-cable-x/badge.svg?branch=master)](https://coveralls.io/github/Code-Vedas/rails-cable-x?branch=master)
+[![Build Status](https://travis-ci.com/code-vedas/rails-cable-x.svg?branch=master)](https://travis-ci.com/code-vedas/rails-cable-x)
+
 # CableX
-Short description and motivation.
+Standard MVC over cable for realtime applications to enjoy seamless experience over cable. Use specialized clients for [Angular](https://github.com/Code-Vedas/ngx-cable-x),[JS](https://github.com/Code-Vedas/cable-x-js),[React](https://github.com/Code-Vedas/cable-x-js),Android, IOS
 
+    Clients for Android, IOS, Angular, React, JS coming soon.
 ## Usage
-How to use my plugin.
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/cable_x/cable/connection.rb

@@ -1,15 +1,74 @@
 # frozen_string_literal: true
 
+require_relative './rate_limit/block_check'
+require_relative './rate_limit/rate_limit'
+require_relative './rate_limit/rate_limit_redis'
+
 module CableX
   module Cable
     ##
     # Connection class to serve entry point
     class Connection < ActionCable::Connection::Base
-      attr_accessor :device_id
+      include RateLimit::RateLimitRedis
+      include RateLimit::CheckRateLimit
+      include RateLimit::BlockCheck
+
+      class << self
+        attr_accessor :rate_limit, :redis_config
+      end
+
+      attr_accessor :device_id, :rate_limit, :redis_config, :redis
       identified_by :device_id
 
       def connect
-        self.device_id = SecureRandom.hex(20)
+        self.device_id = Digest::SHA1.hexdigest(request_str)
+        setup_rate_limit
+      rescue StandardError => _e
+        reject_unauthorized_connection
+      end
+
+      def receive(message)
+        if (blocked_unit = check_block) || (blocked_unit = do_rate_limit)
+          disconnect_client(blocked_unit)
+        elsif check_message(message)
+          super(message)
+        else
+          malformed_message_response
+        end
+      end
+
+      def close(reason, reconnect = false)
+        transmit(type: ActionCable::INTERNAL[:message_types][:disconnect],
+                 reason: reason,
+                 reconnect: reconnect)
+        websocket.close
+      end
+
+      def malformed_message_response
+        transmit(type: 'error',
+                 message: 'malformed_message')
+      end
+
+      def check_message(message)
+        JSON.parse(message) rescue false
+      end
+
+      def setup_rate_limit
+        self.rate_limit = self.class.rate_limit
+        self.redis_config = self.class.redis_config
+        if rate_limit
+          self.redis = Redis.new(url: redis_config[:url])
+          raise StandardError, 'Rate limiting: Slow down!. Try after some time' if check_block
+        end
+        true
+      end
+
+      def request_str
+        headers_to_get = %w[SERVER_PROTOCOL SERVER_SOFTWARE REQUEST_METHOD REQUEST_PATH HTTP_USER_AGENT\
+                            HTTP_CONNECTION HTTP_ORIGIN REMOTE_ADDR ORIGINAL_FULLPATH ORIGINAL_SCRIPT_NAME\
+                            action_dispatch.authorized_host]
+        headers = request.headers.to_h
+        headers_to_get.map { |key| headers[key] }.join('-').gsub(' ', '')
       end
     end
   end

data/lib/cable_x/cable/rate_limit/block_check.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CableX
+  module Cable
+    module RateLimit
+      ##
+      # Process Rate Limit
+      module BlockCheck
+        def check_block
+          check_block_unit('second') || check_block_unit('minute') || check_block_unit('hour') if rate_limit
+        end
+
+        def check_block_unit(unit)
+          unit if redis_exists block_device_key(unit)
+        end
+
+        def block_device(unit)
+          redis_set block_device_key(unit), true, rate_limit[:cool_down].send('second') * 1000
+          unit
+        end
+
+        def disconnect_client(unit)
+          close("Rate limiting: Limit exceeded for per #{unit} Slow down!. Try after some time", false)
+        end
+      end
+    end
+  end
+end
+# "Rate limiting: Slow down!. Try after some time"

data/lib/cable_x/cable/rate_limit/rate_limit.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CableX
+  module Cable
+    module RateLimit
+      ##
+      # Process Rate Limit
+      module CheckRateLimit
+        def do_rate_limit
+          check_rate_limit if rate_limit
+        end
+
+        def check_rate_limit
+          check_unit('second') || check_unit('minute') || check_unit('hour')
+        end
+
+        def check_unit(unit)
+          check_value = rate_limit[unit.to_s.to_sym]
+          return unless check_value
+
+          key = device_key unit
+          redis_set key, 0, 1.send(unit) * 1000 unless redis_exists(key)
+          redis_incr key
+          block_connection = (redis_get(key) || -1).to_i >= check_value
+          return unless block_connection
+
+          block_device unit
+        end
+      end
+    end
+  end
+end

data/lib/cable_x/cable/rate_limit/rate_limit_redis.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CableX
+  module Cable
+    module RateLimit
+      ##
+      # Process Rate Limit
+      module RateLimitRedis
+        def redis_set(key, value, expire_millisecond)
+          redis.set key, value, px: expire_millisecond
+        end
+
+        def redis_incr(key)
+          redis.incr key
+        end
+
+        def redis_exists(key)
+          redis.exists? key
+        end
+
+        def redis_get(key)
+          redis.get key
+        end
+
+        def device_key(schedule)
+          "#{redis_config[:channel_prefix]}-rl-#{schedule}-#{device_id}"
+        end
+
+        def block_device_key(schedule)
+          "#{redis_config[:channel_prefix]}-rl-block-#{schedule}-#{device_id}"
+        end
+      end
+    end
+  end
+end

data/lib/cable_x/engine.rb

@@ -12,12 +12,21 @@ module CableX
     isolate_namespace CableX
 
     def self.server
-      config = Rails.application.config_for(:cable_x) rescue nil
-      self.allowed_request_origins = config[:allowed_request_origins] if config
+      setup_rate_limiting
       server = CableX::Server.server
       server.config.connection_class = -> { CableX::Cable::Connection }
       server.config.allowed_request_origins = allowed_request_origins
       server
     end
+
+    def self.setup_rate_limiting
+      cable_config = Rails.application.config_for(:cable) rescue nil
+      cable_x_config = Rails.application.config_for(:cable_x) rescue nil
+      self.allowed_request_origins = cable_x_config[:allowed_request_origins]
+      return unless cable_x_config && cable_config && cable_config[:adapter] == 'redis'
+
+      CableX::Cable::Connection.redis_config = cable_config
+      CableX::Cable::Connection.rate_limit = cable_x_config[:rate_limit]
+    end
   end
 end

data/lib/cable_x/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CableX
-  VERSION = '0.1.0'
+  VERSION = File.read('Version').split("\n").first.gsub('v', '')
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cable_x
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Nitesh Purohit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.23
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.23
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.0.0
 description: Standard MVC over cable for realtime applications to enjoy seamless experience
   over cable. Use specialized clients for Android, IOS, Angular, React, JS
 email:
@@ -66,6 +38,9 @@ files:
 - lib/cable_x.rb
 - lib/cable_x/cable/channel.rb
 - lib/cable_x/cable/connection.rb
+- lib/cable_x/cable/rate_limit/block_check.rb
+- lib/cable_x/cable/rate_limit/rate_limit.rb
+- lib/cable_x/cable/rate_limit/rate_limit_redis.rb
 - lib/cable_x/channel/cable_x_channel.rb
 - lib/cable_x/channel/process/controller.rb
 - lib/cable_x/channel/process/request.rb
@@ -99,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Standard MVC over cable for realtime applications to enjoy seamless experience