Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/onmyway133/github.swift

:octocat: Unofficial GitHub API client in Swift
https://github.com/onmyway133/github.swift

api github ios octokit rxswift

Last synced: 3 months ago
JSON representation

:octocat: Unofficial GitHub API client in Swift

Host: GitHub
URL: https://github.com/onmyway133/github.swift
Owner: onmyway133
License: other
Archived: true
Created: 2016-04-02T18:46:50.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2020-05-12T21:31:43.000Z (over 4 years ago)
Last Synced: 2024-08-07T23:46:59.797Z (3 months ago)
Topics: api, github, ios, octokit, rxswift
Language: Swift
Homepage:
Size: 2.76 MB
Stars: 188
Watchers: 9
Forks: 23
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-ios - GitHub.swift - :octocat: Unofficial GitHub API client in Swift (SDK / Unofficial)
awesome-ios-star - GitHub.swift - :octocat: Unofficial GitHub API client in Swift (SDK / Unofficial)

README

        # Github.swift

❤️ Support my apps ❤️ 

- [Push Hero - pure Swift native macOS application to test push notifications](https://onmyway133.com/pushhero)

- [PastePal - Pasteboard, note and shortcut manager](https://onmyway133.com/pastepal)

- [Quick Check - smart todo manager](https://onmyway133.com/quickcheck)

- [Alias - App and file shortcut manager](https://onmyway133.com/alias)

- [My other apps](https://onmyway133.com/apps/)

❤️❤️😇😍🤘❤️❤️

[![CI Status](http://img.shields.io/travis/onmyway133/GithubSwift.svg?style=flat)](https://travis-ci.org/onmyway133/GithubSwift)

[![Version](https://img.shields.io/cocoapods/v/GithubSwift.svg?style=flat)](http://cocoadocs.org/docsets/GithubSwift)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![License](https://img.shields.io/cocoapods/l/GithubSwift.svg?style=flat)](http://cocoadocs.org/docsets/GithubSwift)

[![Platform](https://img.shields.io/cocoapods/p/GithubSwift.svg?style=flat)](http://cocoadocs.org/docsets/GithubSwift)

![](Screenshots/Banner.png)

## Description

- A Swift implementation of [octokit.objc](https://github.com/octokit/octokit.objc), using [RxSwift](https://github.com/ReactiveX/RxSwift), [Alamofire](https://github.com/Alamofire/Alamofire) and [Tailor](https://github.com/zenangst/Tailor)

- Try to use more Swift style as possible

- Note: you may consider using GraphQL https://developer.github.com/v4/

## Usage

#### Client

- User: identify a user

- Server: identify server (Github or Github Enterprise)

- Client: make request. If associated with a valid token, it is considered authenticated client

```swift

let _ =

  Client.signInUsingWebBrowser(Server.dotComServer, scopes: [.Repository])

    .flatMap { client in

      return client.fetchUserRepositories()

    }.subscribeNext { repositories in

      repositories.forEach { print($0.name)

    }

  }

```

#### Request Descriptor

Make your own request using `RequestDescriptor`, using syntax from [Construction](https://github.com/onmyway133/Construction)

```swift

let requestDescriptor: RequestDescriptor = construct {

  $0.path = "repos/\(owner)/\(name)"

  $0.etag = "12345"

  $0.offset = 2

  $0.perPage = 50

  $0.parameters["param"] = "value"

  $0.headers["header"] = "value"

  $0.method = .PUT  

}

return enqueue(requestDescriptor).map {

  return Parser.one($0)

}

```

#### Pagination

- The `subscribe` gets called many times if there is pagination

```swift

client

.fetchUserRepositories()

.subscribeNext { repositories in

  // This gets called many times depending pagination

  repositories.forEach { print($0.name)

}

```

- Use `toArray` if we want `subscribe` to be called once with all the values collected

```swift

client

.fetchUserRepositories()

.toArray()

.subscribeNext { repositories: [[Repository]] in

  repositories.flatMap({$0}).forEach { print($0.name)

}

```

## Features

#### Metadata

- Fetch server metadata

#### Sign in

- Native flow

- OAuth flow

#### User

- Follow

- Unfollow

- Fetch user info

#### Repository

- Fetch repositories

- Create repository

- Fetch commits

- Fetch pull requests

- Fetch issues

- Watch

#### Pull request

- Make pull requests

#### Issue

- Create issue

- Fetch issues

#### Organization

- Fetch organizations

- Fetch teams

#### Search

- Search repositories

#### Event

- Fetch user events

#### Gists

- Fetch gists

#### Git

- Create tree

- Create blob

- Create commit

#### Activity

- Star

- Unstar

#### Notification

- Fetch notifications

## Installation

**GithubSwift** is available through [CocoaPods](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod 'GithubSwift'

```

**GithubSwift** is also available through [Carthage](https://github.com/Carthage/Carthage).

To install just write into your Cartfile:

```ruby

github "onmyway133/Github.swift"

```

## Author

Khoa Pham, [email protected]

## Contributing

We would love you to contribute to **GithubSwift**, check the [CONTRIBUTING](https://github.com/onmyway133/GithubSwift/blob/master/CONTRIBUTING.md) file for more info.

## License

**GithubSwift** is available under the MIT license. See the [LICENSE](https://github.com/onmyway133/GithubSwift/blob/master/LICENSE.md) file for more info.