Package googleapiclient :: Module http :: Class RequestMockBuilder
[hide private]
[frames] | no frames]

Class RequestMockBuilder

source code


A simple mock of HttpRequest

Pass in a dictionary to the constructor that maps request methodIds to
tuples of (httplib2.Response, content, opt_expected_body) that should be
returned when that method is called. None may also be passed in for the
httplib2.Response, in which case a 200 OK response will be generated.
If an opt_expected_body (str or dict) is provided, it will be compared to
the body and UnexpectedBodyError will be raised on inequality.

Example:
  response = '{"data": {"id": "tag:google.c...'
  requestBuilder = RequestMockBuilder(
    {
      'plus.activities.get': (None, response),
    }
  )
  googleapiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)

Methods that you do not supply a response for will return a
200 OK with an empty string as the response content or raise an excpetion
if check_unexpected is set to True. The methodId is taken from the rpcName
in the discovery document.

For more details see the project wiki.

Instance Methods [hide private]
 
__init__(self, responses, check_unexpected=False)
Constructor for RequestMockBuilder
source code
 
__call__(self, http, postproc, uri, method="GET", body=None, headers=None, methodId=None, resumable=None)
Implements the callable interface that discovery.build() expects of requestBuilder, which is to build an object compatible with HttpRequest.execute().
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, responses, check_unexpected=False)
(Constructor)

source code 
Constructor for RequestMockBuilder

The constructed object should be a callable object
that can replace the class HttpResponse.

responses - A dictionary that maps methodIds into tuples
            of (httplib2.Response, content). The methodId
            comes from the 'rpcName' field in the discovery
            document.
check_unexpected - A boolean setting whether or not UnexpectedMethodError
                   should be raised on unsupplied method.

Overrides: object.__init__

__call__(self, http, postproc, uri, method="GET", body=None, headers=None, methodId=None, resumable=None)
(Call operator)

source code 
Implements the callable interface that discovery.build() expects
of requestBuilder, which is to build an object compatible with
HttpRequest.execute(). See that method for the description of the
parameters and the expected response.