Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 0535bb4

Browse files
mahtinmahtin
committed
2.9.4 release
2 parents d2622ed + 44d7d65 commit 0535bb4

5 files changed

Lines changed: 168 additions & 14 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
- 2021-07-21 11:47:15 +0200 [ff66435](../../commit/ff664357f9fe2b24767e909a8777864f6d8efa11) handle /pages using {} for account_id
3131
- 2020-12-03 14:24:07 -0800 [dc14687](../../commit/dc14687e4957c4ed93f65fe697b2821a0c6f4a93) CHANGELOG.md pushed to github
3232
- 2020-12-03 14:22:47 -0800 [9e170eb](../../commit/9e170ebe2f9139d2b0620d7f31be2330dd532aaa) 2.8.14 release
33+
- 2020-11-14 12:58:07 -0500 [acc3b99](../../commit/acc3b9963581ad5b875f6f80b517822261775d62) Removing excess trailing parenthesis
34+
- 2020-11-14 12:51:53 -0500 [bf583e2](../../commit/bf583e2ccce999cdeaa27ac3a6860ef425eb9343) Removing excess trailing parenthesis
3335
- 2020-09-20 15:58:25 -0700 [b70b520](../../commit/b70b5209664dc64ae4f0e5773806aec05b799cbd) first pass at adding travis CI
3436
- 2020-09-17 14:17:45 -0700 [9975223](../../commit/997522321c61f08cc91bcc61f3ee707f38179f9a) zones/waiting_rooms, accounts/diagnostics, and more
3537
- 2020-08-13 10:41:22 -0700 [8ed99e4](../../commit/8ed99e4899637a7d7bc11c4bee76982537fcc45f) CHANGELOG.md pushed to github

‎CloudFlare/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
""" Cloudflare v4 API"""
22
from __future__ import absolute_import
33

4-
__version__ = '2.9.3'
4+
__version__ = '2.9.4'
55

66
from .cloudflare import CloudFlare
77

‎CloudFlare/read_configs.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ def read_configs(profile=None):
1414
config = {'email': None, 'token': None, 'certtoken': None, 'extras': None, 'base_url': None, 'profile': None}
1515

1616
# envioronment variables override config files - so setup first
17-
config['email'] = os.getenv('CF_API_EMAIL')
18-
config['token'] = os.getenv('CF_API_KEY')
19-
config['certtoken'] = os.getenv('CF_API_CERTKEY')
20-
config['extras'] = os.getenv('CF_API_EXTRAS')
21-
config['base_url'] = os.getenv('CF_API_URL')
17+
config['email'] = os.getenv('CLOUDFLARE_EMAIL') if os.getenv('CLOUDFLARE_EMAIL') != None else os.getenv('CF_API_EMAIL')
18+
config['token'] = os.getenv('CLOUDFLARE_API_KEY') if os.getenv('CLOUDFLARE_API_KEY') != None else os.getenv('CF_API_KEY')
19+
config['certtoken'] = os.getenv('CLOUDFLARE_API_CERTKEY') if os.getenv('CLOUDFLARE_API_CERTKEY') != None else os.getenv('CF_API_CERTKEY')
20+
config['extras'] = os.getenv('CLOUDFLARE_API_EXTRAS') if os.getenv('CLOUDFLARE_API_EXTRAS') != None os.getenv('CF_API_EXTRAS')
21+
config['base_url'] = os.getenv('CLOUDFLARE_API_URL') if os.getenv('CLOUDFLARE_API_URL') != None os.getenv('CF_API_URL')
2222
if profile is None:
2323
profile = 'CloudFlare'
2424
config['profile'] = profile

‎README.md‎

Lines changed: 80 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ import CloudFlare
185185
cf = CloudFlare.CloudFlare()
186186

187187
# A minimal call with debug enabled
188-
cf = CloudFlare.CloudFlare(debug=True))
188+
cf = CloudFlare.CloudFlare(debug=True)
189189

190190
# An authenticated call using an API Token (note the missing email)
191191
cf = CloudFlare.CloudFlare(token='00000000000000000000000000000000')
@@ -202,16 +202,16 @@ import CloudFlare
202202

203203
If the account email and API key are not passed when you create the class, then they are retrieved from either the users exported shell environment variables or the .cloudflare.cfg or ~/.cloudflare.cfg or ~/.cloudflare/cloudflare.cfg files, in that order.
204204

205-
If you're using an API Token, any `cloudflare.cfg` file must either not contain an `email` attribute or be a zero length string and the `CF_API_EMAIL` environment variable must be unset or be a zero length string, otherwise the token will be treated as a key and will throw an error.
205+
If you're using an API Token, any `cloudflare.cfg` file must either not contain an `email` attribute or be a zero length string and the `CLOUDFLARE_EMAIL` environment variable must be unset or be a zero length string, otherwise the token will be treated as a key and will throw an error.
206206

207207
There is one call that presently doesn't need any email or token certification (the */ips* call); hence you can test without any values saved away.
208208

209209
### Using shell environment variables
210210

211211
```bash
212-
$ export CF_API_EMAIL='user@example.com' # Do not set if using an API Token
213-
$ export CF_API_KEY='00000000000000000000000000000000'
214-
$ export CF_API_CERTKEY='v1.0-...'
212+
$ export CLOUDFLARE_EMAIL='user@example.com' # Do not set if using an API Token
213+
$ export CLOUDFLARE_API_KEY='00000000000000000000000000000000'
214+
$ export CLOUDFLARE_API_CERTKEY='v1.0-...'
215215
$
216216
```
217217

@@ -297,7 +297,7 @@ This can be used with email values also.
297297

298298
### About /certificates and certtoken
299299

300-
The *CF_API_CERTKEY* or *certtoken* values are used for the Origin-CA */certificates* API calls.
300+
The *CLOUDFLARE_API_CERTKEY* or *certtoken* values are used for the Origin-CA */certificates* API calls.
301301
You can leave *certtoken* in the configuration with a blank value (or omit the option variable fully).
302302

303303
The *extras* values are used when adding API calls outside of the core codebase.
@@ -426,7 +426,7 @@ Next a simple/single error response.
426426
This is simulated by providing incorrect authentication information.
427427

428428
```
429-
$ CF_API_EMAIL='someone@example.com' cli4 /zones/
429+
$ CLOUDFLARE_EMAIL='someone@example.com' cli4 /zones/
430430
cli4: /zones - 9103 Unknown X-Auth-Key or X-Auth-Email
431431
$
432432
```
@@ -740,6 +740,79 @@ COUNT=1 PAGE=7 PER_PAGE=5 TOTAL_COUNT=31 TOTAL_PAGES=7 -- varius.example vehicul
740740
COUNT=5 PAGE=6 PER_PAGE=5 TOTAL_COUNT=31 TOTAL_PAGES=7 -- vivamus.example
741741
```
742742

743+
### Paging thru lists (using cursors)
744+
745+
Some API calls use cursors to read beyond the initally returned values. See the API page in order to see which API calls do this.
746+
747+
```
748+
$ ACCOUNT_ID="00000000000000000000000000000000"
749+
$ LIST_ID="00000000000000000000000000000000"
750+
$
751+
$ cli4 --raw /accounts/::${ACCOUNT_ID}/rules/lists/::${LIST_ID}/items > /tmp/page1.json
752+
$ after=`jq -r '.result_info.cursors.after' < /tmp/page1.json`
753+
$ echo "after=$after"
754+
after=Mxm4GVmKjYbFjy2VxMPipnJigm1M_s6lCS9ABR9wx-RM2A
755+
$
756+
```
757+
758+
Once we have the ```after``` value, we can pass it along in order to read the next hunk of values. We finish when ```after``` returns as null (or isn't present).
759+
760+
```
761+
$ cli4 --raw cursor="$after" /accounts/::${ACCOUNT_ID}/rules/lists/::${LIST_ID}/items > /tmp/page2.json
762+
$ after=`jq -r '.result_info.cursors.after' < /tmp/page2.json`
763+
$ echo "after=$after"
764+
after=null
765+
$
766+
```
767+
768+
We can see the results now in two files.
769+
770+
```
771+
$ jq -c '.result[]' < /tmp/page1.json | wc -l
772+
25
773+
$
774+
775+
$ jq -c '.result[]' < /tmp/page2.json | wc -l
776+
5
777+
$
778+
779+
$ for f in /tmp/page?.json ; do jq -r '.result[]|.id,.ip,.comment' < $f | paste - - - ; done | column -s' ' -t
780+
0fe44928258549feb47126a966fbf4a0 0.0.0.0 all zero
781+
2e1e02120f5e466f8c0e26375e4cf4c8 1.0.0.1 Cloudflare DNS a
782+
9ca5fd0ac6f54fdbb9dedd3fb72ce2da 1.1.1.1 Cloudflare DNS b
783+
b3654987446743738c782f36ebe074f5 10.0.0.0/8 RFC1918 space
784+
90bec8ce37d242faa2e27d1e78c1d8e2 103.21.244.0/22 Cloudflare IP
785+
970a3c810cda41af9bef2c36a1892f7e 103.22.200.0/22 Cloudflare IP
786+
3ec8516158bf4f3cac18210f611ee541 103.31.4.0/22 Cloudflare IP
787+
ee9d268367204e6bb8e5e4c907f22de8 104.16.0.0/12 Cloudflare IP
788+
93ae02eda9774c45840af367a02fe529 108.162.192.0/18 Cloudflare IP
789+
62891ebf6db44aa494d79a6401af185e 131.0.72.0/22 Cloudflare IP
790+
cac40cd940cc470582b8c912a8a12bea 141.101.64.0/18 Cloudflare IP
791+
f6d5eacd81a2407f8e0d81caee21e7f8 162.158.0.0/15 Cloudflare IP
792+
3d538dfc38ab471d9d3fe78332acfa4e 172.16.0.0/12 RFC1918 space
793+
f353cb8f98424837ad35382a22b9debe 172.64.0.0/13 Cloudflare IP
794+
78f3e1a0bafc41f88d4d40ad49a642e0 173.245.48.0/20 Cloudflare IP
795+
c23a545475c54c32a7681c6b508d3e80 188.114.96.0/20 Cloudflare IP
796+
f693237c9e294fe481221cbc2d7c20ef 190.93.240.0/20 Cloudflare IP
797+
6d465ab3a0994c07827ebdcf8f34d977 192.168.0.0/16 RFC1918 space
798+
1ad1e634b3664bac939086185c62faf7 197.234.240.0/22 Cloudflare IP
799+
5d2968e7b3114d8e869a379d71c8ba86 198.41.128.0/17 Cloudflare IP
800+
6a69de60b31448fa864f0a3ac5abe8d0 224.0.0.0/24 Multicast
801+
30749cce89af4ab3a80e308294f46a46 240.0.0.0/4 Class E
802+
2b32c67ea4d044628abe39f28662d8f0 255.255.255.255 all ones
803+
cc7cd828b2fb4bcfb9391c2d3ef8d068 2400:cb00::/32 Cloudflare IP
804+
b30d4cbd7dcd48729e8ebeda552e48a8 2405:8100::/32 Cloudflare IP
805+
49db60758c8344959c338a74afc9748a 2405:b500::/32 Cloudflare IP
806+
96e9eca1923c40d5a84865145f5a5d6a 2606:4700::/32 Cloudflare IP
807+
21bc52a26e10405d89b7180ddcf49302 2803:f800::/32 Cloudflare IP
808+
ff78f842188e4b869eb5389ae9ab8f41 2a06:98c0::/29 Cloudflare IP
809+
0880cdfc40b14f6fa0639522a728859d 2c0f:f248::/32 Cloudflare IP
810+
$
811+
```
812+
813+
The ```result_info.cursors``` area also contains a ```before``` value for reverse scrolling.
814+
815+
As with ```per_page``` scrolling, raw mode is used.
743816

744817
### DNSSEC CLI examples
745818

‎README.rst‎

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ parameters.
210210
cf = CloudFlare.CloudFlare()
211211
212212
# A minimal call with debug enabled
213-
cf = CloudFlare.CloudFlare(debug=True))
213+
cf = CloudFlare.CloudFlare(debug=True)
214214
215215
# An authenticated call using an API Token (note the missing email)
216216
cf = CloudFlare.CloudFlare(token='00000000000000000000000000000000')
@@ -825,6 +825,85 @@ It produces the following results.
825825
COUNT=1 PAGE=7 PER_PAGE=5 TOTAL_COUNT=31 TOTAL_PAGES=7 -- varius.example vehicula.example velit.example velit.example vitae.example
826826
COUNT=5 PAGE=6 PER_PAGE=5 TOTAL_COUNT=31 TOTAL_PAGES=7 -- vivamus.example
827827

828+
Paging thru lists (using cursors)
829+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
830+
831+
Some API calls use cursors to read beyond the initally returned values.
832+
See the API page in order to see which API calls do this.
833+
834+
::
835+
836+
$ ACCOUNT_ID="00000000000000000000000000000000"
837+
$ LIST_ID="00000000000000000000000000000000"
838+
$
839+
$ cli4 --raw /accounts/::${ACCOUNT_ID}/rules/lists/::${LIST_ID}/items > /tmp/page1.json
840+
$ after=`jq -r '.result_info.cursors.after' < /tmp/page1.json`
841+
$ echo "after=$after"
842+
after=Mxm4GVmKjYbFjy2VxMPipnJigm1M_s6lCS9ABR9wx-RM2A
843+
$
844+
845+
Once we have the ``after`` value, we can pass it along in order to read
846+
the next hunk of values. We finish when ``after`` returns as null (or
847+
isn't present).
848+
849+
::
850+
851+
$ cli4 --raw cursor="$after" /accounts/::${ACCOUNT_ID}/rules/lists/::${LIST_ID}/items > /tmp/page2.json
852+
$ after=`jq -r '.result_info.cursors.after' < /tmp/page2.json`
853+
$ echo "after=$after"
854+
after=null
855+
$
856+
857+
We can see the results now in two files.
858+
859+
::
860+
861+
$ jq -c '.result[]' < /tmp/page1.json | wc -l
862+
25
863+
$
864+
865+
$ jq -c '.result[]' < /tmp/page2.json | wc -l
866+
5
867+
$
868+
869+
$ for f in /tmp/page?.json ; do jq -r '.result[]|.id,.ip,.comment' < $f | paste - - - ; done | column -s' ' -t
870+
0fe44928258549feb47126a966fbf4a0 0.0.0.0 all zero
871+
2e1e02120f5e466f8c0e26375e4cf4c8 1.0.0.1 Cloudflare DNS a
872+
9ca5fd0ac6f54fdbb9dedd3fb72ce2da 1.1.1.1 Cloudflare DNS b
873+
b3654987446743738c782f36ebe074f5 10.0.0.0/8 RFC1918 space
874+
90bec8ce37d242faa2e27d1e78c1d8e2 103.21.244.0/22 Cloudflare IP
875+
970a3c810cda41af9bef2c36a1892f7e 103.22.200.0/22 Cloudflare IP
876+
3ec8516158bf4f3cac18210f611ee541 103.31.4.0/22 Cloudflare IP
877+
ee9d268367204e6bb8e5e4c907f22de8 104.16.0.0/12 Cloudflare IP
878+
93ae02eda9774c45840af367a02fe529 108.162.192.0/18 Cloudflare IP
879+
62891ebf6db44aa494d79a6401af185e 131.0.72.0/22 Cloudflare IP
880+
cac40cd940cc470582b8c912a8a12bea 141.101.64.0/18 Cloudflare IP
881+
f6d5eacd81a2407f8e0d81caee21e7f8 162.158.0.0/15 Cloudflare IP
882+
3d538dfc38ab471d9d3fe78332acfa4e 172.16.0.0/12 RFC1918 space
883+
f353cb8f98424837ad35382a22b9debe 172.64.0.0/13 Cloudflare IP
884+
78f3e1a0bafc41f88d4d40ad49a642e0 173.245.48.0/20 Cloudflare IP
885+
c23a545475c54c32a7681c6b508d3e80 188.114.96.0/20 Cloudflare IP
886+
f693237c9e294fe481221cbc2d7c20ef 190.93.240.0/20 Cloudflare IP
887+
6d465ab3a0994c07827ebdcf8f34d977 192.168.0.0/16 RFC1918 space
888+
1ad1e634b3664bac939086185c62faf7 197.234.240.0/22 Cloudflare IP
889+
5d2968e7b3114d8e869a379d71c8ba86 198.41.128.0/17 Cloudflare IP
890+
6a69de60b31448fa864f0a3ac5abe8d0 224.0.0.0/24 Multicast
891+
30749cce89af4ab3a80e308294f46a46 240.0.0.0/4 Class E
892+
2b32c67ea4d044628abe39f28662d8f0 255.255.255.255 all ones
893+
cc7cd828b2fb4bcfb9391c2d3ef8d068 2400:cb00::/32 Cloudflare IP
894+
b30d4cbd7dcd48729e8ebeda552e48a8 2405:8100::/32 Cloudflare IP
895+
49db60758c8344959c338a74afc9748a 2405:b500::/32 Cloudflare IP
896+
96e9eca1923c40d5a84865145f5a5d6a 2606:4700::/32 Cloudflare IP
897+
21bc52a26e10405d89b7180ddcf49302 2803:f800::/32 Cloudflare IP
898+
ff78f842188e4b869eb5389ae9ab8f41 2a06:98c0::/29 Cloudflare IP
899+
0880cdfc40b14f6fa0639522a728859d 2c0f:f248::/32 Cloudflare IP
900+
$
901+
902+
The ``result_info.cursors`` area also contains a ``before`` value for
903+
reverse scrolling.
904+
905+
As with ``per_page`` scrolling, raw mode is used.
906+
828907
DNSSEC CLI examples
829908
~~~~~~~~~~~~~~~~~~~
830909

0 commit comments

Comments
 (0)