Merge pull request #21 from appwrite/dev

Dev

Author: abnegate

README.md

@@ -1,16 +1,16 @@
 # Appwrite Ruby SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.4.13-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.5.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?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**
+**This SDK is compatible with Appwrite server version 1.5.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)
+![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
 
 ## Installation
 
@@ -45,7 +45,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
 ```ruby
 users = Appwrite::Users.new(client);
 
-user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
+user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
 ```
 
 ### Full Example
@@ -63,7 +63,7 @@ client
 
 users = Appwrite::Users.new(client);
 
-user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
+user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
 ```
 
 ### Error Handling
@@ -73,7 +73,7 @@ The Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code`
 users = Appwrite::Users.new(client);
 
 begin
-    user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
+    user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
 rescue Appwrite::Exception => error
     puts error.message
 end

appwrite.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name = 'appwrite'
-  spec.version = '10.1.2'
+  spec.version = '11.0.0'
   spec.license = 'BSD-3-Clause'
   spec.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'
   spec.author = 'Appwrite Team'

docs/examples/account/create-anonymous-session.md

@@ -0,0 +1,11 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_anonymous_session()

docs/examples/account/create-email-password-session.md

@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_email_password_session(
+    email: 'email@example.com',
+    password: 'password'
+)

docs/examples/account/create-email-token.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_email_token(
+    user_id: '<USER_ID>',
+    email: 'email@example.com',
+    phrase: false # optional
+)

docs/examples/account/create-j-w-t.md

@@ -0,0 +1,11 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_jwt()

docs/examples/account/create-magic-u-r-l-token.md

@@ -0,0 +1,16 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_magic_url_token(
+    user_id: '<USER_ID>',
+    email: 'email@example.com',
+    url: 'https://example.com', # optional
+    phrase: false # optional
+)

docs/examples/account/create-mfa-authenticator.md

@@ -0,0 +1,15 @@
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_session('') # The user session to authenticate with
+
+account = Account.new(client)
+
+result = account.create_mfa_authenticator(
+    type: AuthenticatorType::TOTP
+)

docs/examples/account/create-mfa-challenge.md

@@ -0,0 +1,14 @@
+require 'appwrite'
+
+include Appwrite
+include Appwrite::Enums
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+
+account = Account.new(client)
+
+result = account.create_mfa_challenge(
+    factor: AuthenticationFactor::EMAIL
+)

docs/examples/account/create-mfa-recovery-codes.md

@@ -0,0 +1,12 @@
+require 'appwrite'
+
+include Appwrite
+
+client = Client.new
+    .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint
+    .set_project('5df5acd0d48c2') # Your project ID
+    .set_session('') # The user session to authenticate with
+
+account = Account.new(client)
+
+result = account.create_mfa_recovery_codes()