Class: HTTPX::StreamResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/httpx/plugins/stream.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request, session) ⇒ StreamResponse

Returns a new instance of StreamResponse.



7
8
9
10
11
12
13
 
# File 'lib/httpx/plugins/stream.rb', line 7

def initialize(request, session)
  @request = request
  @options = @request.options
  @session = session
  @response_enum = nil
  @buffered_chunks = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args, **kwargs, &block) ⇒ Object (private) 



114
115
116
117
118
 
# File 'lib/httpx/plugins/stream.rb', line 114

def method_missing(meth, *args, **kwargs, &block)
  return super unless response.respond_to?(meth)

  response.__send__(meth, *args, **kwargs, &block)
end

Instance Attribute Details

#request ⇒ Object (readonly)

Returns the value of attribute request.



5
6
7
 
# File 'lib/httpx/plugins/stream.rb', line 5

def request
  @request
end

Instance Method Details

#each(&block) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/httpx/plugins/stream.rb', line 15

def each(&block)
  return enum_for(__method__) unless block

  if (response_enum = @response_enum)
    @response_enum = nil
    # streaming already started, let's finish it

    while (chunk = @buffered_chunks.shift)
      block.call(chunk)
    end

    # consume enum til the end
    begin
      while (chunk = response_enum.next)
        block.call(chunk)
      end
    rescue StopIteration
      return
    end
  end

  @request.stream = self

  begin
    @on_chunk = block

    response = @session.request(@request)

    response.raise_for_status
  ensure
    @on_chunk = nil
  end
end

#each_line {|line| ... } ⇒ Object

Yields:

  • (line) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/httpx/plugins/stream.rb', line 49

def each_line(&block)
  return enum_for(__method__) unless block

  line = "".b

  each do |chunk|
    line << chunk

    while (idx = line.index("\n"))
      if idx.zero?
        yield ""
      else
        yield line.byteslice(0..(idx - 1))
      end

      line = line.byteslice((idx + 1)..-1)
    end
  end

  yield line unless line.empty?
end

#inspect ⇒ Object

:nocov:



79
80
81
 
# File 'lib/httpx/plugins/stream.rb', line 79

def inspect
  "#<#{self.class}:#{object_id}>"
end

#on_chunk(chunk) ⇒ Object

This is a ghost method. It’s to be used ONLY internally, when processing streams

Raises:

  • (NoMethodError) 


72
73
74
75
76
 
# File 'lib/httpx/plugins/stream.rb', line 72

def on_chunk(chunk)
  raise NoMethodError unless @on_chunk

  @on_chunk.call(chunk)
end

#to_s ⇒ Object

:nocov:



84
85
86
87
88
89
90
 
# File 'lib/httpx/plugins/stream.rb', line 84

def to_s
  if @request.response
    @request.response.to_s
  else
    @buffered_chunks.join
  end
end