https://github.com/juanjoarreola/apic

https://github.com/juanjoarreola/apic

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/juanjoarreola/apic
• Owner: JuanjoArreola
• License: mit
• Created: 2016-01-05T18:25:16.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-06-07T00:25:15.000Z (over 5 years ago)
• Last Synced: 2024-10-30T00:38:32.262Z (about 2 months ago)
• Language: Swift
• Size: 298 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Apic

![Cocoapods](https://img.shields.io/cocoapods/v/Apic.svg)

![Platform](https://img.shields.io/cocoapods/p/Apic.svg)

![License](https://img.shields.io/cocoapods/l/Apic.svg)

[![codebeat badge](https://codebeat.co/badges/d92500f6-a28d-401f-95da-ac84762f1657)](https://codebeat.co/projects/github-com-juanjoarreola-apic-master)

Apic communicates with **RESTful services**, parses the **JSON** HTTP response and delivers objects.

## Installation

### CocoaPods

####  Swift < 2.3:

  pod 'Apic' '~> 2.2.4'

####  Swift 3.x :

   pod 'Apic' '~> 3.9.6'

#### Swift 4

  pod 'Apic' '~> 4.0.0'

  pod 'Apic' '~> 5.0.0'

## Repositories

The repository is a class that implements the logic to communicate with the services that provide the REST resources, basically a Repository has methods that correspond to endpoints in the backend, all repositories inherit from the generic class `AbstractRepository`:

```swift

class GistsRepository: AbstractRepository {

    func requestGistsOfUser(_ user: String, completion: ([Gist]) -> Void) -> Request<[Gist]> {

        return requestArray(route: .get("https://api.github.com/users/\(user)/gists"), completion: completion)

    }

}

```

The only requirement is that `Gist` implements `Decodable`

This repository can now be used by a `ViewController` to request a user's gists.

```swift

class GistsController: UITableViewController {

	let gistsRepository = GistsRepository()

    var gists: [Gist]?

    var gistsRequest: Request<[Gist]>?

    override func viewDidLoad() {

        super.viewDidLoad()

        requestGists()

    }

    func requestGists() {

        gistsRequest?.cancel()

        gistsRequest = gistsRepository.requestGistsOfUser("UserName", completion: { [weak self] gists in

            self?.gists = gists

        }).fail { [weak self] error in

            self?.handleError(error)

        }.finished { [weak self] in

            self?.tableView.reloadData()

        }

    }

}

```

When the `GistsRepository` finishes calling the service and parsing the response it calls the completion closure that you provide sending you an array of `[Gist]` in this case.