Giters

1312inc / Webasyst-X-iOS-Pod

Handles user authorization via Webasyst ID, stores and refreshes API tokens, provides the basic layer for working with any custom Webasyst apps APIs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Webasyst

CI Status Version License Platform

Requirements

  • iOS 13.0+
  • Xcode 11+
  • Swift 5.1+

Demo app

TLDR: Boilerplate app using the Webasyst library is available here: https://github.com/1312inc/Webasyst-X-iOS

Installation

Webasyst is available through CocoaPods. To install it, simply add the following line into your Podfile:

pod 'Webasyst'

And execute it in the terminal while in the project folder

pod install

Library configuration

The library requires an initial setup. The following steps are needed:

  1. Import the library into your project's AppDelegate file
import Webasyst
  1. In the root of your project, create a configuration file Webasyst.plist, which has the following fields (use the demo app's Webasyst.plist.example.plist file as a reference):
"clientId": String //  clientId of your application. Example: "72at75391ea785412a24f4568528ed49"
"host": String //  Webasyst ID auth domain: "www.webasyst.com"
"scope": String // the scope required by your application (separated by dot). Example: "site.blog.shop"

Get your Webasyst ID auth client id here: https://www.webasyst.com/my/waid/apps/

Webasyst ID API documentation: https://developers.webasyst.com/docs/features/webasyst-id-auth/resources-server-api/

After creating this file, in the didFinishLaunchingWithOptions method of the AppDelegate file, call the WebasystApp configuration method

let webasyst = WebasystApp()
webasyst.configure()
  1. After configuration of the bibiloteca, you can easily use the Webasyst bibiloteca anywhere in your application

Warning! After retrieving the list of user settings at login, the library will set the active setting from the list to UserDefaults, by the selectDomainUser key

Description of methods

A description of all methods, including all parameters, can be obtained from the XCode autocomplete or via QuickHelp

  • configure Webasyst library configuration method.

  • url Return url for local storage.

  • getDefaultLocalizedString Returns the NSLocalizedString contained in the Webasyst localisation files.

    • Parameters:
      • key: Parameter for NSLocalizedString method;
      • comment: Parameter for NSLocalizedString method;
    • Returns: String returned by NSLocalizedString;

  • requestFullScreenConfetti Start a confetti animation for selected viewController.

    • Parameters:
      • viewController: UIViewController for which the confetti animation will be called;

  • getToken A method for getting Webasyst tokens.

    • Parameters:
      • tokenType: Type of token (Access Token or Refresh Token);
    • Returns: Requested token in string format;

  • authWebasyst (DEPRECATED!!!) Webasyst server authorization method. ![#f03c15] #f03c15

    • Parameters:
      • navigationController: UINavigationController to display the OAuth webasyst modal window;
      • action: Closure to perform an action after authorization;

  • oAuthLogin The method presents a webView with a Webasyst authorisation form. After successful completion of the form, the user is authenticated and the user status is returned.

    • Parameters:

      • merge: Parameter that is responsible for merging accounts;
      • code: Parameter responsible for merging accounts, which is obtained from the 'mergeTwoAccs' method;
      • navigationController: UINavigationController to display the OAuth webasyst modal window;
      • action: Closure to perform an action after authorization with status of user;
      UserStatus

Values:

   `authorizedButProfileIsEmpty`: Status when a user is authorised but their profile is empty.

   `authorizedButNoneInstalls`: Status when a user is authorised but has not installs.

   `authorizedButNoneInstallsAndProfileIsEmpty`: Status when a user is authorised but has not installs and their profile is empty.

   `authorized`: Status when user is authorized.

   `networkError(String)`: State when the network is unavailable.

   `nonAuthorized`: Status when user is not authorized.

   `error(message: String)`: Status when the server returned an error.

  • oAuthAppleID Authorization in Webasyst with an Apple ID.

    • Parameters:
      • authData: Authorization data sent by the Apple ID authorization controller;
      • result: Closure with result of authorization;

  • mergeResultCheck Merge result check.

    • Parameters:
      • completion: The closure performed after the check returns a Bool value about whether the result was successful or not and a description of the error, if there was one;

  • getAuthCode Method for requesting a confirmation code for authorization via WAID without a browser.

    • Parameters:

      • value: Email or phone number to which a confirmation code should be sent;
      • type: Value type(.email/.phone);
      • success: Closure performed after the method has been executed. Contains the status of code sent to the user by email or text message, see the AuthResult documentation for a detailed description of the statuses;
      AuthResult

Server response when authentication is requested

Values:

   `success`: Successful request Tokens saved in Keychain.

   `no_channels`: Incorrect clientId.

   `invalid_client`: Not transmitted code_challenge.

   `require_code_challenge`: Not transmitted code_challenge.

   `invalid_email`: An invalid string is passed as an email.

   `invalid_phone`: An invalid string is passed as a phone number.

   `request_timeout_limit`: Repeat request was sent before timeout was expired.

   `sent_notification_fail`: The server was unable to send the code.

   `server_error`: Server error.

   `undefined`: Unknown error, in the value error, transmits the text of the error.

  • sendConfirmCode Sending a confirmation code after calling the getAuthCode method or after reading qr-code.

    • Parameters:
      • type: Type of confirmation code;
      • code: Code received by user by e-mail or text message or qr content;
      • success: Closure performed after the method has been executed. Bool value whether the server has accepted the code, if true then the tokens are saved in the Keychain;

  • checkInstallApp App installation.

    • Parameters:
      • app: Application name;
      • completion: The closure performed after the check returns a Bool value about whether the result was successful or not and a description of the error, if there was one;

  • checkLicense Tries to find a free (not tied to the installation) license from the user whose token is accessed by the mobile application. If there is one, then binds it to the installation. Otherwise, it creates a trial product license tied to the installation.

    • Parameters:
      • app: Application name;
      • completion: The closure performed after the check returns a Bool value of whether the user is authorized or not;

  • extendLicense Tries to find a free (not tied to the installation) license from the user whose token is accessed by the mobile application. If there is one, then binds it to the installation. Otherwise, it creates a trial product license tied to the installation.

    • Parameters:
      • type: Type of subscription plan;
      • date: Subscription cut-off date;
      • completion: The closure performed after the check returns a Bool value of whether the user is authorized or not;

  • defaultChecking User authentication check on Webasyst server.

    • Parameters:
      • completion: The closure performed after the check returns a Bool value of whether the user is authorized or not;

  • checkUserAuth User authentication check on Webasyst server.

    • Parameters:
      • completion: Updating the user token, and checking authorization. Returns user status in the application;

  • mergeTwoAccs A new free WAID contact connected to the opposite application can oppose another existing WAID contact.

    • Parameters:
      • completion: Returns result with code to merge or error;

  • deleteAccount The method sends a request to delete the current account and returns the result.

    • Parameters:
      • completion: Account deletion result or error;

  • getAllUserInstall Getting user install list.

    • Parameters:
      • completion: List of all user installations in UserInstall format (name, clientId, domain, accessToken, url);

  • updateUserInstalls Updating and Getting user install list from server

    • Parameters:
      • completion: List of all user installations in UserInstallCodable format (name, clientId, domain, accessToken, url);

  • getUserInstall Obtaining user installation.

    • Parameters:
      • clientId: clientId setting;
    • Returns: Installation in User Install format;

  • deleteInstall Deletes the installation from the database.

    • Parameters:
      • clientId: clientId install;

  • getProfileData Returns user profile data

    • Returns: User profile data in ProfileData format;

  • updateUserImage Update current user image.

    • Parameters:
      • image: Image to update;
      • success: Closure performed after executing the method. Result value which can be successfully or errorable;

  • deleteUserImage Delete current user image.

    • Parameters:
      • image: Closure performed after executing the method. Result value which can be successfully or errorable;

  • changeCurrentUserData Change the data of the current user.

    • Parameters:
      • profile: Pass the current data model with user information;
      • success: Closure performed after executing the method. Result value which can be successfully or errorable;

  • createWebasystAccount Creating a new Webasyst account.

    • Parameters:
      • bundle: Bundle of the account being created;
      • plainId: Plain id of the account being created;
      • accountDomain: Domain of the account being created;
      • accountName: Name of the account being created;
      • completion: Contains a result of creating and renaming of new account. Reutrns client id and url of new account if successed;

  • logOutUser Logs out a user from the account and deletes all records in the database.

    • Parameters:
      • completion: Boolean value of deauthorization success;

Errors

In case of an error, it will be displayed in the XCode console with the label Webasyst error. You need to specify the error code and the text of the message while contacting technical support.

Example of an error

Error Domain=Webasyst warning: https://1312.io The data couldn’t be read because it was missing. Code=205 "(null)"
  • 200: Successful implementation of the method
  • 205: Non-critical error, method ran, but with an alert
  • 400: Network layer error while working with the central WAID server
  • 401: Network layer error while working with the user installation server
  • 500: General library database error
  • 501: Database error while working with the list of user settings
  • 502: Database error while working with a user profile

Author

Company: 1312 Inc. hello@1312.io

License

Webasyst is available under the LGPL license. See the LICENSE file for more info.

About

Handles user authorization via Webasyst ID, stores and refreshes API tokens, provides the basic layer for working with any custom Webasyst apps APIs.

License:GNU Lesser General Public License v3.0

Languages

Language:Swift 98.7%Language:Ruby 1.0%Language:Objective-C 0.3%