{"id":1600,"url":"https://github.com/epam/road-ios-framework","last_synced_at":"2025-08-02T04:31:52.280Z","repository":{"id":7309103,"uuid":"8626687","full_name":"epam/road-ios-framework","owner":"epam","description":"ROAD – Rapid Objective-C Applications Development","archived":false,"fork":false,"pushed_at":"2018-06-09T17:16:08.000Z","size":19021,"stargazers_count":56,"open_issues_count":21,"forks_count":18,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-07-18T09:58:01.137Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/epam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"Contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-07T12:14:58.000Z","updated_at":"2025-06-18T22:51:13.000Z","dependencies_parsed_at":"2022-08-31T22:31:23.481Z","dependency_job_id":null,"html_url":"https://github.com/epam/road-ios-framework","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/epam/road-ios-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epam%2Froad-ios-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epam%2Froad-ios-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epam%2Froad-ios-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epam%2Froad-ios-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/epam","download_url":"https://codeload.github.com/epam/road-ios-framework/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epam%2Froad-ios-framework/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268334614,"owners_count":24233793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-01-05T20:15:51.056Z","updated_at":"2025-08-02T04:31:51.802Z","avatar_url":"https://github.com/epam.png","language":"Objective-C","funding_links":[],"categories":["Networking"],"sub_categories":["Video","Other free courses"],"readme":"[![License](https://cocoapod-badges.herokuapp.com/l/ROADFramework/badge.svg)](http://opensource.org/licenses/BSD-3-Clause)\n[![Platform](https://cocoapod-badges.herokuapp.com/p/ROADFramework/badge.png)](https://github.com/epam/road-ios-framework/)\n[![Version](https://cocoapod-badges.herokuapp.com/v/ROADFramework/badge.png)](https://github.com/epam/road-ios-framework/)\n[![Coverage Status](http://img.shields.io/coveralls/epam/road-ios-framework/master.svg?style=flat)](https://coveralls.io/r/epam/road-ios-framework?branch=master)\n[![Build Status](http://img.shields.io/travis/epam/road-ios-framework/master.svg?style=flat)](https://travis-ci.org/epam/road-ios-framework)\n\nA set of reusable components taking advantage of extra dimension [Attribute-Oriented Programming](https://en.wikipedia.org/wiki/Attribute-oriented_programming) adds.\n\n## Components\n\n**Core** - support for attributes, reflection and helper-extensions on Foundation classes.  \n**Services** - implementation of Service Locator pattern, centralized replacement for singletons.  \n**Serialization** - attribute-based JSON and XML parsers for easy DOM (de)serializations.  \n**Web Services** - attribute-based HTTP client API.  \n\n## Snippet\nConnection to the test HTTP server, that returns JSON from headers you send, could look as follows:\n\n\tRF_ATTRIBUTE(RFWebService, serviceRoot = @\"http://headers.jsontest.com/\")\n\t@interface JsonTestWebClient : RFWebServiceClient\n\t\n\tRF_ATTRIBUTE(RFWebServiceCall, method = @\"GET\", prototypeClass = [MyWebServiceResponse class])\n\tRF_ATTRIBUTE(RFWebServiceHeader, headerFields = @{@\"Text\" : @\"A lot of text\",\n\t                                                   @\"Number\" : [@1434252.234 stringValue],\n\t                                                   @\"Date\" : [[NSDate dateWithTimeIntervalSince1970:100000000] description]})\n\t- (id\u003cRFWebServiceCancellable\u003e)echoRequestHeadersAsJSONWithSuccess:(void(^)(MyWebServiceResponse result))successBlock failure:(void(^)(NSError *error))failureBlock;\n\t\n\t@end\n\nthen we define the model:\n\n\tRF_ATTRIBUTE(RFSerializable)\n\t@interface MyWebServiceResponse : NSObject\n\t\n\tRF_ATTRIBUTE(RFSerializable, serializationKey = @\"Text\")\n\t@property NSString *text;\n\t\n\tRF_ATTRIBUTE(RFSerializable, serializationKey = @\"Number\")\n\t@property NSNumber *number;\n\t\n\tRF_ATTRIBUTE(RFSerializable, serializationKey = @\"Date\")\n\tRF_ATTRIBUTE(RFSerializableDate, format = @\"yyyy-MM-dd HH:mm:ss Z\")\n\t@property NSDate *date;\n\t\n\t@end\n\nand make singleton instance of JsonTestWebClient accessible through RFServiceProvider:\n\n\t@interface RFServiceProvider (JsonTestWebClient)\n\t\n\tRF_ATTRIBUTE(RFService, serviceClass = [JsonTestWebClient class])\n\t+ (JsonTestWebClient *)jsonTestWebClient;\n\t\n\t@end\n\nNow we can use it: \n\n\t[[RFServiceProvider jsonTestWebClient] echoRequestHeadersAsJSONWithSuccess:^(MyWebServiceResponse *result) {\n\t    NSLog(@\"%@\", result);\n\t} failure:^(NSError *error) {\n\t    NSLog(@\"Something terrible happened! Here are details : %@\", error);\n\t}];\n\n## Requirements\n\nROAD requires **iOS 5.0** and above. The compatibility with **4.3** and older is not tested.\n\nROAD initially designed to use **ARC**. \n\n## Jump Start\n[CocoaPods](http://cocoapods.org) is the only recommended way of ROAD integration. Besides the standard configuration of pod dependencies, pod_install hook is required as shown below. A typical Podfile will look as follows:\n\n\tpod 'ROADFramework'\n\n\tpost_install do |installer|\n\t    require File.expand_path('ROADConfigurator.rb', './Pods/libObjCAttr/libObjCAttr/Resources/')\n\t    ROADConfigurator::post_install(installer)\n\tend\n\t\n**Note:**\nIf you want to get rid of warning from Xcodeproj gem, copy-paste and run in terminal next command before running `pod install`:\n\n```shell\nexport COCOAPODS_DISABLE_DETERMINISTIC_UUIDS=YES\n```\n\n\n**Using components separately**  \nIf you'd like to embed only specific components from the framework it can be done with CocoaPods as well.\n\n\tpod 'ROADFramework/ROADServices'\n\tpod 'ROADFramework/ROADWebService'\n\nDetailed information on internals of ROAD integration as well as advanced topics like integration with predefined workspace, multiple projects or targets is available in [the documentation](./Documents/Configuration/Cocoapods.md).        \n        \n## Documentation\n\nUser documentation for the following components is available in **Documents** folder:\n\n* [Core](./Documents/ROADCore.md)\n* [Services](./Documents/ROADServices.md)\n* [Serialization](./Documents/ROADSerialization.md)\n* [Web Services](./Documents/ROADWebService.md)\n\nClasses reference is available in [cocoadocs.org](http://cocoadocs.org/docsets/ROADFramework/)\n\n## License\nROAD is made available under the terms of the [BSD-3](http://opensource.org/licenses/BSD-3-Clause). Open the LICENSE file that accompanies this distribution in order to see the full text of the license.\n\n## Contribution\n\nThere are three ways you can help us:\n\n* **Raise an issue.** You found something that does not work as expected? Let us know about it.\n* **Suggest a feature.** It's even better if you come up with a new feature and write us about it.\n* **Write some code.** We would love to see more pull requests to our framework, just make sure you have the latest sources. For more information, check out [the guidelines for contributing](./Contributing.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepam%2Froad-ios-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fepam%2Froad-ios-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepam%2Froad-ios-framework/lists"}