https://github.com/oliveroneill/soft
A Spotify Web API library built for Swift - including Linux support
https://github.com/oliveroneill/soft
linux macos server-side-swift spotify spotify-web-api swift swift-package-manager
Last synced: 8 months ago
JSON representation
A Spotify Web API library built for Swift - including Linux support
- Host: GitHub
- URL: https://github.com/oliveroneill/soft
- Owner: oliveroneill
- License: mit
- Created: 2018-08-21T09:41:55.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-29T09:36:54.000Z (about 7 years ago)
- Last Synced: 2025-02-01T00:51:06.257Z (over 1 year ago)
- Topics: linux, macos, server-side-swift, spotify, spotify-web-api, swift, swift-package-manager
- Language: Swift
- Homepage:
- Size: 84 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Soft
[](https://travis-ci.org/oliveroneill/Soft)
[](https://img.shields.io/badge/Swift-4.2-orange.svg)
[](https://swift.org/package-manager)
A Spotify Web API library for Swift. This is to be used with Swift Package
Manager and supports Linux, so that it can run in desktop and server-side
applications.
This is based on [rspotify](https://github.com/samrayleung/rspotify)'s
implementation.
This is still a work in progress and supports a limited number of calls.
See [SpotifyClient.swift](https://github.com/oliveroneill/Soft/blob/master/Sources/Soft/SpotifyClient.swift)
for the supported calls and some TODOs on what to implement next.
Any help is much appreciated.
## Linux Support
Linux is now supported in Soft! In future we will remove all the unnecessary
`CodingKey` declarations, once `keyEncodingStrategy` and `keyDecodingStrategy`
are supported. See the bug report
[here](https://bugs.swift.org/browse/SR-7180).
## Installation
Add this to your Package.swift:
```swift
.package(url: "https://github.com/oliveroneill/Soft.git", .upToNextMajor(from: "0.0.6")),
```
## Usage
See [SpotifyClient.swift](https://github.com/oliveroneill/Soft/blob/master/Sources/Soft/SpotifyClient.swift)
for the calls are currently available. There are a number of TODOs in that
class for calls that need implementing and I'd appreciate help in
completing the implementation.
### Authorization
All methods require user authorization which means you will need to generate
an authorization token that indicates that the user has granted permission
for your application to perform the given task.
You will need to specify a redirect URL, this URL does not need to lead
anywhere and is purely used to retrieve query parameters that Spotify
has added.
### Example
```swift
import Foundation
import Soft
do {
let oauth = try SpotifyOAuth(clientID: "CLIENT_ID", clientSecret: "CLIENT_SECRET", redirectURI: URL(string: "http://localhost:8888/callback")!, state: "STATE", scope: "playlist-read-private")
// Dispatch group is used so that program does not exit until the result
// is received
let dispatchGroup = DispatchGroup()
dispatchGroup.enter()
getToken(oauth: oauth) { result in
switch result {
case .success(let token):
let client = SpotifyClient(tokenInfo: token)
client.track(trackID: "11dFghVXANMlKmJXsNCbNl") {
print($0)
dispatchGroup.leave()
}
case .failure(let error):
print("error: \(error)")
dispatchGroup.leave()
}
}
dispatchGroup.notify(queue: DispatchQueue.main) {
exit(EXIT_SUCCESS)
}
dispatchMain()
} catch {
print(error)
}
```
### Running tests on Linux
Use this command to run tests on Linux while on macOS, using Docker:
```bash
docker run --rm -v "$(pwd):/pkg" -w "/pkg" swift:latest /bin/bash -c "swift test --build-path ./.build/linux"
```