Merge pull request #1 from spotify/hagmas-patch-1

Add files via upload

Author: hagmas

README.md

@@ -1 +1,44 @@
-# ios-auth
+# SpotifyLogin
+
+## Overview
+`SpotifyLogin` is a lightweight framework that enables your application to obtain the authentication code from the Spotify app. Please note that this framework is currently under development and only supports a subset of the [ios-sdk](https://github.com/spotify/ios-sdk)'s functionalities. If you wish to use all features related to authentication, please utilize [ios-sdk](https://github.com/spotify/ios-sdk).
+
+## Minimum Requirement
+iOS 11
+
+## Usage
+### Prepare Your Environment
+- Install the latest version of Spotify from the App Store onto the device you will be using for development. Run the Spotify app and login or sign up.
+- [Register Your Application](https://developer.spotify.com/documentation/web-api/concepts/apps#register-your-app). You will need to register your application at [My Applications](https://developer.spotify.com/dashboard) and obtain a client ID. When you register your app you will also need to allowlist a redirect URI that the Spotify app will use to callback to your app after authorization.
+
+### Installation
+- Add `SpotifyLogin.xcframework` to your project by dragging and dropping it in <b>Framworks, Libraries, and Embedded Content</b>
+- In your info.plist add the following changes: 
+   - Add your redirect URI you registered at My Applications. You will need to add your redirect URI under "URL types" and "URL Schemes". Be sure to set a unique "URL identifier" as well. More info on URL Schemes
+   - Declare the Spotify’s URL scheme `spotify` by adding the `LSApplicationQueriesSchemes` key.
+   
+### Get authentication code
+1. Initialise `Configuration` with your client ID and redirect URI.
+```swift
+import SpotifyLogin
+
+let configuration = Configuration(clientID: "your_client_id", redirectURLString: "your_redirect_uri")
+```
+2. Initialise `SessionManager` with your configuration and set an object that conforms `SessionManagerDelegate` to the `delegate` of the instance.
+```swift
+let sessionManager = SessionManager(configuration: configuration)
+sessionManager.delegate = <#delegate object#>
+```
+3. Implement `application(_:open:options:)` method to your `UIApplicationDelegate` and call sessionManager's `application(_:open:options:)` there.
+```swift
+class AppDelegate: NSObject, UIApplicationDelegate {
+    func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
+        return sessionManager.application(application, open: url, options: options)
+    }
+}
+```
+4. Start the authrization process with the scopes you need.
+```swift
+sessionManager.startAuthorizationCodeProcess(with: [.playlistModifyPublic, .playlistModifyPrivate])
+```
+

SpotifyLogin.xcframework/Info.plist

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>AvailableLibraries</key>
+	<array>
+		<dict>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64</string>
+			<key>LibraryPath</key>
+			<string>SpotifyLogin.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+		</dict>
+		<dict>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64_x86_64-simulator</string>
+			<key>LibraryPath</key>
+			<string>SpotifyLogin.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+				<string>x86_64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
+		</dict>
+	</array>
+	<key>CFBundlePackageType</key>
+	<string>XFWK</string>
+	<key>XCFrameworkFormatVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>

SpotifyLogin.xcframework/ios-arm64/SpotifyLogin.framework/Headers/SPTScope.h

@@ -0,0 +1,62 @@
+#import <Foundation/Foundation.h>
+
+/// `SPTScope` represents the OAuth scopes that declare how your app wants to access a user's account.
+/// See https://developer.spotify.com/web-api/using-scopes/ for more information.
+typedef NS_OPTIONS(NSUInteger, SPTScope) {
+    // Read access to user's private playlists.
+    SPTScopePlaylistReadPrivate = 1 << 0,
+
+    // Include collaborative playlists when requesting a user's playlists.
+    SPTScopePlaylistReadCollaborative = 1 << 1,
+
+    // Write access to a user's public playlists.
+    SPTScopePlaylistModifyPublic = 1 << 2,
+
+    // Write access to a user's private playlists.
+    SPTScopePlaylistModifyPrivate = 1 << 3,
+
+    // Read access to the list of artists and other users that the user follows.
+    SPTScopeUserFollowRead = 1 << 4,
+
+    // Write/delete access to the list of artists and other users that the user follows.
+    SPTScopeUserFollowModify = 1 << 5,
+
+    // Read access to a user's "Your Music" library.
+    SPTScopeUserLibraryRead = 1 << 6,
+
+    // Write/delete access to a user's "Your Music" library.
+    SPTScopeUserLibraryModify = 1 << 7,
+
+    // Read access to the user's birthdate.
+    SPTScopeUserReadBirthDate = 1 << 8,
+
+    // Read access to user’s email address.
+    SPTScopeUserReadEmail = 1 << 9,
+
+    // Read access to user’s subscription details (type of user account).
+    SPTScopeUserReadPrivate = 1 << 10,
+
+    // Read access to a user's top artists and tracks.
+    SPTScopeUserTopRead = 1 << 11,
+
+    // Upload user generated content images.
+    SPTScopeUgcImageUpload = 1 << 12,
+
+    // Control playback of a Spotify track.
+    SPTScopeStreaming = 1 << 13,
+
+    // Read access to a user’s player state.
+    SPTScopeUserReadPlaybackState = 1 << 14,
+
+    // Write access to a user’s playback state.
+    SPTScopeUserModifyPlaybackState = 1 << 15,
+
+    // Read access to a user’s currently playing track.
+    SPTScopeUserReadCurrentlyPlaying = 1 << 16,
+
+    // Read access to a user’s recently played tracks.
+    SPTScopeUserReadRecentlyPlayed = 1 << 17,
+
+    // Indicate that the application intends to use OIDC to verify the user's identity
+    SPTScopeOpenid = 1 << 18
+} NS_SWIFT_NAME(Scope);