Skip to content

Ruby SSE Client

Akram El Assas edited this page Jul 19, 2025 · 1 revision

Prerequisites

  • Install Ruby
  • Add these gems to your project:
    gem install em-eventsource

SSE Client Sample

Here is a sample SSE Ruby client sse.rb:

require 'net/http'
require 'uri'
require 'json'
require 'em-eventsource'

BASE_URL = 'http://localhost:8000/api/v1'
USERNAME = 'admin'
PASSWORD = 'wexflow2018'
WORKFLOW_ID = 41

def login(username, password, stay_connected = false)
  uri = URI("#{BASE_URL}/login")
  req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
  req.body = { username: username, password: password, stayConnected: stay_connected }.to_json

  res = Net::HTTP.start(uri.hostname, uri.port) do |http|
    http.request(req)
  end

  unless res.is_a?(Net::HTTPSuccess)
    raise "Login failed: #{res.code} #{res.message}"
  end

  json = JSON.parse(res.body)
  json['access_token']
end

def start_workflow(token, workflow_id)
  uri = URI("#{BASE_URL}/start?w=#{workflow_id}")
  req = Net::HTTP::Post.new(uri, 'Authorization' => "Bearer #{token}")

  res = Net::HTTP.start(uri.hostname, uri.port) do |http|
    http.request(req)
  end

  unless res.is_a?(Net::HTTPSuccess)
    raise "Start workflow failed: #{res.code} #{res.message}"
  end

  JSON.parse(res.body)
end

begin
  token = login(USERNAME, PASSWORD)
  job_id = start_workflow(token, WORKFLOW_ID)
  puts "Workflow #{WORKFLOW_ID} started. Job ID: #{job_id}"

  sse_url = "#{BASE_URL}/sse/#{WORKFLOW_ID}/#{job_id}"

  EM.run do
    source = EventMachine::EventSource.new(sse_url, nil, { 'Authorization' => "Bearer #{token}" })

    source.message do |msg|
      begin
        data = JSON.parse(msg)
        puts "Received SSE JSON: #{data}"
        source.close
      rescue => e
        puts "Failed to parse SSE JSON: #{e.message}"
      end
    end

    source.error do |err|
      puts "SSE error: #{err}"
      source.close
    end

    source.open do
      puts "SSE connection opened"
    end

    source.start
  end

rescue => e
  puts "Error: #{e.message}"
end

To run the client, use the following command:

ruby sse.rb
  1. Install Guide
  2. HTTPS/SSL
  3. Screenshots
  4. Docker
  5. Configuration Guide
    1. Wexflow Server
    2. Wexflow.xml
    3. Admin Panel
    4. Authentication
  6. Persistence Providers
  7. Getting Started
  8. Android App
  9. Local Variables
  10. Global Variables
  11. REST Variables
  12. Functions
  13. Cron Scheduling
  14. Command Line Interface (CLI)
  15. REST API Reference
    1. Introduction
    2. JWT Authentication
    3. Sample Clients
      1. C# Client
      2. JavaScript Client
      3. PHP Client
      4. Python Client
      5. Go Client
      6. Rust Client
      7. Ruby Client
      8. Java Client
      9. C++ Client
    4. Security Considerations
    5. Swagger
    6. Workflow Notifications via SSE
      1. C# SSE Client
      2. JavaScript SSE Client
      3. PHP SSE Client
      4. Python SSE Client
      5. Go SSE Client
      6. Rust SSE Client
      7. Ruby SSE Client
      8. Java SSE Client
      9. C++ SSE Client
    7. Endpoints
  16. Samples
    1. Sequential workflows
    2. Execution graph
    3. Flowchart workflows
      1. If
      2. While
      3. Switch
    4. Approval workflows
      1. Simple approval workflow
      2. OnRejected workflow event
      3. YouTube approval workflow
      4. Form submission approval workflow
    5. Workflow events
  17. Logging
  18. Custom Tasks
    1. Introduction
    2. General
      1. Creating a Custom Task
      2. Wexflow Task Class Example
      3. Task Status
      4. Settings
      5. Loading Files
      6. Loading Entities
      7. Need A Starting Point?
    3. Installing Your Custom Task in Wexflow
      1. .NET Framework 4.8 (Legacy Version)
      2. .NET 8.0+ (Stable Version)
      3. Referenced Assemblies
      4. Updating a Custom Task
      5. Using Your Custom Task
    4. Suspend/Resume
    5. Logging
    6. Files
    7. Entities
    8. Shared Memory
    9. Designer Integration
      1. Registering the Task
      2. Adding Settings
    10. How to Debug a Custom Task?
  19. Built-in Tasks
    1. File system tasks
    2. Encryption tasks
    3. Compression tasks
    4. Iso tasks
    5. Speech tasks
    6. Hashing tasks
    7. Process tasks
    8. Network tasks
    9. XML tasks
    10. SQL tasks
    11. WMI tasks
    12. Image tasks
    13. Audio and video tasks
    14. Email tasks
    15. Workflow tasks
    16. Social media tasks
    17. Waitable tasks
    18. Reporting tasks
    19. Web tasks
    20. Script tasks
    21. JSON and YAML tasks
    22. Entities tasks
    23. Flowchart tasks
    24. Approval tasks
    25. Notification tasks
    26. SMS tasks
  20. Run from Source
  21. Fork, Customize, and Sync
Clone this wiki locally