# Calligraphy [![Build Status](https://travis-ci.org/eanlain/calligraphy.svg?branch=master)](https://travis-ci.org/eanlain/calligraphy) [![Gem Version](https://badge.fury.io/rb/calligraphy.svg)](https://badge.fury.io/rb/calligraphy)

Calligraphy is a Web Distributed Authoring and Versioning (WebDAV) solution for Rails that:

* Provides a framework for handling WebDAV requests (e.g. `PROPFIND`, `PROPPATCH`)
* Allows you to extend WedDAV functionality to any type of resource
* Passes all of the [Litmus](https://github.com/eanlain/litmus) tests (using `Calligraphy::FileResource` and digest authentication)

## Getting Started

Add the following line to your Gemfile:

```ruby
gem 'calligraphy'
```

Then, run `bundle install`

Next, run the generator:

```ruby
rails generate calligraphy:install
```

The generator will install an initializer which describes Calligraphy's configuration options.

Finally, set up a `calligraphy_resource` route in `config/routes.rb` with a `resource_class`.

```ruby
# config/routes.rb
calligraphy_resource :webdav, resource_class: Calligraphy::FileResource
```

The above will create a route, `/webdav` that will be able to handle the following HTTP request methods:

* `OPTIONS`
* `GET`
* `PUT`
* `DELETE`
* `COPY`
* `MOVE`
* `MKCOL`
* `PROPFIND`
* `PROPPATCH`
* `LOCK`
* `UNLOCK`

The routes will also use the `Calligraphy::FileResource`, enabling Rails to carry out WebDAV actions on files.
Additionally, when using the `FileResource` class the resource root path (the location you'd like to serve files from) with the `resource_root_path` key:

```ruby
# config/routes.rb
calligraphy_resource :webdav, resource_class: Calligraphy::FileResource, resource_root_path: '/home/webdav'
```

This will serve local files from `/home/webdav` on the server through the `/webdav` endpoint.

## Extensibility

The `Calligraphy::Resource` class exposes all the methods used in the various `Calligraphy::WebDavRequest` classes.
To create a custom resource, simply inherit from `Calligraphy::Resource` and redefine the public methods you'd like to customize.

For example, to create a `CalendarResource`:

```ruby
module Calligraphy
  class CalendarResource < Resource

    def propfind(nodes)
      # custom implementation of propfind for CalendarResource
    end

    ...
  end
end
```

## License

Calligraphy is Copyright © 2017 Brandon Robins.
It is free software, and may be redistributed under the terms specified in the [LICENSE](/LICENSE) file.