{"id":17740513,"url":"https://github.com/flywirecorp/glare","last_synced_at":"2025-04-21T07:32:37.992Z","repository":{"id":48561553,"uuid":"58464468","full_name":"flywirecorp/glare","owner":"flywirecorp","description":"Ruby gem for CloudFlare API v4","archived":false,"fork":false,"pushed_at":"2023-01-25T14:43:15.000Z","size":153,"stargazers_count":14,"open_issues_count":0,"forks_count":3,"subscribers_count":40,"default_branch":"master","last_synced_at":"2024-09-17T14:00:20.719Z","etag":null,"topics":["cloudflare","cloudflare-account","cloudflare-api","dns-record","hacktoberfest","ruby","ruby-gem","rubygems"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flywirecorp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-10T13:40:34.000Z","updated_at":"2023-05-24T03:54:23.000Z","dependencies_parsed_at":"2023-02-14T08:31:20.688Z","dependency_job_id":null,"html_url":"https://github.com/flywirecorp/glare","commit_stats":null,"previous_names":["peertransfer/glare"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flywirecorp%2Fglare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flywirecorp%2Fglare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flywirecorp%2Fglare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flywirecorp%2Fglare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flywirecorp","download_url":"https://codeload.github.com/flywirecorp/glare/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250014776,"owners_count":21361007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflare","cloudflare-account","cloudflare-api","dns-record","hacktoberfest","ruby","ruby-gem","rubygems"],"created_at":"2024-10-26T03:06:16.860Z","updated_at":"2025-04-21T07:32:37.732Z","avatar_url":"https://github.com/flywirecorp.png","language":"Ruby","readme":"# Glare\n\nRuby gem to interact with CloudFlare API v4\n\n## Build Status\n\n[![Build Status](https://github.com/peertransfer/glare/actions/workflows/ruby.yml/badge.svg)](https://github.com/peertransfer/glare/actions)\n[![Code Climate](https://codeclimate.com/github/peertransfer/glare/badges/gpa.svg)](https://codeclimate.com/github/peertransfer/glare)\n[![Known Vulnerabilities](https://snyk.io/test/github/peertransfer/glare/badge.svg)](https://snyk.io/test/github/peertransfer/glare)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'glare'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install glare\n\n## Usage\n\nIn order to configure credentials used to interact with Cloudflare API you will need to setup the following environment variable:\n\n- `CF_API_TOKEN`: Scoped API [token](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys) defined in a Cloudflare account\n\nor both of the following variables:\n\n- `CF_EMAIL`: Email used to create a Cloudflare account\n- `CF_AUTH_KEY`: Auth key of the given user\n\nAdditionally, you can set other environment variables:\n\n- `CF_DEBUG`: Set to `1` to enable HTTP requests' debug\n\n### Create/update DNS record\n\n```ruby\nrequire 'glare'\n\nGlare.register('example.domain.com', 'destination.com' ,'CNAME')\nGlare.register('example.domain.com', 'destination.com' ,'CNAME', proxied: true)\nGlare.register('example.domain.com', 'destination.com' ,'CNAME', ttl: 300)\n```\n\nWhere:\n  - `example.domain.com`: Name of the record to create\n  - `destination.com`: Name(s) of the values of the record\n  - `CNAME`: Type of the DNS record\n\n### Delete DNS record\n\n```ruby\nrequire 'glare'\n\nGlare.deregister('example.domain.com', 'CNAME')\n```\n\nWhere:\n  - `example.domain.com`: Name of the record to destroy\n  - `CNAME`: Type of the DNS record\n\n### Resolve DNS record\n\n```ruby\nrequire 'glare'\n\nGlare.resolve('example.domain.com', 'CNAME')\n```\n\nWhere:\n  - `example.domain.com`: Name of the record to resolve\n  - `CNAME`: Type of the DNS record\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\n1. Fork it ( https://github.com/peertransfer/glare/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflywirecorp%2Fglare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflywirecorp%2Fglare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflywirecorp%2Fglare/lists"}