GoogleRestClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  GoogleRestClient.qm Copyright (C) 2020 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum qore version
 
// require type definitions everywhere
 
// enable all warnings
 
// don't use "$" for vars, members, and methods, assume local variable scope
 
// do not ignore argument errors
 
 
 
namespace GoogleRestClient {
 
class GoogleRestClient : public RestClient::RestClient {
 
public:
        const DefaultUrl = "https://www.googleapis.com";
 
        const DefaultAuthArgs = {"access_type": "offline"};
 
        const DefaultAuthUrl = "https://accounts.google.com/o/oauth2/v2/auth";
 
        const DefaultGrantType = "authorization_code";
 
        const DefaultTokenUrl = "https://oauth2.googleapis.com/token";
 
        const DefaultData = "json";
 
        const DefaultOptions = {
            "data": DefaultData,
            "encode_chars": "+",
            "oauth2_auth_args": DefaultAuthArgs,
            "oauth2_auth_url": DefaultAuthUrl,
            "oauth2_grant_type": DefaultGrantType,
            "oauth2_token_url": DefaultTokenUrl,
            "url": DefaultUrl,
        };
 
        const ApiProfiles = {
            "none": {},
            "calendar": {
                "oauth2_scopes": (
                    "https://www.googleapis.com/auth/calendar",
                ),
                "ping_method": DefaultGooglePingMethod,
                "ping_path": "/calendar/v3/users/me/calendarList?maxResults=1",
                "ping_headers": DefaultGooglePingHeaders,
            },
        };
 
        const DefaultGooglePingMethod= "GET";
 
        const DefaultGooglePingHeaders = {
            "Accept": MimeTypeJson,
        };
 
 
    constructor(hash<auto> opts, *softbool do_not_connect) ;
 
 
      static hash<auto> getOptions(hash<auto> opts);
};
 
 
class GoogleRestConnection : public RestClient::RestConnection {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("GoogleRestConnection"),
            "options": RestConnection::ConnectionScheme.options + {
                "api_profile": <ConnectionOptionInfo>{
                    "type": "string",
                    "desc": "the API profile according to the Google API in use; this option will set the REST "
                        "options if they are not already set (`oauth2_scopes`, `ping_body`, `ping_headers`, and "
                        "`ping_method`); valid "
                        "values:\n"
                        "- `none`: no options configured (default)\n"
                        "- `calendar`: set options for the Google calendar API",
                    "default_value": "none",
                    "allowed_values": (
                        <AllowedValueInfo>{
                            "desc": "No options are set",
                            "value": "none",
                        },
                        <AllowedValueInfo>{
                            "desc": "Set REST client options for the Google calendar API",
                            "value": "calendar",
                        },
                    ),
                },
                "data": RestConnection::ConnectionScheme.options."data"
                + <ConnectionOptionInfo>{
                    "default_value": GoogleRestClient::DefaultData,
                },
                "oauth2_auth_args": RestConnection::ConnectionScheme.options.oauth2_auth_args
                + <ConnectionOptionInfo>{
                    "default_value": GoogleRestClient::DefaultAuthArgs,
                },
                "oauth2_auth_url": RestConnection::ConnectionScheme.options.oauth2_auth_url
                + <ConnectionOptionInfo>{
                    "default_value": GoogleRestClient::DefaultAuthUrl,
                },
                "oauth2_grant_type": RestConnection::ConnectionScheme.options.oauth2_grant_type
                + <ConnectionOptionInfo>{
                    "default_value": GoogleRestClient::DefaultGrantType,
                },
                "oauth2_token_url": RestConnection::ConnectionScheme.options.oauth2_token_url
                + <ConnectionOptionInfo>{
                    "default_value": GoogleRestClient::DefaultTokenUrl,
                },
            },
            "required_options": "token|oauth2_auth_url,oauth2_grant_type,oauth2_token_url,"
                "oauth2_client_id,oauth2_client_secret",
        };
 
 
    constructor(string name, string description, string url = GoogleRestClient::DefaultUrl, hash<auto> attributes = {}, hash<auto> options = {})
 ;
 
 
    string getType();
 
 
 
    bool hasDataProvider();
 
 
 
    DataProvider::AbstractDataProvider getDataProvider();
 
 
      static hash<auto> getOptions(hash<auto> opts);
 
protected:
     setChildCapabilities();
public:
 
 
 
protected:
     GoogleRestClient getImpl(bool connect = True, *hash<auto> rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};