Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erudika/para-client-ios
iOS Client for Para
https://github.com/erudika/para-client-ios
api-client backend backend-services cocoapods ios para pure-swift swift swift-4 swift-package-manager
Last synced: 3 months ago
JSON representation
iOS Client for Para
- Host: GitHub
- URL: https://github.com/erudika/para-client-ios
- Owner: Erudika
- License: apache-2.0
- Created: 2016-05-11T23:26:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-12T18:35:10.000Z (about 3 years ago)
- Last Synced: 2024-11-14T20:49:09.325Z (3 months ago)
- Topics: api-client, backend, backend-services, cocoapods, ios, para, pure-swift, swift, swift-4, swift-package-manager
- Language: Swift
- Homepage: https://paraio.org
- Size: 140 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iOS Client for Para
[](https://img.shields.io/cocoapods/v/ParaClient.svg)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/ParaClient)
[](https://gitter.im/Erudika/para?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## What is this?
**Para** was designed as a simple and modular backend framework for object persistence and retrieval.
It helps you build applications faster by taking care of the backend. It works on three levels -
objects are stored in a NoSQL data store or any old relational database, then automatically indexed
by a search engine and finally, cached.
This is the Swift client for Para for iOS, tvOS, macOS and watchOS.
## Quick start
**NOTE:** This XCode project is broken when used with CocoaPods! I gave up fixing it since the release of XCode 10. Feel free to fix it and submit a pull request. Thanks!
### CocoaPods
For the latest release in CocoaPods add the following to your `Podfile`:
```ruby
use_frameworks!
pod 'ParaClient'
```
And install it with:
```sh
$ pod install
```
### Swift Package Manager
Add ParaClient as a dependency to your `Package.swift`. For example:
```swift
let package = Package(
name: "YourPackageName",
dependencies: [
.Package(url: "https://github.com/Erudika/para-client-ios.git", majorVersion: 1)
]
)
```
## Usage
Initialize the client in your code like so:
```js
import ParaClient
// avoid using the secret key on mobile devices
let client = ParaClient(accessKey: "ACCESS_KEY", secretKey:"")
client.signIn("facebook", providerToken: "fb_access_token", callback: { user in
if user != nil {
// success! user is authenticated, JWT token is saved on the device
// you can now call the API methods
}
})
```
It's a bad idea to hardcode your Para secret key in your code because it will run in an insecure client-side environment. Instead use the `signIn()` method to get an access token (JWT) with limited client permissions. Think of it like this: API key+secret = **full API access**, `paraClient.signIn()` = **limited API access** for clients with JWT tokens.
You can have a [special user object created](http://paraio.org/docs/#034-api-jwt-signin) just for your iOS app and assign it special permissions so that your app can access a part of the Para API before authenticating another real user. [Read the documentation for more information about client permissions](http://paraio.org/docs/#012-permissions).
For granting resource permissions to your client users go to [console.paraio.org](https://console.paraio.org) where you can edit your app object and allow your users the call specific API methods.
## Requirements
- iOS 9.2+ / macOS 10.10+ / tvOS 9.2+ / watchOS 2.2+
- Xcode 7.3+, Swift 2.2+, CocoaPods 1.0+
## Thanks
Special thanks to [Christopher Sexton](https://github.com/csexton) for porting the
[AWS Signature 4 algorithm to Swift](http://www.codeography.com/2017/03/20/signing-aws-api-requests-in-swift.html).
His code was used in this project and is also licensed under Apache 2.0.
## Documentation
### [Read the Docs](https://paraio.org/docs)
## Contributing
1. Fork this repository and clone the fork to your machine
2. Create a branch (`git checkout -b my-new-feature`)
3. Implement a new feature or fix a bug and add some tests
4. Commit your changes (`git commit -am 'Added a new feature'`)
5. Push the branch to **your fork** on GitHub (`git push origin my-new-feature`)
6. Create new Pull Request from your fork
For more information see [CONTRIBUTING.md](https://github.com/Erudika/para/blob/master/CONTRIBUTING.md)
## License
[Apache 2.0](LICENSE)