Ember OSF

master Build Status:

develop Build Status:

This repo contains code for interacting with the OSF APIv2 inside of an Ember app.

Contributing?

Please read the CONTRIBUTING.md

Installation (for Development)

git clone this repository
npm install
bower install

Using this code in an Ember app

Clone the repository: git clone https://github.com/CenterForOpenScience/ember-osf.git
From the consuming Ember app:

install the addon and it's dependencies: ember install ../ember-osf
- this generates a config/local.yml file (see 'Configuration' below)
link the app for local development: npm link ../ember-osf
Import code from ember-osf like:

import Ember from 'ember';
import OsfTokenLoginRouteMixin from 'ember-osf/mixins/osf-token-login-route';

export default Ember.Route.extend(OsfLoginRouteMixin);

Note: Running ember install will automatically install all bower and npm dependencies for ember-osf.

Configuration

local.yml settings

This file is structured like:

<backend>:
  CLIENT_ID: null
  PERSONAL_ACCESS_TOKEN: null
  OAUTH_SCOPES: osf.full_read osf.full_write
  REDIRECT_URI: http://localhost:4200/login

You will need to fill out options for each backend you want to use (see 'Running' below). We recommend using the 'test' backend for development and testing as it is the most stable of our environments. When configuring your application, make sure that your login redirect uri is correct. If it needs a trailing slash, be sure to include a trailing slash!

Edit the new file (installed in the config directory) and set:

CLIENT_ID to the client id of your developer application
PERSONAL_ACCESS_TOKEN to the newly generated token (if applicable, optional for staging development)
REDIRECT_URI: Must exactly match the redirect URI used to register the OAuth developer application. Default value is appropriate for local development using ember server, with a login page at /login

Using the Test API

To do this, you will need to create a developer application on the relevant version of the OSF.

Running the OSF Locally (optional)

For local development, you will need to be running the OSF APIv2. To connect to the APIv2 while using fakecas, you will need to generate a personal access token on your local OSF instance ([here](http://localhost:5000/settings/tokens/-- go ahead and grant access to all scopes)).

Create a local settings file

If for some reason you don't have a config/local.yml you can generate one. To do this:

ember generate ember-osf

Usage

Ember Data: Using the OSF models

The models, serializers, adapters bundled in this addon with be available to you automatically. For example, simply do:

this.store.findAll('node')

to fetch all nodes.

Running

We recommend developers target out test server:

test (test): matches production features, very stable

Other options include:

local (local): for developers running the OSF stack locally
staging (stage): contains bleeding edge features, but less stable
staging2 (stage2): another version of staging using running a specific feature branch

Then (using test as an example) run: BACKEND=test ember server

and visit your app at http://localhost:4200.

Note: This runs the dummy app contained in /tests/dummy

Running Tests

npm test (Runs ember try:testall to test your addon against multiple Ember versions)
ember test
ember test --server

Building

ember build

For more information on using ember-cli, visit http://www.ember-cli.com/.

el1t / ember-osf