appwrite 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed117cf461a878f949d987bfc8dfabc562be72e34cfd648d0047651b4f986e7
-  data.tar.gz: f7dfd52f109f0566e010b2958efff2a8b201332e56de28ff51184b1721b57791
+  metadata.gz: 2ff4eead29ef5fcae244fbcc93ee35d51d26c04d44f6cae00bde1a35d7cd4590
+  data.tar.gz: 0fee5b3c85b96692adcf9c29b024986bce8c5ff7fd935b4d9e67e1fea48685f8
 SHA512:
-  metadata.gz: df0356df74fd99bb0bc4dab701b274a9b5ec2f798148875ca147265c99a27ca44b60478492fed5e7d0192aecb07bd97399e7b7e699a50b46040f038abd58f93d
-  data.tar.gz: 8a9a553d9272f3ad02ecc4684b92d0fcf2e9206dd7d4daa42733d5418ddfaa11ef6c93e44d61502cde503fef8e342141afef49c88b7d56b4e6acce733bd03078
+  metadata.gz: 7ee92d121c635eb76a2f872a8446d2516925b353fbb97fa3dba0c342730fe131cf537bfe49aece631442ab37704b624d8dd4e02a14d9fe9ca645038ee0501eae
+  data.tar.gz: 3e0f8d737f3340996e1b2414991a143863c5e76c61edbd688d165cd98909394aa5dbd4ab92791b925659325e41899fb9d25d9f5c8be4cca5efb299ae17863a64

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/README.md

@@ -1,9 +1,11 @@
 # 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.7.0-blue.svg?v=1)
+![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.7.0. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**
+**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.
@@ -19,6 +21,73 @@ 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.

data/appwrite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
  
   s.name = 'appwrite'
-  s.version = '2.0.0'
+  s.version = '2.2.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'

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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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_jwt('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-q-r.md

@@ -10,6 +10,6 @@ client
 
 avatars = Appwrite::Avatars.new(client);
 
-response = avatars.get_q_r(text: '[TEXT]');
+response = avatars.get_qr(text: '[TEXT]');
 
 puts response

data/docs/examples/database/create-document.md

@@ -10,6 +10,6 @@ client
 
 database = Appwrite::Database.new(client);
 
-response = database.create_document(collection_id: '[COLLECTION_ID]', data: {}, read: [], write: []);
+response = database.create_document(collection_id: '[COLLECTION_ID]', data: {});
 
 puts response

data/docs/examples/database/update-collection.md

@@ -10,6 +10,6 @@ client
 
 database = Appwrite::Database.new(client);
 
-response = database.update_collection(collection_id: '[COLLECTION_ID]', name: '[NAME]', read: [], write: []);
+response = database.update_collection(collection_id: '[COLLECTION_ID]', name: '[NAME]');
 
 puts response

data/docs/examples/database/update-document.md

@@ -10,6 +10,6 @@ client
 
 database = Appwrite::Database.new(client);
 
-response = database.update_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]', data: {}, read: [], write: []);
+response = database.update_document(collection_id: '[COLLECTION_ID]', document_id: '[DOCUMENT_ID]', data: {});
 
 puts response

data/docs/examples/functions/create.md

@@ -10,6 +10,6 @@ client
 
 functions = Appwrite::Functions.new(client);
 
-response = functions.create(name: '[NAME]', execute: [], env: 'node-14.5');
+response = functions.create(name: '[NAME]', execute: [], env: 'dotnet-3.1');
 
 puts response

data/docs/examples/health/get-d-b.md

@@ -10,6 +10,6 @@ client
 
 health = Appwrite::Health.new(client);
 
-response = health.get_d_b();
+response = health.get_db();
 
 puts response

data/docs/examples/locale/get-countries-e-u.md

@@ -10,6 +10,6 @@ client
 
 locale = Appwrite::Locale.new(client);
 
-response = locale.get_countries_e_u();
+response = locale.get_countries_eu();
 
 puts response