| Category: Swift / Miscellaneous |
| Watchers: 1 |
| Star: 7 |
| Fork: 0 |
| Last update: Jan 17, 2022 |
Twift is an asynchronous Swift library for the Twitter v2 API.
requestUserCredentials)To be completed
To be completed
You can find the full documentation in this repo's Wiki (auto-generated by SwiftDoc).
I've been running into an issue with refresh tokens. I have no issues logging in for the user, but I'm finding if I come back several hours later I'm unauthorized and have to initiate the login process all over again.
This is what I'm running at start of the update in my AppDelegate. Do I need to refreshOAuth2AccessToken at initiateLogin?
func initiateLogin(forceReconnect: Bool = false, completion: @escaping (Bool)->Void) {
Task {
try await container.client?.refreshOAuth2AccessToken() // I don't know if this will do anything, but I'm trying.
await loginUser(forceReconnect: forceReconnect, completion: { user in
if let encoded = try? self.encoder.encode(user) {
self.defaults.set(encoded, forKey: ConstantStrings.authKeyChainString)
self.initClient(withCredentials: user)
completion(true)
}
})
}
}
func loginUser(forceReconnect: Bool = false, completion: @escaping (OAuth2User)->Void) async {
do {
// flow with existing user
if let savedUser = defaults.object(forKey: ConstantStrings.authKeyChainString) as? Data {
if let oauthUser = try? decoder.decode(OAuth2User.self, from: savedUser), !forceReconnect {
completion(oauthUser)
} else {
// flow with new user
let oauthUser = try await Twift.Authentication().authenticateUser(
clientId: TWITTER_clientId,
redirectUri: URL(string: TWITTER_CALL_BACKURL)!,
scope: Set(OAuth2Scope.allCases),
presentationContextProvider: nil)
completion(oauthUser)
}
}
} catch {
print(error.localizedDescription)
}
}
func initClient(withCredentials oauthUser: OAuth2User) {
container.client = Twift(oauth2User: oauthUser, onTokenRefresh: { newUser in
if let encoded = try? self.encoder.encode(newUser) {
self.defaults.set(encoded, forKey: ConstantStrings.authKeyChainString)
}
})
}
Good morning,
Am I missing something here? I am trying to feed a User array into my preview, but for the life of me I cannot get this thing to work. Below is a snippet, the error is "Type Twift has no member User", however this a nearly exact copy of the results received from the api call. Thoughts.
struct FollowingView_Previews: PreviewProvider { static var previews: some View { let users: [User] = [Twift.User(id: "1445771133337235470", name: "Oppenheimer", username: "OppenheimerFilm", createdAt: Date(), protected: false, withheld: WithheldInformation, location: "nowhere", pinnedTweetId: "", url: "", description: "", verified: "", entities: "", profileImageUrl: "", publicMetrics: "")] FollowingView(users: users) } }
Create List method was lacking from the "Manage Lists" group. https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/introduction
Not sure If this is the correct way to do it, but I tried to follow the same approach as for some other similar methods I saw inside Twift.
@daneden Note 👇 The main concern on my end is: "How do I test this?" 😅 So far I've only worked on personal packages and changing branches was easy 👌 However, when contributing I do not know how to test it without having to do quite a bit of duplication 😅
Unfortunately I was not able to find proper spec in the Twitter API for this before, and only way to really test this is to have it in the package and use it.
Or could we somehow test this in the demo app @daneden ?
As for this PR, I presumed that mediaType and contentType are the same, however from a bit of testing it turns you types slightly differ in strings, so we needed a new enum to handle that.
I have an issue where I am not sure If I am doing anything wrong or if there is an issue with 2.0 token.
When I initiate the app and login by authorizing the user like so:
let oauthUser = try await Twift.Authentication().authenticateUser(
clientId: Constants.clientID,
redirectUri: URL(string: Constants.urlScheme)!,
scope: Set(OAuth2Scope.allCases),
presentationContextProvider: nil)
client = Twift(.oauth2UserAuth(oauthUser))
UserDefaults.encodeUser(user: oauthUser)
self.oauthUser = oauthUser
completion(true)
Everything works fine (UserDefaults storing is temporary)
But after launching the app for example...few hours later, same build in xcode, I use the path:
if let oauthUser = UserDefaults.decodeUser() {
client = Twift(.oauth2UserAuth(oauthUser))
completion(true)
However, the call I make after this, using the said client, fails to get a response other than Unauthorised
When I follow the call, refresh is not used as authToken is valid, and by checking expiresIn myself, I saw that is true.
So, seems that the client is not initiated/authorized then?
The only difference in two flows is that first one uses authenticateUser and second one does not, but I am storing that user properly (I read it before and after storing and it seems 👌)
Here is the call that gets invalid response"
https://api.twitter.com/2/users/me?user.fields=description,profile_image_url
with token:
Bearer akNhMEZxTklrSU1ZV19TVS1qM2FSenRmdmdlWm9OZ0x6dTd6WktzUWlzZmE0OjE2NTQxMTE1MDg1NTE6MTowOmF0OjE
Update:
If I perform the force refresh, everything is fine 🤷♂️.
client?.refreshOAuth2AccessToken()
So maybe the Twift(.oauth2UserAuth(oauthUser)) just needs to be async?
Hope I am not talking out my ass here, just typing this as I debug 😂
Fix for #56. Currently authenticating causes a runtime warning
The instructions for this framework say to use env.example as an example for the environment variables, but there is no such file. What I need to know is what the scheme:// looks like to put in the Twitter App Info URL field.
Following scenario:
Result: After successful authentication native Twitter app gets launched and becomes foreground app.
Any ideas on how to fix this issue ?
iOS 13 introduces the new prefersEphemeralWebBrowserSession property on ASWebAuthenticationSession.
Setting this property to true indicates you don't want to share any cookies or browsing data between this authentication session and the user's normal browser session in Safari. More importantly, to us, it skips the '"App" Wants to use "domain" to Sign In' prompt which many of our users have complained about.
Can you provide an optional on authenticateUser to set this as true or false?
Added scope validation per endpoint, based on the “OAuth 2.0 scopes required by this endpoint” section listed for each endpoint in the Twitter API v2 docs (https://developer.twitter.com/en/docs/twitter-api).
Motivation for this addition is that if you're not using a scope of Set(OAuth2Scope.allCases) when authentication with OAuth2, it can be easy to call an endpoint you don't have the proper scope for and only get back a TwitterAPIError with a non-specific HTTP 401 Unauthorized message (same error you'd get if you weren't properly authenticated), which can be confusing for 1st-time users of Twift setting things up in their app. Further, since the call to Twift.Authentication().authenticateUser(…, scope: …, …) and the call to a twiftClient.get…() endpoint often live in different files in app code, it's not obvious where the issue is.
This addition checks the OAuth2User's scopes against the required scopes for the Twitter endpoint (APIRoute + HTTPMethod), via new internal requiredScopes(for:APIRoute,method:HTTPMethod) -> Set<OAuth2Scope> helper method. The result (in a failure state) is that the client app will get a (new) specific TwiftError.UnauthorizedForRequiredScopes(_:,missingScopes:) exception instead of a generic HTTP 401 TwitterAPIError without actually making the invalid call to the Twitter API. I also considered doing this check in decodeOrThrow<…>(…) (where TwitterAPIError is thrown from) only after we get a 401 back from the Twitter API, but decided that a more immediate exception and avoiding hitting Twitter with invalid requests is probably better overall.
call<>(route:,method:,queryItems:,body:), now checking if the requiredScopes for this endpoint (route + method) is a subset of the current oauthUser.scope. If not, throwing a TwiftError.UnauthorizedForRequiredScopes.requiredScopes(for route: APIRoute, method: HTTPMethod) which returns a Set<OAuth2Scope> containing all the required scopes for the endpoint.requiredScopesFor…Route() util methods to produce the return value.requiredScopesForGET/POST/PUT/DELETERoute(_ route: APIRoute) which switch on the route returning the API doc-specified Set<OAuth2Scope> list for all valid routes, and defaulting to emitting a fatalError(…) if the route is not valid for that method.fatalError(…) instead of throwing a Swift error because a missing route would be an issue in Twift's code, not app client code— so an error we're guaranteed to see in Twift's Tests.TwiftError.UnauthorizedForRequiredScopes(_ requiredScopes: Set<OAuth2Scope>, missingScopes: Set<OAuth2Scope>) error.call<…>(…) methodLower the minimum supported OS versions to macOS 10.15 and iOS 13, the lowest versions that support Swift Concurrency.
Also I noticed an issue while creating a polyfill: the Twitter developer page mentions that the line separator in the streaming API is \r\n, but AsyncLineSequence interprets CR (\r), LF (\n), CRLF (\r\n), NEL (\u{85}), LS (\u{2028}) and PS (\u{2029}) as line separators. This could potentially cause problems with tweets containing these characters. So I created AsyncCRLFLineSequence.
I have a user that when launching the app post sign in they're unable to get their bookmarks. I can see the error being returned is the following. Any leads on why this would be failing? I added the tweet in question as a bookmark and no issues.
UnknownError(Optional("{\"data\":[{\"text\":\"OK, hear me out, this was actually a visionary and inspired action.\\nhttps://t.co/OeMH8DVg2V\",\"edit_history_tweet_ids\":[\"1581146439098716160\"],\"entities\":{\"urls\":[{\"start\":68,\"end\":91,\"url\":\"https://t.co/OeMH8DVg2V\",\"expanded_url\":\"https://twitter.com/damiengayle/status/1580864210741133312/video/1\",\"display_url\":\"pic.twitter.com/OeMH8DVg2V\",\"media_key\":\"7_1580864119145697282\"}]},\"created_at\":\"2022-10-15T04:54:22.000Z\",\"public_metrics\":{\"retweet_count\":4932,\"reply_count\":1624,\"like_count\":19660,\"quote_count\":1946},\"lang\":\"en\",\"id\":\"1581146439098716160\",\"author_id\":\"881615056437297152\",\"attachments\":{\"media_keys\":[\"7_1580864119145697282\"]},\"source\":\"Twitter Web App\",\"conversation_id\":\"1581146439098716160\",\"possibly_sensitive\":false,\"reply_settings\":\"everyone\"},{\"text\":\"Their apps are non-native and poorly d<…>
Full Changelog: https://github.com/daneden/Twift/compare/v0.2.1...v0.2.2
Full Changelog: https://github.com/daneden/Twift/compare/v0.2.0...v0.2.1
Full Changelog: https://github.com/daneden/Twift/compare/v0.1.2...v0.2.0
Full Changelog: https://github.com/daneden/Twift/compare/v0.1.1...v0.1.2
Full Changelog: https://github.com/daneden/Twift/compare/v0.1.0...v0.1.1
I’m excited to publish this version of Twift as pre-1.0 stable!
Now that Twift covers all but a handful of the v2 Twitter API endpoints and has a complete test suite, it’s ready for more broad use.
Stable v1.0 of Twift is still going to take some time, mostly due to some major missing endpoints in Twitter's V2 API (specifically media endpoints). v1.0 of Twift will properly deprecate OAuth 1.0a user authentication in favour of OAuth 2.0.
The only v2 endpoints missing from this release are the compliance and tweet count endpoints, because frankly I’m impatient, and those endpoints seem less commonly-used than others. As always, contributions are welcome!
