GAppAuth

1.6.4

Convenient Wrapper for AppAuth with Google Services written in Swift (>= 4).
benlmyers/GAppAuth

What's New

1.6.4

2021-12-27T23:34:17Z

GAppAuth

pod License Twitter

This is a drop-in class to handle AppAuth with Google Services (iOS & macOS).

Installation via cocoapods

Just add this dependency to your Podfile:

pod GAppAuth

The transitive dependency to GTMAppAuth is added automatically.

Manually

Add GTMAppAuth dependency to your Podfile (Cocoapods) or copy the files manually to your project directory. Add GAppAuth.swift to your project and set-up you project as follows to use AppAuth with Google Services.

iOS

  1. Setup your project (APIs & Services -> Credentials -> Create Credentials -> OAuth Client ID -> iOS) at https://console.developers.google.com to retrieve ClientID and iOS scheme URL.
  2. Enable Google APIs as desired.
  3. Add ClientId and RedirectUri to your Info.plist:
<key>GAppAuth</key>
<dict>
    <key>RedirectUri</key>
    <string>com.googleusercontent.apps.YOUR-CLIENT-ID:/oauthredirect</string>
    <key>ClientId</key>
    <string>YOUR-CLIENT-ID.apps.googleusercontent.com</string>
</dict>
  1. Add custom URL-Scheme to your project:
<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>com.googleusercontent.apps.YOUR-CLIENT</string>
    </array>
  </dict>
</array>

macOS

  1. Setup your project (APIs & Services -> Credentials -> Create Credentials -> OAuth Client ID -> Other) at https://console.developers.google.com to retrieve ClientID and ClientSecret.
  2. Enable Google APIs as desired.
  3. Add ClientId, ClientSecret RedirectUri to your Info.plist:
<key>GAppAuth</key>
<dict>
    <key>RedirectUri</key>
    <string>com.googleusercontent.apps.YOUR-CLIENT-ID:/oauthredirect</string>
    <key>ClientId</key>
    <string>YOUR-CLIENT-ID.apps.googleusercontent.com</string>
    <key>ClientSecret</key>
    <string>YOUR-SECRET</string>
</dict>
  1. Add custom URL-Scheme to your project:
<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>com.googleusercontent.apps.YOUR-CLIENT</string>
    </array>
  </dict>
</array>

Note: Make sure Sandboxing is turned off or properly configured, otherwise it's not possible to open the Browser window.

General

  1. In order to authorize for any Google Service, you'd need to append the respective scope to the authorization request via: GAppAuth.shared.appendAuthorizationRealm (i.e. kGTLRAuthScopeDrive for Google Drive access).
  2. From any UIViewController or NSViewController start the authorization workflow by calling GAppAuth.shared.authorize.
  3. You might want to retrieve any existing authorization upon start of the app which can be done via GAppAuth.shared.retrieveExistingAuthorizationState.
  4. There are two closures you can monitor in order to be notified about any changes stateChangeCallback or errors errorCallback.

Note: In case of a revoked access by the user, both callbacks will be called.

A good spot for 5. and 7. is the AppDelegate's didFinishLaunchingWithOptions.

Contribution

Feel free to create issues or open up a PR.

Description

  • Swift Tools 5.1.0
View More Packages from this Author

Dependencies

Last updated: Mon Sep 19 2022 23:55:21 GMT-0500 (GMT-05:00)