https://github.com/remirobert/foursquare-kit-ios
Foursquare Kit is a native SDK to include Foursquare API inside mobile apps.
https://github.com/remirobert/foursquare-kit-ios
foursquare-api swift4
Last synced: 6 months ago
JSON representation
Foursquare Kit is a native SDK to include Foursquare API inside mobile apps.
- Host: GitHub
- URL: https://github.com/remirobert/foursquare-kit-ios
- Owner: remirobert
- License: mit
- Created: 2018-01-13T03:32:34.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-22T02:41:39.000Z (over 6 years ago)
- Last Synced: 2025-04-24T01:46:10.346Z (6 months ago)
- Topics: foursquare-api, swift4
- Language: Swift
- Size: 63.5 KB
- Stars: 20
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# foursquare-kit-ios
[](https://app.bitrise.io/app/0cf816feba3589af)
[](https://codecov.io/gh/remirobert/foursquare-kit-ios)
Foursquare Kit is a easy way to use the Foursquare API in your apps. You can search for venues, get details and photos.
It's a very light framework without any dependencies, extensible, and tested. It doesn't cover all the APIs yet. If you have a specific need, please be free to open an issue, or a pull request.
## Installation
To add Foursquare Kit to your app, simply add **FoursquareKit** to your ```Podfile```.
```
target 'MyApp' do
use_frameworks!
pod 'FoursquareKit'
end
```
## Initialize a FoursquareClient instance
You can authentificate to the Foursquare API with **client_id / client_secret** or with a **token**.
```Swift
import FoursquareKit
class RestaurantsViewController: UIViewController {
override viewDidLoad() {
super.viewDidLoad()
let auth = Authentification(clientId: "123", clientSecret: "456")
let client = FoursquareClient(authentification: auth)
}
}
```
## Performing API requests
Start by creating a reference to the **FoursquareClient** instance that you will use to make your API calls.
Searching for venues (documentation https://developer.foursquare.com/docs/api/venues/search):
```Swift
let parameters = ["ll" : "44.3,37.2"]
client.search.venues(parameters: parameters).response { result in
switch result {
case .success(let data):
venues = data.response.venues
case .failure(let error):
print("error : \(error)")
}
}
```
Searching for trending venues (documentation https://developer.foursquare.com/docs/api/venues/trending):
```Swift
let parameters = ["ll" : "44.3,37.2"]
client.search.trending(parameters: parameters).response { result in
switch result {
case .success(let data):
venues = data.response.venues
case .failure(let error):
print("error : \(error)")
}
}
```
Get details for a venue (documentation https://developer.foursquare.com/docs/api/venues/details):
```Swift
client.venue.details(id: "123").response { result in
switch result {
case .success(let data):
venue = data.response.venue
case .failure(let error):
print("error : \(error)")
}
}
```
Get photos for a venue (documentation https://developer.foursquare.com/docs/api/venues/photos):
```Swift
client.venue.photos(id: "123").response { result in
switch result {
case .success(let data):
photos = data.response.photos.items
case .failure(let error):
print("error : \(error)")
}
}
```
## Cache 📦
You can add a cache strategy for each Request, to allow to get the data from local storage.
Foursquare Kit was designed with no external dependency. Foursquare Kit can works with any cache libraries.
For doing that, your cache implementation has to conform to the protocol **Cachable**.
Then calling the cache function and pass the **Cachable object**.
Here an example for PINCache:
```Swift
extension PINCache: FoursquareKit.Cachable {
func data(forKey key: String, completion: ((Data?) -> Swift.Void)) {
self.object(forKey: key) { (_, _, object) in
completion(object as? Data)
}
}
func set(data: Data, forKey key: String) {
self.setObject(data, forKey: key)
}
}
let request = client.venue.photos(id: "123")
request
.cache(PINCache.shared)
.response { result in
//...
}
```
## Cancelling a request ✋
All the API calls will return a ```Request``` object, simply call the ```cancel``` function to cancel the network call.
```Swift
let request = client.venue.photos(id: "123").response { result in
//...
}
request.cancel()
```