8621812797

Committed 09 Apr 2024 08:22PM UTC coverage: 90.097%. Remained the same

Build # 8621812797

Build Type

Pull #538

github

Committed by

web-flow

Commit Message

Merge 59f3d6a0e into 45eca1a69

Pull Request Pull Request #538: Added secrets to actions to run test example

Run Details

464 of 515 relevant lines covered (90.1%)

5.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.0

/requests_oauthlib/oauth1_auth.py

# -*- coding: utf-8 -*-
import logging

from oauthlib.common import extract_params
from oauthlib.oauth1 import Client, SIGNATURE_HMAC, SIGNATURE_TYPE_AUTH_HEADER
from oauthlib.oauth1 import SIGNATURE_TYPE_BODY
from requests.utils import to_native_string
from requests.auth import AuthBase

CONTENT_TYPE_FORM_URLENCODED = "application/x-www-form-urlencoded"
CONTENT_TYPE_MULTI_PART = "multipart/form-data"


log = logging.getLogger(__name__)

# OBS!: Correct signing of requests are conditional on invoking OAuth1
# as the last step of preparing a request, or at least having the
# content-type set properly.
class OAuth1(AuthBase):
    """Signs the request using OAuth 1 (RFC5849)"""

    client_class = Client

    def __init__(
        self,
        client_key,
        client_secret=None,
        resource_owner_key=None,
        resource_owner_secret=None,
        callback_uri=None,
        signature_method=SIGNATURE_HMAC,
        signature_type=SIGNATURE_TYPE_AUTH_HEADER,
        rsa_key=None,
        verifier=None,
        decoding="utf-8",
        client_class=None,
        force_include_body=False,
        **kwargs
    ):

        try:
            signature_type = signature_type.upper()
        except AttributeError:
            pass

        client_class = client_class or self.client_class

        self.force_include_body = force_include_body

        self.client = client_class(
            client_key,
            client_secret,
            resource_owner_key,
            resource_owner_secret,
            callback_uri,
            signature_method,
            signature_type,
            rsa_key,
            verifier,
            decoding=decoding,
            **kwargs
        )

    def __call__(self, r):
        """Add OAuth parameters to the request.

        Parameters may be included from the body if the content-type is
        urlencoded, if no content type is set a guess is made.
        """
        # Overwriting url is safe here as request will not modify it past
        # this point.
        log.debug("Signing request %s using client %s", r, self.client)

        content_type = r.headers.get("Content-Type", "")
        if (
            not content_type
            and extract_params(r.body)
            or self.client.signature_type == SIGNATURE_TYPE_BODY
        ):
            content_type = CONTENT_TYPE_FORM_URLENCODED
        if not isinstance(content_type, str):
            content_type = content_type.decode("utf-8")

        is_form_encoded = CONTENT_TYPE_FORM_URLENCODED in content_type

        log.debug(
            "Including body in call to sign: %s",
            is_form_encoded or self.force_include_body,
        )

        if is_form_encoded:
            r.headers["Content-Type"] = CONTENT_TYPE_FORM_URLENCODED
            r.url, headers, r.body = self.client.sign(
                str(r.url), str(r.method), r.body or "", r.headers
            )
        elif self.force_include_body:
            # To allow custom clients to work on non form encoded bodies.
            r.url, headers, r.body = self.client.sign(
                str(r.url), str(r.method), r.body or "", r.headers
            )
        else:
            # Omit body data in the signing of non form-encoded requests
            r.url, headers, _ = self.client.sign(
                str(r.url), str(r.method), None, r.headers
            )

        r.prepare_headers(headers)
        r.url = to_native_string(r.url)
        log.debug("Updated url: %s", r.url)
        log.debug("Updated headers: %s", headers)
        log.debug("Updated body: %r", r.body)
        return r

1	# -- coding: utf-8 --
2	import logging	6✔
3
4	from oauthlib.common import extract_params	6✔
5	from oauthlib.oauth1 import Client, SIGNATURE_HMAC, SIGNATURE_TYPE_AUTH_HEADER	6✔
6	from oauthlib.oauth1 import SIGNATURE_TYPE_BODY	6✔
7	from requests.utils import to_native_string	6✔
8	from requests.auth import AuthBase	6✔
9
10	CONTENT_TYPE_FORM_URLENCODED = "application/x-www-form-urlencoded"	6✔
11	CONTENT_TYPE_MULTI_PART = "multipart/form-data"	6✔
12
13
14	log = logging.getLogger(__name__)	6✔
15
16	# OBS!: Correct signing of requests are conditional on invoking OAuth1
17	# as the last step of preparing a request, or at least having the
18	# content-type set properly.
19	class OAuth1(AuthBase):	6✔
20	"""Signs the request using OAuth 1 (RFC5849)"""
21
22	client_class = Client	6✔
23
24	def __init__(	6✔
25	self,
26	client_key,
27	client_secret=None,
28	resource_owner_key=None,
29	resource_owner_secret=None,
30	callback_uri=None,
31	signature_method=SIGNATURE_HMAC,
32	signature_type=SIGNATURE_TYPE_AUTH_HEADER,
33	rsa_key=None,
34	verifier=None,
35	decoding="utf-8",
36	client_class=None,
37	force_include_body=False,
38	**kwargs
39	):
40
41	try:	6✔
42	signature_type = signature_type.upper()	6✔
43	except AttributeError:	×
44	pass	×
45
46	client_class = client_class or self.client_class	6✔
47
48	self.force_include_body = force_include_body	6✔
49
50	self.client = client_class(	6✔
51	client_key,
52	client_secret,
53	resource_owner_key,
54	resource_owner_secret,
55	callback_uri,
56	signature_method,
57	signature_type,
58	rsa_key,
59	verifier,
60	decoding=decoding,
61	**kwargs
62	)
63
64	def __call__(self, r):	6✔
65	"""Add OAuth parameters to the request.
66
67	Parameters may be included from the body if the content-type is
68	urlencoded, if no content type is set a guess is made.
69	"""
70	# Overwriting url is safe here as request will not modify it past
71	# this point.
72	log.debug("Signing request %s using client %s", r, self.client)	6✔
73
74	content_type = r.headers.get("Content-Type", "")	6✔
75	if (	6✔
76	not content_type
77	and extract_params(r.body)
78	or self.client.signature_type == SIGNATURE_TYPE_BODY
79	):
80	content_type = CONTENT_TYPE_FORM_URLENCODED	6✔
81	if not isinstance(content_type, str):	6✔
82	content_type = content_type.decode("utf-8")	×
83
84	is_form_encoded = CONTENT_TYPE_FORM_URLENCODED in content_type	6✔
85
86	log.debug(	6✔
87	"Including body in call to sign: %s",
88	is_form_encoded or self.force_include_body,
89	)
90
91	if is_form_encoded:	6✔
92	r.headers["Content-Type"] = CONTENT_TYPE_FORM_URLENCODED	6✔
93	r.url, headers, r.body = self.client.sign(	6✔
94	str(r.url), str(r.method), r.body or "", r.headers
95	)
96	elif self.force_include_body:	6✔
97	# To allow custom clients to work on non form encoded bodies.
98	r.url, headers, r.body = self.client.sign(	×
99	str(r.url), str(r.method), r.body or "", r.headers
100	)
101	else:
102	# Omit body data in the signing of non form-encoded requests
103	r.url, headers, _ = self.client.sign(	6✔
104	str(r.url), str(r.method), None, r.headers
105	)
106
107	r.prepare_headers(headers)	6✔
108	r.url = to_native_string(r.url)	6✔
109	log.debug("Updated url: %s", r.url)	6✔
110	log.debug("Updated headers: %s", headers)	6✔
111	log.debug("Updated body: %r", r.body)	6✔
112	return r	6✔

requests / requests-oauthlib / 8621812797

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous