Mechanize v0.1.0 Mechanize.Browser View Source
Entry point module for every web page interaction using Mechanize. In this module you'll find functions to do all kinds of HTTP requests.
To begin interacting with web pages, first start a new browser:
iex> browser = Browser.new()
iex> is_pid(browser)
true You can also start using start_link/1 and start/1 functions in case you need more control:
iex> {:ok, browser} = Browser.start_link()
iex> is_pid(browser)
true
iex> {:ok, browser} = Browser.start()
iex> is_pid(browser)
true It's possible to configure Mechanize Browser passing configuration parameters to new/1,
start_link/1 and start/1 functions:
Browser.new(redirect_limit: 10) See request!/4 for all available options.
Finally, after start the browser, it's time to fetch our page:
%Page{} = Browser.get!(b, "https://www.google.com.br")Link to this section Summary
Functions
Issues a DELETE request to the given url. See request!/5 for details.
Return if browser is following 3xx redirects.
Issues a to request the given url. See request!/5 for details.
Returns the HTML parser used by browser.
Returns the HTTP adapter used by the browser.
Get value of HTTP header form browser by its name.
Returns all browser default HTTP headers.
Return the max number of redirects browser will follow on a redirect chain.
Returns user agent string for browser.
Returns the corresponding user agent string for a given ua_alias.
Issues a HEAD request to the given url. See request!/5 for details.
Start a new linked Mechanize Browser.
Issues a OPTIONS request to the given url. See request!/5 for details.
Issues a PATCH request to the given url. See request!/5 for details.
Issues a POST request to the given url. See request!/5 for details.
Issues a PUT request to the given url. See request!/5 for details.
Enable/disable 3xx redirect follow.
Changes the HTML parser used by the browser and return the browser.
Changes the HTTP adapter used by the browser and return the browser.
Put a new default header and preserve other existing headers.
Adds a new default HTTP header to browser if not present, otherwise updates the header value.
Configure all HTTP headers of browser at once.
Put the limit of redirects followed by browser on a redirect chain.
Adds/updates user-agent header using human-friendly browser aliases.
Adds an user-agent header if not present, otherwise replaces the previous header value with
agent_string.
Issues a HTTP request using method to the given url.
See Mechanize.Browser.Impl.resolve_url/2.
Start a new unlinked Mechanize Browser, similar to new/1. It returns GenServer.on_start()
instead.
Start a new linked Mechanize Browser, similar to new/1, but return GenServer.on_start()
instead.
Link to this section Types
Specs
response_chain() :: [Mechanize.Response.t()]
Specs
t() :: pid()
Link to this section Functions
Specs
Issues a DELETE request to the given url. See request!/5 for details.
Specs
Return if browser is following 3xx redirects.
Specs
get!(t(), String.t(), keyword()) :: Mechanize.Page.t()
Issues a to request the given url. See request!/5 for details.
Specs
Returns the HTML parser used by browser.
Specs
Returns the HTTP adapter used by the browser.
Specs
Get value of HTTP header form browser by its name.
In case of a browser having more than one HTTP header with same name, this function will
return the first matched header value.
Example
Browser.get_http_header_value(browser, "user-agent")Specs
Returns all browser default HTTP headers.
Example
[
{"accept", "text/html"},
{"accept-encoding", "gzip, deflate, br"}
] = Browser.get_http_headers(browser)Specs
Return the max number of redirects browser will follow on a redirect chain.
Specs
Returns user agent string for browser.
This is the same of Browser.get_http_header_value(browser, "user-agent").
Specs
Returns the corresponding user agent string for a given ua_alias.
Example
iex> Browser.get_user_agent_string_from_alias(:windows_firefox) "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0"
Specs
head!(t(), String.t(), keyword()) :: Mechanize.Page.t()
Issues a HEAD request to the given url. See request!/5 for details.
Specs
Start a new linked Mechanize Browser.
You can configure the browser using opts parameter:
http_adapterset HTTP adapter used to fetch pages. Defaults toMechanize.HTTPAdapter.Httpoisonmodule and it's the only available adapter at the moment.html_parserset HTTP adapter used to parse pages. Defaults toMechanize.HTMLParser.Flokimodule and it's the only available parser at the moment.http_headersset all default browser headers at once. These headers will be sent on every request made by the current started browser. Defaults to[{"user-agent", @user_agent_aliases[:mechanize]}]. Note that using this options will replace all default headers. To append a new header, seeput_http_header/2orput_http_header/3.follow_redirectfollow HTTP 3xx redirects whentrue. Defaults totrue.redirect_limitset maximun redirects to follow. Defaults to5.follow_meta_refreshfollow<meta http-equiv="refresh" ...>tags whentrue. Defaults tofalse.
Example
Start a browser that follows <meta http-equiv="refresh" ...>.
iex> browser = Browser.new(follow_meta_refresh: true)
iex> is_pid(browser)
trueSpecs
options!(t(), String.t(), keyword()) :: Mechanize.Page.t()
Issues a OPTIONS request to the given url. See request!/5 for details.
Specs
Issues a PATCH request to the given url. See request!/5 for details.
Specs
Issues a POST request to the given url. See request!/5 for details.
Specs
Issues a PUT request to the given url. See request!/5 for details.
Specs
Enable/disable 3xx redirect follow.
Examples
Browser.put_follow_redirect(browser, true) # Follow 3xx redirects
Browser.put_follow_redirect(browser, false) # Don't follow 3xx redirectsSpecs
Changes the HTML parser used by the browser and return the browser.
At the moment, the only available parser is Mechanize.HTMLParser.Floki.
Specs
Changes the HTTP adapter used by the browser and return the browser.
At the moment, the only available adapter is Mechanize.HTTPAdapter.Httpoison.
Specs
Put a new default header and preserve other existing headers.
This header will be sent on every requestmade by this browser.
Example
Browser.put_http_header(browser, {"accept", "text/html"})Specs
Adds a new default HTTP header to browser if not present, otherwise updates the header value.
This header will be sent on every request made by this browser.
Example
Browser.put_http_header(browser, "accept", "text/html")Specs
Configure all HTTP headers of browser at once.
These headers will be sent on every request made by this browser. Note that all current headers
are replaced. To add a new reader preserving the existing, see put_http_header/2 and
put_http_header/3.
Example
Browser.put_htttp_headers(browser, [
{"accept", "text/html"},
{"accept-encoding", "gzip, deflate, br"}
])Specs
Put the limit of redirects followed by browser on a redirect chain.
Specs
Adds/updates user-agent header using human-friendly browser aliases.
Example
Browser.put_user_agent(browser, :windows_firefox)is the same of using put_http_header/3 this way:
Browser.put_http_header(browser, "user-agent",
"Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0"
)Available aliases
:android- Mozilla/5.0 (Linux; Android 5.1.1; Nexus 7 Build/LMY47V) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.76 Safari/537.36:googlebot- Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html):googlebot_mobile- Mozilla/5.0 (Linux; Android 6.0.1; Nexus 5X Build/MMB29P) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.96 Mobile Safari/537.36 (compatible; Googlebot/2.1; +http://www.google.com/bot.html):ipad- Mozilla/5.0 (iPad; CPU OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1:iphone- Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B5110e Safari/601.1:linux_firefox- Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:43.0) Gecko/20100101 Firefox/43.0:linux_konqueror- Mozilla/5.0 (compatible; Konqueror/3; Linux):linux_mozilla- Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4) Gecko/20030624:mac_firefox- Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:43.0) Gecko/20100101 Firefox/43.0:mac_mozilla- Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.4a) Gecko/20030401:mac_safari- Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9:mac_safari_4- Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; de-at) AppleWebKit/531.21.8 (KHTML, like Gecko) Version/4.0.4 Safari/531.21.10:mechanize- Mechanize/0.1.0 Elixir/1.10.2 (http://github.com/gushonorato/mechanize/):windows_chrome- Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.125 Safari/537.36:windows_edge- Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2486.0 Safari/537.36 Edge/13.10586:windows_firefox- Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0:windows_ie_10- Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0):windows_ie_11- Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko:windows_ie_6- Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1):windows_ie_7- Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727):windows_ie_8- Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727):windows_ie_9- Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0):windows_mozilla- Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6
Specs
Adds an user-agent header if not present, otherwise replaces the previous header value with
agent_string.
See put_user_agent/2 for a more convenient way to add/update user-agent header.
Examples
Browser.put_user_agent_string(browser,
"Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0"
)is the same of using put_http_header/3 this way:
Browser.put_http_header(browser, "user-agent",
"Mozilla/5.0 (Windows NT 6.3; WOW64; rv:43.0) Gecko/20100101 Firefox/43.0"
)Specs
Issues a HTTP request using method to the given url.
If the request does not fail, a Page struct is returned, otherwise, it raises
Mechanize.HTTPAdapter.NetworkError.
This function accepts opts:
:headers- a list of additional headers for this request.:params- a list of params to be merged into theurl.
Examples
Browser.request!(browser, :get, "https://www.example.com")
# GET https://www.example.comRequest with custom headers:
Browser.request!(browser, :get, "https://www.example.com", "", headers: [
{"accept", "text/html"}, {"user-agent", "Custom UA"}
])
# GET https://www.example.com
# Accept: text/html
# User-agent: Custom UARequest with custom params:
Browser.request!(browser, :get, "https://www.example.com", "", params: [
{"search", "mechanize"}, {"order", "name"}
])
# GET https://www.example.com?search=mechanize&order=nameSee Mechanize.Browser.Impl.resolve_url/2.
Specs
start(keyword()) :: GenServer.on_start()
Start a new unlinked Mechanize Browser, similar to new/1. It returns GenServer.on_start()
instead.
Use this function when you need more control. For all available opts see new/1.
Example
iex> {:ok, browser} = Browser.start(follow_meta_refresh: true)
iex> is_pid(browser)
trueSpecs
start_link(keyword()) :: GenServer.on_start()
Start a new linked Mechanize Browser, similar to new/1, but return GenServer.on_start()
instead.
Use this function when you need more control. For all available opts see new/1.
Example
iex> {:ok, browser} = Browser.start_link(follow_meta_refresh: true)
iex> is_pid(browser)
true