summaryrefslogtreecommitdiff
path: root/python-emailage-official.spec
blob: c17198a127da1aebc11a9f700c36123d1684ba63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
%global _empty_manifest_terminate_build 0
Name:		python-emailage-official
Version:	1.2.2
Release:	1
Summary:	Official Emailage API client written in Python
License:	MIT
URL:		https://www.emailage.com/
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/11/fe/0804d0a2129d1b7413fb9d018163063922a3169aefc5a811f6da17aae7ce/emailage-official-1.2.2.tar.gz
BuildArch:	noarch


%description
##### `emailage.signature.create`( _method_ , _url_ , _params_ , _hmac_key_ )
Generates the OAuth1.0 signature used as the value for the query string
parameter oauth_signature
Parameters
  * **method** ( _str_ )  HTTP method that will be used to send the request ( GET | POST )
  * **url** ( _str_ )  API domain and endpoint up to the ?
  * **params** ( _dict_ )  user-provided query string parameters and the OAuth1.0 parameters :method add_oauth_entries_to_fields_dict:
  * **hmac_key** ( _str_ )  for Emailage users, this is your consumer token with an & (ampersand) appended to the end
Returns
str value used for oauth_signature
Example
    >>> from emailage.signature import add_oauth_entries_to_fields_dict, create
    >>> your_api_key = 'SOME_KEY'
    >>> your_hmac_key = 'SOME_SECRET' + '&'
    >>> api_url = 'https://sandbox.emailage.com/emailagevalidator/'
    >>> query_params = { 'query': 'user.you.are.validating@gmail.com', 'user_email': 'admin@yourcompany.com' }
    >>> query_params = add_oauth_entries_to_fields_dict(your_api_key, query_params)
    >>> query_params['oauth_signature'] = create('GET', api_url, query_params, your_hmac_key)
(C)2018, Emailage Dev Team. | Powered by Sphinx 2.2.0 & Alabaster 0.7.12 |
Page source
# Revision History
## 1.2.2 (11 March 2020)
- Fix POST requests for Python 2.7 users
## 1.2.1 (3 March 2020)
- Remove mock dependency from requirements.txt
## 1.2.0 (10 January 2020)
- HTTP verb for requests is a parameter to `__init__`, defaults to GET
- Request timeout can be specified as parameter to `__init__`
- UTF-8 characters may be sent via the POST request
## 1.1.6 (14 December 2018)
 - Fix choice of URL encoding function for Python 2.7 users
## 1.1.4 (17 September 2018)
 - Corrected IPv4 validation Regex to allow 0s in octets 2,3,4
## 1.1.0 (30 August 2018)
 - Corrected bug in the URL encoding of spaces
 - Significantly expanded documentation of signature functions
 - Extracted all OAuth signature generation logic from request generation into the signature module
 - Explicit decoding of API response bytes removes the need to run a Regex over the response
## 1.0.2 (30 October 2017)
 - Corrected the validation of IPv4 and IPv6 IP addresses
 - Added an optional parameter to specify TLS 1.1 or 1.2 on the initialization of EmailageClient

%package -n python3-emailage-official
Summary:	Official Emailage API client written in Python
Provides:	python-emailage-official
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-emailage-official
##### `emailage.signature.create`( _method_ , _url_ , _params_ , _hmac_key_ )
Generates the OAuth1.0 signature used as the value for the query string
parameter oauth_signature
Parameters
  * **method** ( _str_ )  HTTP method that will be used to send the request ( GET | POST )
  * **url** ( _str_ )  API domain and endpoint up to the ?
  * **params** ( _dict_ )  user-provided query string parameters and the OAuth1.0 parameters :method add_oauth_entries_to_fields_dict:
  * **hmac_key** ( _str_ )  for Emailage users, this is your consumer token with an & (ampersand) appended to the end
Returns
str value used for oauth_signature
Example
    >>> from emailage.signature import add_oauth_entries_to_fields_dict, create
    >>> your_api_key = 'SOME_KEY'
    >>> your_hmac_key = 'SOME_SECRET' + '&'
    >>> api_url = 'https://sandbox.emailage.com/emailagevalidator/'
    >>> query_params = { 'query': 'user.you.are.validating@gmail.com', 'user_email': 'admin@yourcompany.com' }
    >>> query_params = add_oauth_entries_to_fields_dict(your_api_key, query_params)
    >>> query_params['oauth_signature'] = create('GET', api_url, query_params, your_hmac_key)
(C)2018, Emailage Dev Team. | Powered by Sphinx 2.2.0 & Alabaster 0.7.12 |
Page source
# Revision History
## 1.2.2 (11 March 2020)
- Fix POST requests for Python 2.7 users
## 1.2.1 (3 March 2020)
- Remove mock dependency from requirements.txt
## 1.2.0 (10 January 2020)
- HTTP verb for requests is a parameter to `__init__`, defaults to GET
- Request timeout can be specified as parameter to `__init__`
- UTF-8 characters may be sent via the POST request
## 1.1.6 (14 December 2018)
 - Fix choice of URL encoding function for Python 2.7 users
## 1.1.4 (17 September 2018)
 - Corrected IPv4 validation Regex to allow 0s in octets 2,3,4
## 1.1.0 (30 August 2018)
 - Corrected bug in the URL encoding of spaces
 - Significantly expanded documentation of signature functions
 - Extracted all OAuth signature generation logic from request generation into the signature module
 - Explicit decoding of API response bytes removes the need to run a Regex over the response
## 1.0.2 (30 October 2017)
 - Corrected the validation of IPv4 and IPv6 IP addresses
 - Added an optional parameter to specify TLS 1.1 or 1.2 on the initialization of EmailageClient

%package help
Summary:	Development documents and examples for emailage-official
Provides:	python3-emailage-official-doc
%description help
##### `emailage.signature.create`( _method_ , _url_ , _params_ , _hmac_key_ )
Generates the OAuth1.0 signature used as the value for the query string
parameter oauth_signature
Parameters
  * **method** ( _str_ )  HTTP method that will be used to send the request ( GET | POST )
  * **url** ( _str_ )  API domain and endpoint up to the ?
  * **params** ( _dict_ )  user-provided query string parameters and the OAuth1.0 parameters :method add_oauth_entries_to_fields_dict:
  * **hmac_key** ( _str_ )  for Emailage users, this is your consumer token with an & (ampersand) appended to the end
Returns
str value used for oauth_signature
Example
    >>> from emailage.signature import add_oauth_entries_to_fields_dict, create
    >>> your_api_key = 'SOME_KEY'
    >>> your_hmac_key = 'SOME_SECRET' + '&'
    >>> api_url = 'https://sandbox.emailage.com/emailagevalidator/'
    >>> query_params = { 'query': 'user.you.are.validating@gmail.com', 'user_email': 'admin@yourcompany.com' }
    >>> query_params = add_oauth_entries_to_fields_dict(your_api_key, query_params)
    >>> query_params['oauth_signature'] = create('GET', api_url, query_params, your_hmac_key)
(C)2018, Emailage Dev Team. | Powered by Sphinx 2.2.0 & Alabaster 0.7.12 |
Page source
# Revision History
## 1.2.2 (11 March 2020)
- Fix POST requests for Python 2.7 users
## 1.2.1 (3 March 2020)
- Remove mock dependency from requirements.txt
## 1.2.0 (10 January 2020)
- HTTP verb for requests is a parameter to `__init__`, defaults to GET
- Request timeout can be specified as parameter to `__init__`
- UTF-8 characters may be sent via the POST request
## 1.1.6 (14 December 2018)
 - Fix choice of URL encoding function for Python 2.7 users
## 1.1.4 (17 September 2018)
 - Corrected IPv4 validation Regex to allow 0s in octets 2,3,4
## 1.1.0 (30 August 2018)
 - Corrected bug in the URL encoding of spaces
 - Significantly expanded documentation of signature functions
 - Extracted all OAuth signature generation logic from request generation into the signature module
 - Explicit decoding of API response bytes removes the need to run a Regex over the response
## 1.0.2 (30 October 2017)
 - Corrected the validation of IPv4 and IPv6 IP addresses
 - Added an optional parameter to specify TLS 1.1 or 1.2 on the initialization of EmailageClient

%prep
%autosetup -n emailage-official-1.2.2

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-emailage-official -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.2-1
- Package Spec generated