appwrite 1.0.9 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 435a9e4f801ceb45d990c57a8f5aaffdb8c4068978527c8b1d9ce619ea6a7e1c
-  data.tar.gz: 2171bf4a196ba398f3444dbe5d53e4082fc970a97eea5d7b13560c7250411220
+  metadata.gz: 60c647c8e3078dfcaf45b0f34cdd816df13d2c8bece8b86c89be41264ea04933
+  data.tar.gz: 85d0f920c5004020948bee06cb900db62f31f15570f0153c9a15fec633169981
 SHA512:
-  metadata.gz: 06a40d4c714c50b9ab205e90c2bfe3adcd6814c9c53193c8266c295b4559bd04e253b5cd70a4adfe801ba1141a4669e66eef6b21101fcbd4ad85294aba4a98f3
-  data.tar.gz: dd3d40be334f7650b8664959f246063d55b2e0b8563bf0d592c64f229582fc05dc868f20194e9ed2f379f9a47d95d944bd2e2412936fc9b6bb4b1fa1ba98facc
+  metadata.gz: 1b12a4dd2b4ccef9fddfa8e9648cd54398d2d764c63a3e6ffcd90b3aef2812987f471b93b7cc061a3ebd988e32bb7d5eb8f78984e6e383a7a559484c58080fd5
+  data.tar.gz: 6338164ad49b29ccf0c6c642ba97a86206bdfac6395df959b435b4234d7c4304fce32d556fa591d8106a63b8d19cc4c1d695ab556a01979934cf769f8e51fa4f

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - 2.7
+
+jobs:
+  include:
+    - stage: ruby gems release
+      rvm: "2.7"
+      script: echo "Deploying to ruby gems ..."
+      deploy:
+        provider: rubygems
+        api_key: $RUBYGEMS_TOKEN
+        gem: appwrite
+        on:
+          tags: true

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Change Log

data/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
+gem 'mime-types', '~> 3.1'
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2021 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/README.md

@@ -1,13 +1,15 @@
-# Appwrite SDK for Ruby
+# Appwrite Ruby SDK
 
-![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?v=1)
-![Version](https://img.shields.io/badge/api%20version-0.5.0-blue.svg?v=1)
-
-**This SDK is compatible with Appwrite server version . For older versions, please check previous releases.**
-
-Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.8.0-blue.svg?style=flat-square)
+[![Twitter Account](https://img.shields.io/twitter/follow/appwrite_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
+**This SDK is compatible with Appwrite server version 0.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**
 
+Appwrite 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)
 
 ![Appwrite](https://appwrite.io/images/github.png)
 
@@ -19,6 +21,77 @@ To install via [Gem](https://rubygems.org/):
 gem install appwrite --save
 ```
 
+
+## Getting Started
+
+### Init your SDK
+Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from project's API keys section.
+
+```ruby
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
+    .set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
+    .set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
+    .setSelfSigned() # Use only on dev mode with a self-signed SSL cert
+;
+```
+
+### Make Your First Request
+Once 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 section.
+
+```ruby
+users = Appwrite::Users.new(client);
+
+result = users.create(email: 'email@example.com', password: 'password');
+```
+
+### Full Example
+```ruby
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
+    .set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
+    .set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
+    .setSelfSigned() # Use only on dev mode with a self-signed SSL cert
+;
+
+users = Appwrite::Users.new(client);
+
+result = users.create(email: 'email@example.com', password: 'password');
+```
+
+### Error Handling
+The 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.
+
+```ruby
+users = Appwrite::Users.new(client);
+
+begin
+    result = users.create(email: 'email@example.com', password: 'password');
+rescue Appwrite::Exception => error
+    puts error.message
+end
+```
+
+### Learn more
+You can use followng resources to learn more and get help
+- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
+- 📜 [Appwrite Docs](https://appwrite.io/docs)
+- 💬 [Discord Community](https://appwrite.io/discord)
+- 🚂 [Appwrite Ruby Playground](https://github.com/appwrite/playground-for-ruby)
+
+
+## Contribution
+
+This 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.
+
 ## License
 
 Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

data/appwrite.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
  
   s.name = 'appwrite'
-  s.version = '1.0.9'
-  s.summary = "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)"
+  s.version = '2.1.0'
+  s.summary = "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API"
   s.author = 'Appwrite Team'
   s.homepage = 'https://appwrite.io/support'
   s.email = 'team@appwrite.io'

data/docs/examples/account/create-recovery.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.create_recovery(email: 'email@example.com', url: 'https://example.com');
+
+puts response

data/docs/examples/account/create-verification.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.create_verification(url: 'https://example.com');
+
+puts response

data/docs/examples/account/delete-session.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.delete_session(session_id: '[SESSION_ID]');
+
+puts response

data/docs/examples/account/delete-sessions.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.delete_sessions();
+
+puts response

data/docs/examples/account/delete.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.delete();
+
+puts response

data/docs/examples/account/get-logs.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.get_logs();
+
+puts response

data/docs/examples/account/get-prefs.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.get_prefs();
+
+puts response

data/docs/examples/account/get-sessions.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.get_sessions();
+
+puts response

data/docs/examples/account/get.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.get();
+
+puts response

data/docs/examples/account/update-email.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_email(email: 'email@example.com', password: 'password');
+
+puts response

data/docs/examples/account/update-name.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_name(name: '[NAME]');
+
+puts response

data/docs/examples/account/update-password.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_password(password: 'password');
+
+puts response

data/docs/examples/account/update-prefs.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_prefs(prefs: {});
+
+puts response

data/docs/examples/account/update-recovery.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_recovery(user_id: '[USER_ID]', secret: '[SECRET]', password: 'password', password_again: 'password');
+
+puts response

data/docs/examples/account/update-verification.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_j_w_t('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token
+;
+
+account = Appwrite::Account.new(client);
+
+response = account.update_verification(user_id: '[USER_ID]', secret: '[SECRET]');
+
+puts response

data/docs/examples/avatars/get-browser.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+;
+
+avatars = Appwrite::Avatars.new(client);
+
+response = avatars.get_browser(code: 'aa');
+
+puts response

data/docs/examples/avatars/get-credit-card.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+client = Appwrite::Client.new()
+
+client
+    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+;
+
+avatars = Appwrite::Avatars.new(client);
+
+response = avatars.get_credit_card(code: 'amex');
+
+puts response