Rubyflare

Super thin Ruby wrapper for Cloudflare's V4 API.

Installation

Add this line to your application's Gemfile:

gem 'rubyflare'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubyflare

Usage

First off, open https://api.cloudflare.com/ to see all the availble endpoints

Quick start

  require 'rubyflare'
  
  connection = Rubyflare.connect_with('[email protected]', 'supersecretapikey')
  
  # Get your user account details
  user = connection.get('user')

  # Get the result
  p user.result

  # Get your first name
  p user.result[:first_name]

  # Create a new zone (domain)
  zone = connection.post('zones', { name: 'supercooldomain.com' })

  # Check it out
  p zone.result

  # Want more details? Pluralize #result
  p zones.results

  # Catch errors
  begin
    connection.get('user')
  rescue => e
    # Inspect this for more details
    p e.response
  end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/trev/rubyflare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.