{"id":24725556,"url":"https://github.com/routerify/routerify-websocket","last_synced_at":"2025-10-09T19:31:12.741Z","repository":{"id":45188980,"uuid":"267351851","full_name":"routerify/routerify-websocket","owner":"routerify","description":"The WebSocket support for the Routerify library","archived":false,"fork":false,"pushed_at":"2022-01-02T12:47:31.000Z","size":28,"stargazers_count":9,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-06T03:52:11.769Z","etag":null,"topics":["hyper","hyper-rs","routerify","websocket","websocket-server","websockets","ws"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/routerify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-27T15:08:43.000Z","updated_at":"2025-03-04T15:44:57.000Z","dependencies_parsed_at":"2022-09-03T00:10:54.332Z","dependency_job_id":null,"html_url":"https://github.com/routerify/routerify-websocket","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/routerify/routerify-websocket","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/routerify%2Frouterify-websocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/routerify%2Frouterify-websocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/routerify%2Frouterify-websocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/routerify%2Frouterify-websocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/routerify","download_url":"https://codeload.github.com/routerify/routerify-websocket/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/routerify%2Frouterify-websocket/sbom","scorecard":{"id":785582,"data":{"date":"2025-08-11","repo":{"name":"github.com/routerify/routerify-websocket","commit":"b5c70795db2386266cd892e576fa9cb930062a41"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/9 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/routerify/routerify-websocket/test.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"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"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T06:00:21.513Z","repository_id":45188980,"created_at":"2025-08-23T06:00:21.513Z","updated_at":"2025-08-23T06:00:21.513Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001975,"owners_count":26083244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hyper","hyper-rs","routerify","websocket","websocket-server","websockets","ws"],"created_at":"2025-01-27T13:19:46.702Z","updated_at":"2025-10-09T19:31:12.423Z","avatar_url":"https://github.com/routerify.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Github Actions Status](https://github.com/routerify/routerify-websocket/workflows/Test/badge.svg)](https://github.com/routerify/routerify-websocket/actions)\n[![crates.io](https://img.shields.io/crates/v/routerify-websocket.svg)](https://crates.io/crates/routerify-websocket)\n[![Documentation](https://docs.rs/routerify-websocket/badge.svg)](https://docs.rs/routerify-websocket)\n[![MIT](https://img.shields.io/crates/l/routerify-websocket.svg)](./LICENSE)\n\n# routerify-websocket\n\nThe `WebSocket` support for the [Routerify](https://github.com/routerify/routerify) library.\n\n[Docs](https://docs.rs/routerify-websocket)\n\n## Install\n\nAdd this to your `Cargo.toml` file:\n\n```toml\n[dependencies]\nrouterify = \"3\"\nrouterify-websocket = \"3\"\n```\n\n## Example\n \n```rust\n// Import `SinkExt` and `StreamExt` to send and read websocket messages.\nuse futures::{SinkExt, StreamExt};\nuse hyper::{Body, Response, Server};\nuse routerify::{Router, RouterService};\n// Import websocket types.\nuse routerify_websocket::{upgrade_ws, Message, WebSocket};\nuse std::{convert::Infallible, net::SocketAddr};\n\n// A handler for websocket connections.\nasync fn ws_handler(ws: WebSocket) {\n    println!(\"New websocket connection: {}\", ws.remote_addr());\n\n    // The `WebSocket` implements the `Sink` and `Stream` traits\n    // to read and write messages.\n    let (mut tx, mut rx) = ws.split();\n\n    // Read messages.\n    while let Some(msg) = rx.next().await {\n        let msg = msg.unwrap();\n\n        // Check message type and take appropriate actions.\n        if msg.is_text() {\n            println!(\"{}\", msg.into_text().unwrap());\n        } else if msg.is_binary() {\n            println!(\"{:?}\", msg.into_bytes());\n        }\n\n        // Send a text message.\n        let send_msg = Message::text(\"Hello world\");\n        tx.send(send_msg).await.unwrap();\n    }\n}\n\nfn router() -\u003e Router\u003cBody, Infallible\u003e {\n    // Create a router and specify the path and the handler for new websocket connections.\n    Router::builder()\n        // It will accept websocket connections at `/ws` path with any method type.\n        .any_method(\"/ws\", upgrade_ws(ws_handler))\n        // It will accept http connections at `/` path.\n        .get(\"/\", |_req| async move {\n            Ok(Response::new(\"I also serve http requests\".into()))\n        })\n        .build()\n        .unwrap()\n}\n\n#[tokio::main]\nasync fn main() {\n    let router = router();\n\n    // Create a Service from the router above to handle incoming requests.\n    let service = RouterService::new(router).unwrap();\n\n    // The address on which the server will be listening.\n    let addr = SocketAddr::from(([127, 0, 0, 1], 3001));\n\n    // Create a server by passing the created service to `.serve` method.\n    let server = Server::bind(\u0026addr).serve(service);\n\n    println!(\"App is running on: {}\", addr);\n    if let Err(err) = server.await {\n        eprintln!(\"Server error: {}\", err);\n    }\n}\n```\n\n## Contributing\n\nYour PRs and suggestions are always welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frouterify%2Frouterify-websocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frouterify%2Frouterify-websocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frouterify%2Frouterify-websocket/lists"}