Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bullhorn/bullhornjs
javascript library to use the Bullhorn's REST APIs
https://github.com/bullhorn/bullhornjs
bullhorn demo javascript
Last synced: 2 months ago
JSON representation
javascript library to use the Bullhorn's REST APIs
- Host: GitHub
- URL: https://github.com/bullhorn/bullhornjs
- Owner: bullhorn
- License: mit
- Created: 2014-11-18T19:36:57.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-09-28T17:25:42.000Z (about 3 years ago)
- Last Synced: 2024-04-26T17:07:33.639Z (8 months ago)
- Topics: bullhorn, demo, javascript
- Language: JavaScript
- Size: 27.3 KB
- Stars: 39
- Watchers: 55
- Forks: 11
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BullhornJS
BullhornJS is a micro-library that makes it easy to use the Bullhorn REST APIs in JavaScript applications.
BullhornJS allows you to easily login into Bullhorn using OAuth, and to manipulate your Bullhorn data using a simple
API.
This is an early version. I appreciate any feedback, comments, and help if you think this library is useful.
### Key Characteristics
- No jQuery dependency
- Plain JavaScript
- Works transparently in the browser
- Simple API to manipulate data (create, update, delete, upsert)
- CommonJS format
### Installation
##### NPM
npm install --save @bullhorn/bullhornjs
##### Bower
bower install --save bullhornjs
### Usage
1. Initialize
```
var bullhorn = new Bullhorn({
BhRestToken: '~BULLHORN_REST_TOKEN~',
restUrl: '~BULLHORN_REST_URL~',
});
```
2. Check if logged in:
```
bullhorn.isLoggedIn()
.then(function(success){
alert('Login success: ' + success);
})
.catch(function(error){
alert('Error: ' + error.message);
});
```
3. Invoke a function: Search(), Query(), Entity(), Meta():
```
// Most functions are all fluent (ie. they return 'this')
var job = new Entity('entity/JobOrder').fields('title');
// the 'fields' function created a getter and setter for 'title'
job.title = 'My New Job';
job.save(); //returns a promise
```
4. Use a convenience method: CandidateSearch(), JobOrder(), ContactMeta(), etc...:
```
// This command creates the convenience functions
Bullhorn.initDefaults();
// Now you can use them
var job = new Job().fields('title'); //works the same as above
job.get(123).then(function(response){
console.log('Job Title is ', job.title);
});
```
### Sample App
Check out the demo in the `demo` folder. To run the demo:
```
> git clone https://github.com/bullhorn/bullhornjs.git
> cd bullhornjs
> npm install
> npm run bundle
> npm install -g http-server
> http-server
```
open `http://localhost:8080/demo/index.html` in your browser
### Server
Because the browser should not know your `CLIENT_ID` or `CLIENT_SECRET` your will need to handle the OAuth flow separately then have the server provide the `BhRestToken` and `restUrl` to the client.
### Building
We build two versions of the source, 1) we create a bundle using [rollup](http://rollupjs.org/) and 2) we compile all the sources separately with babel. All transpiled files are stored in the `lib` directory.
##### Rollup Bundle
This uses `rollup.config.js` to determine how to rollup the source. The bundle is located in `lib/bundle.js`. Configuration options are available [here](https://github.com/rollup/rollup/wiki/Command-Line-Interface). To create a new bundle:
npm run bundle
##### Babel Compile
This uses `.babelrc` to determine how to babel compiles the source. The files are transpiled to the `lib/` directory. Other configuration options are available [here](http://babeljs.io/docs/usage/babelrc/). To rebuild these:
npm run compile
### Testing
We use [Jest](https://facebook.github.io/jest/) to run all of our unit test. To run the tests, in the working directory:
npm test