{"id":13534140,"url":"https://github.com/appwrite/sdk-for-ruby","last_synced_at":"2025-04-09T18:17:19.887Z","repository":{"id":41097039,"uuid":"188027237","full_name":"appwrite/sdk-for-ruby","owner":"appwrite","description":"[READ-ONLY] Official Appwrite Ruby SDK 💎 🔴","archived":false,"fork":false,"pushed_at":"2025-01-29T13:21:30.000Z","size":620,"stargazers_count":60,"open_issues_count":0,"forks_count":8,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-09T18:17:08.820Z","etag":null,"topics":["appwrite","baas","hacktoberfest","ruby"],"latest_commit_sha":null,"homepage":"https://appwrite.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appwrite.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-22T11:43:57.000Z","updated_at":"2025-04-04T03:49:33.000Z","dependencies_parsed_at":"2024-02-27T09:41:26.390Z","dependency_job_id":"546412af-79ad-450c-8828-7158096f3b82","html_url":"https://github.com/appwrite/sdk-for-ruby","commit_stats":{"total_commits":138,"total_committers":9,"mean_commits":"15.333333333333334","dds":0.572463768115942,"last_synced_commit":"37d2188bd58342a72ea7fc693e0806c5f6ed871b"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appwrite","download_url":"https://codeload.github.com/appwrite/sdk-for-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085321,"owners_count":21045139,"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":["appwrite","baas","hacktoberfest","ruby"],"created_at":"2024-08-01T07:01:26.880Z","updated_at":"2025-04-09T18:17:19.861Z","avatar_url":"https://github.com/appwrite.png","language":"Ruby","readme":"# Appwrite Ruby SDK\n\n![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square)\n![Version](https://img.shields.io/badge/api%20version-1.6.1-blue.svg?style=flat-square)\n[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)\n[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee\u0026label=twitter\u0026style=flat-square)](https://twitter.com/appwrite)\n[![Discord](https://img.shields.io/discord/564160730845151244?label=discord\u0026style=flat-square)](https://appwrite.io/discord)\n\n**This SDK is compatible with Appwrite server version 1.6.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**\n\nAppwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Ruby SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)\n\n![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)\n\n## Installation\n\nTo install via [Gem](https://rubygems.org/):\n\n```bash\ngem install appwrite\n```\n\n\n## Getting Started\n\n### Init your SDK\nInitialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key from project's API keys section.\n\n```ruby\nrequire 'appwrite'\n\nclient = Appwrite::Client.new()\n\nclient\n    .set_endpoint(ENV[\"APPWRITE_ENDPOINT\"]) # Your API Endpoint\n    .set_project(ENV[\"APPWRITE_PROJECT\"]) # Your project ID\n    .set_key(ENV[\"APPWRITE_SECRET\"]) # Your secret API key\n    .setSelfSigned() # Use only on dev mode with a self-signed SSL cert\n;\n```\n\n### Make Your First Request\nOnce your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.\n\n```ruby\nusers = Appwrite::Users.new(client);\n\nuser = users.create(userId: Appwrite::ID::unique(), email: \"email@example.com\", phone: \"+123456789\", password: \"password\", name: \"Walter O'Brien\");\n```\n\n### Full Example\n```ruby\nrequire 'appwrite'\n\nclient = Appwrite::Client.new()\n\nclient\n    .set_endpoint(ENV[\"APPWRITE_ENDPOINT\"]) # Your API Endpoint\n    .set_project(ENV[\"APPWRITE_PROJECT\"]) # Your project ID\n    .set_key(ENV[\"APPWRITE_SECRET\"]) # Your secret API key\n    .setSelfSigned() # Use only on dev mode with a self-signed SSL cert\n;\n\nusers = Appwrite::Users.new(client);\n\nuser = users.create(userId: Appwrite::ID::unique(), email: \"email@example.com\", phone: \"+123456789\", password: \"password\", name: \"Walter O'Brien\");\n```\n\n### Error Handling\nThe Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code` and `response` properties. You can handle any errors by catching `Appwrite::Exception` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.\n\n```ruby\nusers = Appwrite::Users.new(client);\n\nbegin\n    user = users.create(userId: Appwrite::ID::unique(), email: \"email@example.com\", phone: \"+123456789\", password: \"password\", name: \"Walter O'Brien\");\nrescue Appwrite::Exception =\u003e error\n    puts error.message\nend\n```\n\n### Learn more\nYou can use the following resources to learn more and get help\n- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)\n- 📜 [Appwrite Docs](https://appwrite.io/docs)\n- 💬 [Discord Community](https://appwrite.io/discord)\n- 🚂 [Appwrite Ruby Playground](https://github.com/appwrite/playground-for-ruby)\n\n\n## Contribution\n\nThis library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.\n\n## License\n\nPlease see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.\n","funding_links":[],"categories":["SDK","Ruby"],"sub_categories":["Official Appwrite SDKs"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappwrite%2Fsdk-for-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-ruby/lists"}