Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/elwayman02/ember-data-github

Ember Data library for the GitHub API
https://github.com/elwayman02/ember-data-github

ember ember-addon ember-data emberjs github github-api

Last synced: 2 months ago
JSON representation

Ember Data library for the GitHub API

Awesome Lists containing this project

README 

        
# Ember Data Github



[![Build Status](https://travis-ci.org/elwayman02/ember-data-github.svg?branch=master)](https://travis-ci.org/elwayman02/ember-data-github)

[![Ember Observer Score](http://emberobserver.com/badges/ember-data-github.svg)](http://emberobserver.com/addons/ember-data-github)

[![Code Climate](https://codeclimate.com/github/elwayman02/ember-data-github/badges/gpa.svg)](https://codeclimate.com/github/elwayman02/ember-data-github)



Ember Data abstraction for the [GitHub REST API v3](https://developer.github.com/v3/).



## Installation



```

ember install ember-data-github

```



## Usage



You need to choose how you wish to authenticate your GitHub requests using OAuth. `ember-data-github` provides a simple

and direct mechanism that is specific to itself. Alternatively, you can use a more general authentication framework like

`ember-simple-auth`.



### Authenticating Directly



If you already have a token to use the OAuth endpoints, such as a *Personal access token*, you must set the property

named `githubAccessToken` on `github-session` service with the currently logged in user's GitHub access token.



### Authenticating with `ember-simple-auth`



If you are using [ember-simple-auth](http://ember-simple-auth.com/) (ESA) to authenticate, perhaps with

[torii](http://vestorly.github.io/torii) and ESA's `torii-provider`, you can authenticate by creating a github

authorizer and extending `ember-data-github`'s adapter for each model you use. See the respective addon docs and

[GitHub's OAuth docs](https://developer.github.com/v3/oauth/) to set it up.



Once you have a token, the authorizer will look like

```js

// app/authorizers/github.js



import { inject as service } from '@ember/service';

import { isEmpty } from '@ember/utils';

import Base from 'ember-simple-auth/authorizers/base';



export default Base.extend({

  session: service(),

  authorize(sessionData, block) {

    if (this.get('session.isAuthenticated') && !isEmpty(sessionData.access_token)) {

      block('Authorization', `token ${sessionData.access_token}`);

    }

  }

});

```

assuming `access_token` is the name of the property containing the token. This automatically injects the `Authorization`

header into the API requests using ESA mechanisms.



An extended adapter for `github-user` would look like

```js

// app/adapters/github-user.js



import GitHubUserAdapter from 'ember-data-github/adapters/github-user';

import DataAdapterMixin from 'ember-simple-auth/mixins/data-adapter-mixin';



export default GitHubUserAdapter.extend(DataAdapterMixin, {

  authorizer: 'authorizer:github'

});

```



### Retrieving GitHub Data



#### [Users](https://developer.github.com/v3/users/)



##### [Get the current authenticated user](https://developer.github.com/v3/users/#get-the-authenticated-user)

```js

this.get('store').findRecord('github-user', '#');

```



##### [Get a single user](https://developer.github.com/v3/users/#get-a-single-user)

```js

this.get('store').findRecord('github-user', 'jimmay5469'); // get a user by user login

this.get('store').findRecord('github-user', 917672); // get a user by user id

```



#### [Repositories](https://developer.github.com/v3/repos/)



##### [Get](https://developer.github.com/v3/repos/#get)

```js

this.get('store').findRecord('github-repository', 'jimmay5469/old-hash'); // get a repository by repository name

this.get('store').findRecord('github-repository', 34598603); // get a repository by repository id

```



##### [Get By User](https://developer.github.com/v3/repos/#list-user-repositories)

```js

this.get('store').query('github-repository', { user: 'elwayman02' }); // get repositories owned by user

this.get('store').query('github-repository', { user: 'elwayman02', type: 'all' }); // get all repositories for user

this.get('store').query('github-repository', { user: 'elwayman02', sort: 'updated', direction: 'asc' }); // get repositories owned by user sorted by last updated, ascending

```



##### [Repository Contents](https://developer.github.com/v3/repos/contents/)



##### [Get](https://developer.github.com/v3/repos/contents/#get-contents)

Note: At this time we only support getting file contents.

```js

this.get('store').queryRecord('github-repository-contents', { repo: 'jmar910/test-repo-yay', file: 'app.json' }); // get file contents from repo



```



##### [Branches](https://developer.github.com/v3/repos/branches/)



###### [List branches](https://developer.github.com/v3/repos/branches/#list-branches)



```js

this.get('store').query('github-branch', { repo: 'jimmay5469/old-hash' });

```



###### [Get](https://developer.github.com/v3/repos/branches/#get-branch)

```js

this.get('store').findRecord('github-branch', 'jimmay5469/old-hash/branches/master'); // get a branch

this.get('store').queryRecord('github-branch', { repo: 'jimmay5469/old-hash', branch: 'master' }); // get a specific branch

```



##### [Releases](https://developer.github.com/v3/repos/releases/)



###### [List releases for a repository](https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository)

```js

this.get('store').query('github-release', { repo: 'jimmay5469/old-hash' });

```



###### [Get a single release](https://developer.github.com/v3/repos/releases/#get-a-single-release)

```js

this.get('store').queryRecord('github-release', { repo: 'jimmay5469/old-hash', releaseId: 1 });

```



##### [Commits](https://developer.github.com/v3/repos/commits/)



###### [Compate two commits](https://developer.github.com/v3/repos/commits/#compare-two-commits)



```js

this.get('store').queryRecord('github-compare', { repo: 'jimmay5469/old-hash', base: '1234', head: '5678' });

```



#### [Pull Requests](https://developer.github.com/v3/pulls/)



##### [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)

```js

this.get('store').query('github-pull', { repo: 'jimmay5469/old-hash' });

```



##### [Get a single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request)

```js

this.get('store').queryRecord('github-pull', { repo: 'jimmay5469/old-hash', pullId: 1 });

```

#### [GitHub Organizations](https://developer.github.com/v3/orgs/)



##### [Get an organizaton](https://developer.github.com/v3/orgs/#get-an-organization)

```js

this.get('store').findRecord('github-organization', { org: 'my-org' });

```



##### [Get organization members](https://developer.github.com/v3/orgs/members/#members-list)

```js

this.get('store').query('github-members', { org: 'my-org' })

```



#### [Git Blobs](https://developer.github.com/v3/git/blobs/)



##### [Get a blob](https://developer.github.com/v3/git/blobs/#get-a-blob)



```js

this.get('store').queryRecord('github-blob', { repo: 'jimmay5469/old-hash', sha: '47c5438403ca875f170db2aa07d1bfa3689406e3' });

```

#### [Git Trees](https://developer.github.com/v3/git/trees/)



##### [Get a Tree](https://developer.github.com/v3/git/trees/#get-a-tree)



```js

this.get('store').queryRecord('github-tree', { repo: 'jimmay5469/old-hash', sha: '47c5438403ca875f170db2aa07d1bfa3689406e3' });

```



## Testing with Mirage



This addon uses [ember-cli-mirage](http://www.ember-cli-mirage.com/) in its tests.  It is often beneficial for consuming apps to be able to re-use the factories and models defined in mirage, so if you would like to use these in your tests you can add the `mirage-support` object to your `ember-cli-build.js` file:



```

module.exports = function(defaults) {

  let app = new EmberApp(defaults, {

    ...

    'mirage-support': {

      includeAll: true

    }

    ...

  });



  return app.toTree();

};

```



As long as `ember-cli-mirage` is not disabled, the files in this addon's `mirage-support` directory will be merged with the consuming app's namespace, and be made available to that mirage context.

The `'mirage-support'` key has 3 options:



Key | Type | Description

--- | --- | ---

`includeAll` | `Boolean` | If `true`, includes the full `mirage-support` tree, i.e. no-brainer just use it all.

`exclude` | _{Array of `GlobStrings,RegExps,Functions`}_ | This value gets passed directly to `broccoli-funnel`, *only* if `includeAll` is specified. Allows for excluding certain files from import.

`include` | _{Array of `GlobStrings,RegExps,Functions`}_ | Passed dirctly to `broccoli-funnel`. Allows to pick only certain files to be imported into app namespace.



## Contributing



### Installation



* `git clone [email protected]:elwayman02/ember-data-github.git`

* `cd ember-data-github`

* `yarn`



### Running



* `ember serve`

* Visit your app at [http://localhost:4200](http://localhost:4200).



### Running Tests



* `ember test` – Runs the test suite on the current Ember version

* `ember test --server` – Runs the test suite in "watch mode"

* `ember try:each` – Runs the test suite against multiple Ember versions



### Building



* `ember build`



For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).