Results for: "remove_const"

Creates a new Net::HTTP object, http, via Net::HTTP.new:

• For arguments address and port, see Net::HTTP.new.

• For proxy-defining arguments p_addr through p_pass, see Proxy Server.

• For argument opts, see below.

With no block given:

• Calls http.start with no block (see start), which opens a TCP connection and HTTP session.

• Returns http.

• The caller should call finish to close the session:

  http = Net::HTTP.start(hostname)
  http.started? # => true
  http.finish
  http.started? # => false
  

With a block given:

• Calls http.start with the block (see start), which:

  • Opens a TCP connection and HTTP session.

  • Calls the block, which may make any number of requests to the host.

  • Closes the HTTP session and TCP connection on block exit.

  • Returns the block’s value object.

• Returns object.

Example:

hostname = 'jsonplaceholder.typicode.com'
Net::HTTP.start(hostname) do |http|
  puts http.get('/todos/1').body
  puts http.get('/todos/2').body
end

Output:

{
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}
{
  "userId": 1,
  "id": 2,
  "title": "quis ut nam facilis et officia qui",
  "completed": false
}

If the last argument given is a hash, it is the opts hash, where each key is a method or accessor to be called, and its value is the value to be set.

The keys may include:

• ca_file

• ca_path

• cert

• cert_store

• ciphers

• close_on_empty_response

• ipaddr (calls ipaddr=)

• keep_alive_timeout

• key

• open_timeout

• read_timeout

• ssl_timeout

• ssl_version

• use_ssl (calls use_ssl=)

• verify_callback

• verify_depth

• verify_mode

• write_timeout

Note: If port is nil and opts[:use_ssl] is a truthy value, the value passed to new is Net::HTTP.https_default_port, not port.

Returns a string representation of self:

Net::HTTP.new(hostname).inspect
# => "#<Net::HTTP jsonplaceholder.typicode.com:80 open=false>"

Returns true if the HTTP session has been started:

http = Net::HTTP.new(hostname)
http.started? # => false
http.start
http.started? # => true
http.finish # => nil
http.started? # => false

Net::HTTP.start(hostname) do |http|
  http.started?
end # => true
http.started? # => false

Starts an HTTP session.

Without a block, returns self:

http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.start
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=true>
http.started? # => true
http.finish

With a block, calls the block with self, finishes the session when the block exits, and returns the block’s value:

http.start do |http|
  http
end
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.started? # => false

Sends a POST request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Post object created from string path, string data, and initial headers hash initheader.

With a block given, calls the block with the response body:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.post('/todos', data) do |res|
  p res
end # => #<Net::HTTPCreated 201 Created readbody=true>

Output:

"{\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n  \"id\": 201\n}"

With no block given, simply returns the response object:

http.post('/todos', data) # => #<Net::HTTPCreated 201 Created readbody=true>

Related:

• Net::HTTP::Post: request class for HTTP method POST.

• Net::HTTP.post: sends POST request, returns response body.

Sends a COPY request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Copy object created from string path and initial headers hash initheader.

http = Net::HTTP.new(hostname)
http.copy('/todos/1')

Sends a MKCOL request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Mkcol object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http.mkcol('/todos/1', data)
http = Net::HTTP.new(hostname)

Posts data to a host; returns a Net::HTTPResponse object.

Argument url must be a URL; argument data must be a string:

_uri = uri.dup
_uri.path = '/posts'
data = '{"title": "foo", "body": "bar", "userId": 1}'
headers = {'content-type': 'application/json'}
res = Net::HTTP.post(_uri, data, headers) # => #<Net::HTTPCreated 201 Created readbody=true>
puts res.body

Output:

{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}

Related:

• Net::HTTP::Post: request class for HTTP method POST.

• Net::HTTP#post: convenience method for HTTP method POST.

Creates a new Net::HTTP object, http, via Net::HTTP.new:

• For arguments address and port, see Net::HTTP.new.

• For proxy-defining arguments p_addr through p_pass, see Proxy Server.

• For argument opts, see below.

With no block given:

• Calls http.start with no block (see start), which opens a TCP connection and HTTP session.

• Returns http.

• The caller should call finish to close the session:

  http = Net::HTTP.start(hostname)
  http.started? # => true
  http.finish
  http.started? # => false
  

With a block given:

• Calls http.start with the block (see start), which:

  • Opens a TCP connection and HTTP session.

  • Calls the block, which may make any number of requests to the host.

  • Closes the HTTP session and TCP connection on block exit.

  • Returns the block’s value object.

• Returns object.

Example:

hostname = 'jsonplaceholder.typicode.com'
Net::HTTP.start(hostname) do |http|
  puts http.get('/todos/1').body
  puts http.get('/todos/2').body
end

Output:

{
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}
{
  "userId": 1,
  "id": 2,
  "title": "quis ut nam facilis et officia qui",
  "completed": false
}

If the last argument given is a hash, it is the opts hash, where each key is a method or accessor to be called, and its value is the value to be set.

The keys may include:

• ca_file

• ca_path

• cert

• cert_store

• ciphers

• close_on_empty_response

• ipaddr (calls ipaddr=)

• keep_alive_timeout

• key

• open_timeout

• read_timeout

• ssl_timeout

• ssl_version

• use_ssl (calls use_ssl=)

• verify_callback

• verify_depth

• verify_mode

• write_timeout

Note: If port is nil and opts[:use_ssl] is a truthy value, the value passed to new is Net::HTTP.https_default_port, not port.

Returns a string representation of self:

Net::HTTP.new(hostname).inspect
# => "#<Net::HTTP jsonplaceholder.typicode.com:80 open=false>"

Returns true if the HTTP session has been started:

http = Net::HTTP.new(hostname)
http.started? # => false
http.start
http.started? # => true
http.finish # => nil
http.started? # => false

Net::HTTP.start(hostname) do |http|
  http.started?
end # => true
http.started? # => false

Starts an HTTP session.

Without a block, returns self:

http = Net::HTTP.new(hostname)
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.start
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=true>
http.started? # => true
http.finish

With a block, calls the block with self, finishes the session when the block exits, and returns the block’s value:

http.start do |http|
  http
end
# => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
http.started? # => false

Sends a POST request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Post object created from string path, string data, and initial headers hash initheader.

With a block given, calls the block with the response body:

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http = Net::HTTP.new(hostname)
http.post('/todos', data) do |res|
  p res
end # => #<Net::HTTPCreated 201 Created readbody=true>

Output:

"{\n  \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n  \"id\": 201\n}"

With no block given, simply returns the response object:

http.post('/todos', data) # => #<Net::HTTPCreated 201 Created readbody=true>

Related:

• Net::HTTP::Post: request class for HTTP method POST.

• Net::HTTP.post: sends POST request, returns response body.

Sends a COPY request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Copy object created from string path and initial headers hash initheader.

http = Net::HTTP.new(hostname)
http.copy('/todos/1')

Sends a MKCOL request to the server; returns an instance of a subclass of Net::HTTPResponse.

The request is based on the Net::HTTP::Mkcol object created from string path, string body, and initial headers hash initheader.

data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
http.mkcol('/todos/1', data)
http = Net::HTTP.new(hostname)

Returns a string representation of the request:

Net::HTTP::Post.new(uri).inspect # => "#<Net::HTTP::Post POST>"

Args

v

String

Description

Public setter for the typecode v (with validation).

See also URI::FTP.check_typecode.

Usage

require 'uri'

uri = URI.parse("ftp://john@ftp.example.com/my_file.img")
#=> #<URI::FTP ftp://john@ftp.example.com/my_file.img>
uri.typecode = "i"
uri
#=> #<URI::FTP ftp://john@ftp.example.com/my_file.img;type=i>

This is used as a predicate, and ought to be called first.

Returns the encoding of the source code, which is set by parameters to the parser or by the encoding magic comment.

Return the column number for the given byte offset.

Returns all comments that are associated with this location (both leading and trailing comments).

Create a new location object with the given options.

Returns a string representation of this location.