appwrite 2.0.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b656d8cd5e37c875f295d2e0c7b53a2319a202065dc28e3fb0c73c6d4a5c73a
-  data.tar.gz: 8e6d0b772542e847ebaae1f25461e2051f0cc2680f96d6c4f9a4b8ddab271ba5
+  metadata.gz: 7af7a36b8f84e4c0cc14fe71d566d3a12f838319c77024e486eaede9ecb4f6bf
+  data.tar.gz: '008f87179f1bbccfb26a44be5b8d57b3784ba9512aa500c59c7d91b7e915ca47'
 SHA512:
-  metadata.gz: 95197a1c5cc2a86f227a6bc0997274078403e908270be825799a628b07f426a519b02ace27ec54db7914b000d65aec5a4cf73922f61721d12ad35bcf0c4df539
-  data.tar.gz: 6813fbc37180cd4f878da5de97ebfe63f9add2200e97d0f0924fd58a25d00a5ff09f054874915d97270ca458e06ffd73b346900d3486fac902d7c1301f035fed
+  metadata.gz: 97a422d4d22aad866049e1dd30609515806e7691ebb4d33a1fc54aeb123af7a8afd7f4bd3e08282a411ef5a6410a7ad4ecf9840fe9e82213df0b6ba56877511c
+  data.tar.gz: cf27ec1ea058dad70e0445c604e6b4661491dd19641c3ece83b5b8cd77e40f8061bfaf35dc206de8d8765587775fdf7279d38c388a0f860a8c004729bb5c7b15

data/.travis.yml

@@ -13,4 +13,4 @@ jobs:
         api_key: $RUBYGEMS_TOKEN
         gem: appwrite
         on:
-          tags: true
+          tags: true

data/Gemfile

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

data/README.md

@@ -1,13 +1,14 @@
 # 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.9.0-blue.svg?style=flat-square)
+[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
+[![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.9.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 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 +20,73 @@ To install via [Gem](https://rubygems.org/):
 gem install appwrite --save
 ```
 
+
+## Getting Started
+
+### Init your SDK
+Initialize 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.
+
+```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](https://appwrite.io/docs) 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 following 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,11 +1,11 @@
 Gem::Specification.new do |s|
  
   s.name = 'appwrite'
-  s.version = '2.0.2'
+  s.version = '2.3.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'
   s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
  
-end
+end

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-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.get_session(session_id: '[SESSION_ID]');
+
+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