https://github.com/johnnythetank/aping-plugin-github

GitHub Plugin for apiNG
https://github.com/johnnythetank/aping-plugin-github

angular api aping aping-plugin github github-api

Last synced: about 1 month ago
JSON representation

GitHub Plugin for apiNG

• Host: GitHub
• URL: https://github.com/johnnythetank/aping-plugin-github
• Owner: JohnnyTheTank
• License: mit
• Created: 2015-12-09T23:06:44.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-31T19:12:38.000Z (over 6 years ago)
• Last Synced: 2024-11-11T11:58:08.377Z (about 2 months ago)
• Topics: angular, api, aping, aping-plugin, github, github-api
• Language: JavaScript
• Size: 49.8 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[logo]: https://camo.githubusercontent.com/4bf6757723e08f87dec92ac931514d1e234b7ed3/687474703a2f2f6a6f686e6e7974686574616e6b2e6769746875622e696f2f6170694e472f6c6f676f2f3332302f6170696e672d6c6f676f2e706e67 "apiNG Plugin"

![apiNG][logo]

[![Join the chat at https://gitter.im/JohnnyTheTank/apiNG](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/JohnnyTheTank/apiNG?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![npm version](https://badge.fury.io/js/aping-plugin-github.svg)](https://badge.fury.io/js/aping-plugin-github)

[![Bower version](https://badge.fury.io/bo/apiNG-plugin-github.svg)](https://badge.fury.io/bo/apiNG-plugin-github)

**_apiNG-plugin-github_** is a [GitHub Data API v3](https://developer.github.com/v3/) plugin for [**apiNG**](https://github.com/JohnnyTheTank/apiNG).

# Information

* **Supported apiNG models: `repo`**

* This plugin supports the [`get-native-data` parameter](https://aping.readme.io/docs/advanced#parameters)

* This plugin may needs an [access token](#2-access-token) :warning:

* Used promise library: [angular-github-api-factory](https://github.com/JohnnyTheTank/angular-github-api-factory) _(included in distribution files)_

# Documentation

1. [INSTALLATION](#1-installation)

    1. Get file

    2. Include file

    3. Add dependency

    4. Add plugin

2. [ACCESS TOKEN](#2-access-token)

    1. Generate your `access_token`

    2. Insert your `access_token` into `aping-config.js`

3. [USAGE](#3-usage)

    1. Models

    2. Requests

    3. Rate limit

## 1. INSTALLATION

    a) Get file

    b) Include file

    c) Add dependency

    d) Add the plugin

### I. Get file

Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/), CDN (jsDelivr) or downloaded files:

* `bower install apiNG-plugin-github --save`

* `npm install aping-plugin-github --save`

* use [CDN file](https://www.jsdelivr.com/projects/aping.plugin-github)

* download [apiNG-plugin-github.zip](https://github.com/JohnnyTheTank/apiNG-plugin-github/zipball/master)

### II. Include file

Include `aping-plugin-github.min.js` in your apiNG application

```html

```

### III. Add dependencies

Add the module `jtt_aping_github` as a dependency to your app module:

```js

angular.module('app', ['jtt_aping', 'jtt_aping_github']);

```

### IV. Add the plugin

Add the plugin's directive `aping-github="[]"` to your apiNG directive and [configure your requests](#ii-requests)

```html

```

## 2. ACCESS TOKEN

### I. Generate your `access_token`

1. Login on [github.com](https://github.com)

2. Open [github.com/settings/tokens/new](https://github.com/settings/tokens/new)

    * Remove all scopes except **public_repo**

    * Generate your access_token

### II. Insert your `access_token` into `aping-config.js`

Create and open `js/apiNG/aping-config.js` in your application folder. It should be look like this snippet:

```js

angular.module('jtt_aping').config(['$provide', function ($provide) {

    $provide.value("apingDefaultSettings", {

        apingApiKeys : {

            github: [

                {'access_token':''}

            ],

            //...

        }

    });

}]);

```

:warning: Replace `` with your github `access_token`

## 3. USAGE

### I. Models

Supported apiNG models

|  model   | content | support | max items
per request | (native) default items
per request |

|----------|---------|---------|--------|---------|

| `repo` | **repositories** | full    | `100`   | `30`   |

| `user` | **users** | full    | `100`   | `30`   |

**support:**

* full: _the source platform provides a full list with usable results_ 


* partly: _the source platform provides just partly usable results_

### II. Requests

Every **apiNG plugin** expects an array of **requests** as html attribute.

#### Requests by User

|  parameter  | sample | default | description | optional |

|----------|---------|---------|---------|---------|

| **`user`** | `JohnnyTheTank` |  | GitHub username | no |

| **`repo`** | `apiNG` |  | Limits the request to specific GitHub repository name | yes |

| **`items`**  | `75` | `30` | Items per request (`0`-`100`) |  yes  |

Sample requests:

* `[{'user':'JohnnyTheTank'}, {'user':'xremix', 'items':10}]`

* `[{'user':'JohnnyTheTank', 'repo':'apiNG'}]`

* `[{'user':'JohnnyTheTank'}]`

#### Requests by Search

|  parameter  | sample | default | description | optional |

|----------|---------|---------|---------|---------|

| **`search`** | `bootstrap` |  | The search keywords, as well as any qualifierse | no |

| **`sort`** | `stars` |  | The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match | yes |

| **`order`** | `asc` | `desc` | The sort order if `sort` parameter is provided. One of `asc` or `desc` | yes |

| **`items`**  | `75` | `30` | Items per request (`0`-`100`) |  yes  |

Sample requests:

* `[{'search':'apiNG', 'sort':'stars', 'order':'desc', 'items':50}]`

* `[{'search':'JohnnyTheTank', 'items':10}]`

### III. Rate limit

Visit the official [GitHub Data API documentation](https://developer.github.com/v3/#rate-limiting)

> For requests using Basic Authentication or OAuth, you can make up to 5,000 requests per hour.

# Licence

MIT