Gathering detailed insights and metrics for action-cable-react-jwt
Installations
npm install action-cable-react-jwtDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
7.4.0
NPM Version
4.0.5
Score
78
Supply Chain
99
Quality
75.3
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
4
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
zekedran
Download Statistics
Total Downloads
386,602
Last Day
311
Last Week
2,072
Last Month
7,903
Last Year
85,636
GitHub Statistics
MIT License
38 Stars
25 Commits
17 Forks
5 Watchers
1 Branches
4 Contributors
Updated on Oct 22, 2021
Bundle Size
10.69 kB
Minified
3.23 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.0.5
Package Id
action-cable-react-jwt@0.0.5
Size
6.54 kB
NPM Version
4.0.5
Node Version
7.4.0
Total Downloads
Cumulative downloads
Total Downloads
386,602
Last Day
-20.3%
311
Compared to previous day
Last Week
8%
2,072
Compared to previous week
Last Month
30.5%
7,903
Compared to previous month
Last Year
8.7%
85,636
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
No dependencies detected.
action-cable-react-jwt
Same as action-cable-react, but allows authenticating websockets using JWTs
Installation
Yarn:
1yarn add action-cable-react-jwt 2
npm:
1npm install action-cable-react-jwt 2
Usage
Import action-cable-react-jwt
1import ActionCable from 'action-cable-react-jwt.js'; 2 3// if you don't use ES6 then use 4// const ActionCable = require('action-cable-react-jwt.js'); 5
Creating an actioncable websocket
1let App = {}; 2App.cable = ActionCable.createConsumer("ws://cable.example.com", jwt) // place your jwt here 3 4// you shall also use this.cable = ActionCable.createConsumer(...) 5// to create the connection as soon as the view loads, place this in componentDidMount
Subscribing to a Channel for Receiving data
1this.subscription = App.cable.subscriptions.create({channel: "YourChannel"}, { 2 connected: function() { console.log("cable: connected") }, // onConnect 3 disconnected: function() { console.log("cable: disconnected") }, // onDisconnect 4 received: (data) => { console.log("cable received: ", data); } // OnReceive 5} 6
Send data to a channel
1this.subscription.send('hello world') 2
Call a method on channel with arguments
1this.subscription.perform('method_name', arguments) 2
In your ApplicationCable::Connection class in Ruby add
1# app/channels/application_cable/connection.rb 2module ApplicationCable 3 class Connection < ActionCable::Connection::Base 4 identified_by :current_user 5 6 def connect 7 self.current_user = find_verified_user 8 end 9 10 private 11 12 def find_verified_user 13 begin 14 header_array = self.request.headers[:HTTP_SEC_WEBSOCKET_PROTOCOL].split(',') 15 token = header_array[header_array.length-1] 16 decoded_token = JWT.decode token, Rails.application.secrets.secret_key_base, true, { :algorithm => 'HS256' } 17 if (current_user = User.find((decoded_token[0])['sub'])) 18 current_user 19 else 20 reject_unauthorized_connection 21 end 22 rescue 23 reject_unauthorized_connection 24 end 25 end 26 27 end 28end
And in YourChannel.rb
1# app/channels/you_channel.rb 2class LocationChannel < ApplicationCable::Channel 3 4 # calls connect in client 5 def subscribed 6 stream_from 'location_user_' + current_user.id.to_s 7 end 8 9 # calls disconnect in client 10 def unsubscribed 11 # Any cleanup needed when channel is unsubscribed 12 end 13 14 # called when send is called in client 15 def receive(params) 16 print params[:data] 17 end 18 19 # called when perform is called in client 20 def method_name(params) 21 print params[:data] 22 end 23 24end
Remove a subscription from cable
1App.cable.subscriptions.remove(this.subscription) 2 3// Place this in componentWillUnmount to remove subscription on exiting app 4
Add a subscription to cable
1App.cable.subscriptions.add(this.subscription) 2
Querying url and jwt from cable
1console.log(App.cable.jwt); 2console.log(App.cable.url); 3
Querying subscriptions and connection from cable
1console.log(App.cable.subscriptions); 2console.log(App.cable.connection); 3
License
MIT
Copyright (c) 2017 Zeke
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 3/22 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 6 are checked with a SAST tool
Score
3.2
/10
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More