Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mattdonnelly/Swifter

[DEPRECATED] :bird: A Twitter framework for iOS & OS X written in Swift
https://github.com/mattdonnelly/Swifter

deprecated

Last synced: about 2 months ago
JSON representation

[DEPRECATED] :bird: A Twitter framework for iOS & OS X written in Swift

Lists

README 

        
# ⚠️ This project has been deprecated: https://github.com/mattdonnelly/Swifter/issues/360  ⚠️



***





  Swifter




[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

## Getting Started



### Installation



If you're using Xcode 6 and above, Swifter can be installed by simply dragging the Swifter Xcode project into your own project and adding either the SwifteriOS or SwifterMac framework as an embedded framework.



### Usage



Swifter can be used with the 3 different kinds of authentication protocols Twitter allows. You can specify which protocol to use as shown below. For more information on each of the authentication protocols, please check [Twitter OAuth Help](https://dev.twitter.com/oauth).



Instantiation with ACAccount:



```swift



// Instantiation using ACAccount

var swifter = Swifter(account: twitterAccount)



// Instantiation using Twitter's OAuth Consumer Key and secret

swifter = Swifter(consumerKey: TWITTER_CONSUMER_KEY, consumerSecret: TWITTER_CONSUMER_SECRET)



// Instantiation using App-Only authentication

swifter = Swifter(consumerKey: TWITTER_CONSUMER_KEY, consumerSecret: TWITTER_CONSUMER_SECRET, appOnly: true)



```



## Example Requests



#### OAuth Authorization:



```swift

swifter.authorize(with: callbackURL, success: { accessToken, response in

  // ...

}, failure: { error in

  // ...

})

```



#### Get Home Timeline:



```swift

swifter.getHomeTimeline(count: 50, success: { json in

  // ...

}, failure: { error in

  // ...

})

```



#### ListTag, UserTag, and UsersTag

Certain  Twitter API calls allows you to use either the `user_id` or `screen_name` to get user related objects (and `list_id`/`slug` for lists). Swifter offers a solution so that the user won't accidentally use the wrong method, and have nothing returned. For more information, check the `SwifterTag.swift` file.



```swift

swifter.getUserFollowersIDs(for: .id(userId), success: { json, prev, next in

    // alternatively, you can use .screenName(userName)

    // ...

}, failure: { error in

    // ...

})



```



```swift



swifter.getListSubscribers(for: .slug(listSlug, owner: .screenName(userName)), success: { json, prev, next in

    // alternatively, you can use .id(listId)

    // ...

}, failure: { error in

    // ...

})



```

Additionally, there is also `.screenName(arrayOfUserNames)` and `.id(arrayOfIds)` for methods that take arrays of screen names, or userIDs



#### Streaming API:



**Important Note**: Twitter has deprecated the Streaming API in favour of their new [Accounts Activity API](https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/aaa-enterprise). You can find out more about migrating to the new API [here](https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/migration/us-ss-migration-guide). Twitter plans to remove the old streaming API on August 16, 2018, Swifter will remove the endpoints for it shortly after that. 



```swift

swifter.streamRandomSampleTweets(progress: { status in

  // ...

}, stallWarnings: { code, message, percentFull in

  // ...

}, failure: { error in

  // ...

})

```



#### Status Update:



```swift

swifter.postTweet(status: "Hello, world.", success: { status in

  // ...

}, failure: { error in

  // ...

})

```



## JSON Handling



To make accessing data returned by twitter requests simple, Swifter provides a class for representing JSON which you interact with similarly to a dictionary. The main advantage of using this instead of a Dictionary is that it works better with Swift's strict typing system and doesn't require you to constantly downcast accessed objects. It also removes the need for lots of optional chaining, making your code much cleaner and easier to read.



Here's an example of how you would access the text of the first element in list of statuses:



```swift

if let statusText = statuses[0]["text"].string {

    // ...

}

```



## OAuth Consumer Tokens



In Twitter REST API v1.1, each client application must authenticate itself with consumer key and consumer secret tokens. You can request consumer tokens for your app on [Twitter's dev website](https://dev.twitter.com/apps)



## Single Sign-On [Deprecated]



If you authorize with SSO, you should add URL-Scheme your Info.plist.

*REPLACE $(TWITTER_CONSUMER_KEY) TO YOUR CONSUMER KEY.*



```

CFBundleURLTypes



	

		CFBundleTypeRole

		Editor

		CFBundleURLSchemes

		

			swifter-$(TWITTER_CONSUMER_KEY)

		

	



```



# License



Swifter is licensed under the MIT License. See the LICENSE file for more information.