Class: Sketchup::Http::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb

Overview

Http::Request objects allows you to send HTTP request to HTTP servers.

Version:

  • SketchUp 2017

Instance Method Summary collapse

Constructor Details

#initialize(url, method = Sketchup::Http::GET) ⇒ Sketchup::Http::Request

Note:

If no reference is kept to the Sketchup::Http::Request, it can be garbage collected, making the download silently fail. This is especially noticeable for larger downloads that takes longer time.

The default port is 80, to use a different port define it in the URL when creating a new Sketchup::Http::Request.

The method parameter accepts any custom HTTP method or one of the following:

  • Sketchup::Http::GET

  • Sketchup::Http::POST

  • Sketchup::Http::PUT

  • Sketchup::Http::DELETE

  • Sketchup::Http::HEAD

  • Sketchup::Http::OPTIONS

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)

@request.start do |request, response|
  puts "body: #{response.body}"
end

Parameters:

  • url (String)
  • method (String) (defaults to: Sketchup::Http::GET)

Version:

  • SketchUp 2017



126
127
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 126

def initialize(url, method = Sketchup::Http::GET)
end

Instance Method Details

#body ⇒ String

Gets the HTTP body that is going to be used when sending the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.start do |request, response|
  puts "body: #{request.body}"
end

Returns:

Version:

  • SketchUp 2017



23
24
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 23

def body
end

#body=(body) ⇒ String

Sets the HTTP body that is going to be used when sending the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.body = "Hello World"

@request.start do |request, response|
  puts "body: #{request.body}"
end

Parameters:

  • body (String) —

    A String containing the body.

Returns:

Version:

  • SketchUp 2017



42
43
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 42

def body=(body)
end

#cancel ⇒ true

Cancels the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.start do |request, response|
  puts "body: #{response.body}"
end

@request.cancel

Returns:

  • (true)

Version:

  • SketchUp 2017



58
59
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 58

def cancel
end

#headers ⇒ Hash

Returns the HTTP headers that are going to be used when sending the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.headers = { :key1 => "value1", :key2 => "value2" }

@request.headers.each do |key, value|
  puts "#{key}: #{value}"
end

Returns:

  • (Hash)

Version:

  • SketchUp 2017



74
75
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 74

def headers
end

#headers=(headers) ⇒ Boolean

Sets the HTTP headers that are going to be used when sending the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.headers = { :key1 => "value1", :key2 => "value2" }

@request.headers.each do |key, value|
  puts "#{key}: #{value}"
end

Parameters:

  • headers (Hash) —

    A key/value pair hash.

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



93
94
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 93

def headers=(headers)
end

#method ⇒ String

Returns the HTTP method that is going to be used when sending the request.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.start do |request, response|
  puts "request.method: #{request.method}"
end

Returns:

Version:

  • SketchUp 2017



141
142
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 141

def method
end

#method=(method) ⇒ Boolean

Sets the HTTP method that is going to be used when sending the request. The value can be any custom HTTP method or one of the following:

  • Sketchup::Http::GET

  • Sketchup::Http::POST

  • Sketchup::Http::PUT

  • Sketchup::Http::DELETE

  • Sketchup::Http::HEAD

  • Sketchup::Http::OPTIONS

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.method = Sketchup::Http::POST

@request.start do |request, response|
  puts "request.method: #{request.method}"
end

Parameters:

  • method (String) —

    A string containing the HTTP method name.

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



167
168
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 167

def method=(method)
end

#set_download_progress_callback {|current, total| ... } ⇒ Boolean

Note:

total is -1 if the server doesn’t specify a file size in the response header.

Adds a download progress callback block that will get called everytime we have received data from the server until the download finishes.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.set_download_progress_callback do |current, total|
  if total == -1
    puts "#{current}B"
  else
    percentage = (current.to_f / total * 100).round
    puts "#{current}B / #{total}B (#{percentage}%)"
  end
end

@request.start

Yields:

  • A block to be invoked everytime data is downloaded from the server.

Yield Parameters:

  • current (Integer) —

    Current bytes transferred.

  • total (Integer) —

    Total bytes to transfer.

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



200
201
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 200

def set_download_progress_callback
end

#set_upload_progress_callback {|current, total| ... } ⇒ Boolean

Adds a upload progress callback block that will get called everytime we have uploaded data to the server until the upload finishes.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.set_upload_progress_callback do |current, total|
  puts "upload current: #{current}"
  puts "upload total: #{total}"
end

request.start

Yields:

  • A block to be invoked everytime data is sent to the server.

Yield Parameters:

  • current (Integer) —

    Current bytes transferred.

  • total (Integer) —

    Total bytes to transfer.

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



227
228
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 227

def set_upload_progress_callback
end

#start {|request, response| ... } ⇒ Boolean

Starts the request with optionally a response callback block.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.start do |request, response|
  puts "body: #{response.body}"
end

Yield Parameters:

Returns:

  • (Boolean)

Version:

  • SketchUp 2017



246
247
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 246

def start
end

#status ⇒ Integer

Returns the internal status code. It can be one of the following:

  • Sketchup::Http::STATUS_UNKNOWN

  • Sketchup::Http::STATUS_SUCCESS

  • Sketchup::Http::STATUS_PENDING

  • Sketchup::Http::STATUS_CANCELED

  • Sketchup::Http::STATUS_FAILED

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")
@request.start
puts "response.status: #{@request.status}"

Returns:

  • (Integer)

Version:

  • SketchUp 2017



264
265
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 264

def status
end

#url ⇒ String

Returns a copy of the Request’s URL.

Examples:

@request = Sketchup::Http::Request.new("http://localhost:8080")

@request.start do |request, response|
  puts "url: #{request.url}"
end

Returns:

Version:

  • SketchUp 2017



279
280
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb', line 279

def url
end