spikard 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/lib/spikard/sse.rb CHANGED
@@ -1,111 +1,111 @@
1
- # frozen_string_literal: true
2
-
3
- module Spikard
4
- # Represents a Server-Sent Event.
5
- #
6
- # @!attribute [rw] data
7
- # @return [Hash] Event data (will be JSON serialized)
8
- # @!attribute [rw] event_type
9
- # @return [String, nil] Optional event type
10
- # @!attribute [rw] id
11
- # @return [String, nil] Optional event ID for client reconnection support
12
- # @!attribute [rw] retry_ms
13
- # @return [Integer, nil] Optional retry timeout in milliseconds
14
- class SseEvent
15
- attr_accessor :data, :event_type, :id, :retry_ms
16
-
17
- # Create a new SSE event.
18
- #
19
- # @param data [Hash] Event data (will be JSON serialized)
20
- # @param event_type [String, nil] Optional event type
21
- # @param id [String, nil] Optional event ID for client reconnection support
22
- # @param retry_ms [Integer, nil] Optional retry timeout in milliseconds
23
- def initialize(data:, event_type: nil, id: nil, retry_ms: nil)
24
- @data = data
25
- @event_type = event_type
26
- @id = id
27
- @retry_ms = retry_ms
28
- end
29
-
30
- # Convert to hash for JSON serialization.
31
- #
32
- # @return [Hash] Hash representation of the event
33
- def to_h
34
- {
35
- data: @data,
36
- event_type: @event_type,
37
- id: @id,
38
- retry: @retry_ms
39
- }.compact
40
- end
41
- end
42
-
43
- # Base class for SSE event producers.
44
- #
45
- # Implement this class to generate Server-Sent Events.
46
- #
47
- # @example
48
- # class NotificationProducer < Spikard::SseEventProducer
49
- # def initialize
50
- # @count = 0
51
- # end
52
- #
53
- # def next_event
54
- # sleep 1 # Wait 1 second between events
55
- #
56
- # return nil if @count >= 10 # End stream after 10 events
57
- #
58
- # event = Spikard::SseEvent.new(
59
- # data: { message: "Notification #{@count}" },
60
- # event_type: 'notification',
61
- # id: @count.to_s
62
- # )
63
- # @count += 1
64
- # event
65
- # end
66
- #
67
- # def on_connect
68
- # puts "Client connected to SSE stream"
69
- # end
70
- #
71
- # def on_disconnect
72
- # puts "Client disconnected from SSE stream"
73
- # end
74
- # end
75
- #
76
- # app = Spikard::App.new
77
- #
78
- # app.sse('/notifications') do
79
- # NotificationProducer.new
80
- # end
81
- #
82
- # app.run
83
- class SseEventProducer
84
- # Generate the next event.
85
- #
86
- # This method is called repeatedly to produce the event stream.
87
- #
88
- # @return [SseEvent, nil] SseEvent when an event is ready, or nil to end the stream.
89
- def next_event
90
- raise NotImplementedError, "#{self.class.name} must implement #next_event"
91
- end
92
-
93
- # Called when a client connects to the SSE endpoint.
94
- #
95
- # Override this method to perform initialization when a client connects.
96
- #
97
- # @return [void]
98
- def on_connect
99
- # Optional hook - default implementation does nothing
100
- end
101
-
102
- # Called when a client disconnects from the SSE endpoint.
103
- #
104
- # Override this method to perform cleanup when a client disconnects.
105
- #
106
- # @return [void]
107
- def on_disconnect
108
- # Optional hook - default implementation does nothing
109
- end
110
- end
111
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Spikard
4
+ # Represents a Server-Sent Event.
5
+ #
6
+ # @!attribute [rw] data
7
+ # @return [Hash] Event data (will be JSON serialized)
8
+ # @!attribute [rw] event_type
9
+ # @return [String, nil] Optional event type
10
+ # @!attribute [rw] id
11
+ # @return [String, nil] Optional event ID for client reconnection support
12
+ # @!attribute [rw] retry_ms
13
+ # @return [Integer, nil] Optional retry timeout in milliseconds
14
+ class SseEvent
15
+ attr_accessor :data, :event_type, :id, :retry_ms
16
+
17
+ # Create a new SSE event.
18
+ #
19
+ # @param data [Hash] Event data (will be JSON serialized)
20
+ # @param event_type [String, nil] Optional event type
21
+ # @param id [String, nil] Optional event ID for client reconnection support
22
+ # @param retry_ms [Integer, nil] Optional retry timeout in milliseconds
23
+ def initialize(data:, event_type: nil, id: nil, retry_ms: nil)
24
+ @data = data
25
+ @event_type = event_type
26
+ @id = id
27
+ @retry_ms = retry_ms
28
+ end
29
+
30
+ # Convert to hash for JSON serialization.
31
+ #
32
+ # @return [Hash] Hash representation of the event
33
+ def to_h
34
+ {
35
+ data: @data,
36
+ event_type: @event_type,
37
+ id: @id,
38
+ retry: @retry_ms
39
+ }.compact
40
+ end
41
+ end
42
+
43
+ # Base class for SSE event producers.
44
+ #
45
+ # Implement this class to generate Server-Sent Events.
46
+ #
47
+ # @example
48
+ # class NotificationProducer < Spikard::SseEventProducer
49
+ # def initialize
50
+ # @count = 0
51
+ # end
52
+ #
53
+ # def next_event
54
+ # sleep 1 # Wait 1 second between events
55
+ #
56
+ # return nil if @count >= 10 # End stream after 10 events
57
+ #
58
+ # event = Spikard::SseEvent.new(
59
+ # data: { message: "Notification #{@count}" },
60
+ # event_type: 'notification',
61
+ # id: @count.to_s
62
+ # )
63
+ # @count += 1
64
+ # event
65
+ # end
66
+ #
67
+ # def on_connect
68
+ # puts "Client connected to SSE stream"
69
+ # end
70
+ #
71
+ # def on_disconnect
72
+ # puts "Client disconnected from SSE stream"
73
+ # end
74
+ # end
75
+ #
76
+ # app = Spikard::App.new
77
+ #
78
+ # app.sse('/notifications') do
79
+ # NotificationProducer.new
80
+ # end
81
+ #
82
+ # app.run
83
+ class SseEventProducer
84
+ # Generate the next event.
85
+ #
86
+ # This method is called repeatedly to produce the event stream.
87
+ #
88
+ # @return [SseEvent, nil] SseEvent when an event is ready, or nil to end the stream.
89
+ def next_event
90
+ raise NotImplementedError, "#{self.class.name} must implement #next_event"
91
+ end
92
+
93
+ # Called when a client connects to the SSE endpoint.
94
+ #
95
+ # Override this method to perform initialization when a client connects.
96
+ #
97
+ # @return [void]
98
+ def on_connect
99
+ # Optional hook - default implementation does nothing
100
+ end
101
+
102
+ # Called when a client disconnects from the SSE endpoint.
103
+ #
104
+ # Override this method to perform cleanup when a client disconnects.
105
+ #
106
+ # @return [void]
107
+ def on_disconnect
108
+ # Optional hook - default implementation does nothing
109
+ end
110
+ end
111
+ end
@@ -1,21 +1,44 @@
1
- # frozen_string_literal: true
2
-
3
- module Spikard
4
- # Represents a streaming HTTP response made of chunks produced lazily.
5
- class StreamingResponse
6
- attr_reader :stream, :status_code, :headers
7
-
8
- def initialize(stream, status_code: 200, headers: nil)
9
- unless stream.respond_to?(:next) || stream.respond_to?(:each)
10
- raise ArgumentError, 'StreamingResponse requires an object responding to #next or #each'
11
- end
12
-
13
- @stream = stream.respond_to?(:to_enum) ? stream.to_enum : stream
14
- @status_code = Integer(status_code || 200)
15
- header_hash = headers || {}
16
- @headers = header_hash.each_with_object({}) do |(key, value), memo|
17
- memo[String(key)] = String(value)
18
- end
19
- end
20
- end
21
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Spikard
4
+ # Represents a streaming HTTP response made of chunks produced lazily.
5
+ class StreamingResponse
6
+ attr_reader :stream, :status_code, :headers, :native_response
7
+
8
+ def initialize(stream, status_code: 200, headers: nil)
9
+ unless stream.respond_to?(:next) || stream.respond_to?(:each)
10
+ raise ArgumentError, 'StreamingResponse requires an object responding to #next or #each'
11
+ end
12
+
13
+ @stream = stream.respond_to?(:to_enum) ? stream.to_enum : stream
14
+ @status_code = Integer(status_code || 200)
15
+ header_hash = headers || {}
16
+ @headers = header_hash.each_with_object({}) do |(key, value), memo|
17
+ memo[String(key)] = String(value)
18
+ end
19
+
20
+ rebuild_native!
21
+ end
22
+
23
+ def to_native_response
24
+ @native_response
25
+ end
26
+
27
+ private
28
+
29
+ def rebuild_native!
30
+ ensure_native!
31
+ @native_response = Spikard::Native.build_streaming_response(@stream, @status_code, @headers)
32
+ return unless @native_response
33
+
34
+ @status_code = @native_response.status_code
35
+ @headers = @native_response.headers
36
+ end
37
+
38
+ def ensure_native!
39
+ return if defined?(Spikard::Native) && Spikard::Native.respond_to?(:build_streaming_response)
40
+
41
+ raise 'Spikard native extension is not loaded'
42
+ end
43
+ end
44
+ end