Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/esttorhe/rec
Helper library to record URL requests and save them locally (great for fixtures in HTTP stubbing)
https://github.com/esttorhe/rec
Last synced: about 1 month ago
JSON representation
Helper library to record URL requests and save them locally (great for fixtures in HTTP stubbing)
- Host: GitHub
- URL: https://github.com/esttorhe/rec
- Owner: esttorhe
- License: mit
- Created: 2015-05-08T22:12:52.000Z (over 9 years ago)
- Default Branch: swift-2.0
- Last Pushed: 2015-06-10T16:54:47.000Z (over 9 years ago)
- Last Synced: 2024-10-10T14:34:32.739Z (about 1 month ago)
- Language: Swift
- Size: 1.45 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Carthage/Carthage)
[](http://cocoapods.org/pods/Rec)
[](https://circleci.com/gh/esttorhe/Rec)
[](https://travis-ci.org/esttorhe/Rec)
[](https://coveralls.io/r/esttorhe/Rec)
[](http://cocoapods.org/pods/Rec)
[](http://cocoapods.org/pods/Rec)
# 
Helper library to record URL requests and save them locally (great for fixtures in HTTP stubbing)
-------
Why? •
OHHTTPStubs •
Rec •
Error Codes •
TODO •
-------
# Why?
[@Orta][orta] told me once over `Skype` how he has incorporated into their `API` teams some way to have a "sample" `JSON` for each call (I'm paraphrasing) so they can actually test with «real life» sample data and even support an «offline» mode for the app for when developing while riding the :train:, etc.
Sadly for me I work at a company that does multiple projects a year and not always we control the `API` development part which kinds of "cripples" the addition of "sample" `JSON`s.
## [`OHHTTPStubs`][httpstubs]
Enter [`OHHTTPStubs`][httpstubs]; I started adding `HTTP Stubs` to my projects for testing purposes and had to manually enter the `URL` for each request and save the resulting `JSON` in each file to add it to the fixtures folder for the test cases.
As an engineer (and more importantly an overly lazy person) I decided that this was a terribly tedious and slow process; so… why not automate it?
# Rec
This is where `Rec` comes to play; it's an `NSURLProtocol` that intercepts each `NSURL` request made from `NSURLSession`s (with `defaultSessionConfiguration` & `ephemeralSessionConfiguration`) and adds itself as the delegate for the connection; once the request succeeds the framework will save it to the application's `Documents` folder (under «Fixtures» folder).
`Rec` follows in the steps of [`OHHTTPStubs`][httpstubs] and «automagically» adds itself as the listener (it does so by swizzling `defaultSessionConfiguration` & `ephemeralSessionConfiguration` and returning a "pre configured" session configuration object).
## Error Codes
Here's the list of «internal» error codes:
```swift
public enum RecordingError: ErrorType {
/// Unable to start loading the request
case UnableToStartLoadingRequest
/// Failed to connect with NSURLRequest
case FailedToConnectToWithRequest(NSURLRequest)
/// Unable to correctly parse as a `JSON` response
case UnableToCorrectlyParseAsJSON(NSURLRequest)
/// Unable to get the `Document`'s directory path
case UnableToGetDocumentsDirectoryPath
/// Unable to extract the request's last path component for file name generation.
case UnableToExtractRequestsLastPath(NSURLRequest)
/// Unable to save file to path
case UnableToSaveFileToPath(String)
/// Unable to get a successful response from URL.
case UnableToGetSuccessfullResponseFromRequest(NSURLRequest)
}
```
# TODO:
- [ ] Support other responses (e.g.: `xml`, etc) • [Issue #1] (https://github.com/esttorhe/Rec/issues/1)
- [ ] Support custom «save» paths • [Issue #2] (https://github.com/esttorhe/Rec/issues/2)
- [ ] Support disabling automatic «injection» • [Issue #3] (https://github.com/esttorhe/Rec/issues/3)
- [ ] Fix the race condition happening on the Example App (`println()` I'm :eyes: at you :unamused: ) • [Issue #4] (https://github.com/esttorhe/Rec/issues/4)
- [x] ~~Add support for `OS X`~~ • [Issue #5] (https://github.com/esttorhe/Rec/issues/5)
[Orta]:https://github.com/orta
[httpstubs]:https://github.com/AliSoftware/OHHTTPStubs