https://github.com/jchavarri/ambrosio
An iOS butler app that relies on Redbooth API
https://github.com/jchavarri/ambrosio
Last synced: 5 months ago
JSON representation
An iOS butler app that relies on Redbooth API
- Host: GitHub
- URL: https://github.com/jchavarri/ambrosio
- Owner: jchavarri
- Created: 2015-11-11T00:41:20.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-15T21:59:26.000Z (about 10 years ago)
- Last Synced: 2025-04-04T20:47:16.678Z (9 months ago)
- Language: Swift
- Size: 0 Bytes
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#  Ambrosio
Ambrosio is an iOS app built with Swift, that uses iBeacons to help you set up "physical reminders" for your Redbooth tasks.
The name c
##Features
- The "physical reminders" are iOS notifications, and they can be activated when you arrive or when you leave
- You can set them up individually for each task
- They are triggers automatically, even if the app is not opened, whenever you arrive or leave home. So no more excuses that you forgot that important document at home!
## Installing Ambrosio
- Clone the repo
- Run `carthage update`
- Add the file `AuthDataManager.Config` to folder `Classes/Common/Services/Auth` with this content (replace the tags <> with your API configuration):
```
extension AuthDataManager {
internal struct Config {
internal static let redirectUri = "ambrosio://return-uri"
internal static let clientId = ""
internal static let clientSecret = ""
}
}
```
- Run the project
## How to test iBeacons
Once you have Ambrosio installed, you can simulate the iBeacon events by following these steps:
- Install the app [Locate Beacon](https://itunes.apple.com/es/app/locate-beacon/id738709014?mt=8) (from Radius Software) on one [compatible device](https://en.wikipedia.org/wiki/IBeacon#Compatible_devices). This device will simulate the real iBeacon that could be placed in the user’s house.
- Open Locate Beacon and enable the “Null Beacon” device, the one with all zeros as UDID. There’s no need of entering major and minor. You can trigger “Getting home” and “Leaving home” by using the switch. The change is applied immediately, so no need to press Save after changes
## Technical details
Ambrosio is my first Swift app. Some inner details about it:
- For Ambrosio, "home" means every iBeacon in the "Null Beacon" region, i.e. the UDID is all zeros
- Ambrosio adds a specific tag to the Redbooth description field to contain the alarm information. This tag looks like `[ambrosio]WhenArriving[/ambrosio]`
- The app architecture is very influenced by the VIPER principles. There are plenty of resources online but the ones I've visited more are:
- Blog posts: [This one](https://www.objc.io/issues/13-architecture/viper/) from objc.io and [this other](https://medium.com/brigade-engineering/brigades-experience-using-an-mvc-alternative-36ef1601a41f) from Brigade
- Github examples: [This one](https://github.com/objcio/issue-13-viper-swift/) (companion to the previous blog post) and [this other](https://github.com/mutualmobile/Counter). Both from Mutual Mobile
- Helper: [Boa](https://github.com/team-supercharge/boa) is a simple gem to initialize VIPER projects and add modules to them. It helps you avoid all the boilerplate files and code
- Video: [This video](https://www.youtube.com/watch?v=OX4rLAJC7lw) by the Redbooth Mobile Team
- I started using [Locksmith](https://github.com/matthewpalmer/Locksmith) to store the authorization data on the keychain. But I was never able to setup the keychain item accessibility constant to `kSecAttrAccessibleAfterFirstUnlock` that is required to read the keychain in background (see [Apple doc](https://developer.apple.com/library//ios/documentation/Security/Reference/keychainservices/index.html#//apple_ref/doc/constant_group/Keychain_Item_Accessibility_Constants)). So I ended up using [KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess), which has a simple API and works in background by default.
### TODO
- User can configure her specific beacons
- Better task management (complete tasks, filter, search)
- Add persistent storage
- i18n support
- Remove the dependency from RootWireframe
- Add alarms for other users as well (notify Paul about this when he gets to the office tomorrow)