https://github.com/grottopress/cryflare
A low-level API client for Cloudflare® v4
https://github.com/grottopress/cryflare
api cdn cloudflare crystal dns http-client rest
Last synced: 11 months ago
JSON representation
A low-level API client for Cloudflare® v4
- Host: GitHub
- URL: https://github.com/grottopress/cryflare
- Owner: GrottoPress
- License: mit
- Created: 2020-12-10T18:21:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T17:39:28.000Z (over 1 year ago)
- Last Synced: 2024-08-15T19:50:06.898Z (over 1 year ago)
- Topics: api, cdn, cloudflare, crystal, dns, http-client, rest
- Language: Crystal
- Homepage:
- Size: 125 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cryflare
*Cryflare* is a low-level API client for *Cloudflare®* v4. It features an intuitive interface that maps directly to the *Cloudflare* API.
### Usage Examples
```crystal
# Create a new client
client = Cryflare.new(email: "cloudflare-email", key: "cloudflare-api-key")
```
1. Get zone by name
```crystal
client.zones.list(name: "grottopress.com") do |response|
if response.success?
response.result.try &.first?.try do |zone|
puts zone.id
puts zone.name
puts zone.owner.name
# ...
end
else
response.errors.each do |error|
puts error.code
puts error.message
end
end
end
```
1. Create new DNS record
```crystal
client.dns_records.create(
"zone-id",
type: "A",
name: "example.com",
content: "127.0.0.1",
ttl: 120
) do |response|
if response.success?
response.result.try do |dns_record|
puts dns_record.id
puts dns_record.name
puts dns_record.content
# ...
end
else
response.errors.each do |error|
puts error.code
puts error.message
end
end
end
```
1. Delete firewall rule
```crystal
client.firewall_rules.delete("zone-id", "rule-id") do |response|
if response.success?
response.result.try do |firewall_rule|
puts firewall_rule.id
# ...
end
else
response.errors.each do |error|
puts error.code
puts error.message
end
end
end
```
## Documentation
Find the complete documentation in the `docs/` directory of this repository.
## Todo
- [x] Accounts
- [x] Account members
- [x] Account roles
- [x] User
- [ ] User memberships
- [x] User organizations
- [x] Zones
- [x] Zone settings
- [x] DNS records
- [x] Cloudflare IPs
- [x] User-level Firewall Access Rule
- [x] Account-level Firewall access rule
- [x] Firewall Access Rule for a Zone
- [x] Filters
- [x] Firewall rules
- [ ] Page Rules for a Zone
- [ ] Available Page Rules for a Zone
## Development
Generate a token from your Cloudflare [account](https://dash.cloudflare.com/profile/api-tokens) that can read zones (`Zone:Read`).
Create a `.env.sh` file:
```bash
#!/bin/bash
#
export CLOUDFLARE_TOKEN='your-cloudflare-token-here'
```
Update the file with your own details. Then run tests with `source .env.sh && crystal spec`.
**IMPORTANT**: Remember to set permissions for your env file to `0600` or stricter: `chmod 0600 .env*`.
## Contributing
1. [Fork it](https://github.com/GrottoPress/cryflare/fork)
1. Switch to the `master` branch: `git checkout master`
1. Create your feature branch: `git checkout -b my-new-feature`
1. Make your changes, updating changelog and documentation as appropriate.
1. Commit your changes: `git commit`
1. Push to the branch: `git push origin my-new-feature`
1. Submit a new *Pull Request* against the `GrottoPress:master` branch.
## Legal
*Cloudflare is a registered trademark of Cloudflare, Inc.*