appwrite 1.0.10 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff65ad15eb1cf2ca4567493cb39b9bf1e633763259cc314aa99987b51a745e1f
-  data.tar.gz: 877438373c9c376f55c6443c5d0bec9c9533f5fe6d2c7f9b807f962cdfecb431
+  metadata.gz: 1fe06a326eed6537ffa429178e237f1c925b0f40224824f775b61771603f52d5
+  data.tar.gz: 8d7847c0288e59b751e0c5aa37a602609c5509c13eb5729952b2eb5699d929ca
 SHA512:
-  metadata.gz: 1ef02ec0d182fbc27b8e14cf4a49830f3ca5abc0284cea6861033a64eedfc2109dfb0d4494cee573f72fcf72eb773e5f0eb9b10ceb81ca1ab86f784912570a04
-  data.tar.gz: cacf6d28374fd2d08a24cbfcb7b75d563feac5219e2e75cc04968fa4c77168b1a47a2b697f99eac662570cb0de10f690aa4a929bd25f2aef736861c22b18c42e
+  metadata.gz: c93b91e386e903cc480934818bdb93a55538469cb8f512112daa407946e30179c81a6a41f8838ecc2f06267373363041582614d9dee56dfa8d2efeacc97d2602
+  data.tar.gz: 17dc4accecde0078a260f062f30ea8bfa039687f4c978fcfe09c9be14897d67260bfa9ed3355bd7d65c498ad913e21ff2a87e275f27aaebeb9a42043d957a1d6

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/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,16 +1,16 @@
 # 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.6.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.6.0. For older versions, please check previous 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.
                         For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
-
-
 ![Appwrite](https://appwrite.io/images/github.png)
 
 ## Installation
@@ -21,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,13 +1,11 @@
 Gem::Specification.new do |s|
  
   s.name = 'appwrite'
-  s.version = '1.0.10'
-  s.summary = "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)"
+  s.version = '2.1.1'
+  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@localhost.test'
+  s.email = 'team@appwrite.io'
   s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
  
 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_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