add comment

This commit is contained in:
Kanezoh 2021-10-14 11:15:26 +09:00
parent 88219df484
commit 289b79c3d5

View File

@ -14,6 +14,7 @@ require "./mechanize/errors/*"
# ``` # ```
# # GET # # GET
# agent = Mechanize.new # agent = Mechanize.new
# # send GET request to http://example.com/?foo=bar
# agent.get("http://example.com", # agent.get("http://example.com",
# params: {"foo" => "bar"}, # params: {"foo" => "bar"},
# headers: HTTP::Headers{"Foo" => "Bar"}) # headers: HTTP::Headers{"Foo" => "Bar"})
@ -21,7 +22,7 @@ require "./mechanize/errors/*"
# #
# ``` # ```
# # POST # # POST
# # sending post request whose post body is "foo=bar" # # send POST request whose post body is "foo=bar"
# agent = Mechanize.new # agent = Mechanize.new
# agent.post("http://example.com", # agent.post("http://example.com",
# query: {"foo" => "bar"}) # query: {"foo" => "bar"})
@ -124,17 +125,32 @@ class Mechanize
# get the page mechanize last visited. # get the page mechanize last visited.
# #
# ``` # ```
# agent.current_page # agent.current_page => #<MechanizeCr::Page>
# ``` # ```
def current_page : MechanizeCr::Page def current_page : MechanizeCr::Page
@agent.current_page @agent.current_page
end end
# get the latest page recorded in history, and the page is deleted from history. # get the latest page recorded in history, and the page is deleted from history.
#
# ```
# agent.back => #<MechanizeCr::Page>
# ```
def back : MechanizeCr::Page def back : MechanizeCr::Page
@agent.history.pop @agent.history.pop
end end
# send request from form. 'form' args is necessary, but 'button' is optional.
# you can specify button if you want to use other button which is not in the form.
# TODO: now only supports POST. other HTTP methods should be supported.
#
# ```
# page = agent.get("http://example.com")
# form = page.forms[0]
# # set field value
# form.field_with("foo").value = "bar"
# agent.submit(form)
# ```
def submit(form, button = nil) : MechanizeCr::Page? def submit(form, button = nil) : MechanizeCr::Page?
form.add_button_to_query(button) if button form.add_button_to_query(button) if button
case form.method.upcase case form.method.upcase
@ -148,6 +164,11 @@ class Mechanize
MechanizeCr::Page.new(uri, response, body, code, self) MechanizeCr::Page.new(uri, response, body, code, self)
end end
# get the history (`MechanizeCr::History`).
# the requests mechanize send is recorded in this history.
# ```
# agent.history => #<MechanizeCr::History>
# ```
def history def history
@agent.history @agent.history
end end