Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/princemaple/elixir-cloudflare-api-client
Cloudflare API Client for Elixir community
https://github.com/princemaple/elixir-cloudflare-api-client
api-client cloudflare elixir rest-api
Last synced: 11 days ago
JSON representation
Cloudflare API Client for Elixir community
- Host: GitHub
- URL: https://github.com/princemaple/elixir-cloudflare-api-client
- Owner: princemaple
- License: mit
- Created: 2021-02-09T10:28:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-06T00:45:14.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T00:02:45.610Z (7 months ago)
- Topics: api-client, cloudflare, elixir, rest-api
- Language: Elixir
- Homepage: https://hex.pm/packages/cloudflare
- Size: 143 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloudflare
[](https://hex.pm/packages/cloudflare)
[](https://hex.pm/packages/cloudflare)
[](https://github.com/princemaple/elixir-cloudflare-api-client)
`Cloudflare` API Client. Written for the Elixir community,
based on [`:restlax`](https://github.com/princemaple/restlax).
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `cloudflare` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:cloudflare, "~> 0.2"}
]
end
```
## Configuration
### Authentication
```elixir
config :cloudflare,
auth_token: "my-auth-token"
```
Or
```elixir
config :cloudflare,
auth_email: "[email protected]",
auth_key: "my-auth-key"
```
Or both `¯\(°_o)/¯`.
#### Or passed in
```elixir
Cloudflare.Zone.index(opts: [auth_token: "my-auth-token"])
```
```elixir
Cloudflare.Zone.index(opts: [auth_email: "[email protected]", auth_key: "my-auth-key"])
```
Or directly as header
```elixir
Cloudflare.Zone.index(headers: [{"Authorization", "Bearer my-auth-token"}])
```
```elixir
Cloudflare.Zone.index(headers: [{"X-Auth-Email", "[email protected]"}, {"X-Auth-Key", "my-auth-key"}])
```
### Register client
Normally it's teadius to explicitly pass the client module in.
```elixir
Cloudflare.Zone.index(client: CloudFlare.Client)
```
It can be registered on application start, e.g. in `YourApp.Application.start`
```elixir
defmodule YourApp.Application do
use Application
def start(_type, _args) do
Cloudflare.Client.init() # <- You can add this line
children = [
{Phoenix.PubSub, name: App.PubSub},
App.Repo,
AppWeb.Endpoint
]
opts = [strategy: :one_for_one, name: App.Supervisor]
Supervisor.start_link(children, opts)
end
def config_change(changed, _new, removed) do
AppWeb.Endpoint.config_change(changed, removed)
:ok
end
end
```
## Usage
```elixir
Cloudflare.Zone.index()
```
```elixir
Cloudflare.DnsRecord.index(params: [zone_id: "my-zone-id"])
```
```elixir
Cloudflare.DnsRecord.create(
%{type: "A", name: "my.domain", content: "127.0.0.1", ttl: 120},
params: [zone_id: "my-zone-id"]
)
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/cloudflare](https://hexdocs.pm/cloudflare).
## Contribution
Half manually scraped Cloudflare docs are located in `priv/docs`. Pick an entity and write module for it.
Simple entities can be as easy as `Cloudflare.Account` and `Cloudflare.User`
Some need a little customization like `Cloudflare.DnsRecord`
Some need more `Cloudflare.ZoneSetting`