Gem Version Codeship Status for brandon-meeks/bunny_cdn Maintainability

BunnyCdn

This gem allows you to interact with the BunnyCdn API. Currently you can interact with the Storage and Pullzone APIs.

This does require you to have an account with BunnyCDN.

Installation

Add this line to your application's Gemfile:

gem 'bunny_cdn'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bunny_cdn

Usage

Rails

Create the initializer config/initializers/bunny_cdn.rb and set the configuration options.

BunnyCdn.configure do |config|
    config.apiKey = # The API key for your BunnyCDN account
    config.storageZone = # The storage zone you want to work with
    config.region = # the region of the storage zone. Options are 'eu' for Falkenstein, 'ny' for New York, 'la' for Los Angeles, or 'sg' for Asia
    config.accessKey = # The password for your storage zone
end

File Uploads

New to v1.2.0, there are now two methods for handling file uploads.

To upload a file from a file input on a form, simply use

BunnyCdn::Storage.uploadFormFile(path, file)

To upload a file to BunnyCDN that already exists on the system, or to upload a file as a secondary option to storing it on the system use

BunnyCdn::Storage.uploadFile(path, file)

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/[USERNAME]/bunny_cdn. 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.

Code of Conduct

Everyone interacting in the BunnyCdn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.