Shortcut services for scripts: http_get and http_download

Redefined classes

redef abstract class Text

curl :: extra $ Text

High-level abstraction for all text representations

All class definitions

redef abstract class Text

curl :: extra $ Text

High-level abstraction for all text representations
package_diagram curl::extra extra curl curl curl::extra->curl core core curl->core json json curl->json ...core ... ...core->core ...json ... ...json->json a_star-m a_star-m a_star-m->curl::extra

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module array

core :: array

This module introduces the standard array structure.
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module exec

core :: exec

Invocation and management of operating system sub-processes.
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module list

core :: list

This module handle double linked lists
module math

core :: math

Mathematical operations
module native

core :: native

Native structures for text and bytes
module native_curl

curl :: native_curl

Binding of C libCurl which allow us to interact with network.
module numeric

core :: numeric

Advanced services for Numeric types
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module ropes

core :: ropes

Tree-based representation of a String.
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module stream

core :: stream

Input and output streams of characters
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O

Parents

module curl

curl :: curl

Data transfer powered by the native curl library

Children

module a_star-m

a_star-m

# Shortcut services for scripts: `http_get` and `http_download`
module extra

import curl

redef class Text

	# Execute a simple HTTP GET request to the URL `self`
	#
	# Set `accept_status_code` to the expected response HTTP code, defaults to 200.
	# If a different status code is received, the return code is printed to stderr.
	#
	# Returns the response body on success and `null` on error. Prints the error
	# message to stderr.
	#
	# For more control, set HTTP request headers, keep the response status code
	# and much more, use `CurlHTTPRequest`.
	#
	# ~~~nitish
	# assert "http://example.com/".http_get != null
	# ~~~
	fun http_get(accept_status_code: nullable Int): nullable String
	do
		var req = new CurlHTTPRequest(self.to_s)
		var resp = req.execute
		req.close

		if resp isa CurlResponseSuccess then
			if resp.status_code == (accept_status_code or else 200) then
				return resp.body_str
			else
				print_error "HTTP request failed: server returned {resp.status_code}"
			end
		else if resp isa CurlResponseFailed then
			print_error "HTTP request failed: {resp.error_msg}"
		else abort
		return null
	end

	# Download the file at URL `self` to `output_path` with a simple HTTP request
	#
	# If not set, `output_path` defaults to `self.basename`.
	#
	# Set `accept_status_code` to the expected response HTTP code, defaults to 200.
	# If a different status code is received, the return code is printed to stderr.
	#
	# Returns the path to the downloaded file on success and `null` on errors.
	# Prints the error message to stderr.
	#
	# For more control, set HTTP request headers, keep the response status code
	# and much more, use `CurlHTTPRequest`.
	#
	# ~~~nitish
	# assert "http://example.com/".http_download("index.html") == "example.com"
	# ~~~
	fun http_download(output_path: nullable Text, accept_status_code: nullable Int): nullable String
	do
		var path = (output_path or else self.basename).to_s

		var req = new CurlHTTPRequest(self.to_s)
		var resp = req.download_to_file(path)
		req.close

		if resp isa CurlFileResponseSuccess then
			if resp.status_code == (accept_status_code or else 200) then
				return path
			else
				print_error "HTTP request failed: server returned {resp.status_code}"
			end
		else if resp isa CurlResponseFailed then
			print_error "HTTP request failed: {resp.error_msg}"
		else abort
		return null
	end
end
lib/curl/extra.nit:15,1--89,3