{"id":16987845,"url":"https://github.com/timfjord/carddav","last_synced_at":"2025-11-01T05:03:04.734Z","repository":{"id":62555132,"uuid":"57206112","full_name":"timfjord/carddav","owner":"timfjord","description":"CardDAV ruby implementation","archived":false,"fork":false,"pushed_at":"2022-05-10T14:42:47.000Z","size":17,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-05T16:40:48.197Z","etag":null,"topics":["carddav","ruby"],"latest_commit_sha":null,"homepage":null,"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/timfjord.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-27T10:50:12.000Z","updated_at":"2025-01-18T17:52:47.000Z","dependencies_parsed_at":"2022-11-03T05:15:48.289Z","dependency_job_id":null,"html_url":"https://github.com/timfjord/carddav","commit_stats":null,"previous_names":["timsly/carddav"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/timfjord/carddav","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timfjord%2Fcarddav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timfjord%2Fcarddav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timfjord%2Fcarddav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timfjord%2Fcarddav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timfjord","download_url":"https://codeload.github.com/timfjord/carddav/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timfjord%2Fcarddav/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278343083,"owners_count":25971399,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["carddav","ruby"],"created_at":"2024-10-14T02:50:53.970Z","updated_at":"2025-10-04T16:50:29.552Z","avatar_url":"https://github.com/timfjord.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)\n\n# Carddav\n\n[![Build Status](https://travis-ci.org/timsly/carddav.svg?branch=master)](https://travis-ci.org/timsly/carddav)\n\nRuby implementation for the CardDAV protocol.\n\nFor now you can only get cards.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'carddav'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install carddav\n\n## Usage\n\nThe gem was tested with two providers: `iCloud` and `gmx`.\nTo get contacts from these two providers do the following:\n\n```ruby\nservice = Carddav.service(:gmx, 'email@gmx.net', 'password')\nservice.cards\n```\n\nor\n\n```ruby\nservice = Carddav.service(:apple, 'email@icloud.com', 'password')\nservice.cards\n```\n\nUnder the hood it uses `Carddav::Client`, which uses the standard approach of getting data\nfrom CardDAV servers.\n\n```ruby\nclient = Carddav::Client.new('http://my-carddav-server.org', 'email@mail.net', 'password')\nclient.cards\n```\n\n## Discovery process\n\n`Carddav::Client` discovers urls step by step and then, as the last step, gets data from `addressbook_url`\nand then parses vcards from the response.\n\nHere are all steps:\n\n* getting `current_user_principal` url\n* getting `addressbook_home_set` url\n* getting `addressbook` url\n* getting cards\n\nWhen one of the urls is static it can be passed to the client directly.\nThis way some steps in the discovery process will be bypassed\n\n```ruby\nclient = Carddav::Client.new('http://my-carddav-server.org', 'email@mail.net', 'password')\nclient.addressbook_url = '/my-addressbook-url'\nclient.cards # http://my-carddav-server.org/my-addressbook-url will be used and cards will be fetched from it.\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will 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\nBug reports and pull requests are welcome on GitHub at https://github.com/timsly/carddav.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimfjord%2Fcarddav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimfjord%2Fcarddav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimfjord%2Fcarddav/lists"}