skip to navigation
skip to content

bullhorn_interface 2.0.5.dev0

A simple Python package to facilitate interactions with the Bullhorn REST API


Description
===========

This package facilitates the usage of Bullhorn's developer API.

Features
--------

- Handles `Authorization <#login_token>`__

- `Stored <#no_plaintext>`__ Credentials Optional

- Handles Tokens

- `Granting <#login_token>`__
- `Storing <#databases>`__
- Auto Refresh Expired Tokens

- Facilitates Simple `Concurrency <#creation>`__
- Works in Windows (Please no flash photography)

Setup
=====

Environment
===========

Linux
-----

Create environment using anaconda or whatever and activate it:

.. code:: ipython3

conda create -n bullhorn3.6
source activate bullhorn3.6
pip install -r /path/to/project_root/requirements.txt

Windows (Anaconda)
==================

Same as above, but you will need to perform

.. code:: ipython3

conda install psycopg2
conda install sqlalchemy

afterwards, as there are some dependencies that Anaconda has to work out
to make these packages work on Windows. I highly recommend you use
Anaconda in windows, as it will handle all the nasty c bits that
numerous python packages require.

## Configuration

There needs to be a file named ``bullhorn_interface.conf`` that looks
like this somewhere on your system:

.. code:: ipython3

[bullhorn_interface]
TOKEN_HANDLER = [pick from 'live', 'pg', or 'sqlite']
CLIENT_ID = client_id
CLIENT_SECRET = client_secret
BULLHORN_USERNAME = username
BULLHORN_PASSWORD = password
EMAIL_ADDRESS = email@email.com
EMAIL_PASSWORD = password
DB_NAME = bullhorn_box
DB_HOST = localhost
DB_USER = db_user
DB_PASSWORD = password

If this file lives in your working directory you are good to go. If not,
you will need to set an environment variable to the full path of this
file. Note that you can leave each of these lines blank if you are not
comfortable storing items in plaintext, but none of the test will pass
if vital items are left blank. See `here <#no_plaintext>`__ about how to
use the interface without storing credentials in plain text.

Linux
=====

.. code:: ipython3

export INTERFACE_CONF_FILE=/home/jjorissen/bullhorn_secrets.conf

Windows
=======

.. code:: ipython3

set INTERFACE_CONF_FILE=/full/path/to/bullhorn_secrets.conf

To test your current configuration you can do:

.. code:: ipython3

# this cannot be run in jupyter notebooks, sadly.
from bullhorn_interface import tests
tests.run()

If you want to run a full coverage test (for even the features you
aren't configured for) you can set the below environment variable first.

.. code:: ipython3

export TEST_FULL_COVERAGE=1 # it's actually not quite full coverage, sorry.

Developers, you can run the below to test the coverage.

.. code:: ipython3

sudo apt-get install coverage
coverage run -m unittest discover -s bullhorn_interface/
#inline summary
coverage report -m
# generate browser navigable summary
coverage html

If you change your configuration file after loading either the testing or the api library, you must reload ``bullhorn_interface`` to make these changes propogate or the package will continue using the old configurations.
============================================================================================================================================================================================================================

.. code:: ipython3

import importlib
from bullhorn_interface import api, tests
importlib.reload(api)
importlib.reload(tests)




.. parsed-literal::

<module 'bullhorn_interface.tests'="" from="" '="" home="" jjorissen="" projects="" bullhorn_interface="" bullhorn_interface="" tests.py'="">



# Using Postgres or SQLite

Database Setup
==============

Note: If you are using PG, your ``DB_USER`` must have access to the 'postgres' database on your postgreSQL server, and must have sufficient permissions to create and edit databases.
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

To create a database to house your tokens:

.. code:: ipython3

from bullhorn_interface.api import tokenbox
tokenbox.create_database()


.. parsed-literal::

bullhorn_box created successfully.


If you wish to drop that database for some reason:

.. code:: ipython3

tokenbox.destroy_database()


.. parsed-literal::

Database named bullhorn_box will be destroyed in 5...4...3...2...1...0
bullhorn_box dropped successfully.


It's that easy. The necessary tables will be created automatically when
the tokens are generated for the first time, so don't sweat anything!
For more information on using ``tokenbox``, visit the
`repo <https: github.com="" jjorissen52="" tokenbox="">`__.

# Interface Creation ``bullhorn_interface`` interacts will Bullhorn's
API using ``Interface`` objects. \*
```LiveInterface`` <#liveinterface>`__ keeps tokens on itself. These
guys should always be created as
```independent`` <#independent_explanation>`__, as ``LiveInterface``
objects are capable of refreshing expired tokens only for themselves. \*
```StoredInterface`` <#storedinterface>`__ keeps tokens on itself and
also checks tokens in the database before allowing a refresh to happen.
This allows you to use the same token among many interfaces in case you
need to have many running at once. \* Bullhorn doesn't seem to mind if
you have numerous API logins running simultaneously, so there isn't much
utility to the ``StoredInterface``. However, in the case where you are
creating new ``Interface`` objects frequently, using an
```independent`` <#independent_explanation>`__ stored interface will
keep you from having to wait on unnecessary ``login()`` calls.

#### Note: Either of the above ``Interface`` subclasses are fine for
concurrent api calls in most sitations. For a ``LiveInterface`` make a
few independent ones and run the scripts that invoke them at the same
time. For a ``StoredInterface``, make one independent and the rest
dependent.

## Using LiveInterface

### Generate Login Token

.. code:: ipython3

from bullhorn_interface import api
interface = api.LiveInterface(username=api.BULLHORN_USERNAME, password=api.BULLHORN_PASSWORD)
interface.login()


.. parsed-literal::

New Login Token


### Generate API Token Once you've been granted a login token, you can
get a token and url for the rest API.

.. code:: ipython3

interface.get_api_token()


.. parsed-literal::

New Access Token


### Make API Calls

.. code:: ipython3

# Gets info of Cndidate with id:1
interface.api_call()




.. parsed-literal::

{'count': 0, 'data': [], 'start': 0, 'total': 0}



If you got something that looks like the above then you are all
configured. If you want to know what some queries with real data will
look like feel free to play with the below:

.. code:: ipython3

first, last = "John-Paul", "Jorissen"
qs = f"firstName:{first} AND lastName:{last}"
interface.api_call(query=qs)['data'][0]




.. parsed-literal::

{'_score': 1.0,
'comments': '',
'firstName': 'John-Paul',
'id': 425082,
'lastName': 'Jorissen',
'middleName': None,
'notes': {'data': [], 'total': 0}}



Using StoredInterface
=====================

If you for `some reason <#storedinterface_reasons>`__ need (or want) to
keep your tokens stored in a database, you can use the stored interface.

.. code:: ipython3

interface = api.StoredInterface(username=api.BULLHORN_USERNAME, password=api.BULLHORN_PASSWORD)

You interact with everything the same way as the ``LiveInterface``
setup.

.. code:: ipython3

interface.login()
interface.get_api_token()
# there is basically no reason to manually invoke refresh_token(); api_call() will handle expired tokens
# for you.
interface.refresh_token()
interface.api_call()


.. parsed-literal::

New Login Token
New Access Token




.. parsed-literal::

{'count': 0, 'data': [], 'start': 0, 'total': 0}



There is one difference here, however. You can make your
``StoredInterface`` objects independent. This means that they will not
login or refresh tokens on their own; they will instead be relying on a
lead ``StoredInterface`` to keep tokens fresh. For a demonstration run 1
and 2 in separate python command prompts.

.. code:: ipython3

from bullhorn_interface import api
first, last = "John-Paul", "Jorissen"
qs = f"firstName:{first} AND lastName:{last}"
lead_interface = api.StoredInterface(username=api.BULLHORN_USERNAME, password=api.BULLHORN_PASSWORD)
dependent_interface = api.StoredInterface(username=api.BULLHORN_USERNAME, password=api.BULLHORN_PASSWORD,
independent=False)
lead_interface.login()
lead_interface.get_api_token()
# using the tokens that lead_interface aquired
dependent_interface.api_call(query=qs)
# forcing the dependent interface to think the token on its person has expired
dependent_interface.login_token['expiry'] = 0
# the interface will now check itself and find that it's token has expired. after the first failure, it will
# check the database to see if an independent interface has put in a token that has not expired.
dependent_interface.api_call(query=qs)['data'][0]


.. parsed-literal::

New Login Token
New Access Token
Token Expired. Attempt 1/10 failed.




.. parsed-literal::

{'_score': 1.0,
'comments': '',
'firstName': 'John-Paul',
'id': 425082,
'lastName': 'Jorissen',
'middleName': None,
'notes': {'data': [], 'total': 0}}



### Avoiding Plaintext Passwords

If you are a bit squeamish about storing your Bullhorn login credentials
in plaintext somewhere on your filesystem there is a workaround for you.

.. code:: ipython3

import os
os.environ['INTERFACE_CONF_FILE'] = '/home/jjorissen/bullhorn_secrets.conf'
from bullhorn_interface import api
# don't give the interface your password in the config file (leave that field blank)
interface = api.LiveInterface(username="", password="")
# run login and get the url that will generate a login code for you. YOU MUST RUN IT YOURSELF; VISITING
# THE URL FROM THIS TUTORIAL WILL NOT WORK FOR YOU.
interface.login()

::

Credentials not provided. Provide a username/password combination or follow the procedure below:
Paste this URL into browser https://auth.bullhornstaffing.com/oauth/authorize?client_id=YOUCLIENTID&response_type=code
Redirect URL will look like this: http://www.bullhorn.com/?code=YOUR%CODE%WILL%BE%RIGHT%HERE&client_id=YOURCLIENTID

.. code:: ipython3

# you can only login with this code once.
interface.login(code="YOUR%CODE%WILL%BE%RIGHT%HERE")


.. parsed-literal::

New Login Token


You can also avoiding storing any other sensitive information in
plaintext by omitting them from your configurations (leave the key
empty) file and manually adding it to the ``Interface`` and
``api.tokenbox`` like shown below:

.. code:: ipython3

from tokenbox import TokenBox
api.tokenbox = TokenBox('username', 'password', 'db_name', api.metadata, db_host='localhost',
use_sqlite=True, **api.table_definitions)
interface.client_id = "I%am%your%client%ID"
interface.client_secret = "I%am%your%client%secret"
interface.login()

API Parameters
==============

Now with your interfaces in order, you can make API calls. This will all
be done with ``interface.api_call``. You'll need to look over the
Bullhorn API Reference Material to know what the heck everything below
is about.

- `API Reference <http: bullhorn.github.io="" rest-api-docs=""/>`__
- `Entity
Guide <http: bullhorn.github.io="" rest-api-docs="" entityref.html="">`__

``api_call`` key-word arguments:

- ``command`` (``str``) designates which Bullhorn API command type is
being used. Valid options are

- ``command="search"``

- Will return default fields unless ``select_fields`` is set

- ``command="query"``

- Will return default fields unless ``select_fields`` is set
- Must designate a where clause using
``kwargs={'where': WHERE_CLAUSE}``
- Can designate other API parameters using ``kwargs`` such as
``kwargs={. . ., 'orderBy': 'id'}``

- ``command="entity"``

- Must be used in conjunction with approprate ``method``,
``entity``, and ``query`` or ``entity_id``.

- ``query`` (``str``) allows you to designate an SQL style ``WHERE``
clause when using ``command="search"``.
- ``entity`` (``str``) designates which `type of
entity <http: bullhorn.github.io="" rest-api-docs="" entityref.html="">`__
will be selected, created, or updated.

- Must use ``method="CREATE"`` or ``method="UPDATE"`` or
``method="GET"``.

- ``method`` (``str``) designates which HTTP method will be used to
carry out the request. ``"UPDATE"`` corresponds to ``POST``,
``"CREATE"`` corresponds to ``PUT``, and ``"GET"`` corresponds to
``GET``. It is unnecessary to specify ``method`` for
``command="seach"`` or ``command="query"``, but it is necessary to
specify ``method`` for ``command="entity"``.
- ``entity_id`` (``str``) designates the id of the desired entity if
``query`` is not set.
- ``select_fields`` (``str`` or ``list``) designates which bullhorn
fields will be present in the API response.

- ``select_fields=["id", "firstName", "middleName", "lastName", "comments", "notes(*)"]``
- ``select_fields="id, firstName, middleName, lastName, comments, notes(*)"``

- ``body`` allows you to pass a request body. This is necessary when
updating or creating an entity, for example.
- ``auto_refresh`` (``bool``) defaults to ``True``. This argument
designates whether or you wish to extend the lifetime of your tokens
before carrying out the API call. If you set this to ``False``
(because refreshing tokens is time consuming), you will need to
implement your own logic to ensure that your tokens are being
refreshed at least every ten minutes.

Any other keyword arguemnts will be passed as API parameters when making
an API call.

Example Usage
=============

By default, ``api_call()`` will do a search on the candidate
corresponding to ``id:1`` and return the API response object. It will
refresh your tokens automatically.

For testing purposes, ``api_call()`` with no passed arguments is
equivalent to

.. code:: ipython3

api_call(command="search", entity="Candidate", query="id:1",
select_fields="id, firstName, middleName, lastName, comments, notes(*)",
auto_refresh=True)

Get Candidate IDs (and comments) by first and last name
=======================================================

.. code:: ipython3

first_name, last_name = "John-Paul", "Jorissen"

def get_candidate_id(first_name, last_name):
return interface.api_call(command="search", entity="Candidate", select_fields=["id", "comments"],
query=f"firstName:{first_name} AND lastName:{last_name}")

candidate = get_candidate_id(first_name, last_name)['data']
print(list(filter(lambda x: x['id'] == 425084, candidate)))


.. parsed-literal::

[{'id': 425084, 'comments': 'I am the old comment', '_score': 1.0}]


Update a Candidate's comments
=============================

.. code:: ipython3

candidate_id = 425084
comments = 'I am the new comment'
body = {"comments": comments}
interface.api_call(command="entity", entity="Candidate", entity_id=candidate_id, body=body, method="UPDATE")




.. parsed-literal::

{'changeType': 'UPDATE',
'changedEntityId': 425084,
'changedEntityType': 'Candidate',
'data': {'comments': 'I am the new comment'}}



.. code:: ipython3

print(list(filter(lambda x: x['id'] == 425084, get_candidate_id(first_name, last_name)['data'])))


.. parsed-literal::

[{'id': 425084, 'comments': 'I am the new comment', '_score': 1.0}]


Questions
=========

Feel free to contact me with questions and suggestions of improvements.
Contributions are greatly appreciated.

`jjorissen52@gmail.com <mailto:jjorissen52@gmail.com?subject=bullhorn_interface%20->`__

 
File Type Py Version Uploaded on Size
bullhorn_interface-2.0.5.dev0.tar.gz (md5) Source 2017-09-14 15KB