{"id":15175162,"url":"https://github.com/eanlain/calligraphy","last_synced_at":"2025-10-01T12:30:58.760Z","repository":{"id":54232845,"uuid":"107821719","full_name":"eanlain/calligraphy","owner":"eanlain","description":"WebDAV framework and extension for Rails","archived":true,"fork":false,"pushed_at":"2021-03-02T03:54:44.000Z","size":133,"stargazers_count":11,"open_issues_count":11,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-19T05:16:53.008Z","etag":null,"topics":["rails","webdav","webdav-server"],"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/eanlain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-21T22:55:46.000Z","updated_at":"2023-01-28T09:14:26.000Z","dependencies_parsed_at":"2022-08-13T09:50:10.669Z","dependency_job_id":null,"html_url":"https://github.com/eanlain/calligraphy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eanlain%2Fcalligraphy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eanlain%2Fcalligraphy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eanlain%2Fcalligraphy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eanlain%2Fcalligraphy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eanlain","download_url":"https://codeload.github.com/eanlain/calligraphy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219866621,"owners_count":16554249,"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":["rails","webdav","webdav-server"],"created_at":"2024-09-27T12:04:04.713Z","updated_at":"2025-10-01T12:30:58.375Z","avatar_url":"https://github.com/eanlain.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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)\n\nCalligraphy is a Web Distributed Authoring and Versioning (WebDAV) solution for Rails that:\n\n* Provides a framework for handling WebDAV requests (e.g. `PROPFIND`, `PROPPATCH`)\n* Allows you to extend WedDAV functionality to any type of resource\n* Passes all of the [Litmus](https://github.com/eanlain/litmus) tests (using `Calligraphy::FileResource` and digest authentication)\n\n## Getting Started\n\nAdd the following line to your Gemfile:\n\n```ruby\ngem 'calligraphy'\n```\n\nThen, run `bundle install`\n\nNext, run the generator:\n\n```ruby\nrails generate calligraphy:install\n```\n\nThe generator will install an initializer which describes Calligraphy's configuration options.\n\nFinally, set up a `calligraphy_resource` route in `config/routes.rb` with a `resource_class`.\n\n```ruby\n# config/routes.rb\ncalligraphy_resource :webdav, resource_class: Calligraphy::FileResource\n```\n\nThe above will create a route, `/webdav` that will be able to handle the following HTTP request methods:\n\n* `OPTIONS`\n* `GET`\n* `PUT`\n* `DELETE`\n* `COPY`\n* `MOVE`\n* `MKCOL`\n* `PROPFIND`\n* `PROPPATCH`\n* `LOCK`\n* `UNLOCK`\n\nThe routes will also use the `Calligraphy::FileResource`, enabling Rails to carry out WebDAV actions on files.\nAdditionally, when using the `FileResource` class the resource root path (the location you'd like to serve files from) with the `resource_root_path` key:\n\n```ruby\n# config/routes.rb\ncalligraphy_resource :webdav, resource_class: Calligraphy::FileResource, resource_root_path: '/home/webdav'\n```\n\nThis will serve local files from `/home/webdav` on the server through the `/webdav` endpoint.\n\n## Extensibility\n\nThe `Calligraphy::Resource` class exposes all the methods used in the various `Calligraphy::WebDavRequest` classes.\nTo create a custom resource, simply inherit from `Calligraphy::Resource` and redefine the public methods you'd like to customize.\n\nFor example, to create a `CalendarResource`:\n\n```ruby\nmodule Calligraphy\n  class CalendarResource \u003c Resource\n\n    def propfind(nodes)\n      # custom implementation of propfind for CalendarResource\n    end\n\n    ...\n  end\nend\n```\n\n## License\n\nCalligraphy is Copyright © 2017 Brandon Robins.\nIt is free software, and may be redistributed under the terms specified in the [LICENSE](/LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feanlain%2Fcalligraphy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feanlain%2Fcalligraphy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feanlain%2Fcalligraphy/lists"}