.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Duo::Mock::Agent 3pm" .TH Net::Duo::Mock::Agent 3pm "2015-08-16" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Duo::Mock::Agent \- Mock LWP::UserAgent for Net::Duo testing .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& # Build the Net::Duo object and the mock. \& my %args = (key_file => \*(Aqadmin.json\*(Aq); \& my $mock = Net::Duo::Mock::Agent\->new(\e%args); \& $args{user_agent} = $mock; \& my $duo = Net::Duo::Admin\->new(\e%args); \& \& # Indicate what to expect and then make the Net::Duo call. \& $mock\->expect( \& { \& method => \*(AqGET\*(Aq, \& uri => \*(Aq/admin/v1/users\*(Aq, \& response_file => \*(Aqresponse.json\*(Aq, \& } \& ); \& my @users = $duo\->users; .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Perl 5.14 or later and the modules HTTP::Request and HTTP::Response (part of HTTP::Message), \s-1JSON,\s0 Perl6::Slurp, and URI::Escape (part of \s-1URI\s0), all of which are available from \s-1CPAN.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides the same interface as LWP::UserAgent, for the methods that Net::Duo calls, and verifies that the information passed in by Duo is correct. It can also simulate responses to exercise response handling in Net::Duo. To test Net::Duo, pass a Test::Mock::Duo::Agent object to the constructor of a Net::Duo\-based class as the user_agent argument. .PP All tests are reported by Test::More, and no effort is made to produce a predictable number of test results. This means that any calling test program should probably not specify a plan and instead use \fIdone_testing()\fR. .PP This module is primarily used by the Net::Duo test suite and can be ignored entirely when using Net::Duo normally. It is provided as part of the Net::Duo module install, instead of kept only in the distribution source tree, because it may be useful for the test suites of other Perl modules or programs that use Net::Duo internally and want to test that integration without network access or a live Duo account to point to. .SH "CLASS METHODS" .IX Header "CLASS METHODS" .IP "new(\s-1ARGS\s0)" 4 .IX Item "new(ARGS)" Create a new Net::Duo::Mock::Agent object. \s-1ARGS\s0 should be the same data structure passed to the Net::Duo\-derived constructor (with the obvious exception of the user_agent argument, which is ignored). .SH "INSTANCE METHODS" .IX Header "INSTANCE METHODS" .IP "expect(\s-1ARGS\s0)" 4 .IX Item "expect(ARGS)" Expect a \s-1REST API\s0 call from Net::Duo. .Sp \&\s-1ARGS\s0 is used to specify both the expected request data and the response to return to the caller. The same response is returned regardless of whether the request is correct. .Sp There are two ways to specify the response: a complete HTTP::Response object, or the \s-1JSON\s0 data of the response. If only the \s-1JSON\s0 data is specified, the request will return a response with a status code of 200 and a Duo success result (\f(CW\*(C`stat\*(C'\fR of \f(CW\*(C`OK\*(C'\fR), with the supplied \s-1JSON\s0 data as the \f(CW\*(C`response\*(C'\fR key in the \s-1JSON\s0 response data. The content will have a Content-Type of \f(CW\*(C`application/json\*(C'\fR. .Sp \&\s-1ARGS\s0 should be a reference to a hash with keys selected from the following: .RS 4 .IP "method" 4 .IX Item "method" The expected method of the request. .IP "uri" 4 .IX Item "uri" The expected \s-1URI\s0 of the request. This should just be the path, not the hostname or protocol portions of the full \s-1URL,\s0 and should not include any \&\s-1GET\s0 parameters. .IP "content" 4 .IX Item "content" The expected content of the request. This is the parameters in the \s-1URL\s0 if the method is \s-1GET\s0 and the expected \f(CW\*(C`application/x\-www\-form\-urlencoded\*(C'\fR content of the request for any other request type. It may be empty or not specified if the request should not contain any additional parameters. .IP "response" 4 .IX Item "response" An HTTP::Response object to return to the client. This object is always returned without modification to any request, even if it doesn't match the expected request. .IP "response_data" 4 .IX Item "response_data" A data structure that will be converted to \s-1JSON\s0 and included as the value of the \f(CW\*(C`response\*(C'\fR key in the returned success response to the client. .IP "response_file" 4 .IX Item "response_file" A file containing \s-1JSON\s0 that will be included as the value of the \&\f(CW\*(C`response\*(C'\fR key in the returned success response to the client. .RE .RS 4 .RE .IP "request(\s-1REQUEST\s0)" 4 .IX Item "request(REQUEST)" This is the interface called internally by Net::Duo to make an \s-1API\s0 call. The interface is the same as the \fIrequest()\fR method of LWP::UserAgent: \&\s-1REQUEST\s0 is an HTTP::Request object, and Net::Duo::Mock::Agent will return an HTTP::Response object. Currently, this is the only LWP::UserAgent method implemented by this mock, since it's the only one that Net::Duo uses. .Sp When \fIrequest()\fR is called, it checks the content of the request against whatever the mock was told to expect via the \fIexpect()\fR method. The results of that comparison are reported via Test::More functions. The expected call is then cleared. This means that \fIexpect()\fR must be called between each call to a Net::Duo method that would result in a \s-1REST API\s0 call request. .Sp If \fIrequest()\fR is called when no request was expected (via an \fIexpect()\fR call), it throws an exception. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2014 The Board of Trustees of the Leland Stanford Junior University .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Net::Duo .PP This module is part of the Net::Duo distribution. The current version of Net::Duo is available from \s-1CPAN,\s0 or directly from its web site at .